Use HTTP to talk to calabash-android (>0.2.0)

also, revamp tests to be more reliable

Author: peritus

.gitignore

@@ -5,11 +5,10 @@ MANIFEST
 dist/
 parts/
 src/robotframework_androidlibrary.egg-info/
-features/
 develop-eggs/robotframework-androidlibrary.egg-link
-.calabash_settings
 android-screenshot-*.png
 log.html
 output.xml
 report.html
 ApiDemos.apk
+test_servers/

DEVELOPMENT.rst

@@ -11,9 +11,9 @@ Prerequisites
 =============
 
 - Install the `Android SDK <http://developer.android.com/sdk/index.html>`_
-- Install calabash-android v0.1.0::
+- Install calabash-android v0.2.9::
 
-    gem install --version '= 0.1.0' calabash-android
+    gem install --version '= 0.2.9' calabash-android
 
 - Create a debug keystore::
 

README.rst

@@ -21,14 +21,9 @@ To install, just fetch the latest version from PyPI::
 Prepare your App
 ++++++++++++++++
 
-robotframework-androidlibrary works only with::
+robotframework-androidlibrary uses calabash-android underneath. To install calabash-android (we've only tested this with v0.2.9 yet), use the following command::
 
-    calabash-android 0.1.0
-
-
-To install calabash-android::
-
-    gem install --version '= 0.1.0' calabash-android
+    gem install --version '= 0.2.9' calabash-android
 
 To prepare your android app look at  <https://github.com/calabash/calabash-android#installation>
 

setup.py

@@ -27,7 +27,7 @@
   zip_safe         = False,
   classifiers      = CLASSIFIERS.splitlines(),
   package_dir      = {'' : 'src'},
-  install_requires = ['robotframework'],
+  install_requires = ['robotframework', 'requests'],
   packages         = ['AndroidLibrary'],
   package_data     = {'AndroidLibrary': ['src/AndroidLibrary/*.jar']}
 )

src/AndroidLibrary/__init__.py

@@ -1,10 +1,8 @@
+import json
 import logging
 import os
 import subprocess
-import json
-import telnetlib
-import os
-
+import requests
 
 THIS_DIR = os.path.dirname(os.path.abspath(__file__))
 execfile(os.path.join(THIS_DIR, 'version.py'))
@@ -106,29 +104,28 @@ def stop_emulator(self):
 
         self._emulator_proc = None
 
-    def set_package_name(self, package_name):
-        self._package_name = package_name
+    def _execute_and_output_does_not_contain_error(self, *args):
+        output = self._execute(*args)
+        assert 'Error' not in output, output
+        return output
+
+    def uninstall_application(self, package_name):
+        self._execute_and_output_does_not_contain_error([self._adb, "uninstall", package_name])
 
-    def install_apk(self, test_apk_path, app_apk_path):
+    def install_application(self, apk_file):
         '''
         Installs the given Android application package file (APK) on the emulator along with the test server.
 
         For instrumentation (and thus all remote keywords to work) both .apk
         files must be signed with the same key.
 
-        `test_apk_path` Path to the Test.apk, usually at 'features/support/Test.apk'
-        `app_apk_path` Path the the application you want to test
+        `apk_file` Path the the application to install
         '''
 
-        def execute_and_output_does_not_contain_error(*args):
-            output = self._execute(*args)
-            assert 'Error' not in output, output
-            return output
+        # TODO polling for package manager
+        # http://code.google.com/p/android/issues/detail?id=842#c7
 
-        execute_and_output_does_not_contain_error([self._adb, "uninstall", "%s.test" % self._package_name])
-        execute_and_output_does_not_contain_error([self._adb, "uninstall", self._package_name])
-        execute_and_output_does_not_contain_error([self._adb, "install", "-r", test_apk_path])
-        execute_and_output_does_not_contain_error([self._adb, "install", "-r", app_apk_path])
+        self._execute_and_output_does_not_contain_error([self._adb, "install", "-r", apk_file])
 
     def wait_for_device(self):
         '''
@@ -150,29 +147,38 @@ def press_menu_button(self):
         '''
         self.send_key(82)
 
