Merge lp:~frankban/juju-quickstart/support-bundle-urls into lp:juju-quickstart

[Francesco Banconi]

Support deploying "bundle:" URLs.

Also added packaging information to the
HACKING file, and updated the fallback
charm URL to the latest version which
officially supports bundles.

Tests: `make check`

QA:
`.venv/bin/python juju-quickstart -e ec2 bundle:~hatch/wiki/7/TestBundle`
Remember to destroy your ec2 environment.

https://codereview.appspot.com/23520044/

[Francesco Banconi (frankban)]

Reviewers: mp+194889_code.launchpad.net,

Message:
Please take a look.

Description:
Support deploying "bundle:" URLs.

Also added packaging information to the
HACKING file, and updated the fallback
charm URL to the latest version which
officially supports bundles.

Tests: `make check`

QA:
`.venv/bin/python juju-quickstart -e ec2
bundle:~hatch/wiki/7/TestBundle`
Remember to destroy your ec2 environment.

https://code.launchpad.net/~frankban/juju-quickstart/support-bundle-urls/+merge/194889

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/23520044/

Affected files (+84, -6 lines):
   M HACKING.rst
   A [revision details]
   M quickstart/app.py
   M quickstart/manage.py
   M quickstart/tests/test_manage.py
   M quickstart/tests/test_utils.py
   M quickstart/utils.py

Index: HACKING.rst
=== modified file 'HACKING.rst'
--- HACKING.rst 2013-11-06 15:21:19 +0000
+++ HACKING.rst 2013-11-12 15:34:15 +0000
@@ -72,3 +72,14 @@
  installation::

      $ .venv/bin/python juju-quickstart --help
+
+Creating PPA releases
+~~~~~~~~~~~~~~~~~~~~~
+
+The recipe for creating packages is in
+<https://code.launchpad.net/~juju-gui-charmers/+recipe/juju-quickstart-daily>.
+We currently publish releases on the Juju Quickstart Beta PPA: see
+<https://launchpad.net/~juju-gui/+archive/quickstart-beta/+packages>.
+Packages depend on `python-jujuclient` and `python-websocket-client` to be
+available. They are available in saucy, and they are also stored in our
PPA in
+order to support previous Ubuntu releases.

Index: [revision details]
=== added file '[revision details]'
--- [revision details] 2012-01-01 00:00:00 +0000
+++ [revision details] 2012-01-01 00:00:00 +0000
@@ -0,0 +1,2 @@
+Old revision:
<email address hidden>
+New revision:
<email address hidden>

Index: quickstart/app.py
=== modified file 'quickstart/app.py'
--- quickstart/app.py 2013-11-06 17:54:09 +0000
+++ quickstart/app.py 2013-11-12 15:55:34 +0000
@@ -31,7 +31,7 @@

  # The default Juju GUI charm URL to use when it is not possible to
retrieve it
  # from the charmworld API, e.g. due to temporary connection/charmworld
errors.
-DEFAULT_CHARM_URL = 'cs:precise/juju-gui-78'
+DEFAULT_CHARM_URL = 'cs:precise/juju-gui-79'

  class ProgramExit(Exception):

