Merge lp:~milo/lava-tool/more-unit-tests into lp:~linaro-validation/lava-tool/trunk

[Milo Casagrande]

More unit tests and some cleanups.

[lp:~milo/lava-tool/more-unit-tests]

426. By Milo Casagrande on 2013-07-22

Merged from parent branch.

427. By Milo Casagrande on 2013-07-22

Added one more test for URL creation method.

428. By Milo Casagrande on 2013-07-24

Merged from parent, fixed conflicts.

[Antonio Terceiro (terceiro)]

Thanks for your work on this. Adding tests is really really nice, and I
hope you are able to do that with the other components as well. :-)

Some comments below.

 review needs-fixing

> === modified file 'lava/commands.py'
> --- lava/commands.py 2013-07-24 14:47:25 +0000
> +++ lava/commands.py 2013-07-24 14:47:25 +0000
> @@ -102,24 +102,31 @@
> raise CommandError("'{0}' already exists, and is a "
> "file.".format(self.args.DIR))
>
> - if not os.path.isdir(full_path):
> - try:
> - os.makedirs(full_path)
> - except OSError:
> - raise CommandError("Cannot create directory "
> - "'{0}'.".format(self.args.DIR))
> -
> - test_path = os.path.join(full_path, TESTS_DIR)
> - if not os.path.isdir(test_path):
> - try:
> - os.makedirs(test_path)
> - except OSError:
> - raise CommandError("Cannot create directory "
> - "'{0}'.".format(self.args.DIR))
> + self._create_dir(full_path)
> + test_path = self._create_dir(full_path, TESTS_DIR)
>
> data = self._update_data()
> self._create_files(data, full_path, test_path)
>
> + def _create_dir(self, full_path, dir_name=None):
> + """Checks if a directory does not exists, and creates it.
> +
> + :param full_path: The path where the directory should be created.
> + :param dir_name: An optional name for a directory to be created at
> + full_path (dir_name will be joined with full_path).
> + :return The path of the created directory."""
> + created_dir = full_path
> + if dir_name:
> + created_dir = os.path.join(full_path, dir_name)
> +
> + if not os.path.isdir(created_dir):
> + try:
> + os.makedirs(created_dir)
> + except OSError:
> + raise CommandError("Cannot create directory "
> + "'{0}'.".format(created_dir))
> + return created_dir
> +
> def _update_data(self):
> """Updates the template and ask values to the user.
>
>
> === modified file 'lava/helper/tests/test_command.py'
> --- lava/helper/tests/test_command.py 2013-07-24 14:47:25 +0000
> +++ lava/helper/tests/test_command.py 2013-07-24 14:47:25 +0000
> @@ -151,3 +151,47 @@
> obtained = BaseCommand.verify_file_extension(
> "/tmp/a_fake.extension", extension, supported)
> self.assertEquals(expected, obtained)
> +
> + def test_verify_and_create_url(self):
> + server = "www.example.org"
> + endpoint = "RPC"
> + expected = "https://www.example.org/RPC/"
> + obtained = BaseCommand.verify_and_create_url(server, endpoint)
> + self.assertEquals(expected, obtained)
> +
> + def test_verify_and_create_url_with_scheme(self):
> + server = "http://www.example.org"
> + endpoint = "RPC/"
> + expected = "http://www.example.org/RPC/"
> + obtained = BaseCommand.verify_and_create_url(server, endpoint)
> + self.ass...

review: Needs Fixing

[Milo Casagrande (milo)]

On Wed, Jul 24, 2013 at 11:07 PM, Antonio Terceiro
<email address hidden> wrote:
>
>
> this part is duplicated with other tests. can we extract it to the base class
> instead?

Hmmm... not so sure... It is tied to the "command" creation, so each
command will have its own initialization, plus there are (and might be
in the future) commands with more than two args that need to be
tested.
I actually do not mind duplicating that code since we are testing
functionalities. I would be more concerned with duplications happening
in the actual code.

--
Milo Casagrande | Automation Engineer
Linaro.org <www.linaro.org> │ Open source software for ARM SoCs

[lp:~milo/lava-tool/more-unit-tests]

429. By Milo Casagrande on 2013-07-26

Merged from parent branch.

430. By Milo Casagrande on 2013-07-26

Fixed test.

431. By Milo Casagrande on 2013-07-26

Added tests for the script commands.

432. By Milo Casagrande on 2013-07-26

More utils tests.

433. By Milo Casagrande on 2013-07-26

Added test for authenticated_server.

434. By Milo Casagrande on 2013-07-26

Merged from parent branch.

435. By Milo Casagrande on 2013-07-29

Merged from parent.

=== modified file 'lava/helper/tests/test_command.py'
--- lava/helper/tests/test_command.py	2013-07-29 08:49:24 +0000
+++ lava/helper/tests/test_command.py	2013-07-29 08:49:25 +0000
@@ -16,7 +16,9 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with lava-tool.  If not, see <http://www.gnu.org/licenses/>.
 
-"""lava.herlp.command module tests."""
+"""lava.helper.command module tests."""
+
+from mock import MagicMock, patch
 
 
 from lava.helper.command import BaseCommand
@@ -32,3 +34,14 @@
         command.register_arguments(self.parser)
         name, args, kwargs = self.parser.method_calls[0]
         self.assertIn("--non-interactive", args)
+
+    @patch("lava.helper.command.AuthenticatingServerProxy", create=True)
+    def test_authenticated_server(self, mocked_auth_server):
+        command = BaseCommand(self.parser, self.args)
+        command.config = MagicMock()
+        command.config.get = MagicMock()
+        command.config.get.side_effect = ["www.example.org", "RPC"]
+
+        command.authenticated_server()
+
+        self.assertTrue(mocked_auth_server.called)

=== modified file 'lava/job/tests/test_commands.py'
--- lava/job/tests/test_commands.py	2013-07-29 08:49:24 +0000
+++ lava/job/tests/test_commands.py	2013-07-29 08:49:25 +0000
@@ -31,6 +31,7 @@
     new,
     run,
     submit,
+    status,
 )
 from lava.parameter import Parameter
 from lava.tool.errors import CommandError
@@ -64,6 +65,22 @@
         if os.path.exists(self.args.FILE):
             os.unlink(self.args.FILE)
 
+    def test_register_arguments(self):
+        new_cmd = new(self.parser, self.args)
+        new_cmd.register_arguments(self.parser)
+
+        # Make sure we do not forget about this test.
+        self.assertEqual(3, len(self.parser.method_calls))
+
+        _, args, _ = self.parser.method_calls[0]
+        self.assertIn("--non-interactive", args)
+
+        _, args, _ = self.parser.method_calls[1]
+        self.assertIn("FILE", args)
+
+        _, args, _ = self.parser.method_calls[2]
+        self.assertIn("--type", args)
+
     def test_create_new_file(self):
         self.new_command.invoke()
         self.assertTrue(os.path.exists(self.args.FILE))
@@ -93,6 +110,19 @@
 
 class JobRunTest(CommandTest):
 
+    def test_register_arguments(self):
+        run_cmd = run(self.parser, self.args)
+        run_cmd.register_arguments(self.parser)
+
+        # Make sure we do not forget about this test.
+        self.assertEqual(2, len(self.parser.method_calls))
+
+        _, args, _ = self.parser.method_calls[0]
+        self.assertIn("--non-interactive", args)
+
+        _, args, _ = self.parser.method_calls[1]
+        self.assertIn("FILE", args)
+
     def test_invoke_raises_0(self):
         # Users passes a non existing job file to the run command.
         self.args.FILE = self.tmp("test_invoke_raises_0.json")
@@ -106,3 +136,20 @@
         mocked_has_command.return_value = False
         command = run(self.parser, self.args)
         self.assertRaises(CommandError, command.invoke)
+
+
+class TestsStatusCommand(CommandTest):
+
+    def test_register_arguments(self):
+        self.args.JOB_ID = "1"
+        status_cmd = status(self.parser, self.args)
+        status_cmd.register_arguments(self.parser)
+
+        # Make sure we do not forget about this test.
+        self.assertEqual(2, len(self.parser.method_calls))
+
+        _, args, _ = self.parser.method_calls[0]
+        self.assertIn("--non-interactive", args)
+
+        _, args, _ = self.parser.method_calls[1]
+        self.assertIn("JOB_ID", args)

=== added directory 'lava/script/tests'
=== added file 'lava/script/tests/__init__.py'
=== added file 'lava/script/tests/test_commands.py'
--- lava/script/tests/test_commands.py	1970-01-01 00:00:00 +0000
+++ lava/script/tests/test_commands.py	2013-07-29 08:49:25 +0000
@@ -0,0 +1,59 @@
+# Copyright (C) 2013 Linaro Limited
+#
+# Author: Milo Casagrande <[e-mail]>
+#
+# This file is part of lava-tool.
+#
+# lava-tool 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-tool 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-tool.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Tests for lava.script.commands.
+"""
+
+from lava.helper.tests.helper_test import HelperTest
+from lava.script.commands import (
+    run,
+    submit,
+)
+
+
+class RunCommandTests(HelperTest):
+
+    def test_register_arguments(self):
+        run_cmd = run(self.parser, self.args)
+        run_cmd.register_arguments(self.parser)
+
+        # Make sure we do not forget about this test.
+        self.assertEqual(2, len(self.parser.method_calls))
+
+        _, args, _ = self.parser.method_calls[0]
+        self.assertIn("--non-interactive", args)
+
+        _, args, _ = self.parser.method_calls[1]
+        self.assertIn("FILE", args)
+
+
+class SubmitCommandTests(HelperTest):
+
+    def test_register_arguments(self):
+        submit_cmd = submit(self.parser, self.args)
+        submit_cmd.register_arguments(self.parser)
+
+        # Make sure we do not forget about this test.
+        self.assertEqual(2, len(self.parser.method_calls))
+
+        _, args, _ = self.parser.method_calls[0]
+        self.assertIn("--non-interactive", args)
+
+        _, args, _ = self.parser.method_calls[1]
+        self.assertIn("FILE", args)

