Merge ~ack/maas:backport-1817687 into maas:2.5

[Alberto Donato]

backport 591ea5acfcdeed93763c396cc4b20741c9b6be8a - LP: #1817687 - prompt the user in maas configauth for creating the service in RBAC if not found

[Alberto Donato (ack)]

review: Approve

diff --git a/src/maascli/init.py b/src/maascli/init.py
index 5f860c6..b9e6692 100644
--- a/src/maascli/init.py
+++ b/src/maascli/init.py
@@ -223,3 +223,50 @@ def init_maas(options):
             create_account_external_auth(auth_config, maas_config)
         else:
             create_admin_account(options)
+
+
+def read_input(prompt):
+    """Reads input from stdin."""
+    while True:
+        try:
+            data = input(prompt)
+        except EOFError:
+            # Ctrl-d was pressed?
+            print()
+            continue
+        except KeyboardInterrupt:
+            print()
+            raise SystemExit(1)
+        else:
+            # The assumption is that, since Python 3 return a Unicode string
+            # from input(), it has Done The Right Thing with respect to
+            # character encoding.
+            return data
+
+
+def prompt_for_choices(prompt, choices, default=None, help_text=None):
+    """Prompt requires specific choice answeres.
+
+    If `help_text` is provided the 'help' is added as a choice.
+    """
+    invalid_msg = 'Invalid input, try again'
+    if help_text:
+        invalid_msg += " or type 'help'"
+    invalid_msg += '.'
+    value = None
+    while True:
+        value = read_input(prompt)
+        if not value:
+            if default:
+                return default
+            else:
+                print_msg(invalid_msg)
+                print_msg()
+        elif value == 'help' and help_text:
+            print_msg(help_text)
+            print_msg()
+        elif value not in choices:
+            print_msg(invalid_msg)
+            print_msg()
+        else:
+            return value
diff --git a/src/maascli/snappy.py b/src/maascli/snappy.py
index 4779f0d..a8e5322 100755
--- a/src/maascli/snappy.py
+++ b/src/maascli/snappy.py
@@ -35,6 +35,8 @@ from maascli.init import (
     deprecated_for,
     init_maas,
     print_msg,
+    prompt_for_choices,
+    read_input,
 )
 import netifaces
 import tempita
@@ -478,25 +480,6 @@ def perform_work(msg, cmd, *args, **kwargs):
     return ret
 
 
-def read_input(prompt):
-    """Reads input from stdin."""
-    while True:
-        try:
-            data = input(prompt)
-        except EOFError:
-            # Ctrl-d was pressed?
-            print()
-            continue
-        except KeyboardInterrupt:
-            print()
-            raise SystemExit(1)
-        else:
-            # The assumption is that, since Python 3 return a Unicode string
-            # from input(), it has Done The Right Thing with respect to
-            # character encoding.
-            return data
-
-
 def required_prompt(prompt, help_text=None):
     """Prompt for required input."""
     value = None
@@ -508,34 +491,6 @@ def required_prompt(prompt, help_text=None):
     return value
 
 
-def prompt_for_choices(prompt, choices, default=None, help_text=None):
-    """Prompt requires specific choice answeres.
-
-    If `help_text` is provided the 'help' is added as a choice.
-    """
-    invalid_msg = 'Invalid input, try again'
-    if help_text:
-        invalid_msg += " or type 'help'"
-    invalid_msg += '.'
-    value = None
-    while True:
-        value = read_input(prompt)
-        if not value:
-            if default:
-                return default
-            else:
-                print_msg(invalid_msg)
-                print_msg()
-        elif value == 'help' and help_text:
-            print_msg(help_text)
-            print_msg()
-        elif value not in choices:
-            print_msg(invalid_msg)
-            print_msg()
-        else:
-            return value
-
-
 def prompt_for_maas_url():
     """Prompt for the MAAS URL."""
     default_url = get_default_url()
diff --git a/src/maasserver/management/commands/configauth.py b/src/maasserver/management/commands/configauth.py
index d6bf7e8..2a8aa9a 100644
--- a/src/maasserver/management/commands/configauth.py
+++ b/src/maasserver/management/commands/configauth.py
@@ -18,8 +18,10 @@ from django.db import DEFAULT_DB_ALIAS
 from maascli.init import (
     add_candid_options,
     add_rbac_options,
+    prompt_for_choices,
+    read_input,
 )