Index: quickstart/manage.py
=== modified file 'quickstart/manage.py'
--- quickstart/manage.py 2013-11-06 17:54:09 +0000
+++ quickstart/manage.py 2013-11-12 15:39:31 +0000
@@ -53,14 +53,21 @@
      Exit with an error if the bundle options are not valid.
      """
      bundle = options.bundle
+ if bundle.startswith('bundle:'):
+ # Convert "bundle:" URLs into HTTPS ones. The next if block below
will
+ # then load the bundle contents from the remote location.
+ try:
+ bundle = utils.convert_bundle_url(bundle)
+ except ValueError as err:
+ return parser.error('unable to open the bundle:
{}'.format(err))
      if bundle.startswith('http://') or bundle.startswith('https://'):
- # Load the bundle URL.
+ # Load the bundle from a remote URL.
         ...

[Richard Harding (rharding)]

LGTM QA-ok

https://codereview.appspot.com/23520044/diff/1/quickstart/manage.py
File quickstart/manage.py (right):

https://codereview.appspot.com/23520044/diff/1/quickstart/manage.py#newcode171
quickstart/manage.py:171: '3) a fully qualified bundle URL (starting
with "bundle:") or '
with this change should we promote bundle:, then url, then the local
options?

https://codereview.appspot.com/23520044/

[Francesco Banconi (frankban)]

On 2013/11/12 16:49:26, rharding wrote:
> LGTM QA-ok

> https://codereview.appspot.com/23520044/diff/1/quickstart/manage.py
> File quickstart/manage.py (right):

https://codereview.appspot.com/23520044/diff/1/quickstart/manage.py#newcode171
> quickstart/manage.py:171: '3) a fully qualified bundle URL (starting
with
> "bundle:") or '
> with this change should we promote bundle:, then url, then the local
options?

ok, thanks for the review.

https://codereview.appspot.com/23520044/

[lp:~frankban/juju-quickstart/support-bundle-urls]

14. By Francesco Banconi on 2013-11-12

Changes as per review.

[Francesco Banconi (frankban)]

*** Submitted:

Support deploying "bundle:" URLs.

Also added packaging information to the
HACKING file, and updated the fallback
charm URL to the latest version which
officially supports bundles.

Tests: `make check`

QA:
`.venv/bin/python juju-quickstart -e ec2
bundle:~hatch/wiki/7/TestBundle`
Remember to destroy your ec2 environment.

R=rharding
CC=
https://codereview.appspot.com/23520044

https://codereview.appspot.com/23520044/

=== modified file 'HACKING.rst'
--- HACKING.rst	2013-11-06 15:21:19 +0000
+++ HACKING.rst	2013-11-12 17:01:48 +0000
@@ -72,3 +72,14 @@
 installation::
 
     $ .venv/bin/python juju-quickstart --help
+
+Creating PPA releases
+~~~~~~~~~~~~~~~~~~~~~
+
+The recipe for creating packages is in
+<https://code.launchpad.net/~juju-gui-charmers/+recipe/juju-quickstart-daily>.
+We currently publish releases on the Juju Quickstart Beta PPA: see
+<https://launchpad.net/~juju-gui/+archive/quickstart-beta/+packages>.
+Packages depend on `python-jujuclient` and `python-websocket-client` to be
+available. They are available in saucy, and they are also stored in our PPA in
+order to support previous Ubuntu releases.

=== modified file 'quickstart/app.py'
--- quickstart/app.py	2013-11-06 17:54:09 +0000
+++ quickstart/app.py	2013-11-12 17:01:48 +0000
@@ -31,7 +31,7 @@
 
 # The default Juju GUI charm URL to use when it is not possible to retrieve it
 # from the charmworld API, e.g. due to temporary connection/charmworld errors.
-DEFAULT_CHARM_URL = 'cs:precise/juju-gui-78'
+DEFAULT_CHARM_URL = 'cs:precise/juju-gui-79'
 
 
 class ProgramExit(Exception):

=== modified file 'quickstart/manage.py'
--- quickstart/manage.py	2013-11-06 17:54:09 +0000
+++ quickstart/manage.py	2013-11-12 17:01:48 +0000
@@ -53,14 +53,21 @@
     Exit with an error if the bundle options are not valid.
     """
     bundle = options.bundle
+    if bundle.startswith('bundle:'):
+        # Convert "bundle:" URLs into HTTPS ones. The next if block below will
+        # then load the bundle contents from the remote location.
+        try:
+            bundle = utils.convert_bundle_url(bundle)
+        except ValueError as err:
+            return parser.error('unable to open the bundle: {}'.format(err))
     if bundle.startswith('http://') or bundle.startswith('https://'):
-        # Load the bundle URL.
+        # Load the bundle from a remote URL.
         try:
             bundle_yaml = utils.urlread(bundle)
         except IOError as err:
             return parser.error('unable to open bundle URL: {}'.format(err))
     else:
-        # Load the bundle file.
+        # Load the bundle from a file.
         bundle_file = os.path.abspath(os.path.expanduser(bundle))
         if os.path.isdir(bundle_file):
             bundle_file = os.path.join(bundle_file, 'bundles.yaml')
@@ -159,9 +166,10 @@
     parser.add_argument(
         'bundle', default=None, nargs='?',
         help='The optional bundle to be deployed. The bundle can be '
-             '1) a path to a YAML/JSON file or '
-             '2) a path to a directory containing a bundles.yaml file or '
-             '3) a URL (starting with http:// or https://) to a YAML/JSON')
+             '1) a fully qualified bundle URL (starting with "bundle:") or '
+             '2) a URL (starting with "http://" or "https://") to a YAML/JSON '
+             'or 3) a path to a YAML/JSON file or '
+             '4) a path to a directory containing a "bundles.yaml" file')
     parser.add_argument(
         '-e', '--environment', default=default_env_name, dest='env_name',
         help=env_help)

=== modified file 'quickstart/tests/test_manage.py'
--- quickstart/tests/test_manage.py	2013-11-06 15:12:43 +0000
+++ quickstart/tests/test_manage.py	2013-11-12 17:01:48 +0000
@@ -70,7 +70,8 @@
         self.assertEqual(open(bundle_file).read(), options.bundle_yaml)
 
     def test_resulting_options_from_url(self):
