1
=== modified file 'HACKING.rst'
2
--- HACKING.rst	2015-01-30 18:06:46 +0000
3
+++ HACKING.rst	2015-02-05 13:37:25 +0000
4
@@ -85,6 +85,7 @@
5
85
  bootstrapped in the process;
85
  bootstrapped in the process;
6
86
- a Juju home correctly set up with at least one environment defined in the
86
- a Juju home correctly set up with at least one environment defined in the
7
87
  ``environments.yaml`` file;
87
  ``environments.yaml`` file;
8
88
- the selected Juju environment not to be in use;
9
88
- SSH keys already generated for the user running the tests;
89
- SSH keys already generated for the user running the tests;
10
89
- a working Internet connection.
90
- a working Internet connection.
11
90
91
12
@@ -94,7 +95,7 @@
13
94
    make fcheck JUJU_ENV=myenv
95
    make fcheck JUJU_ENV=myenv
14
95
96
15
96
The environment used by the functional suite is destroyed after the tests
97
The environment used by the functional suite is destroyed after the tests
17
97
complete. For this reason, **ensure the selected environment is not in use**.
98
complete. The tests fail the selected environment is already in use.
18
98
99
19
99
To run the test using a customized build of Juju, pass the ``JUJU`` environment
100
To run the test using a customized build of Juju, pass the ``JUJU`` environment
20
100
variable to ``make``, e.g.::
101
variable to ``make``, e.g.::
21
101
102
22
=== modified file 'quickstart/tests/functional/test_functional.py'
23
--- quickstart/tests/functional/test_functional.py	2015-02-03 14:13:09 +0000
24
+++ quickstart/tests/functional/test_functional.py	2015-02-05 13:37:25 +0000
25
@@ -36,27 +36,55 @@
26
36
FTEST_ENV_VAR = 'JUJU_QUICKSTART_FTESTS'
36
FTEST_ENV_VAR = 'JUJU_QUICKSTART_FTESTS'
27
37
37
28
38
38
31
39
def skip_if_disbled(func):
39
def skip_or_fail_if_environment_not_ready(func):
32
40
    """Decorate a test method so that it is only run when required/possible."""
40
    """Decorate a test method so that it is only run when asked.
33
41
34
42
    Also fail if the Juju environment is already running, or if the default
35
43
    environment cannot be found.
36
44
    """
37
41
    # Check that functional tests are enabled.
45
    # Check that functional tests are enabled.
38
42
    if os.getenv(FTEST_ENV_VAR) != '1':
46
    if os.getenv(FTEST_ENV_VAR) != '1':
39
43
        return unittest.skip(
47
        return unittest.skip(
40
44
            'to run functional tests, set {} to "1"'.format(FTEST_ENV_VAR))
48
            'to run functional tests, set {} to "1"'.format(FTEST_ENV_VAR))
41
45
    # Check that a Juju environment can be found.
42
46
    env_name = envs.get_default_env_name()
43
47
    if env_name is None:
44
48
        return unittest.skip('cannot find a configured Juju environment')
45
49
49
46
50
    @functools.wraps(func)
50
    @functools.wraps(func)
47
51
    def decorated(cls_or_self):
51
    def decorated(cls_or_self):
50
52
        # Decorate the function to update the received class or instance with
52
        # If the environment cannot be found, or it is already running,
51
53
        # the Juju env name.
53
        # do not proceed with setting up the test case class, and make the
52
54
        # tests fail by setting env_error on the class or instance.
53
55
        cls_or_self.env_error = None
54
56
        # Check that a Juju environment can be found.
55
57
        env_name = envs.get_default_env_name()
56
58
        if env_name is None:
57
59
            cls_or_self.env_error = 'cannot find a configured Juju environment'
58
60
            return
59
61
        # Check that the Juju environment is not running.
60
62
        retcode, _, _ = run_juju('status', '-e', env_name)
61
63
        if not retcode:
62
64
            cls_or_self.env_error = (
63
65
                'the {} Juju environment is already running'.format(env_name))
64
66
            return
65
67
        # Update the received class or instance setting the env_name attribute.
66
54
        cls_or_self.env_name = env_name
68
        cls_or_self.env_name = env_name
67
55
        return func(cls_or_self)
69
        return func(cls_or_self)
68
56
70
69
57
    return decorated
71
    return decorated
70
58
72
71
59
73
72
74
def skip_if_environment_not_set(func):
73
75
    """Decorate a test method so that it is not run without an environment.
74
76
75
77
    The presence of the "env_name" attribute in the TestCase indicates whether
76
78
    or not the tests can be run.
77
79
    """
78
80
    @functools.wraps(func)
79
81
    def decorated(cls_or_self):
80
82
        if hasattr(cls_or_self, 'env_name'):
81
83
            return func(cls_or_self)
82
84
83
85
    return decorated
84
86
85
87
86
60
def run_juju(*args):
88
def run_juju(*args):
87
61
    """Run the juju command with the given args.
89
    """Run the juju command with the given args.
88
62
90
89
@@ -81,7 +109,7 @@
90
81
class TestFunctional(unittest.TestCase):
109
class TestFunctional(unittest.TestCase):
91
82
110
92
83
    @classmethod
111
    @classmethod
94
84
    @skip_if_disbled
112
    @skip_or_fail_if_environment_not_ready
95
85
    def setUpClass(cls):
113
    def setUpClass(cls):
96
86
        # Run Juju Quickstart to bootstrap Juju and deploy the Juju GUI.
114
        # Run Juju Quickstart to bootstrap Juju and deploy the Juju GUI.
97
87
        # Note that this is done once per suite. The resulting environment is
115
        # Note that this is done once per suite. The resulting environment is
98
@@ -89,11 +117,17 @@
99
89
        cls.retcode, cls.output, cls.error = run_quickstart(cls.env_name)
117
        cls.retcode, cls.output, cls.error = run_quickstart(cls.env_name)
100
90
118
101
91
    @classmethod
119
    @classmethod
103
92
    @skip_if_disbled
120
    @skip_if_environment_not_set
104
93
    def tearDownClass(cls):
121
    def tearDownClass(cls):
105
94
        # Destroy the environment.
122
        # Destroy the environment.
106
95
        run_juju('destroy-environment', cls.env_name, '-y', '--force')
123
        run_juju('destroy-environment', cls.env_name, '-y', '--force')
107
96
124
108
125
    def setUp(self):
109
126
        # Let all the tests fail if an environment error has been detected
110
127
        # in setUpClass.
111
128
        if self.env_error is not None:
112
129
            self.fail(self.env_error)
113
130
114
97
    def test_executed(self):
131
    def test_executed(self):
115
98
        # The application successfully completed its execution.
132
        # The application successfully completed its execution.
116
99
        self.assertEqual(0, self.retcode)
133
        self.assertEqual(0, self.retcode)
Status:	Merged
Merged at revision:	118
Proposed branch:	lp:~frankban/juju-quickstart/ftest-fixes
Merge into:	lp:juju-quickstart
Diff against target:	116 lines (+46/-11) 2 files modified HACKING.rst (+2/-1) quickstart/tests/functional/test_functional.py (+44/-10)
To merge this branch:	bzr merge lp:~frankban/juju-quickstart/ftest-fixes
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Juju GUI Hackers		2015-02-05	Pending
Review via email: mp+248755@code.launchpad.net