-from maasserver.management.commands.createadmin import read_input
+from maasserver.macaroon_auth import APIError
 from maasserver.models import Config
 from maasserver.models.rbacsync import (
     RBAC_ACTION,
@@ -79,19 +81,27 @@ def update_auth_details_from_rbac_registration(
     services = {
         service['name']: service
         for service in client.get_registerable_services()}
-    if not services:
-        raise CommandError(
-            'No registerable MAAS service on the specified RBAC server')
-    if service_name is not None:
-        service = services.get(service_name)
-        if service is None:
+    if service_name is None:
+        if not services:
             raise CommandError(
-                'Service "{}" is not known, available choices: {}'.
-                format(service_name, ', '.join(sorted(services))))
-
-    else:
+                'No registerable MAAS service on the specified RBAC server')
         service = _pick_service(services)
-
+    else:
+        service = services.get(service_name)
+        if service is None:
+            create_service = prompt_for_choices(
+                'A service with the specified name was not found, '
+                'do you want to create one? (yes/no) [default=no]? ',
+                ['yes', 'no'], default='no')
+            if create_service == 'no':
+                raise CommandError('Registration with RBAC service canceled')
+            try:
+                service = client.create_service(service_name)
+            except APIError as error:
+                if error.status_code == 409:
+                    raise CommandError(
+                        'User not allowed to register this service')
+                raise CommandError(str(error))
     _register_service(client, service, auth_details)
     print('Service "{}" registered'.format(service['name']))
 
diff --git a/src/maasserver/management/commands/createadmin.py b/src/maasserver/management/commands/createadmin.py
index ecb7e79..3296927 100644
--- a/src/maasserver/management/commands/createadmin.py
+++ b/src/maasserver/management/commands/createadmin.py
@@ -14,6 +14,7 @@ from django.core.management.base import (
     CommandError,
 )
 from django.db import DEFAULT_DB_ALIAS
+from maascli.init import read_input
 from maasserver.enum import KEYS_PROTOCOL_TYPE
 from maasserver.models.config import Config
 from maasserver.models.keysource import KeySource
@@ -37,24 +38,6 @@ class SSHKeysError(CommandError):
     """Error during SSH keys import."""
 
 
-def read_input(prompt):
-    while True:
-        try:
-            data = input(prompt)
-        except EOFError:
-            # Ctrl-d was pressed?
-            print()
-            continue
-        except KeyboardInterrupt:
-            print()
-            raise SystemExit(1)
-        else:
-            # The assumption is that, since Python 3 return a Unicode string
-            # from input(), it has Done The Right Thing with respect to
-            # character encoding.
-            return data
-
-
 def read_password(prompt):
     while True:
         try:
diff --git a/src/maasserver/rbac.py b/src/maasserver/rbac.py
index 7d63ea4..a1d9a43 100644
--- a/src/maasserver/rbac.py
+++ b/src/maasserver/rbac.py
@@ -378,12 +378,18 @@ class RBACUserClient(MacaroonClient):
     def __init__(self, url):
         # no auth info is passed as this is meant for interactive use
         super().__init__(url, None)
+        self._maas_product = None
+
+    def create_service(self, name):
+        """Create a MAAS service with the specified name."""
+        maas = self._get_maas_product()
+        data = {'name': name, 'product': {'$ref': maas['$uri']}}
+        return self._api_request('POST', '/service', json=data)
 
     def get_registerable_services(self):
         """Return MAAS services that can be registered by the user."""
         maas = self._get_maas_product()
-        services = self._request(
-            'GET', self._url + self.API_BASE_URL + '/service/registerable')
+        services = self._api_request('GET', '/service/registerable')
         return [
             service for service in services
             if service['product']['$ref'] == maas['$uri']]
@@ -396,11 +402,17 @@ class RBACUserClient(MacaroonClient):
 
     def _get_maas_product(self):
         """Return details for the maas product."""
-        products = self._request(
-            'GET', self._url + self.API_BASE_URL + '/product')
-        [maas] = [
-            product for product in products if product['label'] == 'maas']
-        return maas
+        if self._maas_product is None:
+            products = self._api_request('GET', '/product')
+            [maas] = [
+                product for product in products if product['label'] == 'maas']
+            self._maas_product = maas
+        return self._maas_product
+
+    def _api_request(self, method, path, json=None, status_code=200):
+        return self._request(
+            method, self._url + self.API_BASE_URL + path,
+            json=json, status_code=status_code)
 
 
 class FakeRBACUserClient(RBACUserClient):
@@ -410,6 +422,15 @@ class FakeRBACUserClient(RBACUserClient):
         self.products = []
         self.registered_services = []
 
+    def create_service(self, name):
+        maas = {
+            'name': 'maas',
+            '$uri': '/api/rbac/v1/service/4',
+            'pending': True,
+            'product': {'$ref' '/api/rbac/v1/product/2'}}
+        self.services.append(maas)
+        return maas
+
     def get_products(self):
         return self.products
 
diff --git a/src/maasserver/tests/test_commands.py b/src/maasserver/tests/test_commands.py
index 5a59dec..d16fb0d 100644
--- a/src/maasserver/tests/test_commands.py
+++ b/src/maasserver/tests/test_commands.py
@@ -256,12 +256,12 @@ class TestCommands(MAASServerTestCase):
 
     def test_prompt_for_username_returns_selected_username(self):
         username = factory.make_name('user')
-        self.patch(createadmin, 'input').return_value = username
+        self.patch(createadmin, 'read_input').return_value = username
 
         self.assertEqual(username, createadmin.prompt_for_username())
 
     def test_prompt_for_username_checks_for_empty_username(self):
-        self.patch(createadmin, 'input', lambda x: '')
+        self.patch(createadmin, 'read_input', lambda x: '')
 
         self.assertRaises(
             createadmin.EmptyUsername,
@@ -269,12 +269,12 @@ class TestCommands(MAASServerTestCase):
 
     def test_prompt_for_email_returns_selected_email(self):
         email = factory.make_email_address()
-        self.patch(createadmin, 'input').return_value = email
+        self.patch(createadmin, 'read_input').return_value = email
 
         self.assertEqual(email, createadmin.prompt_for_email())
 
     def test_prompt_for_email_checks_for_empty_email(self):
-        self.patch(createadmin, 'input', lambda x: '')
+        self.patch(createadmin, 'read_input', lambda x: '')
 
         self.assertRaises(
             createadmin.EmptyEmail,
@@ -285,12 +285,12 @@ class TestCommands(MAASServerTestCase):
             random.choice(
                 [KEYS_PROTOCOL_TYPE.LP, KEYS_PROTOCOL_TYPE.GH]),
             factory.make_name('user-id'))
-        self.patch(createadmin, 'input').return_value = ssh_import
+        self.patch(createadmin, 'read_input').return_value = ssh_import
 
         self.assertEqual(ssh_import, createadmin.prompt_for_ssh_import())
 
     def test_prompt_for_ssh_import_returns_None_for_no_user_id(self):
-        self.patch(createadmin, 'input').return_value = ''
+        self.patch(createadmin, 'read_input').return_value = ''
         self.assertEqual('', createadmin.prompt_for_ssh_import())
 
     def test_validate_ssh_import_validates_protocol_and_user_id(self):
diff --git a/src/maasserver/tests/test_commands_configauth.py b/src/maasserver/tests/test_commands_configauth.py
index 74ec282..5e03928 100644
--- a/src/maasserver/tests/test_commands_configauth.py
+++ b/src/maasserver/tests/test_commands_configauth.py
@@ -306,7 +306,7 @@ class TestConfigAuthCommand(MAASServerTestCase):
              'rbac_url': 'http://rbac.example.com/'},
             json.loads(output))
 
