Use CucumberOptions in CucumberInstrumentation, replacing RunWithCucumber. Closes #576.

Author: mfellner

History.md

@@ -15,6 +15,7 @@
 * [Java, Jython] New `--snippet [underscore|camelcase]` option for more control over snippet style. ([#561](https://github.com/cucumber/cucumber-jvm/pull/561), [302](https://github.com/cucumber/cucumber-jvm/pull/302) Márton Mészáros, Aslak Hellesøy)
 * [Windows] Use uri instead of path in CucumberFeature ([#562](https://github.com/cucumber/cucumber-jvm/pull/562) Björn Rasmusson)
 * [Android] Better example for Cucumber-Android. ([#547](https://github.com/cucumber/cucumber-jvm/issues/547), [#574](https://github.com/cucumber/cucumber-jvm/issues/574))
+* [Android] Use @CucumberOptions instead of @RunWithCucumber. ([#576](https://github.com/cucumber/cucumber-jvm/issues/576))
 
 ## [1.1.4](https://github.com/cucumber/cucumber-jvm/compare/v1.1.3...v1.1.4) (2013-08-11)
 

android/src/cucumber/api/android/CucumberInstrumentation.java

@@ -6,10 +6,9 @@
 import android.os.Bundle;
 import android.os.Looper;
 import android.util.Log;
-import cucumber.runtime.Backend;
-import cucumber.runtime.CucumberException;
+import cucumber.api.CucumberOptions;
+import cucumber.runtime.*;
 import cucumber.runtime.Runtime;
-import cucumber.runtime.RuntimeOptions;
 import cucumber.runtime.android.AndroidFormatter;
 import cucumber.runtime.android.AndroidObjectFactory;
 import cucumber.runtime.android.AndroidResourceLoader;
@@ -24,15 +23,10 @@
 import gherkin.formatter.model.*;
 
 import java.io.IOException;
-import java.lang.annotation.Annotation;
-import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Properties;
 
 public class CucumberInstrumentation extends Instrumentation {
-    public static final String ARGUMENT_TEST_CLASS = "class";
-    public static final String ARGUMENT_TEST_PACKAGE = "package";
     public static final String REPORT_VALUE_ID = "InstrumentationTestRunner";
     public static final String REPORT_KEY_NUM_TOTAL = "numtests";
     public static final String REPORT_KEY_NUM_CURRENT = "current";
@@ -47,8 +41,6 @@ public class CucumberInstrumentation extends Instrumentation {
     private ResourceLoader resourceLoader;
     private ClassLoader classLoader;
     private Runtime runtime;
-    private String packageOfTests;
-    private String features;
 
     @Override
     public void onCreate(Bundle arguments) {
@@ -63,46 +55,21 @@ public void onCreate(Bundle arguments) {
         String apkPath = context.getPackageCodePath();
         Reflections reflections = new DexReflections(newDexFile(apkPath));
 
-        // For glue and features either use the provided arguments or try to find a RunWithCucumber annotated class.
-        // If nothing works, default values will be used instead.
-        if (arguments.containsKey(ARGUMENT_TEST_CLASS) || arguments.containsKey(ARGUMENT_TEST_PACKAGE)) {
-
-            String testClass = arguments.getString(ARGUMENT_TEST_CLASS);
-            testClass = testClass != null ? testClass : "null";
-            packageOfTests = arguments.getString(ARGUMENT_TEST_PACKAGE);
-
-            try {
-                Class<?> clazz = classLoader.loadClass(testClass);
-                boolean annotationWasPresent = readRunWithCucumberAnnotation(clazz);
-
-                // If the class is not RunWithCucumber annotated, maybe it's Cucumber annotated?
-                if (!annotationWasPresent) {
-                    SEARCH_ANNOTATION:
-                    for (Method m : clazz.getMethods()) {
-                        for (Annotation a : m.getAnnotations()) {
-                            if (a.annotationType().getName().startsWith("cucumber") && packageOfTests == null) {
-                                packageOfTests = testClass.substring(0, testClass.lastIndexOf("."));
-                                break SEARCH_ANNOTATION;
-                            }
-                        }
-                    }
-                }
-            } catch (ClassNotFoundException e) {
-                Log.w(TAG, e.toString());
-            }
-        } else {
-            for (Class<?> clazz : reflections.getDescendants(Object.class, context.getPackageName())) {
-                if (readRunWithCucumberAnnotation(clazz)) break;
+        Class<?> optionsAnnotatedClass = null;
+        for (Class<?> clazz : reflections.getDescendants(Object.class, context.getPackageName())) {
+            if (clazz.isAnnotationPresent(CucumberOptions.class)) {
+                Log.d(TAG, "Found CucumberOptions in class " + clazz.getName());
+                optionsAnnotatedClass = clazz;
+                break; // We assume there is only one CucumberOptions annotated class.
             }
         }
+        if (optionsAnnotatedClass == null) {
+            throw new CucumberException("No CucumberOptions annotation");
+        }
 
-        Properties properties = new Properties();
-        packageOfTests = packageOfTests != null ? packageOfTests : defaultGlue();
-        features = features != null ? features : defaultFeatures();
-
-        properties.setProperty("cucumber.options", String.format("-g %s %s", packageOfTests, features));
-        runtimeOptions = new RuntimeOptions(properties);
-
+        @SuppressWarnings("unchecked")
+        RuntimeOptionsFactory factory = new RuntimeOptionsFactory(optionsAnnotatedClass, new Class[]{CucumberOptions.class});
+        runtimeOptions = factory.create();
         resourceLoader = new AndroidResourceLoader(context);
 
         List<Backend> backends = new ArrayList<Backend>();
@@ -120,35 +87,16 @@ private DexFile newDexFile(String apkPath) {
         }
     }
 
-    /**
-     * @return true if the class is RunWithCucumber annotated, false otherwise
-     */
-    private boolean readRunWithCucumberAnnotation(Class<?> clazz) {
-        RunWithCucumber annotation = clazz.getAnnotation(RunWithCucumber.class);
-        if (annotation != null) {
-            // isEmpty() only available in Android API 9+
-            packageOfTests = annotation.glue().equals("") ? defaultGlue() : annotation.glue();
-            features = annotation.features().equals("") ? defaultFeatures() : annotation.features();
-            return true;
-        }
-        return false;
-    }
-
-    private String defaultFeatures() {
-        return "features";
-    }
-
-    private String defaultGlue() {
-        return getContext().getPackageName();
-    }
-
     @Override
     public void onStart() {
         Looper.prepare();
 
         List<CucumberFeature> cucumberFeatures = runtimeOptions.cucumberFeatures(resourceLoader);
         int numScenarios = 0;
 
+        // How many individual scenarios (test cases) exist - is there a better way to do this?
+        // This is only relevant for reporting back to the Instrumentation and does not affect
+        // execution.
         for (CucumberFeature feature : cucumberFeatures) {
             for (CucumberTagStatement statement : feature.getFeatureElements()) {
                 if (statement instanceof CucumberScenario) {

android/src/cucumber/api/android/RunWithCucumber.java

@@ -11,14 +11,11 @@ On Windows: use `%ANDROID_HOME%\tools` and `%ANDROID_HOME%\platform-tools` inste
 
 On OS X: Note that for the path to work on the commandline and in IDE's started by launchd [you have to set it](http://stackoverflow.com/questions/135688/setting-environment-variables-in-os-x/588442) in `/etc/launchd.conf` and **NOT** in .bashrc or something else.
 
-### Building
-**Using Maven:**
+### Building using Maven
 
 `mvn package -pl examples/android/android-test -am -P android,android-examples`
 
-### Debugging
+### Debugging using Maven
 Please read [the Android documentation on debugging](https://developer.android.com/tools/debugging/index.html).
 
-**Using Maven:**
-
 `mvn install -pl examples/android/android-test -am -P android,android-examples`

examples/android/android-test/README.md

@@ -2,7 +2,6 @@
 
 import android.app.Activity;
 import android.os.Bundle;
-import cucumber.android.test.R;
 
 public class CucumberActivity extends Activity {
     public void onCreate(Bundle savedInstanceState) {

examples/android/android-test/src/cucumber/example/android/test/CucumberActivity.java

@@ -3,15 +3,32 @@
 import android.app.Instrumentation;
 import android.test.ActivityInstrumentationTestCase2;
 import android.util.Log;
+import cucumber.api.CucumberOptions;
 import cucumber.api.android.CucumberInstrumentation;
 import cucumber.api.java.After;
 import cucumber.api.java.Before;
 import cucumber.api.java.en.Given;
 import cucumber.api.java.en.Then;
 import cucumber.api.java.en.When;
 
-// Glue code classes need to extend Android test classes
-// in order to have access to Context and Instrumentation.
+/**
+ * We extend ActivityInstrumentationTestCase2 in order to have access to methods like getActivity
+ * and getInstrumentation. Depending on what methods we are going to need, we can put our
+ * step definitions inside classes extending any of the following Android test classes:
+ * <p/>
+ * ActivityInstrumentationTestCase2
+ * InstrumentationTestCase
+ * AndroidTestCase
+ * <p/>
+ * The CucumberOptions annotation is mandatory for exactly one of the classes in the test project.
+ * Only the first annotated class that is found will be used, others are ignored. If no class is
+ * annotated, an exception is thrown.
+ * <p/>
+ * The options need to at least specify features = "features". The default value that is set by
+ * Cucumber internally does not work because features are not on the classpath under Android.
+ * Features must be placed inside assets/features/ of the test project (or a subdirectory thereof).
+ */
+@CucumberOptions(features = "features")
 public class CucumberActivitySteps extends ActivityInstrumentationTestCase2<CucumberActivity> {
     private int steps;
 

examples/android/android-test/src/cucumber/example/android/test/CucumberActivitySteps.java

@@ -2,6 +2,7 @@
 
 import android.test.ActivityInstrumentationTestCase2;
 import android.widget.TextView;
+import cucumber.api.CucumberOptions;
 import cucumber.api.java.After;
 import cucumber.api.java.Before;
 import cucumber.api.java.en.Given;
@@ -12,29 +13,38 @@
 
 import static cucumber.example.android.cukeulator.test.Utils.clickOnView;
 
+/**
+ * We extend ActivityInstrumentationTestCase2 in order to have access to methods like getActivity
+ * and getInstrumentation. Depending on what methods we are going to need, we can put our
+ * step definitions inside classes extending any of the following Android test classes:
+ * <p/>
+ * ActivityInstrumentationTestCase2
+ * InstrumentationTestCase
+ * AndroidTestCase
+ * <p/>
+ * The CucumberOptions annotation is mandatory for exactly one of the classes in the test project.
+ * Only the first annotated class that is found will be used, others are ignored. If no class is
+ * annotated, an exception is thrown.
+ * <p/>
+ * The options need to at least specify features = "features". Features must be placed inside
+ * assets/features/ of the test project (or a subdirectory thereof).
+ */
+@CucumberOptions(features = "features")
 public class CalculatorActivitySteps extends ActivityInstrumentationTestCase2<CalculatorActivity> {
-    private CalculatorActivity activity;
 
     public CalculatorActivitySteps() {
         super(CalculatorActivity.class);
     }
 
-    @Before
-    public void before() {
-    }
-
-    @After
-    public void after() {
-    }
-
     @Given("^I have a CalculatorActivity$")
     public void I_have_a_CalculatorActivity() {
-        activity = getActivity();
-        assertNotNull(activity);
+        assertNotNull(getActivity());
     }
 
     @When("^I press (\\d)$")
     public void I_press_d(int d) {
+        CalculatorActivity activity = getActivity();
+
         switch (d) {
             case 0:
                 clickOnView(activity, R.id.btn_d_0);
@@ -71,6 +81,8 @@ public void I_press_d(int d) {
 
     @When("^I press ([+–x\\/=])$")
     public void I_press_op(char op) {
+        CalculatorActivity activity = getActivity();
+
         switch (op) {
             case '+':
                 clickOnView(activity, R.id.btn_op_add);
@@ -92,7 +104,7 @@ public void I_press_op(char op) {
 
     @Then("^I should see (\\S+) on the display$")
     public void I_should_see_s_on_the_display(String s) {
-        TextView display = (TextView) activity.findViewById(R.id.txt_calc_display);
+        TextView display = (TextView) getActivity().findViewById(R.id.txt_calc_display);
         String displayed_result = display.getText().toString();
         assertEquals(s, displayed_result);
     }