Arquillian Droidium 1.0.0.Alpha1 Released

The Arquillian team is proud to announce the 1.0.0.Alpha1 release of the Arquillian Droidium component!

This is the very first release of ongoing effort from the Arquillian community to bring Arquillian goodies even to your mobile environment! Arquillian Droidium container adapter and supplement plugins for it are enabling you to execute functional tests with Arquillian Graphene and Arquillian Drone in the Arquillian way on your Android devices – emulators and physical devices as well.

Arquillian Droidium bits

Droidium consists of three components:

Arquillian container adapter for Android devices

When you think about it, an Android device is in principle some kind of a container where you install your APKs (depoyments) to and uninstalling them from afterwards once your tests are done. The Arquillian container adapter takes care of the device management, meaning starting and stopping your emulator or connecting to it if it is already started (following the remote and managed container abstraction). It even dynamically creates your AVD according to your preferences and deletes it once the tests are done. Android container adapter does not test on its own. The actual testing is delegated to other plugins.

Droidium native plugin

Droidium native plugin enables you to test your native APK applications by using the WebDriver API. The APK you want to test is deployed to the Android emulator, you start your activities from within your test method and from there you are good to go with your WebDriver tests! But wait a minute, we did not stopped there. You can deploy multiple APKs to your emulator prior to test execution and functionally test them all in one go. Is there some APK you do not want to test but it is required as a dependency? No problem at all, just add them to your deployment methods.

Lets see how you can do native testing:

@RunWith(Arquillian.class)
@RunAsClient
public class MyMobileAppTestCase {

    // injection for switching between activities and
    // interacting with Android device on lowlevel
    @ArquillianResource
    AndroidDevice android;

    // you have the possibility to take screenshots as you are 
    // doing tests, they are stored in target, lot of options behind this
    @ArquillianResource
    Screenshooter screenshooter;

    // class scoped Drone, it will be available to use during whole test execution
    @Drone @MyApp WebDriver test_app;

    // Deployments you want to test by WebDriver has to be annotated 
    // with @Instrumentable annotation. Port forwarding from Android device to 
    // localhost is done and WebDriver instance is listening to it. Port on 
    // localhost side is taken from extension configuration in arquillian.xml

    // Every deployment you want to test has to have its own WebDriver

    @Deployment(name = "my-app")
    @Instrumentable(viaPort = 8081)
    public static Archive<?> myAppDeployment() {
        return ShrinkWrap.createFromZipFile(JavaArchive.class, new File("my-app.apk"));
    }

    @Deployment(name = "my-another-app")
    @Instrumentable(viaPort = 8082) // another app so another port, you have second WebDriver
    public static Archive<?> myAnotherAppDeployment() {
        return ShrinkWrap.createFromZipFile(JavaArchive.class, new File("my-another-app.apk"));
    }

    // This APK will not be instrumented. You just need to put it to Android device 
    // e.g. to safisfy APKs dependencies
    @Deployment(name = "resource-apk")
    public static Archive<?> myResourceDeployment() {
        return ShrinkWrap.createFromZipFile(JavaArchive.class, new File("resources.apk"));
    }

    @Test
    @InSequence(1)
    @OperateOnDeployment("my-app")
    public void test01() {
        // activities in APKs are automatically scanned upon deployment installation and Android
        // activity manager knows on which WebDriver instance it should start that activity up
        android.getActivityManagerProvider()
            .getActivityManager()
            .startActivity("my.testapp.HomeScreenActivity");

        // ... tests with test_app Drone
    }

    @Test
    @InSequence(2)
    @OperateOnDeployment("my-another-app")
    public void test02(@Drone @MyTestApp WebDriver myTestApp) {
        android.getActivityManagerProvider()
            .getActivityManager()
            .startActivity("my.another.testapp.MainActivity");

        // ... tests

        // you can do something like this after you want to switch to another activity
        // android.getActivityManagerProvider()
        //      .getActivityManager().startActivity("another.activity")

        // since you have both Drones available here (class scoped and method scoped as well)
        // you can choose whatever activity from both deployments you want. After this method
        // ends, you can start activities only from the "my-app" deployment since the second
        // WebDriver is destroyed
    }
}

Droidium web plugin

The web plugin for the Droidium container enables you to test your web applications that are deployed on an application servers like JBoss AS/Wildfly from your mobile phone. Once you’ve coded your web application, you construct the @Deployment. Droidium will then starts the application container and the Android emulator(or device) automatically for you. The web app is deployed to JBoss AS/Wildfly, the Android server from the Selenium project is installed to the Android device and you are automagically ready to fully use Graphene to test the web application from your mobile phone’s web browser. Sweet?

See it in action

There is lot of example projects which tests various scenarios that deals with Android testing. They can be foundin the project repository in the tests directory

Next release is comming soon

Do not hesitate to drop a message to us on our IRC channel regarding the Droidium extension. We’ll try to release next version fairly soon and we’ll do our best to bring you betas as soon as possible. We look forward to your feedback on this release in our community forums or the #arquillian channel on FreeNode!

Google Summer of Code 2013 project

This project was sponsored by the Google Summer of Code 2013 program where Stefan Miklosovic had a chance to participate. The Arquillian project is very open to new developers willing to help and we are always excited to hear from them. You are welcome to take part as well.

Acknowledgements

I, Stefan Miklosovic, author of these extensions, would like to thank Aslak Knutsen, Karel Piwko, Dan Allen and Tadeas Kriz for their advise, insights and encouragements during the coding period. I would like to thank Dominik Dary from Selendroid project as well on which Droidium native plugin is heavily based.

What is Arquillian?

Arquillian is open source software that empowers you to test JVM-based applications more effectively. Created to defend the software galaxy from bugs, Arquillian brings your test to the runtime so you can focus on testing your application's behavior rather than managing the runtime. Using Arquillian, you can develop a comprehensive suite of tests from the convenience of your IDE and run them in any IDE, build tool or continuous integration environment.

Release details

Component Arquillian Droidium
Version 1.0.0.Alpha1 view tag
Release date 2013-09-18
Released by Karel Piwko
Compiled against

Published artifacts org.arquillian.container

  • org.arquillian.container » arquillian-droidium-container-api jar javadoc pom
  • org.arquillian.container » arquillian-droidium-container-spi jar javadoc pom
  • org.arquillian.container » arquillian-droidium-container-depchain pom
  • org.arquillian.container » arquillian-droidium-container-impl jar javadoc pom
  • org.arquillian.extension » arquillian-droidium-multiple-containers jar javadoc pom
  • org.arquillian.extension » arquillian-droidium-native-api jar javadoc pom
  • org.arquillian.extension » arquillian-droidium-native-spi jar javadoc pom
  • org.arquillian.extension » arquillian-droidium-native-impl jar javadoc pom
  • org.arquillian.extension » arquillian-droidium-native-depchain jar javadoc pom
  • org.arquillian.extension » arquillian-droidium-web-spi jar javadoc pom
  • org.arquillian.extension » arquillian-droidium-web-impl jar javadoc pom
  • org.arquillian.extension » arquillian-droidium-web-depchain jar javadoc pom
  • org.arquillian.droidium.archetypes » arquillian-droidium-archetype-native-test jar javadoc pom
  • org.arquillian.droidium.archetypes » arquillian-droidium-archetype-web-test jar javadoc pom

Release notes and resolved issues 0

Containers an support for native testing of Android in Arquillian

Thanks to the following list of contributors: Stefan Miklosovic, Karel Piwko, Tadeas Kriz, Aslak Knutsen