Calabash Android Java

Implementation of calabash android client in java. Write functional tests for android in java!

Download

Download the latest release calabash-android-java

Getting started

• Download Android Sdk and set up ANDROID_HOME and JAVA_HOME in your environment.
• Calabash-android-java depends on few jars. So add the following jars to class path while running the test.

├── calabash-android-java-<version>.jar
├── commons-io-2.4.jar
├── jackson-core-asl-1.9.13.jar
├── jackson-mapper-asl-1.9.13.jar
├── jruby-1.7.5.jar
├── log4j-1.2.17.jar
└── zip4j_1.3.1.jar

• If you have an existing apk, point to it in the AndroidRunner, see example below on how to write tests.

Note: AndroidRunner starts the emulator if the device name is specified in the configuration, but it is not very stable. So it is advised that the emulator is manually started and serial(e.g emulator-5554) is set in the configuration.

        AndroidConfiguration androidConfiguration = new AndroidConfiguration();
        androidConfiguration.setSerial("emulator-5554");
        AndroidRunner androidRunner = new AndroidRunner("res/AndroidTestApplication.apk", androidConfiguration);
        androidRunner.setup();
        androidRunner.start();

Writing tests

Finding an element and touching it. In the below example, we query for a button and then touch the first one. And if that adds a textview with text "button was touched", we can assert on it.

        AndroidConfiguration androidConfiguration = new AndroidConfiguration();
        androidConfiguration.setSerial("emulator-5554");
        AndroidRunner androidRunner = new AndroidRunner("res/AndroidTestApplication.apk", androidConfiguration);
        AndroidApplication application = androidRunner.start();

        UIElements button = application.query("button");
        button.touch();
        UIElements text = application.query("textview");
        assertEquals("button was touched", text.get(0).getText());

For the query syntax, please take a look at Calabash Wiki. You can use Junit asserts to perform assertions. For more information, visit Calabash page.

Inspecting elements

If you need to know how elements are structured in your application, you can use inspect() method on Application or UIElement instances. It will iterate over each element and it's child elements from which you can build a tree view.

        AndroidConfiguration androidConfiguration = new AndroidConfiguration();
        androidConfiguration.setSerial("emulator-5554");
        AndroidRunner androidRunner = new AndroidRunner("res/AndroidTestApplication.apk", androidConfiguration);
        androidRunner.setup();
        AndroidApplication application = androidRunner.start();

        application.inspect(new InspectCallback() {
  	        public void onEachElement(UIElement element, int nestingLevel) {
   			for (int i = 0; i < nestingLevel; i++) {
   				System.out.print("-");
  			}
   			System.out.print(element.getElementClass() + "\n");
  		}
   	});

Screenshots

takeScreenshot() function can be used to take the screenshot. You can also listen to screenshot events which will be called whenever a screenshot is taken. Calabash ruby client takes screenshots when there is a failure. Hooking on to this event handler will let you know when screenshots are taken.

        File screenshotsDir = new File("screenshots_path");
        application.takeScreenshot(screenshotsDir, "first");
        File screenshot = new File(screenshotsDir, "first_0.png");
        assertTrue(screenshot.exists());

        final StringBuffer screenshotPath = new StringBuffer();
        AndroidConfiguration androidConfiguration = new AndroidConfiguration();
        androidConfiguration.setScreenshotListener(new ScreenshotListener() {
            public void screenshotTaken(String path, String imageType, String fileName) {
                screenshotPath.append(path);
            }
        });
            
        AndroidApplication application = androidRunner.start();
        application.waitFor(new ICondition() {
            @Override
            public boolean test() throws CalabashException {
                return false;
            }
        }, 1);
        
        assertTrue(new File(screenshotPath.toString()).exists());
        

Web View Support

queryWebElements() function can be used to query for webview elements in the webview. It is recommended that you query for unique elements corresponding to the css. touch, setText and other actions work only on the first element if the query returns multiple webelements

        WebElements input = application.queryWebElements("webview css:'input'");
        input.setText(textToEnter);
        
        WebElements button = application.queryWebElements("webview css:'button'");
        button.touch();
        
        //search for all the non visisble elements also
        WebElements div = application.queryWebElements("all webview css:'div'");
        String result = div.getText();
        assertEquals("button was pressed", result);
        

Licence

The MIT License (MIT)

Copyright (c) 2014 Thoughtworks Studios

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.