1
=== modified file 'quickstart/__init__.py'
2
--- quickstart/__init__.py	2013-11-18 22:50:55 +0000
3
+++ quickstart/__init__.py	2013-11-22 15:07:41 +0000
4
@@ -19,7 +19,7 @@
5
19
that it can be managed using a Web interface (the Juju GUI).
19
that it can be managed using a Web interface (the Juju GUI).
6
20
"""
20
"""
7
21
21
9
22
VERSION = (0, 4, 1)
22
VERSION = (0, 4, 2)
10
23
23
11
24
24
12
25
def get_version():
25
def get_version():
13
26
26
14
=== modified file 'quickstart/app.py'
15
--- quickstart/app.py	2013-11-21 19:45:01 +0000
16
+++ quickstart/app.py	2013-11-22 15:07:41 +0000
17
@@ -233,7 +233,7 @@
18
233
                msg = 'unable to retrieve the {} charm URL from the API: {}'
233
                msg = 'unable to retrieve the {} charm URL from the API: {}'
19
234
                logging.warn(msg.format(service_name, err))
234
                logging.warn(msg.format(service_name, err))
20
235
                charm_url = settings.DEFAULT_CHARM_URL
235
                charm_url = settings.DEFAULT_CHARM_URL
22
236
        print('charm URL: {}'.format(charm_url))
236
        utils.check_gui_charm_url(charm_url)
23
237
        # Deploy the service without units.
237
        # Deploy the service without units.
24
238
        try:
238
        try:
25
239
            env.deploy(service_name, charm_url, num_units=0)
239
            env.deploy(service_name, charm_url, num_units=0)
26
@@ -244,11 +244,7 @@
27
244
    else:
244
    else:
28
245
        # We already have the service in the environment.
245
        # We already have the service in the environment.
29
246
        print('service {} already deployed'.format(service_name))
246
        print('service {} already deployed'.format(service_name))
35
247
        charm_url = service_data['CharmURL']
247
        utils.check_gui_charm_url(service_data['CharmURL'])
31
248
        print('charm URL: {}'.format(charm_url))
32
249
        # XXX frankban: warn the user if the actual charm_url != the given
33
250
        # charm_url, and warn louder if the charm URL does not match
34
251
        # /\/juju-gui-\d+$/.
36
252
        service_exposed = service_data.get('Exposed', False)
248
        service_exposed = service_data.get('Exposed', False)
37
253
    # At this point the service is surely deployed in the environment: expose
249
    # At this point the service is surely deployed in the environment: expose
38
254
    # it if necessary and add a unit if it is missing.
250
    # it if necessary and add a unit if it is missing.
39
255
251
40
=== added file 'quickstart/charms.py'
41
--- quickstart/charms.py	1970-01-01 00:00:00 +0000
42
+++ quickstart/charms.py	2013-11-22 15:07:41 +0000
43
@@ -0,0 +1,118 @@
44
1
# This file is part of the Juju Quickstart Plugin, which lets users set up a
45
2
# Juju environment in very few steps (https://launchpad.net/juju-quickstart).
46
3
# Copyright (C) 2013 Canonical Ltd.
47
4
#
48
5
# This program is free software: you can redistribute it and/or modify it under
49
6
# the terms of the GNU Affero General Public License version 3, as published by
50
7
# the Free Software Foundation.
51
8
#
52
9
# This program is distributed in the hope that it will be useful, but WITHOUT
53
10
# ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
54
11
# SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
55
12
# Affero General Public License for more details.
56
13
#
57
14
# You should have received a copy of the GNU Affero General Public License
58
15
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
59
16
60
17
"""Juju Quickstart charms management."""
61
18
62
19
import re
63
20
64
21
65
22
# The following regular expressions are the same used in juju-core: see
66
23
# http://bazaar.launchpad.net/~go-bot/juju-core/trunk/view/head:/charm/url.go.
67
24
valid_user = re.compile(r'^[a-z0-9][a-zA-Z0-9+.-]+$').match
68
25
valid_series = re.compile(r'^[a-z]+([a-z-]+[a-z])?$').match
69
26
valid_name = re.compile(r'^[a-z][a-z0-9]*(-[a-z0-9]*[a-z][a-z0-9]*)*$').match
70
27
71
28
72
29
def parse_url(url):
73
30
    """Parse the given charm URL.
74
31
75
32
    Return a tuple containing the charm URL fragments: schema, user, series,
76
33
    name and revision. Each fragment is a string except revision (int).
77
34
78
35
    Raise a ValueError with a descriptive message if the given URL is not a
79
36
    valid charm URL.
80
37
    """
81
38
    # Retrieve the schema.
82
39
    try:
83
40
        schema, remaining = url.split(':', 1)
84
41
    except ValueError:
85
42
        raise ValueError('charm URL has no schema: {!r}'.format(url))
86
43
    if schema not in ('cs', 'local'):
87
44
        raise ValueError('charm URL has invalid schema: {!r}'.format(schema))
88
45
    # Retrieve the optional user, the series, name and revision.
89
46
    parts = remaining.split('/')
90
47
    parts_length = len(parts)
91
48
    if parts_length == 3:
92
49
        user, series, name_revision = parts
93
50
        if not user.startswith('~'):
94
51
            raise ValueError(
95
52
                'charm URL has invalid user name form: {!r}'.format(user))
96
53
        user = user[1:]
97
54
        if not valid_user(user):
98
55
            raise ValueError(
99
56
                'charm URL has invalid user name: {!r}'.format(user))
100
57
        if schema == 'local':
101
58
            raise ValueError(
102
59
                'local charm URL with user name: {!r}'.format(url))
103
60
    elif parts_length == 2:
104
61
        user = ''
105
62
        series, name_revision = parts
106
63
    else:
107
64
        raise ValueError('charm URL has invalid form: {!r}'.format(url))
108
65
    # Validate the series.
109
66
    if not valid_series(series):
110
67
        raise ValueError('charm URL has invalid series: {!r}'.format(series))
111
68
    # Validate name and revision.
112
69
    try:
113
70
        name, revision = name_revision.rsplit('-', 1)
114
71
    except ValueError:
