Introduce classindex dependency and auto-discover WebDriverFactory im…

…plementations.

README.md

@@ -925,6 +925,10 @@ public class BrowserStackWebDriverFactory implements WebDriverFactory {
 }
 ```
 
+This implementation will bediscovered with [classindex](https://github.com/atteo/classindex), a 
+compile-time alternative to run-time classpath scanning. It requires your IDE to have Annotation Processing 
+enabled in the Java Compiler configuration.
+
 Instead of implementing a new ```WebDriverFactory``` class, you may also override ```newWebDriver()``` in the Test 
 class, but doing so will ignore any value defined in ```webDriver``` configuration property.
 

fluentlenium-core/pom.xml

@@ -23,6 +23,10 @@
             <groupId>javax.inject</groupId>
             <artifactId>javax.inject</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.atteo.classindex</groupId>
+            <artifactId>classindex</artifactId>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

fluentlenium-core/src/main/java/org/fluentlenium/configuration/AlternativeNames.java

@@ -0,0 +1,16 @@
+package org.fluentlenium.configuration;
+
+/**
+ * Add alternative names to an object.
+ *
+ * {@link WebDriverFactory} implementations can also implement this interface to be registered in {@link WebDrivers}
+ * registry with those alternative names.
+ */
+public interface AlternativeNames {
+    /**
+     * Get the alternative names.
+     *
+     * @return
+     */
+    String[] getAlternativeNames();
+}

fluentlenium-core/src/main/java/org/fluentlenium/configuration/DefaultWebDriverFactories.java

@@ -0,0 +1,28 @@
+package org.fluentlenium.configuration;
+
+public class DefaultWebDriverFactories {
+    public static class FirefoxWebDriverFactory extends ReflectiveWebDriverFactory {
+        public FirefoxWebDriverFactory() {
+            super("firefox", "org.openqa.selenium.firefox.FirefoxDriver");
+        }
+    }
+
+    public static class ChromeWebDriverFactory extends ReflectiveWebDriverFactory {
+        public ChromeWebDriverFactory() {
+            super("chrome", "org.openqa.selenium.chrome.ChromeDriver");
+        }
+    }
+
+    public static class InternetExplorerWebDriverFactory extends ReflectiveWebDriverFactory {
+        public InternetExplorerWebDriverFactory() {
+            super("ie", "org.openqa.selenium.ie.InternetExplorerDriver");
+        }
+    }
+
+    public static class HtmlUnitWebDriverFactory extends ReflectiveWebDriverFactory {
+        public HtmlUnitWebDriverFactory() {
+            super("htmlunit", "org.openqa.selenium.htmlunit.HtmlUnitDriver");
+        }
+    }
+
+}

fluentlenium-core/src/main/java/org/fluentlenium/configuration/ReflectiveWebDriverFactory.java

@@ -9,13 +9,15 @@
 /**
  * A simple {@link WebDriverFactory} that create {@link WebDriver} instances using reflection.
  */
-public class ReflectiveWebDriverFactory implements WebDriverFactory {
+public class ReflectiveWebDriverFactory implements WebDriverFactory, AlternativeNames {
+    private String name;
     private Object[] args;
     private String webDriverClassName;
     private Class<? extends WebDriver> webDriverClass;
     private boolean available;
 
-    public ReflectiveWebDriverFactory(String webDriverClassName, Object... args) {
+    public ReflectiveWebDriverFactory(String name, String webDriverClassName, Object... args) {
+        this.name = name;
         this.webDriverClassName = webDriverClassName;
         this.args = args;
         try {
@@ -26,7 +28,8 @@ public ReflectiveWebDriverFactory(String webDriverClassName, Object... args) {
         }
     }
 
-    public ReflectiveWebDriverFactory(Class<? extends WebDriver> webDriverClass, Object... args) {
+    public ReflectiveWebDriverFactory(String name, Class<? extends WebDriver> webDriverClass, Object... args) {
+        this.name = name;
         this.webDriverClass = webDriverClass;
         this.args = args;
         this.webDriverClassName = webDriverClass.getName();
@@ -55,7 +58,12 @@ public WebDriver newWebDriver() {
     }
 
     @Override
-    public String[] getNames() {
+    public String getName() {
+       return name;
+    }
+
+    @Override
+    public String[] getAlternativeNames() {
         if (webDriverClass != null) {
             return new String[]{webDriverClass.getName(), webDriverClass.getSimpleName()};
         }

fluentlenium-core/src/main/java/org/fluentlenium/configuration/WebDriverFactory.java

@@ -1,10 +1,14 @@
 package org.fluentlenium.configuration;
 
+import org.atteo.classindex.IndexSubclasses;
 import org.openqa.selenium.WebDriver;
 
+import javax.inject.Named;
+
 /**
  * Factory of {@link WebDriver}, that can be registered in {@link WebDrivers} registry.
  */
+@IndexSubclasses
 public interface WebDriverFactory {
     /**
      * Creates a new instance of {@link WebDriver}.
@@ -14,9 +18,11 @@ public interface WebDriverFactory {
     WebDriver newWebDriver();
 
     /**
-     * Names of this factory.
+     * Primary name of this factory.
      *
-     * @return
+     * To register it with alternative name, use {@link AlternativeNames}.
+     *
+     * @return Primary name.
      */
-    String[] getNames();
+    String getName();
 }

fluentlenium-core/src/main/java/org/fluentlenium/configuration/WebDriverFactoryProcessor.java

@@ -0,0 +1,9 @@
+package org.fluentlenium.configuration;
+
+import org.atteo.classindex.processor.ClassIndexProcessor;
+
+public class WebDriverFactoryProcessor extends ClassIndexProcessor {
+    public WebDriverFactoryProcessor() {
+        indexSubclasses(WebDriverFactory.class);
+    }
+}

fluentlenium-core/src/main/java/org/fluentlenium/configuration/WebDrivers.java

@@ -1,15 +1,18 @@
 package org.fluentlenium.configuration;
 
 import lombok.experimental.Delegate;
+import org.atteo.classindex.ClassIndex;
 import org.openqa.selenium.WebDriver;
 
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Modifier;
 import java.util.HashMap;
 import java.util.Map;
 
 /**
  * A registry of {@link WebDriverFactory}.
  * <p>
- * Supported drivers are "firefox", "htmlunit".
+ * Supported drivers are "firefox", "chrome", "ie", "htmlunit", or any class name implementing {@link WebDriver}.
  */
 public enum WebDrivers {
     INSTANCE;
@@ -19,10 +22,21 @@ public enum WebDrivers {
 
     static class Impl {
         Impl() {
-            register("firefox", new ReflectiveWebDriverFactory("org.openqa.selenium.firefox.FirefoxDriver"));
-            register("chrome", new ReflectiveWebDriverFactory("org.openqa.selenium.chrome.ChromeDriver"));
-            register("ie", new ReflectiveWebDriverFactory("org.openqa.selenium.ie.InternetExplorerDriver"));
-            register("htmlunit", new ReflectiveWebDriverFactory("org.openqa.selenium.htmlunit.HtmlUnitDriver"));
+            Iterable<Class<? extends WebDriverFactory>> factoryClasses = ClassIndex.getSubclasses(WebDriverFactory.class);
+            for (Class<? extends WebDriverFactory> factoryClass : factoryClasses) {
+                if (factoryClass == ReflectiveWebDriverFactory.class) continue;
+                if (Modifier.isAbstract(factoryClass.getModifiers())) continue;
+                if (!Modifier.isPublic(factoryClass.getModifiers())) continue;
+                WebDriverFactory factory;
+                try {
+                    factory = factoryClass.getConstructor().newInstance();
+                } catch (NoSuchMethodException e) {
+                    throw new ConfigurationException(factoryClass + " should have a public default constructor.", e);
+                } catch (Exception e) {
+                    throw new ConfigurationException(factoryClass + " can't be instantiated.", e);
+                }
+                register(factory);
+            }
         }
 
         private Map<String, WebDriverFactory> factories = new HashMap<>();
@@ -36,7 +50,7 @@ static class Impl {
         public synchronized WebDriverFactory get(String name) {
             WebDriverFactory factory = factories.get(name);
             if (factory == null) {
-                ReflectiveWebDriverFactory reflectiveFactory = new ReflectiveWebDriverFactory(name);
+                ReflectiveWebDriverFactory reflectiveFactory = new ReflectiveWebDriverFactory(name, name);
                 if (reflectiveFactory.isAvailable()) {
                     factories.put(name, reflectiveFactory);
                     factory = reflectiveFactory;
@@ -58,21 +72,29 @@ public synchronized WebDriver newWebDriver(String name) {
         }
 
         /**
-         * Register a new {@link WebDriver} factory with the given name.
+         * Register a new {@link WebDriver} factory.
          *
-         * It will also register the factory under names returned by {@link WebDriverFactory#getNames()}
+         * It will also register the factory under names returned by {@link AlternativeNames#getAlternativeNames()} if
+         * it implements {@link AlternativeNames}.
          *
-         * @param name name to register
          * @param factory {@link WebDriver} factory to register
          */
-        public synchronized void register(String name, WebDriverFactory factory) {
-            if (factories.containsKey(name)) {
-                throw new ConfigurationException("A factory is already registered with this name: " + name + " (" + factories.get(name) + ")");
+        public synchronized void register(WebDriverFactory factory) {
+            if (factories.containsKey(factory.getName())) {
+                throw new ConfigurationException("A factory is already registered with this name: " +
+                        factory.getName() + " (" + factories.get(factory.getName()) + ")");
             }
-            factories.put(name, factory);
-            for (String alternativeName : factory.getNames()) {
-                factories.put(alternativeName, factory);
+            factories.put(factory.getName(), factory);
+            if (factory instanceof AlternativeNames) {
+                for (String alternativeName : ((AlternativeNames) factory).getAlternativeNames()) {
+                    if (factories.containsKey(alternativeName)) {
+                        throw new ConfigurationException("A factory is already registered with this name: " +
+                                alternativeName + " (" + factories.get(alternativeName) + ")");
+                    }
+                    factories.put(alternativeName, factory);
+                }
             }
+
         }
     }
 

fluentlenium-core/src/test/java/org/fluentlenium/configuration/ReflectiveWebDriverFactoryTest.java

@@ -34,7 +34,7 @@ public FailingDriver() {
 
     @Test
     public void testInexistantClass() {
-        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("org.fluentlenium.ThisClassDoesntExists");
+        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("doesnt-exists", "org.fluentlenium.ThisClassDoesntExists");
         assertThat(webDriverFactory.isAvailable()).isFalse();
 
         assertThatThrownBy(new ThrowableAssert.ThrowingCallable() {
@@ -45,13 +45,11 @@ public void call() throws Throwable {
         }).isExactlyInstanceOf(ConfigurationException.class);
 
         assertThat(webDriverFactory.getWebDriverClass()).isNull();
-
-        assertThat(webDriverFactory.getNames()).isEmpty();
     }
 
     @Test
     public void testNonWebDriverClass() {
-        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory(getClass().getName());
+        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("test-class", getClass().getName());
         assertThat(webDriverFactory.isAvailable()).isFalse();
 
         assertThatThrownBy(new ThrowableAssert.ThrowingCallable() {
@@ -66,7 +64,7 @@ public void call() throws Throwable {
 
     @Test
     public void testAbstractClass() {
-        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory(AbstractDriver.class);
+        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("abstract", AbstractDriver.class);
         assertThat(webDriverFactory.isAvailable()).isTrue();
 
         assertThatThrownBy(new ThrowableAssert.ThrowingCallable() {
@@ -79,7 +77,7 @@ public void call() throws Throwable {
 
     @Test
     public void testNoConstructorClass() {
-        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory(NoConstructorDriver.class);
+        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("no-constructor", NoConstructorDriver.class);
         assertThat(webDriverFactory.isAvailable()).isTrue();
 
         WebDriver webDriver = webDriverFactory.newWebDriver();
@@ -92,7 +90,7 @@ public void testNoConstructorClass() {
 
     @Test
     public void testFailingDriverClass() {
-        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory(FailingDriver.class);
+        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("failing", FailingDriver.class);
         assertThat(webDriverFactory.isAvailable()).isTrue();
 
         assertThatThrownBy(new ThrowableAssert.ThrowingCallable() {
@@ -105,7 +103,7 @@ public void call() throws Throwable {
 
     @Test
     public void testCustomConstructorClassInvalidArguments() {
-        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory(CustomConstructorDriver.class);
+        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("custom_constructor", CustomConstructorDriver.class);
         assertThat(webDriverFactory.isAvailable()).isTrue();
 
         assertThatThrownBy(new ThrowableAssert.ThrowingCallable() {
@@ -118,7 +116,7 @@ public void call() throws Throwable {
 
     @Test
     public void testCustomConstructorClass() {
-        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory(CustomConstructorDriver.class, true);
+        final ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("custom_constructor", CustomConstructorDriver.class, true);
         assertThat(webDriverFactory.isAvailable()).isTrue();
 
         WebDriver webDriver = webDriverFactory.newWebDriver();
@@ -131,11 +129,12 @@ public void testCustomConstructorClass() {
 
     @Test
     public void testHtmlUnitWebDriver() {
-        ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory(HtmlUnitDriver.class.getName());
+        ReflectiveWebDriverFactory webDriverFactory = new ReflectiveWebDriverFactory("htmlunit", HtmlUnitDriver.class.getName());
         assertThat(webDriverFactory.isAvailable()).isTrue();
         assertThat(webDriverFactory.getWebDriverClass()).isSameAs(HtmlUnitDriver.class);
 
-        assertThat(webDriverFactory.getNames()).containsExactly(HtmlUnitDriver.class.getName(), HtmlUnitDriver.class.getSimpleName());
+        assertThat(webDriverFactory.getName()).contains("htmlunit");
+        assertThat(webDriverFactory.getAlternativeNames()).containsExactly(HtmlUnitDriver.class.getName(), HtmlUnitDriver.class.getSimpleName());
 
         WebDriver webDriver = webDriverFactory.newWebDriver();
         try {

fluentlenium-core/src/test/java/org/fluentlenium/configuration/WebDriversTest.java

@@ -22,8 +22,8 @@ public WebDriver newWebDriver() {
         }
 
         @Override
-        public String[] getNames() {
-            return new String[]{"custom-factory"};
+        public String getName() {
+            return "custom";
         }
     }
 
@@ -35,15 +35,15 @@ public void before() {
     @Test
     public void testFirefox() {
         WebDriverFactory firefox = webDrivers.get("firefox");
-        assertThat(firefox).isExactlyInstanceOf(ReflectiveWebDriverFactory.class);
+        assertThat(firefox).isExactlyInstanceOf(DefaultWebDriverFactories.FirefoxWebDriverFactory.class);
 
         Class<? extends WebDriver> webDriverClass = ((ReflectiveWebDriverFactory) firefox).getWebDriverClass();
         assertThat(webDriverClass).isSameAs(FirefoxDriver.class);
     }
 
     @Test(expected = ConfigurationException.class)
     public void testRegisterFirefox() {
-        webDrivers.register("firefox", new CustomWebDriverFactory());
+        webDrivers.register(new CustomWebDriverFactory());
     }
 
     @Test

pom.xml

@@ -144,6 +144,11 @@
                 <artifactId>javabean-tester</artifactId>
                 <version>1.4.1</version>
             </dependency>
+            <dependency>
+                <groupId>org.atteo.classindex</groupId>
+                <artifactId>classindex</artifactId>
+                <version>3.4</version>
+            </dependency>
             <dependency>
                 <groupId>org.powermock</groupId>
                 <artifactId>powermock-module-junit4</artifactId>