Merge lp:~frankban/juju-quickstart/maas-detect into lp:juju-quickstart

[Francesco Banconi]

Support automatic detection of a logged in MAAS.

Automatically detect a logged in MAAS API, so that
it is possible to use the stored credentials to
create and bootstrap a MAAS environment without
user intervention.

QA:
- ssh to the GUI MAAS;
- destroy the existing environment;
- remove the ~/.juju directory;
- use the MAAS UI (http://maas.jujugui.org/MAAS/nodes/)
  to release the nodes if they are not in a ready state;
- this branch is already checked out in ~/juju-quickstart/sandbox/;
- start quickstart from there:
  cd ~/juju-quickstart/sandbox/ && .venv/bin/python juju-quickstart
- quickstart should show the option to automatically create and
  bootstrap the MAAS environment;
- select the option and wait for the envirnment to be ready:
  this can fail due to juju/maas interaction problems we currently
  have, retrying the process should eventually succeed.

Done, thank you!

https://codereview.appspot.com/157830043/

[Francesco Banconi (frankban)]

Reviewers: mp+237910_code.launchpad.net,

Message:
Please take a look.

Description:
Support automatic detection of a logged in MAAS.

Automatically detect a logged in MAAS API, so that
it is possible to use the stored credentials to
create and bootstrap a MAAS environment without
user intervention.

QA:
- ssh to the GUI MAAS;
- destroy the existing environment;
- remove the ~/.juju directory;
- use the MAAS UI (http://maas.jujugui.org/MAAS/nodes/)
   to release the nodes if they are not in a ready state;
- this branch is already checked out in ~/juju-quickstart/sandbox/;
- start quickstart from there:
   cd ~/juju-quickstart/sandbox/ && .venv/bin/python juju-quickstart
- quickstart should show the option to automatically create and
   bootstrap the MAAS environment;
- select the option and wait for the envirnment to be ready:
   this can fail due to juju/maas interaction problems we currently
   have, retrying the process should eventually succeed.

Done, thank you!

https://code.launchpad.net/~frankban/juju-quickstart/maas-detect/+merge/237910

(do not edit description out of merge proposal)

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

Affected files (+347, -12 lines):
   A [revision details]
   M quickstart/cli/views.py
   A quickstart/maas.py
   M quickstart/models/envs.py
   M quickstart/settings.py
   M quickstart/tests/cli/test_views.py
   M quickstart/tests/models/test_envs.py
   A quickstart/tests/test_maas.py

[Brad Crittenden (bac)]

On 2014/10/10 08:03:44, frankban wrote:
> Please take a look.

LGTM Francesco, with a few little comments. Thanks!

https://codereview.appspot.com/157830043/

[Brad Crittenden (bac)]

LGTM

https://codereview.appspot.com/157830043/diff/1/quickstart/maas.py
File quickstart/maas.py (right):

https://codereview.appspot.com/157830043/diff/1/quickstart/maas.py#newcode42
quickstart/maas.py:42: Return None if if no authenticated API is found.
s/if if/if/

https://codereview.appspot.com/157830043/diff/1/quickstart/models/envs.py
File quickstart/models/envs.py (right):

https://codereview.appspot.com/157830043/diff/1/quickstart/models/envs.py#newcode388
quickstart/models/envs.py:388: # Assume all missing fields can be
automatically generated.
What happens if this assumption is wrong? Will field.generate() raise an
error?

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

https://codereview.appspot.com/157830043/diff/1/quickstart/tests/cli/test_views.py#newcode64
quickstart/tests/cli/test_views.py:64: default values: "maas-user",
"http://1.2.3.4/MAAS" and "maas-secret".
Maybe not repeat the values set above but just reference them? I reckon
DRY should apply to comments too.

https://codereview.appspot.com/157830043/

[lp:~frankban/juju-quickstart/maas-detect]

111. By Francesco Banconi on 2014-10-10

Fixt a typo and improve test comments.

[Francesco Banconi (frankban)]

Please take a look.

https://codereview.appspot.com/157830043/diff/1/quickstart/maas.py
File quickstart/maas.py (right):

https://codereview.appspot.com/157830043/diff/1/quickstart/maas.py#newcode42
quickstart/maas.py:42: Return None if if no authenticated API is found.
On 2014/10/10 08:48:53, bac wrote:
> s/if if/if/

Done.

https://codereview.appspot.com/157830043/diff/1/quickstart/models/envs.py
File quickstart/models/envs.py (right):

https://codereview.appspot.com/157830043/diff/1/quickstart/models/envs.py#newcode388
quickstart/models/envs.py:388: # Assume all missing fields can be
automatically generated.
On 2014/10/10 08:48:53, bac wrote:
> What happens if this assumption is wrong? Will field.generate() raise
an error?

A field without the ability to automatically generate a value does not
have the generate method. So the above call would raise an
AttributeError.

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

https://codereview.appspot.com/157830043/diff/1/quickstart/tests/cli/test_views.py#newcode64
quickstart/tests/cli/test_views.py:64: default values: "maas-user",
"http://1.2.3.4/MAAS" and "maas-secret".
On 2014/10/10 08:48:53, bac wrote:
> Maybe not repeat the values set above but just reference them? I
reckon DRY
> should apply to comments too.

Done.

https://codereview.appspot.com/157830043/

[Jay R. Wren (evarlast)]

LGTM

https://codereview.appspot.com/157830043/

[Francesco Banconi (frankban)]

*** Submitted:

Support automatic detection of a logged in MAAS.

Automatically detect a logged in MAAS API, so that
it is possible to use the stored credentials to
create and bootstrap a MAAS environment without
user intervention.

QA:
- ssh to the GUI MAAS;
- destroy the existing environment;
- remove the ~/.juju directory;
- use the MAAS UI (http://maas.jujugui.org/MAAS/nodes/)
   to release the nodes if they are not in a ready state;
- this branch is already checked out in ~/juju-quickstart/sandbox/;
- start quickstart from there:
   cd ~/juju-quickstart/sandbox/ && .venv/bin/python juju-quickstart
- quickstart should show the option to automatically create and
   bootstrap the MAAS environment;
- select the option and wait for the envirnment to be ready:
   this can fail due to juju/maas interaction problems we currently
   have, retrying the process should eventually succeed.

Done, thank you!

R=bac, jay.wren
CC=
https://codereview.appspot.com/157830043

https://codereview.appspot.com/157830043/

[Francesco Banconi (frankban)]

Thanks for the reviews!

https://codereview.appspot.com/157830043/

=== modified file 'quickstart/cli/views.py'
--- quickstart/cli/views.py	2014-06-16 10:20:42 +0000
+++ quickstart/cli/views.py	2014-10-10 08:54:59 +0000
@@ -103,6 +103,7 @@
 import urwid
 
 from quickstart import (
+    maas,
     platform_support,
     settings,
 )
@@ -133,6 +134,18 @@
         return err.return_value
 
 
+def _save_and_exit(env_db, env_data, save_callable):
+    """Add the new environment env_data to the env_db.
+
+    Exit the interactive session passing the newly saved environment, so that
+    it is bootstrapped by the application.
+    """
+    envs.set_env_data(env_db, None, env_data)
+    save_callable(env_db)
+    # Use the newly created environment.
+    raise ui.AppExit((env_db, env_data))
+
+
 def env_index(app, env_type_db, env_db, save_callable):
     """Show the Juju environments list.
 
@@ -167,11 +180,16 @@
         # Exit the interactive session selecting the newly created environment.
         env_data = envs.create_local_env_data(
             env_type_db, 'local', is_default=True)
-        # Add the new environment to the environments database.
-        envs.set_env_data(env_db, None, env_data)
-        save_callable(env_db)
-        # Use the newly created environment.
-        raise ui.AppExit((env_db, env_data))
+        _save_and_exit(env_db, env_data, save_callable)
+
+    def create_and_start_maas_env(name, server, api_key):
+        # Automatically create and use a MAAS environment.
+        # This closure can only be called when there are no environments in the
+        # database. For this reason, the new environment is set as default.
+        # Exit the interactive session selecting the newly created environment.
+        env_data = envs.create_maas_env_data(
+            env_type_db, name, server, api_key, is_default=True)
+        _save_and_exit(env_db, env_data, save_callable)
 
     platform = platform_support.get_platform()
     supports_local = platform_support.supports_local(platform)
@@ -196,6 +214,32 @@
                 ('highlight', '$ juju quickstart -i'),
             ]),
         ]
+        # If the MAAS CLI is available and it is logged in to a remote API,
+        # offer to automatically create and bootstrap a MAAS environment with
+        # the info retrieved by calling the MAAS CLI.
+        if maas.cli_available():
+            maas_api_data = maas.get_api_info()
+            if maas_api_data is not None:
+                maas_name, maas_server, maas_api_key = maas_api_data
+                maas_callback = ui.thunk(
+                    create_and_start_maas_env,
+                    maas_name, maas_server, maas_api_key)
+                widgets.extend([
+                    urwid.Text([
+                        '\nThe ',
+                        ('highlight', maas_name),
+                        ' MAAS (bare metal) remote API at ',
+                        ('highlight', maas_server),
+                        ' has been detected, and can be used to '
+                        'automatically set up a MAAS environment. '
+                        'To do that, just click the link below:',
+                    ]),
+                    urwid.Divider(),
+                    ui.MenuButton(
+                        '\N{BULLET} automatically create and bootstrap the {} '
+                        'MAAS environment'.format(maas_name), maas_callback),
+                ])
+
         # If the current platform supports local Juju environments, add an
         # option to automatically create and bootstrap one.
         if supports_local:
@@ -204,7 +248,7 @@
                     '\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:'
+                    'environment (LXC), just click the link below:',
                 ]),
                 urwid.Divider(),
                 ui.MenuButton(

=== added file 'quickstart/maas.py'
--- quickstart/maas.py	1970-01-01 00:00:00 +0000
+++ quickstart/maas.py	2014-10-10 08:54:59 +0000
@@ -0,0 +1,59 @@
+# This file is part of the Juju Quickstart Plugin, which lets users set up a
+# Juju environment in very few steps (https://launchpad.net/juju-quickstart).
+# Copyright (C) 2014 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License version 3, as published by
+# the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+# SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Juju Quickstart utilities for supporting MAAS."""
+
+from __future__ import unicode_literals
+
+import logging
+import os
+
+from quickstart import (
+    settings,
+    utils,
+)
+
+
+def cli_available():
+    """Report whether the MAAS CLI is available on the system."""
+    path = settings.MAAS_CMD
+    return os.path.isfile(path) and os.access(path, os.X_OK)
+
+
+def get_api_info():
+    """Return API info about the first logged in MAAS remote API.
+
+    The info is returned as a tuple including the API name, the MAAS server
+    address and the MAAS OAuth API key.
+
+    Return None if no authenticated API is found.
+    """
+    retcode, output, error = utils.call(settings.MAAS_CMD, 'list')
+    if retcode:
+        # The MAAS CLI command failed. This is not supposed to happen, but
+        # also not critical from the quickstart process perspective.
+        logging.warn('unable to list MAAS remote APIs: ' + error)
+        return None
+    if not output:
+        # No logged in remote API found.
+        return None
+    try:
+        name, api_address, api_key = output.splitlines()[0].split()
+    except ValueError:
+        # The MAAS CLI returned an unexpected response.
+        logging.warn('unexpected response from MAAS CLI: ' + output)
+        return None
+    return name, api_address.split('/api/')[0], api_key

=== modified file 'quickstart/models/envs.py'
--- quickstart/models/envs.py	2014-10-01 15:30:54 +0000
+++ quickstart/models/envs.py	2014-10-10 08:54:59 +0000
@@ -338,7 +338,7 @@
 
 
 def create_local_env_data(env_type_db, name, is_default=False):
-    """Create and return an local (LXC) env_data.
+    """Create and return a local (LXC) env_data.
 
     Local environments' fields (except for name and type) are assumed to be
     either optional or suitable for automatic generation of their values. For
@@ -367,6 +367,29 @@
     return env_data
 
 
+def create_maas_env_data(env_type_db, name, server, api_key, is_default=False):
+    """Create and return a MAAS (bare metal) env_data.
+
+    The env_data is created using the given name, MAAS server and MAAS OAuth
+    API key.
+    """
+    env_data = {
+        'type': 'maas',
+        'name': name,
+        'is-default': is_default,
+        'maas-server': server,
+        'maas-oauth': api_key,
+    }
+    env_metadata = get_env_metadata(env_type_db, env_data)
+    # Retrieve a list of missing required fields.
+    missing_fields = [
+        field for field in env_metadata['fields']
+        if field.required and field.name not in env_data]
+    # Assume all missing fields can be automatically generated.
+    env_data.update((field.name, field.generate()) for field in missing_fields)
+    return env_data
+
+
 def remove_env(env_db, env_name):
     """Remove the environment named env_name from the environments database.
 

=== modified file 'quickstart/settings.py'
--- quickstart/settings.py	2014-10-01 13:43:17 +0000
+++ quickstart/settings.py	2014-10-10 08:54:59 +0000
@@ -76,6 +76,9 @@
 # The set of series supported by the Juju GUI charm.
 JUJU_GUI_SUPPORTED_SERIES = tuple(DEFAULT_CHARM_URLS.keys())
 
+# The path to the MAAS command line interface.
+MAAS_CMD = '/usr/bin/maas'
+
 # The minimum Juju GUI charm revision supporting bundle deployments, for each
 # supported series. Assume not listed series to always support bundles.
 MINIMUM_REVISIONS_FOR_BUNDLES = collections.defaultdict(

=== modified file 'quickstart/tests/cli/test_views.py'
--- quickstart/tests/cli/test_views.py	2014-08-01 16:28:28 +0000
+++ quickstart/tests/cli/test_views.py	2014-10-10 08:54:59 +0000
@@ -18,7 +18,10 @@
 
 from __future__ import unicode_literals
 
-from contextlib import contextmanager
+from contextlib import (
+    contextmanager,
+    nested,
+)
 import unittest
 
 import mock
@@ -36,6 +39,11 @@
 from quickstart.tests.cli import helpers as cli_helpers
 
 
+MAAS_NAME = 'maas-name'
+MAAS_SERVER = 'http://1.2.3.4/MAAS'
+MAAS_API_KEY = 'maas-secret'
+
+
 def local_envs_supported(value):
     """Simulate local environments support in the current platform.
 
@@ -48,6 +56,26 @@
         mock.Mock(return_value=value))
 
 
+def maas_env_detected(value):
+    """Simulate whether a logged in MAAS remote API has been detected.
+
+    The value argument is a boolean representing whether or not a MAAS API
+    is available. If available, also patch "maas list" to return the following
+    default values: MAAS_NAME, MAAS_SERVER and MAAS_API_KEY.
+    Return a context manager that can be used when calling views.
+    """
+    patch_cli_available = mock.patch(
+        'quickstart.cli.views.maas.cli_available',
+        mock.Mock(return_value=value))
+    if value:
+        return_value = (MAAS_NAME, MAAS_SERVER, MAAS_API_KEY)
+        patch_get_api_info = mock.patch(
+            'quickstart.cli.views.maas.get_api_info',
+            mock.Mock(return_value=return_value))
+        return nested(patch_cli_available, patch_get_api_info)
+    return patch_cli_available
+
+
 class TestShow(unittest.TestCase):
 
     @contextmanager
@@ -139,6 +167,9 @@
     base_status = ' \N{UPWARDS ARROW LEFTWARDS OF DOWNWARDS ARROW} navigate '
     create_local_caption = (
         '\N{BULLET} automatically create and bootstrap a local environment')
+    create_maas_caption = (
+        '\N{BULLET} automatically create and bootstrap the {} MAAS '
+        'environment'.format(MAAS_NAME))
 
     def test_view_default_return_value_on_exit(self):
         # The view configures the app so that the return value on user exit is
@@ -257,9 +288,10 @@
         # If that option is clicked, the view quits the application returning
         # the newly created env_data.
         env_db = envs.create_empty_env_db()
-        with local_envs_supported(True):
-            views.env_index(
-                self.app, self.env_type_db, env_db, self.save_callable)
+        with maas_env_detected(False):
+            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.
@@ -285,10 +317,49 @@
                 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.
+        # No "create and bootstrap local" buttons are present.
         captions = map(cli_helpers.get_button_caption, buttons)
         self.assertNotIn(self.create_local_caption, captions)
 
+    def test_create_and_bootstrap_maas_environment_clicked(self):
+        # When there are no environments in the env_db and a remote MAAS API is
+        # detected, the view exposes an option to automatically create and
+        # bootstrap a new MAAS environment.
+        # If that option is clicked, the view quits the application returning
+        # the newly created env_data.
+        env_db = envs.create_empty_env_db()
+        with maas_env_detected(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(
+            self.create_maas_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)
+        new_env_db, env_data = context_manager.exception.return_value
+        # The environments database is no longer empty.
+        self.assertIn(MAAS_NAME, new_env_db['environments'])
+        self.assertEqual(envs.get_env_data(new_env_db, MAAS_NAME), env_data)
+
+    def test_create_and_bootstrap_maas_environment_missing(self):
+        # The option to automatically create and bootstrap a new MAAS
+        # environment is not displayed if no MAAS API endpoints are
+        # available on the system
+        env_db = envs.create_empty_env_db()
+        with maas_env_detected(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 MAAS" buttons are present.
+        captions = map(cli_helpers.get_button_caption, buttons)
+        self.assertNotIn(self.create_maas_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-09-29 13:50:52 +0000
+++ quickstart/tests/models/test_envs.py	2014-10-10 08:54:59 +0000
@@ -644,6 +644,41 @@
         self.assertEqual(expected_env_data, env_data)
 
 
+class TestCreateMaasEnvData(unittest.TestCase):
+
+    def setUp(self):
+        # Store the env_type_db.
+        self.env_type_db = envs.get_env_type_db()
+
+    def test_not_default(self):
+        # The resulting env_data is correctly structured for non default envs.
+        env_data = envs.create_maas_env_data(
+            self.env_type_db, 'my-maas', 'http://1.2.3.4/MAAS', 'Secret!',
+            is_default=False)
+        expected_env_data = {
+            'type': 'maas',
+            'name': 'my-maas',
+            'maas-server': 'http://1.2.3.4/MAAS',
+            'maas-oauth': 'Secret!',
+            'is-default': False,
+        }
+        self.assertEqual(expected_env_data, env_data)
+
+    def test_default(self):
+        # The resulting env_data is correctly structured for default envs.
+        env_data = envs.create_maas_env_data(
+            self.env_type_db, 'another-maas', 'http://1.2.3.4/MAAS', 'Boo!',
+            is_default=True)
+        expected_env_data = {
+            'type': 'maas',
+            'name': 'another-maas',
+            'maas-server': 'http://1.2.3.4/MAAS',
+            'maas-oauth': 'Boo!',
+            'is-default': True,
+        }
+        self.assertEqual(expected_env_data, env_data)
+
+
 class TestRemoveEnv(
         EnvDataTestsMixin, helpers.ValueErrorTestsMixin, unittest.TestCase):
 

=== added file 'quickstart/tests/test_maas.py'
--- quickstart/tests/test_maas.py	1970-01-01 00:00:00 +0000
+++ quickstart/tests/test_maas.py	2014-10-10 08:54:59 +0000
@@ -0,0 +1,98 @@
+# This file is part of the Juju Quickstart Plugin, which lets users set up a
+# Juju environment in very few steps (https://launchpad.net/juju-quickstart).
+# Copyright (C) 2014 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License version 3, as published by
+# the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+# SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Tests for the Juju Quickstart MAAS support."""
+
+from __future__ import unicode_literals
+
+import os
+import shutil
+import tempfile
+import unittest
+
+import mock
+
+from quickstart import maas
+from quickstart.tests import helpers
+
+
+class TestCliAvailable(unittest.TestCase):
+
+    def setUp(self):
+        # Set up a a container for MAAS CLI tests.
+        self.playground = tempfile.mkdtemp()
+        self.addCleanup(shutil.rmtree, self.playground)
+
+    def test_not_found(self):
+        # The MAAS CLI is not installed and cannot be found.
+        path = os.path.join(self.playground, 'no-such')
+        with mock.patch('quickstart.maas.settings.MAAS_CMD', path):
+            self.assertFalse(maas.cli_available())
+
+    def test_not_executable(self):
+        # The file is not executable and for this reason the MAAS CLI is not
+        # considered available.
+        path = os.path.join(self.playground, 'not-executable')
+        open(path, 'w').close()
+        with mock.patch('quickstart.maas.settings.MAAS_CMD', path):
+            self.assertFalse(maas.cli_available())
+
+    def test_available(self):
+        # The MAAS CLI is there and ready to be called.
+        path = os.path.join(self.playground, 'executable')
+        open(path, 'w').close()
+        os.chmod(path, 0744)
+        with mock.patch('quickstart.maas.settings.MAAS_CMD', path):
+            self.assertTrue(maas.cli_available())
+
+
+class TestGetApiInfo(helpers.CallTestsMixin, unittest.TestCase):
+
+    def test_command_error(self):
+        # None is returned and a warning is printed if the MAAS command returns
+        # an error.
+        expected_log = 'unable to list MAAS remote APIs: bad wolf'
+        with self.patch_call(1, '', 'bad wolf'):
+            with helpers.assert_logs([expected_log], level='warn'):
+                api_info = maas.get_api_info()
+        self.assertIsNone(api_info)
+
+    def test_no_apis(self):
+        # None is returned if no remote APIs are detected.
+        with self.patch_call(0, '', ''):
+            with helpers.assert_logs([], level='warn'):
+                api_info = maas.get_api_info()
+        self.assertIsNone(api_info)
+
+    def test_malformed_output(self):
+        # None is returned and a warning is printed if the MAAS command returns
+        # an unexpected output.
+        expected_log = 'unexpected response from MAAS CLI: exterminate!'
+        with self.patch_call(0, 'exterminate!', ''):
+            with helpers.assert_logs([expected_log], level='warn'):
+                api_info = maas.get_api_info()
+        self.assertIsNone(api_info)
+
+    def test_info(self):
+        # If at least one remote MAAS API is detected, then a tuple including
+        # the MAAS name, address and API key is returned.
+        output = 'maas-name http://1.2.3.4/MAAS/api/v1 maas:secret!'
+        with self.patch_call(0, output, ''):
+            with helpers.assert_logs([], level='warn'):
+                api_info = maas.get_api_info()
+        self.assertEqual(
+            ('maas-name', 'http://1.2.3.4/MAAS', 'maas:secret!'),
+            api_info)