115
72
        raise ValueError(
116
73
            'charm URL has no revision: {!r}'.format(url))
117
74
    if not valid_name(name):
118
75
        raise ValueError('charm URL has invalid name: {!r}'.format(name))
119
76
    try:
120
77
        revision = int(revision)
121
78
    except ValueError:
122
79
        raise ValueError(
123
80
            'charm URL has invalid revision: {!r}'.format(revision))
124
81
    return schema, user, series, name, revision
125
82
126
83
127
84
class Charm(object):
128
85
    """Represent the charm information stored in the charm URL."""
129
86
130
87
    def __init__(self, schema, user, series, name, revision):
131
88
        """Initialize the charm. Receives the URL fragments."""
132
89
        self.schema = schema
133
90
        self.user = user
134
91
        self.series = series
135
92
        self.name = name
136
93
        self.revision = int(revision)
137
94
138
95
    @classmethod
139
96
    def from_url(cls, url):
140
97
        """Given a charm URL, create and return a Charm instance.
141
98
142
99
        Raise a ValueError if the charm URL is not valid.
143
100
        """
144
101
        return cls(*parse_url(url))
145
102
146
103
    def __str__(self):
147
104
        """The string representation of a charm is its URL."""
148
105
        return self.url()
149
106
150
107
    def __repr__(self):
151
108
        return '<Charm: {}>'.format(str(self))
152
109
153
110
    def url(self):
154
111
        """Return the charm URL."""
155
112
        user_part = '~{}/'.format(self.user) if self.user else ''
156
113
        return '{}:{}{}/{}-{}'.format(
157
114
            self.schema, user_part, self.series, self.name, self.revision)
158
115
159
116
    def is_local(self):
160
117
        """Return True if this is a local charm, False otherwise."""
161
118
        return self.schema == 'local'
162
0
119
163
=== modified file 'quickstart/manage.py'
164
--- quickstart/manage.py	2013-11-21 18:41:16 +0000
165
+++ quickstart/manage.py	2013-11-22 15:07:41 +0000
166
@@ -25,6 +25,7 @@
167
25
import quickstart
25
import quickstart
168
26
from quickstart import (
26
from quickstart import (
169
27
    app,
27
    app,
170
28
    charms,
171
28
    settings,
29
    settings,
172
29
    utils,
30
    utils,
173
30
)
31
)
174
@@ -88,6 +89,41 @@
175
88
    options.bundle_id = bundle_id
89
    options.bundle_id = bundle_id
176
89
90
177
90
91
178
92
def _validate_charm_url(options, parser):
179
93
    """Validate the provided charm URL option.
180
94
181
95
    Exit with an error if:
182
96
        - the URL is not a valid charm URL;
183
97
        - the URL represents a local charm;
184
98
        - the charm series is not supported;
185
99
        - a bundle deployment has been requested but the provided charm does
186
100
          not support bundles.
187
101
188
102
    Leave the options namespace untouched.
189
103
    """
190
104
    try:
191
105
        charm = charms.Charm.from_url(options.charm_url)
192
106
    except ValueError as err:
193
107
        return parser.error(str(err))
194
108
    if charm.is_local():
195
109
        return parser.error('local charms are not allowed: {}'.format(charm))
196
110
    if charm.series not in settings.JUJU_GUI_SUPPORTED_SERIES:
197
111
        return parser.error(
198
112
            'unsupported charm series: {!r}'.format(charm.series))
199
113
    if (
200
114
        # The user requested a bundle deployment.
201
115
        options.bundle and
202
116
        # This is the official Juju GUI charm.
203
117
        charm.name == settings.JUJU_GUI_CHARM_NAME and
204
118
        not charm.user and
205
119
        # The charm at this revision does not support bundle deployments.
206
120
        charm.revision < settings.MINIMUM_CHARM_REVISION_FOR_BUNDLES
207
121
    ):
208
122
        return parser.error(
209
123
            'bundle deployments not supported by the requested charm '
210
124
            'revision: {}'.format(charm))
211
125
212
126
213
91
def _validate_env(options, parser):
127
def _validate_env(options, parser):
214
92
    """Validate and process the provided environment related options.
128
    """Validate and process the provided environment related options.
215
93
129
216
@@ -210,6 +246,8 @@
217
210
    _validate_env(options, parser)
246
    _validate_env(options, parser)
218
211
    if options.bundle is not None:
247
    if options.bundle is not None:
219
212
        _validate_bundle(options, parser)
248
        _validate_bundle(options, parser)
220
249
    if options.charm_url is not None:
221
250
        _validate_charm_url(options, parser)
222
213
    # Set up logging.
251
    # Set up logging.
223
214
    _configure_logging(logging.DEBUG if options.debug else logging.INFO)
252
    _configure_logging(logging.DEBUG if options.debug else logging.INFO)
224
215
    return options
253
    return options
225
@@ -235,8 +273,8 @@
226
235
    # local provider.
273
    # local provider.
227
236
    machine = None if options.env_type == 'local' else '0'
274
    machine = None if options.env_type == 'local' else '0'
228
237
    unit_name = app.deploy_gui(
275
    unit_name = app.deploy_gui(
231
238
        env, settings.JUJU_GUI_NAME, machine, charm_url=options.charm_url,
276
        env, settings.JUJU_GUI_SERVICE_NAME, machine,
232
239
        check_preexisting=already_bootstrapped)
277
        charm_url=options.charm_url, check_preexisting=already_bootstrapped)
233
240
    address = app.watch(env, unit_name)
278
    address = app.watch(env, unit_name)
234
241
    url = 'https://{}'.format(address)
279
    url = 'https://{}'.format(address)
235
242
    print('url: {}\npassword: {}'.format(url, options.admin_secret))
280
    print('url: {}\npassword: {}'.format(url, options.admin_secret))
