Merge lp:~zyga/lava-core/formats into lp:lava-core

[Zygmunt Krynicki]

This branch adds the well-known but little-specified TestScenario aka 'lava
job' aka 'dispatcher job' JSON file format.

[Michael Hudson-Doyle (mwhudson)]

Seems fine. I am really pretty sure that metadata has to a be string -> string mapping and I am reminded again of the subtly different formats of "jobs as accepted by the scheduler" and "jobs as accepted by the dispatcher". Both of those can wait though.

review: Approve

=== added file 'lava/core/formats.py'
--- lava/core/formats.py	1970-01-01 00:00:00 +0000
+++ lava/core/formats.py	2012-05-23 16:16:18 +0000
@@ -0,0 +1,169 @@
+# Copyright (C) 2011-2012 Linaro Limited
+#
+# Author: Zygmunt Krynicki <[e-mail]>
+#
+# This file is part of lava-core
+#
+# lava-core is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation
+#
+# lava-core is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with lava-core.  If not, see <http://www.gnu.org/licenses/>.
+
+from __future__ import absolute_import
+
+"""
+lava.core.formats
+=================
+"""
+
+from json_document.document import Document
+from json_document import bridge
+
+__all__ = ['TestScenario']
+
+
+class ScenarioAction(Document):
+    """
+    Fragment of the TestScenario document that describes a single action,
+    or step, of the test scenario.
+    """
+
+    document_schema = {
+        'type': 'object',
+        'properties': {
+            'command': {
+                'type': 'string',
+            },
+            'parameters': {
+                'default': {},
+                'optional': True,
+                'type': 'object',
+            },
+            'metadata': {
+                'default': {},
+                'optional': True,
+                # FIXME: meda-data is under-specified
+            },
+        },
+        'additionalProperties': False
+    }
+
+    @bridge.readwrite
+    def command(self):
+        """
+        Name of the action to perform
+
+        Actions can be provided by any third party software. LAVA ships
+        with a number of useful actions for both Ubuntu and Android.
+        """
+
+    @bridge.fragment
+    def parameters(self):
+        """
+        Dictionary of parameters of this action
+        """
+
+    # XXX: this is ugly, why is it here?
+    @bridge.readwrite
+    def metadata(self):
+        """
+        Dictionary of meta-data
+        """
+
+
+class TestScenario(Document):
+    """
+    Document describing the test scenario to execute.
+
+    The scenario is composed of the target definition and a list of actions to
+    perform. Each action describes what to do (the action "command" name),
+    along with any needed parameters.
+
+    In addition to actions the scenario describes some additional things such
+    as the device type, job name or health check flag. They are used for
+    book-keeping in other parts of LAVA.
+    """
+
+    document_schema = {
+        'type': 'object',
+        'additionalProperties': {},
+        'properties': {
+            'actions': {
+                'items': ScenarioAction
+            }
+        },
+        'device_type': {
+            'default': None,
+            'optional': True,
+            'type': 'string',
+        },
+        'job_name': {
+            'default': None
+            'optional': True,
+            'type': 'string',
+        },
+        'health_check': {
+            'default': False,
+            'optional': True,
+            'type': 'bool',
+        },
+        'target': {
+            'default': None,
+            'optional': True,
+            'type': 'string',
+        },
+        'timeout': {
+            'default': None,
+            'optional': False,
+            'type': 'integer',
+        },
+        'logging_level': {
+            'default': None
+            'enum': ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"],
+            'optional': True,
+            'type': 'string',
+        }
+    }
+
+    @bridge.fragment
+    def actions(self):
+        """
+        List of actions to perform as a part of this scenario
+        """
+
+    @bridge.readwrite
+    def target(self):
+        """
+        Name of the device this test scenario is intended for
+        """
+
+    @bridge.readwrite
+    def timeout(self):
+        """
+        Global job timeout in seconds
+        """
+
+    @bridge.readwrite
+    def device_type(self):
+        """"
+        Type of the device this test scenario is intended for.
+        """
+
+    @bridge.readwrite
+    def job_name(self):
+        """
+        Human-readable name of this job
+        """
+
+    @bridge.readwrite
+    def health_check(self):
+        """
+        Flag used to mark health check jobs
+        """

=== added file 'lava/core/tests/test_formats.py'
--- lava/core/tests/test_formats.py	1970-01-01 00:00:00 +0000
+++ lava/core/tests/test_formats.py	2012-05-23 16:16:18 +0000
@@ -0,0 +1,89 @@
+# Copyright (C) 2011-2012 Linaro Limited
+#
+# Author: Zygmunt Krynicki <[e-mail]>
+#
+# This file is part of lava-core
+#
+# lava-core is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation
+#
+# lava-core is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with lava-core.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+lava.core.tests.test_formats
+============================
+
+Unit tests for the lava.core.formats module
+"""
+
+from unittest2 import TestCase
+
+from lava.core.formats import ScenarioAction, TestScenario
+
+
+class ScenarioActionTests(TestCase):
+
+    _str1 = "str1"
+    _str2 = "str2"
+    _param1 = "param1"
+
+    def test_command_getter(self):
+        """
+        Getting ScenarioAction.command works
+        """
+        action = ScenarioAction({
+            'command': self._str1
+        })
+        self.assertEqual(action.command, self._str1)
+
+    def test_command_setter(self):
+        """
+        Setting ScenarioAction.command works
+        """
+        action = ScenarioAction({})
+        action.command = self._str1
+        self.assertEqual(action.command, self._str1)
+
+    def test_command_default(self):
+        """
+        ScenarioAction.command has no default
+        """
+        action = ScenarioAction({})
+        # NOTE: KeyError is surprising here, it should be mapped to
+        # AttributeError
+        with self.assertRaises(KeyError):
+            action.command
+
+    def test_parameters_getter(self):
+        """
+        Getting ScenarioAction.parameters[...] works
+        """
+        action = ScenarioAction({'parameters': {self._param1: self._str1}})
+        param = action.parameters[self._param1]
+        self.assertEqual(param.value, self._str1)
+
+    def test_parameters_setter(self):
+        """
+        Setting ScenarioAction.parameters[...] works
+        """
+        action = ScenarioAction({})
+        action.parameters[self._param1] = self._str1
+        self.assertEqual(action.parameters[self._param1].value, self._str1)
+
+
+class TestScenarioTests(TestCase):
+
+    def test_actions(self):
+        """
+        Referencing scenario.actions produces a fragment of ScenarioAction
+        """
+        scenario = TestScenario({'actions': [{}]})
+        action0 = scenario.actions[0]
+        self.assertIsInstance(action0, ScenarioAction)