-    def test_configauth_rbac_with_name(self):
+    def test_configauth_rbac_with_name_existing(self):
         self.rbac_user_client.services = [
             {'name': 'mymaas',
              '$uri': '/api/rbac/v1/service/4',
@@ -325,26 +325,31 @@ class TestConfigAuthCommand(MAASServerTestCase):
             self.rbac_user_client.registered_services,
             ['/api/rbac/v1/service/4'])
 
-    def test_configauth_rbac_unknown_name(self):
-        self.rbac_user_client.services = [
-            {'name': 'mymaas1',
-             '$uri': '/api/rbac/v1/service/4',
-             'pending': True,
-             'product': {'$ref' '/api/rbac/v1/product/2'}},
-            {'name': 'mymaas2',
-             '$uri': '/api/rbac/v1/service/4',
-             'pending': True,
-             'product': {'$ref' '/api/rbac/v1/product/2'}}]
+    def test_configauth_rbac_with_name_create(self):
+        patch_prompt = self.patch(configauth, 'prompt_for_choices')
+        patch_prompt.return_value = 'yes'
+        call_command(
+            'configauth', rbac_url='http://rbac.example.com',
+            rbac_service_name='maas')
+        patch_prompt.assert_called_once()
+        self.assertEqual(
+            'http://rbac.example.com',
+            Config.objects.get_config('rbac_url'))
+        self.assertEqual(
+            self.rbac_user_client.registered_services,
+            ['/api/rbac/v1/service/4'])
+
+    def test_configauth_rbac_with_name_abort(self):
+        patch_prompt = self.patch(configauth, 'prompt_for_choices')
+        patch_prompt.return_value = 'no'
         error = self.assertRaises(
             CommandError, call_command,
-            'configauth', candid_url='http://example.com:1234',
-            candid_user='user@admin', candid_key='private-key',
-            rbac_url='http://rbac.example.com',
-            rbac_service_name='unknown')
-        self.assertEqual(
-            str(error),
-            'Service "unknown" is not known, available choices: '
-            'mymaas1, mymaas2')
+            'configauth', rbac_url='http://rbac.example.com',
+            rbac_service_name='maas')
+        self.assertEqual(str(error), 'Registration with RBAC service canceled')
+        patch_prompt.assert_called_once()
+        self.assertEqual(Config.objects.get_config('rbac_url'), '')
+        self.assertEqual(self.rbac_user_client.registered_services, [])
 
     def test_configauth_rbac_registration_list(self):
         self.rbac_user_client.services = [
diff --git a/src/maasserver/tests/test_rbac.py b/src/maasserver/tests/test_rbac.py
index 0314c7b..1e2a7dc 100644
--- a/src/maasserver/tests/test_rbac.py
+++ b/src/maasserver/tests/test_rbac.py
@@ -549,3 +549,38 @@ class TestRBACUserClient(MAASServerTestCase):
                 'https://rbac.example.com/api/'
                 'rbac/v1/service/3/credentials',
                 auth=mock.ANY, cookies=mock.ANY, json=json))