236
243
281
237
=== modified file 'quickstart/settings.py'
238
--- quickstart/settings.py	2013-11-14 10:52:31 +0000
239
+++ quickstart/settings.py	2013-11-22 15:07:41 +0000
240
@@ -32,5 +32,14 @@
241
32
# Retrieve the current juju-core home.
32
# Retrieve the current juju-core home.
242
33
JUJU_HOME = os.getenv('JUJU_HOME', '~/.juju')
33
JUJU_HOME = os.getenv('JUJU_HOME', '~/.juju')
243
34
34
244
35
# The name of the Juju GUI charm.
245
36
JUJU_GUI_CHARM_NAME = 'juju-gui'
246
37
247
35
# The name of the Juju GUI service.
38
# The name of the Juju GUI service.
249
36
JUJU_GUI_NAME = 'juju-gui'
39
JUJU_GUI_SERVICE_NAME = JUJU_GUI_CHARM_NAME
250
40
251
41
# The set of series supported by the Juju GUI charm.
252
42
JUJU_GUI_SUPPORTED_SERIES = ('precise',)
253
43
254
44
# The minimum Juju GUI charm revision supporting bundle deployments.
255
45
MINIMUM_CHARM_REVISION_FOR_BUNDLES = 80
256
37
46
257
=== modified file 'quickstart/tests/test_app.py'
258
--- quickstart/tests/test_app.py	2013-11-21 18:41:16 +0000
259
+++ quickstart/tests/test_app.py	2013-11-22 15:07:41 +0000
260
@@ -61,6 +61,7 @@
261
61
        return jujuclient.EnvError({'Error': message})
61
        return jujuclient.EnvError({'Error': message})
262
62
62
263
63
63
264
64
@mock_print
265
64
class TestEnsureDependencies(
65
class TestEnsureDependencies(
266
65
        helpers.CallTestsMixin, ProgramExitTestsMixin, unittest.TestCase):
66
        helpers.CallTestsMixin, ProgramExitTestsMixin, unittest.TestCase):
267
66
67
268
@@ -69,7 +70,7 @@
269
69
            app.ensure_dependencies()
70
            app.ensure_dependencies()
270
70
        return mock_call
71
        return mock_call
271
71
72
273
72
    def test_success_install(self):
73
    def test_success_install(self, mock_print):
274
73
        call = self.call_ensure_dependencies(
74
        call = self.call_ensure_dependencies(
275
74
            (
75
            (
276
75
                (127, '', 'no juju'),
76
                (127, '', 'no juju'),
277
@@ -83,14 +84,18 @@
278
83
        call.assert_has_calls([
84
        call.assert_has_calls([
279
84
            mock.call('juju', 'version'),
85
            mock.call('juju', 'version'),
280
85
            mock.call('lxc-ls'),
86
            mock.call('lxc-ls'),
283
86
            mock.call('sudo', 'apt-add-repository', '-y',
87
            mock.call('sudo', 'apt-add-repository', '-y', 'ppa:juju/stable'),
282
87
                      'ppa:juju/stable'),
284
88
            mock.call('sudo', 'apt-get', 'update'),
88
            mock.call('sudo', 'apt-get', 'update'),
287
89
            mock.call('sudo', 'apt-get', 'install', '-y', 'juju-core',
89
            mock.call('sudo', 'apt-get', 'install', '-y', 'juju-core', 'lxc'),
288
90
                      'lxc'),
90
        ])
289
91
        mock_print.assert_has_calls([
290
92
            mock.call(
291
93
                'The following packages need to be installed: juju-core, lxc'),
292
94
            mock.call(
293
95
                'sudo privileges are required for package installation.'),
294
91
        ])
96
        ])
295
92
97
297
93
    def test_success_no_install(self):
98
    def test_success_no_install(self, mock_print):
298
94
        call = self.call_ensure_dependencies(
99
        call = self.call_ensure_dependencies(
299
95
            [
100
            [
300
96
                (0, '1.16', ''),
101
                (0, '1.16', ''),
301
@@ -102,7 +107,30 @@
302
102
        )
107
        )
303
103
        self.assertEqual(call.call_count, 2)
108
        self.assertEqual(call.call_count, 2)
304
104
109
306
105
    def test_failure(self):
110
    def test_success_one_install(self, mock_print):
307
111
        # One missing installation is correctly handled.
308
112
        call = self.call_ensure_dependencies([
309
113
            (0, '1.16', ''),
310
114
            (127, '', 'no lxc'),
311
115
            (0, 'add repo', ''),
312
116
            (0, 'update', ''),
313
117
            (0, 'install', ''),
314
118
        ])
315
119
        self.assertEqual(call.call_count, 5)
316
120
        call.assert_has_calls([
317
121
            mock.call('juju', 'version'),
318
122
            mock.call('lxc-ls'),
319
123
            mock.call('sudo', 'apt-add-repository', '-y', 'ppa:juju/stable'),
320
124
            mock.call('sudo', 'apt-get', 'update'),
321
125
            mock.call('sudo', 'apt-get', 'install', '-y', 'lxc'),
322
126
        ])
323
127
        mock_print.assert_has_calls([
324
128
            mock.call('The following package needs to be installed: lxc'),
325
129
            mock.call(
326
130
                'sudo privileges are required for package installation.'),
327
131
        ])
328
132
329
133
    def test_failure(self, mock_print):
330
106
        with self.assert_program_exit('install failure'):
134
        with self.assert_program_exit('install failure'):
331
107
            call = self.call_ensure_dependencies(
135
            call = self.call_ensure_dependencies(
332
108
                [
136
                [
333
@@ -374,7 +402,7 @@
334
374
        ProgramExitTestsMixin, helpers.WatcherDataTestsMixin,
402
        ProgramExitTestsMixin, helpers.WatcherDataTestsMixin,
335
375
        unittest.TestCase):
403
        unittest.TestCase):
336
376
404
338
377
    charm_url = 'cs:precise/juju-gui-42'
405
    charm_url = 'cs:precise/juju-gui-100'
339
378
406
340
379
    def make_env(self, unit_name=None, service_data=None, unit_data=None):
407
    def make_env(self, unit_name=None, service_data=None, unit_data=None):
341
380
        """Create and return a mock environment object.
408
        """Create and return a mock environment object.
342
@@ -403,6 +431,44 @@
343
403
        mock_get_charm_url = mock.Mock(side_effect=side_effect)
431
        mock_get_charm_url = mock.Mock(side_effect=side_effect)
344
404
        return mock.patch('quickstart.utils.get_charm_url', mock_get_charm_url)
432
        return mock.patch('quickstart.utils.get_charm_url', mock_get_charm_url)
345
405
433
346
434
    def check_provided_charm_url(
347
435
            self, charm_url, mock_print, expected_logs=None):
348
436
        """Ensure the service is deployed and exposed with the given charm URL.
349
437
350
438
        Also check the expected warnings, if they are provided, are logged.
351
439
        """
352
440
        env = self.make_env(unit_name='my-gui/42')
353
441
        with helpers.assert_logs(expected_logs or [], level='warn'):
354
442
            app.deploy_gui(env, 'my-gui', '0', charm_url=charm_url)
355
443
        env.assert_has_calls([
356
444
            mock.call.deploy('my-gui', charm_url, num_units=0),
357
445
            mock.call.expose('my-gui'),
358
446
            mock.call.add_unit('my-gui', machine_spec='0'),
359
447
        ])
360
448
        mock_print.assert_has_calls([
361
449
            mock.call('requesting my-gui deployment'),
362
450
            mock.call('charm URL: {}'.format(charm_url)),
363
451
        ])
364
452
365
453
    def check_existing_charm_url(
366
454
            self, charm_url, mock_print, expected_logs=None):
367
455
        """Ensure the service is correctly found with the given charm URL.
368
456
369
457
        Also check the expected warnings, if they are provided, are logged.
370
458
        """
371
459
        service_data = {'CharmURL': charm_url}
372
460
        env = self.make_env(unit_name='my-gui/42', service_data=service_data)
373
461
        with helpers.assert_logs(expected_logs or [], level='warn'):
374
462
            app.deploy_gui(env, 'my-gui', '0', check_preexisting=True)
375
463
        env.assert_has_calls([
376
464
            mock.call.get_status(),
377
465
            mock.call.add_unit('my-gui', machine_spec='0'),
378
466
        ])
379
467
        mock_print.assert_has_calls([
380
468
            mock.call('service my-gui already deployed'),
381
469
            mock.call('charm URL: {}'.format(charm_url)),
382
470
        ])
383
471
384
406
    def test_deployment(self, mock_print):
472
    def test_deployment(self, mock_print):
385
407
        # The function correctly deploys and exposes the service, retrieving
473
        # The function correctly deploys and exposes the service, retrieving
386
408
        # the charm URL from the charmworld API.
474
        # the charm URL from the charmworld API.
387
@@ -461,22 +527,6 @@
388
461
            mock.call('charm URL: {}'.format(settings.DEFAULT_CHARM_URL)),
527
            mock.call('charm URL: {}'.format(settings.DEFAULT_CHARM_URL)),
389
462
        ])
528
        ])
390
463
529
391
464
    def test_provided_charm_url(self, mock_print):
392
465
        # The function correctly deploys and exposes the service using a user
393
466
        # provided Juju GUI charm URL.
394
467
        env = self.make_env(unit_name='my-gui/42')
395
468
        charm_url = 'cs:~juju-gui/precise/juju-gui-116'
396
469
        app.deploy_gui(env, 'my-gui', '0', charm_url=charm_url)
397
470
        env.assert_has_calls([
398
471
            mock.call.deploy('my-gui', charm_url, num_units=0),
399
472
            mock.call.expose('my-gui'),
400
473
            mock.call.add_unit('my-gui', machine_spec='0'),
401
474
        ])
402
475
        mock_print.assert_has_calls([
403
476
            mock.call('requesting my-gui deployment'),
404
477
            mock.call('charm URL: {}'.format(charm_url)),
405
478
        ])
406
479
407
480
    def test_existing_service(self, mock_print):
530
    def test_existing_service(self, mock_print):
408
481
        # The deployment is executed reusing an already deployed service.
531
        # The deployment is executed reusing an already deployed service.
409
482
        env = self.make_env(unit_name='my-gui/42', service_data={})
532
        env = self.make_env(unit_name='my-gui/42', service_data={})
410
@@ -551,6 +601,60 @@
411
551
            mock.call.add_unit('my-gui', machine_spec=None),
601
            mock.call.add_unit('my-gui', machine_spec=None),
412
552
        ])
602
        ])
