Merge lp:~frankban/juju-quickstart/local-osx into lp:juju-quickstart

[Francesco Banconi]

Avoid proposing LXC envs as an option on MacOS.

https://codereview.appspot.com/105250043/

[Francesco Banconi (frankban)]

Reviewers: mp+223220_code.launchpad.net,

Message:
Please take a look.

Description:
Avoid proposing LXC envs as an option on MacOS.

https://code.launchpad.net/~frankban/juju-quickstart/local-osx/+merge/223220

(do not edit description out of merge proposal)

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

Affected files (+116, -22 lines):
   A [revision details]
   M quickstart/cli/views.py
   M quickstart/manage.py
   M quickstart/models/envs.py
   M quickstart/tests/cli/test_views.py
   M quickstart/tests/models/test_envs.py
   M quickstart/tests/test_manage.py

[Brad Crittenden (bac)]

LGTM with some typo fixes and QA-ok. Thanks Francesco.

https://codereview.appspot.com/105250043/diff/1/quickstart/tests/cli/test_views.py
File quickstart/tests/cli/test_views.py (right):

https://codereview.appspot.com/105250043/diff/1/quickstart/tests/cli/test_views.py#newcode42
quickstart/tests/cli/test_views.py:42: The value arguments is a boolean
representing whether or not local
typo: s/arguments/argument/

https://codereview.appspot.com/105250043/diff/1/quickstart/tests/cli/test_views.py#newcode186
quickstart/tests/cli/test_views.py:186: # The option to create a new
local environments is not present if they
typo: s/environments/environment/

https://codereview.appspot.com/105250043/

[lp:~frankban/juju-quickstart/local-osx]

90. By Francesco Banconi on 2014-06-16

Fix typos.

[Francesco Banconi (frankban)]

*** Submitted:

Avoid proposing LXC envs as an option on MacOS.

R=bac
CC=
https://codereview.appspot.com/105250043

https://codereview.appspot.com/105250043/diff/1/quickstart/tests/cli/test_views.py
File quickstart/tests/cli/test_views.py (right):

https://codereview.appspot.com/105250043/diff/1/quickstart/tests/cli/test_views.py#newcode42
quickstart/tests/cli/test_views.py:42: The value arguments is a boolean
representing whether or not local
On 2014/06/16 12:27:11, bac wrote:
> typo: s/arguments/argument/

Done.

https://codereview.appspot.com/105250043/diff/1/quickstart/tests/cli/test_views.py#newcode186
quickstart/tests/cli/test_views.py:186: # The option to create a new
local environments is not present if they
On 2014/06/16 12:27:11, bac wrote:
> typo: s/environments/environment/

Done.

https://codereview.appspot.com/105250043/

=== modified file 'quickstart/cli/views.py'
--- quickstart/cli/views.py	2014-04-23 15:53:32 +0000
+++ quickstart/cli/views.py	2014-06-16 12:33:53 +0000
@@ -102,7 +102,10 @@
 
 import urwid
 
-from quickstart import settings
+from quickstart import (
+    platform_support,
+    settings,
+)
 from quickstart.cli import (
     base,
     forms,
@@ -170,6 +173,9 @@
         # Use the newly created environment.
         raise ui.AppExit((env_db, env_data))
 
+    platform = platform_support.get_platform()
+    supports_local = platform_support.supports_local(platform)
+
     if environments:
         title = 'Select an existing Juju environment or create a new one'
         widgets = [
@@ -188,16 +194,24 @@
                 'Quickstart in interactive mode again by passing the -i flag, '
                 'e.g.:\n',
                 ('highlight', '$ juju quickstart -i'),
-                '\n\nAt the bottom of the page you can find links to manually '
-                'create new environments. If you instead prefer to quickly '
-                'start your Juju experience in a local environment (LXC), '
-                'just click the link below:'
             ]),
-            urwid.Divider(),
-            ui.MenuButton(
-                '\N{BULLET} automatically create and bootstrap a local '
-                'environment', ui.thunk(create_and_start_local_env)),
         ]
+        # If the current platform supports local Juju environments, add an
+        # option to automatically create and bootstrap one.
+        if supports_local:
+            widgets.extend([
+                urwid.Text([
+                    '\nAt the bottom of the page you can find links to '
+                    'manually create new environments. If you instead prefer '
+                    'to quickly start your Juju experience in a local '
+                    'environment (LXC), just click the link below:'
+                ]),
+                urwid.Divider(),
+                ui.MenuButton(
+                    '\N{BULLET} automatically create and bootstrap a local '
+                    'environment', ui.thunk(create_and_start_local_env)),
+            ])
+
     app.set_title(title)
     # Start creating the page contents: a list of selectable environments.
     # Wouldn't it be nice if we were able to highlight in some way the
@@ -225,7 +239,8 @@
         env_short_description = envs.get_env_short_description(env_data)
         text = [bullet, ' {}'.format(env_short_description)]
         widgets.append(ui.MenuButton(text, ui.thunk(detail_view, env_data)))