-    def start_testserver(self):
+    def start_testserver(self, package_name):
         '''
         Start the remote test server inside the Android Application.
+
+        `package_name` fully qualified name of the application to test
+
         '''
         self._execute([
           self._adb,
+          "wait-for-device",
           "forward",
           "tcp:%d" % 34777,
-          "tcp:7101"
+          "tcp:7102"
         ])
 
         args = [
           self._adb,
+          "wait-for-device",
           "shell",
           "am",
           "instrument",
           "-w",
           "-e",
           "class",
           "sh.calaba.instrumentationbackend.InstrumentationBackend",
-          "%s.test/sh.calaba.instrumentationbackend.CalabashInstrumentationTestRunner" % self._package_name,
+          "%s.test/sh.calaba.instrumentationbackend.CalabashInstrumentationTestRunner" % package_name,
         ]
 
+        self._host = 'localhost'
+        self._port = 34777
+        self._url = 'http://%s:%d' % (self._host, self._port)
+
         logging.debug("$> %s", ' '.join(args))
         self._testserver_proc = subprocess.Popen(args)
 
@@ -183,25 +189,27 @@ def connect_to_testserver(self):
         Application. Performs a handshake.
         '''
 
-        host = 'localhost'
-        port = 34777
-
-        self._connection = telnetlib.Telnet(host, port)
+        response = requests.get(self._url + '/ping')
 
-        # secret calabash handshake
-        self._connection.write("Ping!\n")
-        self._connection.read_until("Pong!\n")
+        assert response.status_code == 200, "InstrumentationBackend sent status %d, expected 200" % response.status_code
+        assert response.text == 'pong', "InstrumentationBackend replied '%s', expected 'pong'" % response.text
 
     def _perform_action(self, command, *arguments):
         action = json.dumps({
           "command": command,
           "arguments": arguments,
-        }) + '\n'
+        })
+
         logging.debug(">> %r", action)
-        self._connection.write(action)
-        result = self._connection.read_until('\n')
-        logging.debug("<< %r", result)
-        return json.loads(result)
+
+        response = requests.post(self._url,
+          data = { 'command': action },
+          headers = { 'Content-Type': 'application/x-www-form-urlencoded' },
+        )
+
+        logging.debug("<< %r", response.text)
+        assert response.status_code == 200, "InstrumentationBackend sent status %d, expected 200" % response.status_code
+        return response.json
 
     # BEGIN: STOLEN FROM SELENIUM2LIBRARY
 
@@ -234,23 +242,13 @@ def capture_screenshot(self, filename=None):
         '''
 
         path, link = self._get_screenshot_paths(filename)
+        response = requests.get(self._url + '/screenshot')
 
-        jar = os.path.join(os.path.dirname(__file__), 'screenShotTaker.jar')
-
-        args = ["java", "-jar", jar, path]
-
-        logging.debug("$> %s", ' '.join(args))
-
-        screenshot_taking_proc = subprocess.Popen(args, env={
-            "ANDROID_HOME": self._ANDROID_HOME
-        })
-        # TODO the screenshot taking command does not terminate if there is an
-        # error (such as a too small timeout)
-
-        # details see
-        # https://github.com/calabash/calabash-android/issues/69
+        with open(path, 'w') as f:
+            f.write(response.content)
+            f.close()
 
-        # screenshot_taking_proc.wait()
+        assert response.status_code == 200, "InstrumentationBackend sent status %d, expected 200" % response.status_code
 
         logger.info('</td></tr><tr><td colspan="3"><a href="%s">'
                    '<img src="%s"></a>' % (link, link), True, False)

src/AndroidLibrary/screenShotTaker.jar

@@ -5,17 +5,13 @@ Resource          variables.txt
 Library           AndroidLibrary
 Library           OperatingSystem
 
-Suite Setup       Setup Suite
-Suite Teardown    Stop Emulator
+#Suite Setup       Setup Suite
+#Suite Teardown    Stop Emulator
 
 Documentation     Tests the ApiDemos.apk that is included in the Android SDK
 
 *** Keywords ***
 
-Execute    [Arguments]    ${command}
-    ${rc}  ${output} =    Run And Return Rc And Output    ${command}
-    Should Be Equal As Integers    ${rc}    0
-
 Setup Suite
 
     Android SDK Should Exist
@@ -29,7 +25,7 @@ Setup Suite
     Re-Sign ApiDemos.apk with Debug Keystore
     Build Instrumentation App
 