+
+    def test_create_service(self):
+        products = [
+            {
+                '$uri': '/api/rbac/v1/product/1',
+                'label': 'maas',
+                'name': 'MAAS',
+            }
+        ]
+        maas = {
+            '$uri': '/api/rbac/v1/service/2',
+            'name': 'maas',
+            'description': '',
+            'pending': True,
+            'product': {
+                '$ref': '/api/rbac/v1/product/1'
+            },
+        }
+        self.mock_responses(products, maas)
+        self.assertEqual(self.client.create_service('maas'), maas)
+        json = {
+            'name': 'maas',
+            'product': {'$ref': '/api/rbac/v1/product/1'}
+        }
+        self.assertThat(
+            self.mock_request,
+            MockCallsMatch(
+                mock.call(
+                    'GET',
+                    'https://rbac.example.com/api/rbac/v1/product',
+                    auth=mock.ANY, cookies=mock.ANY, json=None),
+                mock.call(
+                    'POST',
+                    'https://rbac.example.com/api/rbac/v1/service',
+                    auth=mock.ANY, cookies=mock.ANY, json=json)))
diff --git a/utilities/check-imports b/utilities/check-imports
index dd1b83e..5c825ec 100755
--- a/utilities/check-imports
+++ b/utilities/check-imports
@@ -262,8 +262,7 @@ RegionControllerRule = Rule(
     Allow("formencode|formencode.**"),
     Allow("jsonschema|jsonschema.**"),
     Allow("lxml|lxml.**"),
-    Allow("maascli.init.add_candid_options"),
-    Allow("maascli.init.add_rbac_options"),
+    Allow("maascli.init.**"),
     Allow("maascli.utils.parse_docstring"),
     Allow("maasserver|maasserver.**"),
     Allow("macaroonbakery|macaroonbakery.**"),