413
553
603
414
604
    def test_offical_charm_url_provided(self, mock_print):
415
605
        # The function correctly deploys and exposes the service using a user
416
606
        # provided revision of the Juju GUI charm URL.
417
607
        self.check_provided_charm_url('cs:precise/juju-gui-4242', mock_print)
418
608
419
609
    def test_customized_charm_url_provided(self, mock_print):
420
610
        # A customized charm URL is correctly recognized and logged if provided
421
611
        # by the user.
422
612
        self.check_provided_charm_url(
423
613
            'cs:~juju-gui/precise/juju-gui-42', mock_print,
424
614
            expected_logs=['using a customized juju-gui charm'])
425
615
426
616
    def test_outdated_charm_url_provided(self, mock_print):
427
617
        # An outdated charm URL is correctly recognized and logged if provided
428
618
        # by the user.
429
619
        self.check_provided_charm_url(
430
620
            'cs:precise/juju-gui-1', mock_print,
431
621
            expected_logs=[
432
622
                'charm is outdated and may not support bundle deployments'])
433
623
434
624
    def test_unexpected_charm_url_provided(self, mock_print):
435
625
        # An unexpected charm URL is correctly recognized and logged if
436
626
        # provided by the user.
437
627
        self.check_provided_charm_url(
438
628
            'cs:precise/exterminate-the-gui-666', mock_print,
439
629
            expected_logs=[
440
630
                'unexpected URL for the juju-gui charm: '
441
631
                'the service may not work as expected'])
442
632
443
633
    def test_offical_charm_url_existing(self, mock_print):
444
634
        # An existing official charm URL is correctly found.
445
635
        self.check_existing_charm_url('cs:precise/juju-gui-4242', mock_print)
446
636
447
637
    def test_customized_charm_url_existing(self, mock_print):
448
638
        # An existing customized charm URL is correctly found and logged.
449
639
        self.check_existing_charm_url(
450
640
            'cs:~juju-gui/precise/juju-gui-42', mock_print,
451
641
            expected_logs=['using a customized juju-gui charm'])
