Applaunch: Port workload from WA2

The report_results parameter has been removed as the parsing functionality
is now performed by the `uxperf` processor therefore to report the
results of the application launch time ensure the processor has been
enabled.

wa/workloads/applaunch/__init__.py

@@ -0,0 +1,128 @@
+#    Copyright 2015 ARM Limited
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# pylint: disable=attribute-defined-outside-init
+import os
+
+from wa import Workload, ApkUiautoWorkload, Parameter, ApkWorkload
+from wa import ApkFile, settings
+from wa.framework import pluginloader
+from wa.framework.exception import ConfigError, ResourceError
+
+from devlib.utils.android import ApkInfo
+
+
+class Applaunch(ApkUiautoWorkload):
+
+    name = 'applaunch'
+    description = '''
+    This workload launches and measures the launch time of applications for supporting workloads.
+
+    Currently supported workloads are the ones that implement ``ApplaunchInterface``. For any
+    workload to support this workload, it should implement the ``ApplaunchInterface``.
+    The corresponding java file of the workload associated with the application being measured
+    is executed during the run. The application that needs to be
+    measured is passed as a parameter ``workload_name``. The parameters required for that workload
+    have to be passed as a dictionary which is captured by the parameter ``workload_params``.
+    This information can be obtained by inspecting the workload details of the specific workload.
+
+    The workload allows to run multiple iterations of an application
+    launch in two modes:
+
+    1. Launch from background
+    2. Launch from long-idle
+
+    These modes are captured as a parameter applaunch_type.
+
+    ``launch_from_background``
+        Launches an application after the application is sent to background by
+        pressing Home button.
+
+    ``launch_from_long-idle``
+        Launches an application after killing an application process and
+        clearing all the caches.
+
+    **Test Description:**
+
+    -   During the initialization and setup, the application being launched is launched
+        for the first time. The jar file of the workload of the application
+        is moved to device at the location ``workdir`` which further implements the methods
+        needed to measure the application launch time.
+
+    -   Run phase calls the UiAutomator of the applaunch which runs in two subphases.
+            A.  Applaunch Setup Run:
+                    During this phase, welcome screens and dialogues during the first launch
+                    of the instrumented application are cleared.
+            B.  Applaunch Metric Run:
+                    During this phase, the application is launched multiple times determined by
+                    the iteration number specified by the parameter ``applaunch_iterations``.
+                    Each of these iterations are instrumented to capture the launch time taken
+                    and the values are recorded as UXPERF marker values in logfile.
+    '''
+    supported_platforms = ['android']
+
+    parameters = [
+        Parameter('workload_name', kind=str,
+                  description='Name of the uxperf workload to launch',
+                  default='gmail'),
+        Parameter('workload_params', kind=dict, default={},
+                  description="""
+                  parameters of the uxperf workload whose application launch
+                  time is measured
+                  """),
+        Parameter('applaunch_type', kind=str, default='launch_from_background',
+                  allowed_values=['launch_from_background', 'launch_from_long-idle'],
+                  description="""
+                  Choose launch_from_long-idle for measuring launch time
+                  from long-idle. These two types are described in the workload
+                  description.
+                  """),
+        Parameter('applaunch_iterations', kind=int, default=1,
+                   description="""
+                  Number of iterations of the application launch
+                  """),
+    ]
+
+    def init_resources(self, context):
+        super(Applaunch, self).init_resources(context)
+        self.workload_params['markers_enabled'] = True
+        self.workload = pluginloader.get_workload(self.workload_name, self.target,
+                                                  **self.workload_params)
+        self.workload.init_resources(context)
+        self.workload.initialize(context)
+        self.package_names = self.workload.package_names
+        self.pass_parameters()
+        # Deploy test workload uiauto apk
+        self.asset_files.append(self.workload.gui.uiauto_file)
+
+    def pass_parameters(self):
+        self.gui.uiauto_params['workload'] = self.workload.name
+        self.gui.uiauto_params['package_name'] = self.workload.package
+        self.gui.uiauto_params.update(self.workload.gui.uiauto_params)
+        if self.workload.apk.activity:
+            self.gui.uiauto_params['launch_activity'] = self.workload.apk.activity
+        else:
+            self.gui.uiauto_params['launch_activity'] = "None"
+        self.gui.uiauto_params['applaunch_type'] = self.applaunch_type
+        self.gui.uiauto_params['applaunch_iterations'] = self.applaunch_iterations
+
+    def setup(self, context):
+        self.workload.gui.uiauto_params['package_name'] = self.workload.apk.apk_info.package
+        self.workload.gui.init_commands()
+        self.workload.gui.deploy()
+        super(Applaunch, self).setup(context)
+
+    def finalize(self, context):
+        super(Applaunch, self).finalize(context)
+        self.workload.finalize(context)