=== added file 'lava/script/tests/test_script.py'
--- lava/script/tests/test_script.py	1970-01-01 00:00:00 +0000
+++ lava/script/tests/test_script.py	2013-07-29 08:49:25 +0000
@@ -0,0 +1,80 @@
+# Copyright (C) 2013 Linaro Limited
+#
+# Author: Milo Casagrande <[e-mail]>
+#
+# This file is part of lava-tool.
+#
+# lava-tool 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-tool 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-tool.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+Unittests for the ShellScript class.
+"""
+
+import os
+import stat
+
+from lava.helper.tests.helper_test import HelperTest
+from lava.script import ShellScript
+
+
+class ShellScriptTests(HelperTest):
+
+    """ShellScript tests."""
+
+    def test_create_file(self):
+        # Tests that a shell script is actually written.
+        try:
+            temp_file = self.tmp("a_shell_test")
+            script = ShellScript(temp_file)
+            script.write()
+
+            self.assertTrue(os.path.isfile(temp_file))
+        finally:
+            os.unlink(temp_file)
+
+    def test_assure_executable(self):
+        # Tests that the shell script created is executable.
+        try:
+            temp_file = self.tmp("a_shell_test")
+            script = ShellScript(temp_file)
+            script.write()
+
+            expected = (stat.S_IRWXU | stat.S_IRWXG | stat.S_IROTH |
+                        stat.S_IXOTH)
+
+            obtained = stat.S_IMODE(os.stat(temp_file).st_mode)
+            self.assertEquals(expected, obtained)
+        finally:
+            os.unlink(temp_file)
+
+    def test_shell_script_content(self):
+        # Tests that the shell script created contains the exepcted content.
+        try:
+            temp_file = self.tmp("a_shell_test")
+            script = ShellScript(temp_file)
+            script.write()
+
+            obtained = ""
+            with open(temp_file) as read_file:
+                obtained = read_file.read()
+
+            expected = ("#!/bin/sh\n# Automatic generated "
+                        "content by lava-tool.\n# Please add your own "
+                        "instructions.\n#\n# You can use all the avialable "
+                        "Bash commands.\n#\n# For the available LAVA "
+                        "commands, see:\n#    http://lava.readthedocs.org/\n"
+                        "#\n")
+
+            self.assertEquals(expected, obtained)
+        finally:
+            os.unlink(temp_file)

=== modified file 'lava/tests/test_parameter.py'
--- lava/tests/test_parameter.py	2013-07-29 08:49:24 +0000
+++ lava/tests/test_parameter.py	2013-07-29 08:49:25 +0000
@@ -26,6 +26,7 @@
 from lava.parameter import (
     ListParameter,
     Parameter,
+    SingleChoiceParameter,
 )
 from lava_tool.utils import to_list
 
@@ -131,3 +132,75 @@
         expected = ["foo", 1, "", "bar"]
         obtained = self.list_parameter.deserialize(expected)
         self.assertEqual(expected, obtained)
+
+    def test_set_value_0(self):
+        # Pass a string to a ListParameter, expect a list.
+        set_value = "foo"
+        expected = [set_value]
+        self.list_parameter.set(set_value)
+        self.assertEquals(expected, self.list_parameter.value)
+
+    def test_set_value_1(self):
+        # Pass a list to a ListParameter, expect the same list.
+        expected = ["foo", "bar"]
+        self.list_parameter.set(expected)
+        self.assertEquals(expected, self.list_parameter.value)
+
+    def test_add_value_0(self):
+        # Add a value to a ListParameter, expect a list back.
+        add_value = "foo"
+        expected = [add_value]
+        self.list_parameter.add(add_value)
+        self.assertEquals(expected, self.list_parameter.value)
+
+    def test_add_value_1(self):
+        # Add a list value to a ListParameter with already a value set, expect
+        # a list with both values.
+        # The ListParameter is initialized with a string.
+        add_value = ["foo"]
+        list_param = ListParameter("list", value="bar")
+        expected = ["bar", "foo"]
+        list_param.add(add_value)
+        self.assertEquals(expected, list_param.value)
+
+    def test_add_value_2(self):
+        # Add a list value to a ListParameter with already a value set, expect
+        # a list with both values.
+        # The ListParameter is initialized with a list.
+        add_value = ["foo"]
+        list_param = ListParameter("list", value=["bar", "baz"])
+        expected = ["bar", "baz", "foo"]
+        list_param.add(add_value)
+        self.assertEquals(expected, list_param.value)
+
+
+class TestsSingleChoiceParameter(GeneralParameterTest):
+
+    def setUp(self):
+        super(TestsSingleChoiceParameter, self).setUp()
+        self.choices = ["foo", "bar", "baz", "bam"]
+        self.param_id = "single_choice"
+        self.single_choice_param = SingleChoiceParameter(self.param_id,
+                                                         self.choices)
+
+    def test_with_old_value(self):
+        # There is an old value for a single choice parameter, the user
+        # is prompted to select from the list of values, but she presses
+        # enter. The old value is returned.
+        old_value = "bat"
+        self.mocked_raw_input.side_effect = ["\n"]
+        obtained = self.single_choice_param.prompt("", old_value=old_value)
+        self.assertEquals(old_value, obtained)
+
+    def test_without_old_value(self):
+        # There is no old value, user just select the first choice.
+        self.mocked_raw_input.side_effect = ["1"]
+        obtained = self.single_choice_param.prompt("")
+        self.assertEquals("foo", obtained)
+
+    def test_with_wrong_user_input(self):
+        # No old value, user inserts at least two wrong choices, and the select
+        # the third one.
+        self.mocked_raw_input.side_effect = ["1000", "0", "3"]
+        obtained = self.single_choice_param.prompt("")
+        self.assertEquals("baz", obtained)

=== modified file 'lava_tool/tests/__init__.py'
--- lava_tool/tests/__init__.py	2013-07-29 08:49:24 +0000
+++ lava_tool/tests/__init__.py	2013-07-29 08:49:25 +0000
@@ -42,6 +42,8 @@
         'lava.helper.tests.test_template',
         'lava.job.tests.test_commands',
         'lava.job.tests.test_job',
+        'lava.script.tests.test_commands',
+        'lava.script.tests.test_script',
         'lava.testdef.tests.test_commands',
         'lava.tests.test_commands',
         'lava.tests.test_config',

=== modified file 'lava_tool/tests/test_utils.py'
--- lava_tool/tests/test_utils.py	2013-07-29 08:49:24 +0000
+++ lava_tool/tests/test_utils.py	2013-07-29 08:49:25 +0000
@@ -18,9 +18,10 @@
 
 """lava_tool.utils tests."""
 
-import sys
 import os
+import shutil
 import subprocess
+import sys
 import tempfile
 
 from unittest import TestCase
@@ -33,10 +34,12 @@
 from lava.tool.errors import CommandError
 from lava_tool.utils import (
     can_edit_file,
+    create_dir,
     edit_file,
     execute,
     has_command,
     retrieve_file,
+    verify_and_create_url,
     verify_file_extension,
 )
 
@@ -137,6 +140,29 @@
             os.unlink(file_name_with_suffix.name)
             os.unlink(hidden_file.name)
 
+    def test_retrieve_job_file_2(self):
+        # Pass a file with the valid extension.
+        temp_file = tempfile.NamedTemporaryFile(suffix=".json")
+        obtained = retrieve_file(temp_file.name, ["json"])
+        self.assertEquals(temp_file.name, obtained)
+
+    def test_retrieve_job_file_3(self):
+        # Pass a file with a non-valid extension.
+        temp_file = tempfile.NamedTemporaryFile(suffix=".bork")
+        self.assertRaises(
+            CommandError, retrieve_file, temp_file.name, ["json"])
+
+    @patch("os.listdir")
+    def test_retrieve_job_file_4(self, mocked_os_listdir):
+        # Pass hidden and wrong files and make sure exception is thrown.
+        a_hidden_file = ".a_hidden.json"
+        b_hidden_file = ".b_hidden.json"
+        c_wrong_file = "a_wrong_file.bork"
+
+        mocked_os_listdir.return_value = [a_hidden_file, b_hidden_file, c_wrong_file]
+        self.assertRaises(
+            CommandError, retrieve_file, tempfile.gettempdir(), ["json"])
+
     @patch("lava_tool.utils.subprocess")
     def test_execute_0(self, mocked_subprocess):
         mocked_subprocess.check_call = MagicMock()
@@ -214,3 +240,43 @@
             obtained = f.read()
 
         self.assertEqual(expected, obtained)
+
+    def test_verify_and_create_url_0(self):
+        expected = "https://www.example.org/"
+        obtained = verify_and_create_url("www.example.org", "")
+        self.assertEquals(expected, obtained)
+
+    def test_verify_and_create_url_1(self):
+        expected = "http://www.example.org/"
+        obtained = verify_and_create_url("http://www.example.org")
+        self.assertEquals(expected, obtained)
+
+    def test_verify_and_create_url_2(self):
+        expected = "http://www.example.org/RPC/"
+        obtained = verify_and_create_url("http://www.example.org", "RPC")
+        self.assertEquals(expected, obtained)
+
+    def test_verify_and_create_url_3(self):
+        expected = "https://www.example.org/RPC/"
+        obtained = verify_and_create_url("www.example.org/", "/RPC/")
+        self.assertEquals(expected, obtained)
+
+    def test_create_dir_0(self):
+        try:
+            temp_dir = os.path.join(tempfile.gettempdir(), "a_dir")
+            create_dir(temp_dir)
+            self.assertTrue(os.path.isdir(temp_dir))
+        finally:
+            shutil.rmtree(temp_dir)
+
+    def test_create_dir_1(self):
+        try:
+            temp_dir = os.path.join(tempfile.gettempdir(), "a_dir")
+            create_dir(temp_dir, "subdir")
+            self.assertTrue(os.path.isdir(os.path.join(temp_dir, "subdir")))
+        finally:
+            shutil.rmtree(temp_dir)
+
+    def test_create_dir_2(self):
+        temp_dir = os.path.join("/", "a_temp_dir")
+        self.assertRaises(CommandError, create_dir, temp_dir)