452
642
453
643
    def test_outdated_charm_url_existing(self, mock_print):
454
644
        # An existing but outdated charm URL is correctly found and logged.
455
645
        self.check_existing_charm_url(
456
646
            'cs:precise/juju-gui-1', mock_print,
457
647
            expected_logs=[
458
648
                'charm is outdated and may not support bundle deployments'])
459
649
460
650
    def test_unexpected_charm_url_existing(self, mock_print):
461
651
        # An existing but unexpected charm URL is correctly found and logged.
462
652
        self.check_existing_charm_url(
463
653
            'cs:precise/exterminate-the-gui-666', mock_print,
464
654
            expected_logs=[
465
655
                'unexpected URL for the juju-gui charm: '
466
656
                'the service may not work as expected'])
467
657
468
554
    def test_status_error(self, mock_print):
658
    def test_status_error(self, mock_print):
469
555
        # A ProgramExit is raised if an error occurs in the status API call.
659
        # A ProgramExit is raised if an error occurs in the status API call.
470
556
        env = self.make_env()
660
        env = self.make_env()
471
@@ -597,7 +701,7 @@
472
597
            with self.assertRaises(ValueError) as context_manager:
701
            with self.assertRaises(ValueError) as context_manager:
473
598
                app.deploy_gui(env, 'juju-gui', '0')
702
                app.deploy_gui(env, 'juju-gui', '0')
474
599
        env.deploy.assert_called_once_with(
703
        env.deploy.assert_called_once_with(
476
600
            'juju-gui', 'cs:precise/juju-gui-42', num_units=0)
704
            'juju-gui', self.charm_url, num_units=0)
477
601
        env.expose.assert_called_once_with('juju-gui')
705
        env.expose.assert_called_once_with('juju-gui')
478
602
        self.assertIs(error, context_manager.exception)
706
        self.assertIs(error, context_manager.exception)
479
603
707
480
604
708
481
=== added file 'quickstart/tests/test_charms.py'
482
--- quickstart/tests/test_charms.py	1970-01-01 00:00:00 +0000
483
+++ quickstart/tests/test_charms.py	2013-11-22 15:07:41 +0000
484
@@ -0,0 +1,205 @@
485
1
# This file is part of the Juju Quickstart Plugin, which lets users set up a
486
2
# Juju environment in very few steps (https://launchpad.net/juju-quickstart).
487
3
# Copyright (C) 2013 Canonical Ltd.
488
4
#
489
5
# This program is free software: you can redistribute it and/or modify it under
490
6
# the terms of the GNU Affero General Public License version 3, as published by
491
7
# the Free Software Foundation.
492
8
#
493
9
# This program is distributed in the hope that it will be useful, but WITHOUT
494
10
# ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
495
11
# SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
496
12
# Affero General Public License for more details.
497
13
#
498
14
# You should have received a copy of the GNU Affero General Public License
499
15
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
500
16
501
17
"""Tests for the Juju Quickstart charms management."""
502
18
503
19
import unittest
504
20
505
21
from quickstart import charms
506
22
from quickstart.tests import helpers
507
23
508
24
509
25
class TestParseUrl(helpers.ValueErrorTestsMixin, unittest.TestCase):
510
26
511
27
    def test_no_schema_error(self):
512
28
        # A ValueError is raised if the URL schema is missing.
513
29
        expected = "charm URL has no schema: 'precise/juju-gui'"
514
30
        with self.assert_value_error(expected):
515
31
            charms.parse_url('precise/juju-gui')
516
32
517
33
    def test_invalid_schema_error(self):
518
34
        # A ValueError is raised if the URL schema is not valid.
519
35
        expected = "charm URL has invalid schema: 'http'"
520
36
        with self.assert_value_error(expected):
521
37
            charms.parse_url('http:precise/juju-gui')
522
38
523
39
    def test_invalid_user_form_error(self):
524
40
        # A ValueError is raised if the user form is not valid.
525
41
        expected = "charm URL has invalid user name form: 'jean-luc'"
526
42
        with self.assert_value_error(expected):
527
43
            charms.parse_url('cs:jean-luc/precise/juju-gui')
528
44
529
45
    def test_invalid_user_name_error(self):
530
46
        # A ValueError is raised if the user name is not valid.
531
47
        expected = "charm URL has invalid user name: 'jean:luc'"
532
48
        with self.assert_value_error(expected):
533
49
            charms.parse_url('cs:~jean:luc/precise/juju-gui')
534
50
535
51
    def test_local_user_name_error(self):
536
52
        # A ValueError is raised if a user is specified on a local charm.
537
53
        expected = (
538
54
            'local charm URL with user name: '
539
55
            "'local:~jean-luc/precise/juju-gui'")
540
56
        with self.assert_value_error(expected):
541
57
            charms.parse_url('local:~jean-luc/precise/juju-gui')
542
58
543
59
    def test_invalid_form_error(self):
544
60
        # A ValueError is raised if the URL is not valid.
545
61
        expected = "charm URL has invalid form: 'cs:~user/series/name/what-?'"
546
62
        with self.assert_value_error(expected):
547
63
            charms.parse_url('cs:~user/series/name/what-?')
548
64
549
65
    def test_invalid_series_error(self):
550
66
        # A ValueError is raised if the series is not valid.
551
67
        expected = "charm URL has invalid series: 'boo!'"
552
68
        with self.assert_value_error(expected):
553
69
            charms.parse_url('cs:boo!/juju-gui-42')
554
70
555
71
    def test_no_revision_error(self):
556
72
        # A ValueError is raised if the charm revision is missing.
557
73
        expected = "charm URL has no revision: 'cs:series/name'"
558
74
        with self.assert_value_error(expected):
559
75
            charms.parse_url('cs:series/name')
560
76
561
77
    def test_invalid_revision_error(self):
562
78
        # A ValueError is raised if the charm revision is not valid.
563
79
        expected = "charm URL has invalid revision: 'revision'"
564
80
        with self.assert_value_error(expected):
565
81
            charms.parse_url('cs:series/name-revision')
566
82
567
83
    def test_invalid_name_error(self):
568
84
        # A ValueError is raised if the charm name is not valid.