-        # The options object is correctly set up when a bundle URL is passed.
+        # The options object is correctly set up when a bundle HTTP(S) URL is
+        # passed.
         bundle_file = self.make_bundle_file()
         url = 'http://example.com/bundle.yaml'
         options = self.make_options(url, bundle_name='bundle1')
@@ -82,6 +83,21 @@
             ['mysql', 'wordpress'], sorted(options.bundle_services))
         self.assertEqual(open(bundle_file).read(), options.bundle_yaml)
 
+    def test_resulting_options_from_bundle_url(self):
+        # The options object is correctly set up when a "bundle:" URL is
+        # passed.
+        bundle_file = self.make_bundle_file()
+        url = 'bundle:~who/my/bundle'
+        options = self.make_options(url, bundle_name='bundle1')
+        with self.patch_urlread(contents=self.valid_bundle) as mock_urlread:
+            manage._validate_bundle(options, self.parser)
+        mock_urlread.assert_called_once_with(
+            'https://manage.jujucharms.com/bundle/~who/my/bundle/json')
+        self.assertEqual('bundle1', options.bundle_name)
+        self.assertEqual(
+            ['mysql', 'wordpress'], sorted(options.bundle_services))
+        self.assertEqual(open(bundle_file).read(), options.bundle_yaml)
+
     def test_resulting_options_from_dir(self):
         # The options object is correctly set up when a bundle dir is passed.
         bundle_dir = self.make_bundle_dir()
@@ -141,6 +157,14 @@
         self.parser.error.assert_called_once_with(
             'unable to open bundle URL: bad wolf')
 
+    def test_bundle_url_error(self):
+        # A parser error is invoked if an invalid "bundle:" URL is provided.
+        url = 'bundle:'
+        options = self.make_options(url)
+        manage._validate_bundle(options, self.parser)
+        self.parser.error.assert_called_once_with(
+            "unable to open the bundle: invalid bundle URL: 'bundle:'")
+
     def test_error_parsing_bundle_contents(self):
         # A parser error is invoked if an error occurs parsing the bundle YAML.
         bundle_file = self.make_bundle_file()

=== modified file 'quickstart/tests/test_utils.py'
--- quickstart/tests/test_utils.py	2013-11-06 14:55:30 +0000
+++ quickstart/tests/test_utils.py	2013-11-12 17:01:48 +0000
@@ -75,6 +75,28 @@
             utils.call('echo', 'we are the borg!')
 
 
+class TestConvertBundleUrl(helpers.ValueErrorTestsMixin, unittest.TestCase):
+
+    def test_conversion(self):
+        # The HTTPS location to the YAML contents are correctly returned.
+        bundle_url = 'bundle:~myuser/wiki-bundle/42/wiki'
+        expected = ('https://manage.jujucharms.com'
+                    '/bundle/~myuser/wiki-bundle/42/wiki/json')
+        self.assertEqual(expected, utils.convert_bundle_url(bundle_url))
+
+    def test_right_strip(self):
+        # The trailing slash in the bundle URL is removed.
+        bundle_url = 'bundle:~myuser/wiki-bundle/42/wiki/'
+        expected = ('https://manage.jujucharms.com'
+                    '/bundle/~myuser/wiki-bundle/42/wiki/json')
+        self.assertEqual(expected, utils.convert_bundle_url(bundle_url))
+
+    def test_error(self):
+        # A ValueError is raised if the given bundle URL is not valid.
+        with self.assert_value_error("invalid bundle URL: 'bundle:'"):
+            utils.convert_bundle_url('bundle:')
+
+
 class TestGetCharmUrl(helpers.UrlReadTestsMixin, unittest.TestCase):
 
     def test_charm_url(self):

=== modified file 'quickstart/utils.py'
--- quickstart/utils.py	2013-11-06 10:16:42 +0000
+++ quickstart/utils.py	2013-11-12 17:01:48 +0000
@@ -58,6 +58,17 @@
     return retcode, output, error
 
 
+def convert_bundle_url(bundle_url):
+    """Return the equivalent YAML HTTPS location for the fiven bundle URL.
+
+    Raise a ValueError if the given URL is not a valid bundle URL.
+    """
+    bundle_id = bundle_url.split(':', 1)[1].rstrip('/')
+    if not bundle_id:
+        raise ValueError('invalid bundle URL: {!r}'.format(bundle_url))
+    return 'https://manage.jujucharms.com/bundle/{}/json'.format(bundle_id)
+
+
 def get_charm_url():
     """Return the charm URL of the latest Juju GUI charm revision.