-    # Add the buttons used to create new environments.
+
+    # Set up the "create a new environment" section.
     widgets.extend([
         urwid.Divider(),
         urwid.Text((
@@ -236,14 +251,23 @@
     # series matches one of the series supported by the GUI.
     # Suggest the most recent supported series by pre-filling the value.
     preferred_series = settings.JUJU_GUI_SUPPORTED_SERIES[-1]
+    # Retrieve the list of supported environment types: exclude the local
+    # environment if not supported by the current OS platform.
+    filter_function = None
+    if not supports_local:
+        filter_function = lambda env_type, _: env_type != 'local'
+    supported_env_types = envs.get_supported_env_types(
+        env_type_db, filter_function=filter_function)
+    # Add the buttons used to create new environments.
     widgets.extend([
         ui.MenuButton(
             ['\N{BULLET} new ', ('highlight', label), ' environment'],
             ui.thunk(edit_view, {
                 'type': env_type, 'default-series': preferred_series})
         )
-        for env_type, label in envs.get_supported_env_types(env_type_db)
+        for env_type, label in supported_env_types
     ])
+
     # Set up the application status messages.
     status = [' \N{UPWARDS ARROW LEFTWARDS OF DOWNWARDS ARROW} navigate ']
     if default_found:

=== modified file 'quickstart/manage.py'
--- quickstart/manage.py	2014-06-13 14:36:30 +0000
+++ quickstart/manage.py	2014-06-16 12:33:53 +0000
@@ -290,7 +290,7 @@
     no_local_support = not platform_support.supports_local(options.platform)
     if options.env_type == 'local' and no_local_support:
         return parser.error(
-            'This host platform does not support local environments.'
+            'this host platform does not support local environments'
         )
     # Update the options namespace with the new values.
     options.admin_secret = env_data.get('admin-secret')

=== modified file 'quickstart/models/envs.py'
--- quickstart/models/envs.py	2014-04-23 11:22:44 +0000
+++ quickstart/models/envs.py	2014-06-16 12:33:53 +0000
@@ -685,15 +685,19 @@
     return env_type_db
 
 
-def get_supported_env_types(env_type_db):
+def get_supported_env_types(env_type_db, filter_function=None):
     """Return a list of supported (provider type, label) tuples.
 
     Each tuple represents an environment type supported by Quickstart.
+    It is possible to filter results by providing a filter_function callable
+    which receives the environment type and metadata.
     """
+    if filter_function is None:
+        filter_function = lambda env_type, metadata: True
     return [
         (env_type, metadata['label'])
         for env_type, metadata in env_type_db.items()
-        if env_type != '__fallback__'
+        if (env_type != '__fallback__') and filter_function(env_type, metadata)
     ]
 
 

=== modified file 'quickstart/tests/cli/test_views.py'
--- quickstart/tests/cli/test_views.py	2014-04-23 12:20:35 +0000
+++ quickstart/tests/cli/test_views.py	2014-06-16 12:33:53 +0000
@@ -36,6 +36,18 @@
 from quickstart.tests.cli import helpers as cli_helpers
 
 
+def local_envs_supported(value):
+    """Simulate local environments support in the current platform.
+
+    The value argument is a boolean representing whether or not local
+    environments are supported.
+    Return a context manager that can be used when calling views.
+    """
+    return mock.patch(
+        'quickstart.cli.views.platform_support.supports_local',
+        mock.Mock(return_value=value))
+
+
 class TestShow(unittest.TestCase):
 
     @contextmanager
@@ -125,6 +137,8 @@
 class TestEnvIndex(EnvViewTestsMixin, unittest.TestCase):
 
     base_status = ' \N{UPWARDS ARROW LEFTWARDS OF DOWNWARDS ARROW} navigate '
+    create_local_caption = (
+        '\N{BULLET} automatically create and bootstrap a local environment')
 
     def test_view_default_return_value_on_exit(self):
         # The view configures the app so that the return value on user exit is
@@ -157,7 +171,9 @@
         # The view displays a list of the environments in env_db, and buttons
         # to create new environments.
         env_db = helpers.make_env_db()
-        views.env_index(self.app, self.env_type_db, env_db, self.save_callable)
+        with local_envs_supported(True):
+            views.env_index(
+                self.app, self.env_type_db, env_db, self.save_callable)
         buttons = self.get_widgets_in_contents(
             filter_function=self.is_a(ui.MenuButton))
         # A button is created for each existing environment (see details) and
@@ -166,6 +182,22 @@
         expected_buttons_number = len(env_db['environments']) + len(env_types)
         self.assertEqual(expected_buttons_number, len(buttons))
 
+    def test_new_local_environment_disabled(self):
+        # The option to create a new local environment is not present if they
+        # are not supported in the current platform.
+        env_db = helpers.make_env_db()
+        with local_envs_supported(False):
+            views.env_index(
+                self.app, self.env_type_db, env_db, self.save_callable)
+        buttons = self.get_widgets_in_contents(
+            filter_function=self.is_a(ui.MenuButton))
+        captions = map(cli_helpers.get_button_caption, buttons)
+        create_local_captions = [
+            caption for caption in captions
+            if caption.startswith('\N{BULLET} new local')
+        ]
+        self.assertEqual([], create_local_captions)
+
     @mock.patch('quickstart.cli.views.env_detail')
     def test_environment_clicked(self, mock_env_detail):
         # The environment detail view is called when clicking an environment.
@@ -196,7 +228,9 @@
         # The environment edit view is called when clicking to create a new
         # environment.
         env_db = helpers.make_env_db()
-        views.env_index(self.app, self.env_type_db, env_db, self.save_callable)
+        with local_envs_supported(True):
+            views.env_index(
+                self.app, self.env_type_db, env_db, self.save_callable)
         buttons = self.get_widgets_in_contents(
             filter_function=self.is_a(ui.MenuButton))
         env_types = envs.get_supported_env_types(self.env_type_db)
@@ -223,14 +257,16 @@
         # If that option is clicked, the view quits the application returning
         # the newly created env_data.
         env_db = envs.create_empty_env_db()
-        views.env_index(self.app, self.env_type_db, env_db, self.save_callable)
+        with local_envs_supported(True):
+            views.env_index(
+                self.app, self.env_type_db, env_db, self.save_callable)
         buttons = self.get_widgets_in_contents(
             filter_function=self.is_a(ui.MenuButton))
         # The "create and bootstrap" button is the first one in the contents.
         create_button = buttons[0]
         self.assertEqual(
-            '\N{BULLET} automatically create and bootstrap a local '
-            'environment', cli_helpers.get_button_caption(create_button))
+            self.create_local_caption,
+            cli_helpers.get_button_caption(create_button))
         # An AppExit is raised clicking the button.
         with self.assertRaises(ui.AppExit) as context_manager:
             cli_helpers.emit(create_button)
@@ -239,6 +275,20 @@
         self.assertIn('local', new_env_db['environments'])
         self.assertEqual(envs.get_env_data(new_env_db, 'local'), env_data)
 
+    def test_create_and_bootstrap_local_environment_missing(self):
+        # The option to automatically create and bootstrap a new local
+        # environment is not displayed if the current platform does not support
+        # local environments.
+        env_db = envs.create_empty_env_db()
+        with local_envs_supported(False):
+            views.env_index(
+                self.app, self.env_type_db, env_db, self.save_callable)
+        buttons = self.get_widgets_in_contents(
+            filter_function=self.is_a(ui.MenuButton))
+        # No "create and bootstrap" buttons are present.
+        captions = map(cli_helpers.get_button_caption, buttons)
+        self.assertNotIn(self.create_local_caption, captions)
+
     def test_selected_environment(self):
         # The default environment is already selected in the list.
         env_db = helpers.make_env_db(default='lxc')

=== modified file 'quickstart/tests/models/test_envs.py'
--- quickstart/tests/models/test_envs.py	2014-04-23 12:20:35 +0000
+++ quickstart/tests/models/test_envs.py	2014-06-16 12:33:53 +0000
@@ -808,9 +808,12 @@
 
 class TestGetSupportedEnvTypes(unittest.TestCase):
 
+    def setUp(self):
+        # Store the environments database.
+        self.env_type_db = envs.get_env_type_db()
+
     def test_env_types(self):
         # All the supported env_types but the fallback one are returned.
-        env_type_db = envs.get_env_type_db()
         expected_env_types = [
             ('ec2', 'Amazon EC2'),
             ('openstack', 'OpenStack (or HP Public Cloud)'),
@@ -818,7 +821,18 @@
             ('joyent', 'Joyent'),
             ('local', 'local (LXC)'),
         ]
-        obtained_env_types = envs.get_supported_env_types(env_type_db)
+        obtained_env_types = envs.get_supported_env_types(self.env_type_db)
+        self.assertEqual(expected_env_types, obtained_env_types)
+
+    def test_filter_function(self):
+        # Results can be filtered by providing a filter function.
+        expected_env_types = [
+            ('ec2', 'Amazon EC2'),
+            ('joyent', 'Joyent'),
+        ]
+        func = lambda env_type, metadata: env_type in ('ec2', 'joyent')
+        obtained_env_types = envs.get_supported_env_types(
+            self.env_type_db, filter_function=func)
         self.assertEqual(expected_env_types, obtained_env_types)
 
 

=== modified file 'quickstart/tests/test_manage.py'
--- quickstart/tests/test_manage.py	2014-06-13 13:47:27 +0000
+++ quickstart/tests/test_manage.py	2014-06-16 12:33:53 +0000
@@ -572,7 +572,7 @@
         self.assertTrue(self.parser.error.called)
         message = self.parser.error.call_args[0][0]
         self.assertEqual(
-            'This host platform does not support local environments.',
+            'this host platform does not support local environments',
             message)
 
     def test_interactive_mode(self):