569
85
        expected = "charm URL has invalid name: 'not:valid'"
570
86
        with self.assert_value_error(expected):
571
87
            charms.parse_url('cs:precise/not:valid-42')
572
88
573
89
    def test_success_with_user(self):
574
90
        # A charm URL including the user is correctly parsed.
575
91
        schema, user, series, name, revision = charms.parse_url(
576
92
            'cs:~who/precise/juju-gui-42')
577
93
        self.assertEqual('cs', schema)
578
94
        self.assertEqual('who', user)
579
95
        self.assertEqual('precise', series)
580
96
        self.assertEqual('juju-gui', name)
581
97
        self.assertEqual(42, revision)
582
98
583
99
    def test_success_without_user(self):
584
100
        # A charm URL not including the user is correctly parsed.
585
101
        schema, user, series, name, revision = charms.parse_url(
586
102
            'cs:trusty/django-1')
587
103
        self.assertEqual('cs', schema)
588
104
        self.assertEqual('', user)
589
105
        self.assertEqual('trusty', series)
590
106
        self.assertEqual('django', name)
591
107
        self.assertEqual(1, revision)
592
108
593
109
    def test_success_local_charm(self):
594
110
        # A local charm URL is correctly parsed.
595
111
        schema, user, series, name, revision = charms.parse_url(
596
112
            'local:saucy/wordpress-100')
597
113
        self.assertEqual('local', schema)
598
114
        self.assertEqual('', user)
599
115
        self.assertEqual('saucy', series)
600
116
        self.assertEqual('wordpress', name)
601
117
        self.assertEqual(100, revision)
602
118
603
119
604
120
class TestCharm(helpers.ValueErrorTestsMixin, unittest.TestCase):
605
121
606
122
    def make_charm(
607
123
            self, schema='cs', user='myuser', series='precise',
608
124
            name='juju-gui', revision=42):
609
125
        """Create and return a Charm instance."""
610
126
        return charms.Charm(schema, user, series, name, revision)
611
127
612
128
    def test_attributes(self):
613
129
        # All charm attributes are correctly stored.
614
130
        charm = self.make_charm()
615
131
        self.assertEqual('cs', charm.schema)
616
132
        self.assertEqual('myuser', charm.user)
617
133
        self.assertEqual('precise', charm.series)
618
134
        self.assertEqual('juju-gui', charm.name)
619
135
        self.assertEqual(42, charm.revision)
620
136
621
137
    def test_revision_as_string(self):
622
138
        # Revision is converted to an int.
623
139
        charm = self.make_charm(revision='47')
624
140
        self.assertEqual(47, charm.revision)
625
141
626
142
    def test_from_url(self):
627
143
        # A Charm can be instantiated from a charm URL.
628
144
        charm = charms.Charm.from_url('cs:~who/trusty/django-1')
629
145
        self.assertEqual('cs', charm.schema)
630
146
        self.assertEqual('who', charm.user)
631
147
        self.assertEqual('trusty', charm.series)
632
148
        self.assertEqual('django', charm.name)
633
149
        self.assertEqual(1, charm.revision)
634
150
635
151
    def test_from_url_without_user(self):
636
152
        # Official charm store URLs are properly handled.
637
153
        charm = charms.Charm.from_url('cs:saucy/django-123')
638
154
        self.assertEqual('cs', charm.schema)
639
155
        self.assertEqual('', charm.user)
640
156
        self.assertEqual('saucy', charm.series)
641
157
        self.assertEqual('django', charm.name)
642
158
        self.assertEqual(123, charm.revision)
643
159
644
160
    def test_from_url_local(self):
645
161
        # Local charms URLs are properly handled.
646
162
        charm = charms.Charm.from_url('local:precise/my-local-charm-42')
647
163
        self.assertEqual('local', charm.schema)
648
164
        self.assertEqual('', charm.user)
649
165
        self.assertEqual('precise', charm.series)
650
166
        self.assertEqual('my-local-charm', charm.name)
651
167
        self.assertEqual(42, charm.revision)
652
168
653
169
    def test_from_url_error(self):
654
170
        # A ValueError is raised by the from_url class method if the provided
655
171
        # URL is not a valid charm URL.
656
172
        expected = "charm URL has invalid form: 'cs:not-a-charm-url'"
657
173
        with self.assert_value_error(expected):
658
174
            charms.Charm.from_url('cs:not-a-charm-url')
659
175
660
176
    def test_string(self):
661
177
        # The string representation of a charm instance is its URL.
662
178
        charm = self.make_charm()
663
179
        self.assertEqual('cs:~myuser/precise/juju-gui-42', str(charm))
664
180
665
181
    def test_repr(self):
666
182
        # A charm instance is correctly represented.
667
183
        charm = self.make_charm()
668
184
        self.assertEqual(
669
185
            '<Charm: cs:~myuser/precise/juju-gui-42>', repr(charm))
670
186
671
187
    def test_charm_store_url(self):
672
188
        # A charm store URL is correctly returned.
673
189
        charm = self.make_charm(schema='cs')
674
190
        self.assertEqual('cs:~myuser/precise/juju-gui-42', charm.url())
675
191
676
192
    def test_local_url(self):
677
193
        # A local charm URL is correctly returned.
678
194
        charm = self.make_charm(schema='local', user='')
679
195
        self.assertEqual('local:precise/juju-gui-42', charm.url())
680
196
681
197
    def test_charm_store_charm(self):
682
198
        # The is_local method returns False for charm store charms.
683
199
        charm = self.make_charm(schema='cs')
684
200
        self.assertFalse(charm.is_local())
685
201
686
202
    def test_local_charm(self):
687
203
        # The is_local method returns True for local charms.
688
204
        charm = self.make_charm(schema='local')
689
205
        self.assertTrue(charm.is_local())
690
0
206
691
=== modified file 'quickstart/tests/test_manage.py'
692
--- quickstart/tests/test_manage.py	2013-11-20 11:40:10 +0000
693
+++ quickstart/tests/test_manage.py	2013-11-22 15:07:41 +0000
694
@@ -178,6 +178,69 @@
695
178
        self.parser.error.assert_called_once_with(expected)
178
        self.parser.error.assert_called_once_with(expected)