-    Wait Until Keyword Succeeds   1m  5s  Install App
+    Install App
 
     Stop Emulator
 
@@ -44,38 +40,42 @@ Create Android Virtual Device
     Execute                       echo "no" | %{ANDROID_HOME}/tools/android --silent create avd --name ${EMULATOR_NAME} --force -t android-${API_LEVEL}
 
 Pull ApiDemos.apk from Device
-    [Timeout]                     120s
-    Wait For Device
+    [Timeout]                     2 minutes
+
+    Wait Until Keyword Succeeds   5 seconds  30 seconds
+    ...                           Wait For Device
+
     Remove File                   ApiDemos.apk
-    Execute                       %{ANDROID_HOME}/platform-tools/adb pull /data/app/ApiDemos.apk
+
+    Wait Until Keyword Succeeds   5 seconds  30 seconds
+    ...  Execute                  %{ANDROID_HOME}/platform-tools/adb pull /data/app/ApiDemos.apk
 
 Re-Sign ApiDemos.apk with Debug Keystore
     File Should Exist             ApiDemos.apk
     Execute                       zip -d ApiDemos.apk META-INF/*
     Execute                       echo "android" | jarsigner -verbose -keystore $HOME/.android/debug.keystore ApiDemos.apk androiddebugkey
 
 Build Instrumentation App
-    Remove File                   .calabash_settings
-    ${settings}=                  Catenate
-    ...                           {
-    ...                             "activity_name": "com.example.android.apis.ApiDemos", 
-    ...                             "api_level": "${API_LEVEL}", 
-    ...                             "app_path": "%{PWD}/ApiDemos.apk", 
-    ...                             "keystore_alias": "androiddebugkey", 
-    ...                             "keystore_alias_password": "debug", 
-    ...                             "keystore_location": "%{HOME}/.android/debug.keystore", 
-    ...                             "keystore_password": "android", 
-    ...                             "package_name": "com.example.android.apis"
-    ...                           }
-    Set Package Name              com.example.android.apis
-    Create File                   .calabash_settings           ${settings}
-    Execute                       calabash-android build
+    Remove Directory              ${EXECDIR}/test_servers/                 recursive=True
+    Execute                       calabash-android build ApiDemos.apk
+
+    ${TEST_SERVERS}=              List Directory    ${EXECDIR}/test_servers/
+    Set Global Variable           ${TEST_APK}       ${TEST_SERVERS[0]}
 
 Install App
-    [Timeout]                     120s
+    [Timeout]                     2 minutes
+
     Wait for Device
 
-    Install APK
-    ...                           ${EXECDIR}/features/support/Test.apk
-    ...                           ${EXECDIR}/ApiDemos.apk
+    Wait Until Keyword Succeeds   5 seconds  30 seconds
+    ...  Uninstall Application    com.example.android.apis
+
+    Wait Until Keyword Succeeds   5 seconds  30 seconds
+    ...  Uninstall Application    com.example.android.apis.test
+
+    Wait Until Keyword Succeeds   5 seconds  30 seconds
+    ...  Install Application      ${EXECDIR}/test_servers/${TEST_APK}
+
+    Wait Until Keyword Succeeds   5 seconds  30 seconds
+    ...  Install Application      ${EXECDIR}/ApiDemos.apk
 

tests/apidemos/__init__.txt

@@ -16,9 +16,13 @@ Setup Suite
     Start Emulator                ${EMULATOR_NAME}          no_window=${HEADLESS_BOOL}
     Wait For Device
     Press Menu Button
+    Execute                       %{ANDROID_HOME}/platform-tools/adb shell setprop log.redirect-stdio true
 
 Setup Test
-    Start Testserver
+    Start Testserver            com.example.android.apis
+
+    Sleep   5 seconds
+
     Wait Until Keyword Succeeds
     ...  1min
     ...  5sec

tests/apidemos/apidemos.txt

@@ -5,3 +5,13 @@ ${API_LEVEL}=       8
 ${SKIP_SETUP}=      False
 ${HEADLESS}=        True
 
+*** Settings ***
+
+Library             OperatingSystem
+
+*** Keywords ***
+
+Execute    [Arguments]    ${command}
+    ${rc}  ${output} =    Run And Return Rc And Output    ${command}
+    Should Be Equal As Integers    ${rc}    0
+