696
179
179
697
180
180
698
181
class TestValidateCharmUrl(unittest.TestCase):
699
182
700
183
    def setUp(self):
701
184
        self.parser = mock.Mock()
702
185
703
186
    def make_options(self, charm_url, has_bundle=False):
704
187
        """Return a mock options object which includes the passed arguments."""
705
188
        options = mock.Mock(charm_url=charm_url, bundle=None)
706
189
        if has_bundle:
707
190
            options.bundle = 'bundle:~who/django/42/django'
708
191
        return options
709
192
710
193
    def test_invalid_url_error(self):
711
194
        # A parser error is invoked if the charm URL is not valid.
712
195
        options = self.make_options('cs:invalid')
713
196
        manage._validate_charm_url(options, self.parser)
714
197
        expected = "charm URL has invalid form: 'cs:invalid'"
715
198
        self.parser.error.assert_called_once_with(expected)
716
199
717
200
    def test_local_charm_error(self):
718
201
        # A parser error is invoked if a local charm is provided.
719
202
        options = self.make_options('local:precise/juju-gui-100')
720
203
        manage._validate_charm_url(options, self.parser)
721
204
        expected = 'local charms are not allowed: local:precise/juju-gui-100'
722
205
        self.parser.error.assert_called_once_with(expected)
723
206
724
207
    def test_unsupported_series_error(self):
725
208
        # A parser error is invoked if the charm series is not supported.
726
209
        options = self.make_options('cs:nosuch/juju-gui-100')
727
210
        manage._validate_charm_url(options, self.parser)
728
211
        expected = "unsupported charm series: 'nosuch'"
729
212
        self.parser.error.assert_called_once_with(expected)
730
213
731
214
    def test_outdated_charm_error(self):
732
215
        # A parser error is invoked if a bundle deployment has been requested
733
216
        # but the provided charm does not support bundles.
734
217
        options = self.make_options('cs:precise/juju-gui-1', has_bundle=True)
735
218
        manage._validate_charm_url(options, self.parser)
736
219
        expected = (
737
220
            'bundle deployments not supported by the requested charm '
738
221
            'revision: cs:precise/juju-gui-1')
739
222
        self.parser.error.assert_called_once_with(expected)
740
223
741
224
    def test_outdated_allowed_without_bundles(self):
742
225
        # An outdated charm is allowed if no bundles are provided.
743
226
        options = self.make_options('cs:precise/juju-gui-1', has_bundle=False)
744
227
        manage._validate_charm_url(options, self.parser)
745
228
        self.assertFalse(self.parser.error.called)
746
229
747
230
    def test_success(self):
748
231
        # The functions completes without error if the charm URL is valid.
749
232
        good = (
750
233
            'cs:precise/juju-gui-100',
751
234
            'cs:~juju-gui/precise/juju-gui-42',
752
235
            'cs:~who/precise/juju-gui-42',
753
236
            'cs:~who/precise/my-juju-gui-42',
754
237
        )
755
238
        for charm_url in good:
756
239
            options = self.make_options(charm_url)
757
240
            manage._validate_charm_url(options, self.parser)
758
241
            self.assertFalse(self.parser.error.called, charm_url)
759
242
760
243
761
181
class TestValidateEnv(helpers.EnvFileTestsMixin, unittest.TestCase):
244
class TestValidateEnv(helpers.EnvFileTestsMixin, unittest.TestCase):
762
182
245
763
183
    def setUp(self):
246
    def setUp(self):
764
@@ -316,6 +379,16 @@
765
316
        self.assertIsInstance(options, argparse.Namespace)
379
        self.assertIsInstance(options, argparse.Namespace)
766
317
        self.assertIsInstance(parser, argparse.ArgumentParser)
380
        self.assertIsInstance(parser, argparse.ArgumentParser)
767
318
381
768
382
    @mock.patch('quickstart.manage._validate_charm_url')
769
383
    def test_charm_url(self, mock_validate_charm_url):
770
384
        # The charm URL validation process is started if a URL is provided.
771
385
        self.call_setup(
772
386
            ['--gui-charm-url', 'cs:precise/juju-gui-42'], exit_called=False)
773
387
        self.assertTrue(mock_validate_charm_url.called)
774
388
        options, parser = mock_validate_charm_url.call_args_list[0][0]
775
389
        self.assertIsInstance(options, argparse.Namespace)
776
390
        self.assertIsInstance(parser, argparse.ArgumentParser)
777
391
778
319
    def test_configure_logging(self):
392
    def test_configure_logging(self):
779
320
        # Logging is properly set up at the info level.
393
        # Logging is properly set up at the info level.
780
321
        logger = logging.getLogger()
394
        logger = logging.getLogger()
781
@@ -359,7 +432,7 @@
782
359
        mock_app.connect.assert_called_once_with(
432
        mock_app.connect.assert_called_once_with(
783
360
            mock_app.get_api_url(), options.admin_secret)
433
            mock_app.get_api_url(), options.admin_secret)
784
361
        mock_app.deploy_gui.assert_called_once_with(
434
        mock_app.deploy_gui.assert_called_once_with(
786
362
            mock_app.connect(), settings.JUJU_GUI_NAME, '0',
435
            mock_app.connect(), settings.JUJU_GUI_SERVICE_NAME, '0',
787
363
            charm_url=options.charm_url,
436
            charm_url=options.charm_url,
788
364
            check_preexisting=mock_app.bootstrap())
437
            check_preexisting=mock_app.bootstrap())
789
365
        mock_app.watch.assert_called_once_with(
438
        mock_app.watch.assert_called_once_with(
790
366
439
791
=== modified file 'quickstart/tests/test_utils.py'
792
--- quickstart/tests/test_utils.py	2013-11-20 20:30:08 +0000
793
+++ quickstart/tests/test_utils.py	2013-11-22 15:07:41 +0000
794
@@ -78,6 +78,36 @@
795
78
            utils.call('echo', 'we are the borg!')
78
            utils.call('echo', 'we are the borg!')
796
79
79
797
80
80
798
81
@mock.patch('__builtin__.print', mock.Mock())
799
82
class TestCheckGuiCharmUrl(unittest.TestCase):
800
83
801
84
    def test_customized(self):
802
85
        # A customized charm URL is properly logged.
803
86
        expected = 'using a customized juju-gui charm'
804
87
        with helpers.assert_logs([expected], level='warn'):
805
88
            utils.check_gui_charm_url('cs:~juju-gui/precise/juju-gui-28')
806
89
807
90
    def test_outdated(self):
808
91
        # An outdated charm URL is properly logged.
809
92
        expected = 'charm is outdated and may not support bundle deployments'
810
93
        with helpers.assert_logs([expected], level='warn'):
811
94
            utils.check_gui_charm_url('cs:precise/juju-gui-1')
812
95
813
96
    def test_unexpected(self):
814
97
        # An unexpected charm URL is properly logged.
815
98
        expected = (
816
99
            'unexpected URL for the juju-gui charm: the service may not work '
817
100
            'as expected')
818
101
        with helpers.assert_logs([expected], level='warn'):
819
102
            utils.check_gui_charm_url('cs:precise/another-gui-42')
820
103
821
104
    def test_official(self):
822
105
        # No warnings are logged if an up to date charm is passed.
823
106
        with mock.patch('logging.warn') as mock_warn:
824
107
            utils.check_gui_charm_url('cs:precise/juju-gui-100')
825
108
        self.assertFalse(mock_warn.called)
826
109
827
110
828
81
class TestConvertBundleUrl(helpers.ValueErrorTestsMixin, unittest.TestCase):
111
class TestConvertBundleUrl(helpers.ValueErrorTestsMixin, unittest.TestCase):
829
82
112
830
83
    def test_conversion(self):
113
    def test_conversion(self):
831
@@ -338,7 +368,7 @@
832
338
    def test_yaml_gui_in_services(self):
368
    def test_yaml_gui_in_services(self):
833
339
        # A ValueError is raised if the bundle contains juju-gui.
369
        # A ValueError is raised if the bundle contains juju-gui.
834
340
        contents = yaml.safe_dump({
370
        contents = yaml.safe_dump({
836
341
            'mybundle': {'services': {'juju-gui': {}}},
371
            'mybundle': {'services': {settings.JUJU_GUI_SERVICE_NAME: {}}},
837
342
        })
372
        })
838
343
        expected = 'bundle mybundle contains an instance of juju-gui. ' \
373
        expected = 'bundle mybundle contains an instance of juju-gui. ' \
839
344
            'quickstart will install the latest version of the Juju GUI ' \
374
            'quickstart will install the latest version of the Juju GUI ' \
840
345
375
841
=== modified file 'quickstart/utils.py'
842
--- quickstart/utils.py	2013-11-20 20:30:08 +0000
843
+++ quickstart/utils.py	2013-11-22 15:07:41 +0000
844
@@ -16,6 +16,7 @@
845
16
16
846
17
"""Juju Quickstart utility functions and classes."""
17
"""Juju Quickstart utility functions and classes."""
847
18
18
848
19
from __future__ import print_function
849
19
import collections
20
import collections
850
20
import httplib
21
import httplib
851
21
import json
22
import json
852
@@ -29,7 +30,10 @@
853
29
30
854
30
import yaml
31
import yaml
855
31
32
857
32
from quickstart import settings
33
from quickstart import (
858
34
    charms,
859
35
    settings
860
36
)
861
33
37
862
34
# Compile the regular expression used to parse the "juju switch" output.
38
# Compile the regular expression used to parse the "juju switch" output.
863
35
_juju_switch_expression = re.compile(r'Current environment: "([\w-]+)"\n')
39
_juju_switch_expression = re.compile(r'Current environment: "([\w-]+)"\n')
864
@@ -59,6 +63,26 @@
865
59
    return retcode, output, error
63
    return retcode, output, error
866
60
64
867
61
65
868
66
def check_gui_charm_url(charm_url):
869
67
    """Print (to stdout or to logs) info and warnings about the charm URL."""
870
68
    print('charm URL: {}'.format(charm_url))
871
69
    charm = charms.Charm.from_url(charm_url)
872
70
    charm_name = settings.JUJU_GUI_CHARM_NAME
873
71
    if charm.name == charm_name:
874
72
        if charm.user or charm.is_local():
875
73
            # This is not the official Juju GUI charm.
876
74
            logging.warn('using a customized {} charm'.format(charm_name))
877
75
        elif charm.revision < settings.MINIMUM_CHARM_REVISION_FOR_BUNDLES:
878
76
            # This is the official Juju GUI charm, but it is outdated.
879
77
            logging.warn(
880
78
                'charm is outdated and may not support bundle deployments')
881
79
    else:
882
80
        # This does not seem to be a Juju GUI charm.
883
81
        logging.warn(
884
82
            'unexpected URL for the {} charm: '
885
83
            'the service may not work as expected'.format(charm_name))
886
84
887
85
888
62
def convert_bundle_url(bundle_url):
86
def convert_bundle_url(bundle_url):
889
63
    """Return the equivalent YAML HTTPS location for the fiven bundle URL.
87
    """Return the equivalent YAML HTTPS location for the fiven bundle URL.
890
64
88
891
@@ -189,7 +213,7 @@
892
189
    if not bundle_services:
213
    if not bundle_services:
893
190
        msg = 'bundle {} does not include any services'.format(bundle_name)
214
        msg = 'bundle {} does not include any services'.format(bundle_name)
894
191
        raise ValueError(msg)
215
        raise ValueError(msg)
896
192
    if settings.JUJU_GUI_NAME in bundle_services:
216
    if settings.JUJU_GUI_SERVICE_NAME in bundle_services:
897
193
        raise ValueError('bundle {} contains an instance of juju-gui. '
217
        raise ValueError('bundle {} contains an instance of juju-gui. '
898
194
                         'quickstart will install the latest version of the '
218
                         'quickstart will install the latest version of the '
899
195
                         'Juju GUI automatically, please remove juju-gui from '
219
                         'Juju GUI automatically, please remove juju-gui from '
Reviewer	Review Type	Date Requested	Status
Juju GUI Hackers		2013-11-22	Pending
Review via email: mp+196244@code.launchpad.net