Merge lp:~gmb/maas/rpc-get-secrets into lp:~maas-committers/maas/trunk

[Graham Binns]

Add an RPC call, GetSecrets, which given a cluster UUID returns the API credentials for that cluster.

This is for use in Pserv services that need to use the API (for the sake of simplicity whilst we're removing Celery and Rabbit).

[Graham Binns (gmb)]

Marking WIP. Needs to handle error conditions.

[Graham Binns (gmb)]

Over-eager hacker is over-eager :). Now reviewable, though.

[Julian Edwards (julian-edwards)]

Please no! Just use RPC for everything.

review: Disapprove

[Graham Binns (gmb)]

On 27 August 2014 13:31, Julian Edwards <email address hidden>
wrote:

> Please no! Just use RPC for everything.
>

Okay.

[Graham Binns (gmb)]

(Besides, accidentally mixed up some branches. Would have been BAD.)

=== modified file 'src/maasserver/rpc/regionservice.py'
--- src/maasserver/rpc/regionservice.py	2014-08-26 14:29:13 +0000
+++ src/maasserver/rpc/regionservice.py	2014-08-27 15:09:21 +0000
@@ -24,12 +24,15 @@
 from textwrap import dedent
 import threading
 
+from apiclient.creds import convert_tuple_to_string
 from crochet import reactor
 from django.db import connection
 from maasserver import (
     eventloop,
     locks,
     )
+from maasserver.models.nodegroup import NodeGroup
+from maasserver.models.user import get_creds_tuple
 from maasserver.rpc import (
     bootsources,
     configuration,
@@ -74,6 +77,17 @@
 from zope.interface import implementer
 
 
+@transactional
+def get_cluster_api_credentials(cluster_uuid):
+    """Return the API creds for a cluster as a string."""
+    try:
+        the_cluster = NodeGroup.objects.get_by_natural_key(cluster_uuid)
+    except NodeGroup.DoesNotExist:
+        raise exceptions.NoSuchCluster(
+            "No cluster found with UUID %s." % cluster_uuid)
+    return convert_tuple_to_string(get_creds_tuple(the_cluster.api_token))
+
+
 class Region(amp.AMP):
     """The RPC protocol supported by a region controller.
 
@@ -212,6 +226,17 @@
         d.addCallback(lambda args: {})
         return d
 
+    @region.GetSecrets.responder
+    def get_secrets(self, cluster_uuid):
+        """get_secrets()
+
+        Implementation of
+        :py:class:`~provisioningserver.rpc.region.GetSecrets`.
+        """
+        d = deferToThread(get_cluster_api_credentials, cluster_uuid)
+        d.addCallback(lambda creds: {b"api_credentials": creds})
+        return d
+
 
 @implementer(IConnection)
 class RegionServer(Region):

=== modified file 'src/maasserver/rpc/tests/test_regionservice.py'
--- src/maasserver/rpc/tests/test_regionservice.py	2014-08-26 17:32:40 +0000
+++ src/maasserver/rpc/tests/test_regionservice.py	2014-08-27 15:09:21 +0000
@@ -14,6 +14,7 @@
 __metaclass__ = type
 __all__ = []
 
+
 from collections import defaultdict
 from contextlib import closing
 from itertools import product
@@ -22,6 +23,7 @@
 import random
 import threading
 
+from apiclient.creds import convert_tuple_to_string
 from crochet import wait_for_reactor
 from django.db import connection
 from django.db.utils import ProgrammingError
@@ -37,6 +39,7 @@
 from maasserver.models.event import Event
 from maasserver.models.eventtype import EventType
 from maasserver.models.node import Node
+from maasserver.models.user import get_creds_tuple
 from maasserver.rpc import regionservice
 from maasserver.rpc.regionservice import (
     Region,
@@ -66,6 +69,7 @@
     exceptions,
     )
 from provisioningserver.rpc.exceptions import (
+    NoSuchCluster,
     NoSuchEventType,
     NoSuchNode,
     )
@@ -74,6 +78,7 @@
     GetBootSources,
     GetBootSourcesV2,
     GetProxies,
+    GetSecrets,
     Identify,
     ListNodePowerParameters,
     MarkNodeBroken,
@@ -1420,3 +1425,48 @@
 
         # If the RPC service is down, _get_addresses() returns nothing.
         self.assertItemsEqual([], service._get_addresses())
+
+
+class TestRegionProtocol_GetSecrets(MAASTestCase):
+
+    def test_identify_is_registered(self):
+        protocol = Region()
+        responder = protocol.locateResponder(GetSecrets.commandName)
+        self.assertIsNot(responder, None)
+
+    @transactional
+    def create_cluster(self):
+        return factory.make_node_group()
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test_returns_api_secrets_for_cluster(self):
+        cluster = yield deferToThread(self.create_cluster)
+        expected_api_credentials = convert_tuple_to_string(
+            get_creds_tuple(cluster.api_token))
+
+        response = yield call_responder(
+            Region(), GetSecrets,
+            {
+                b'cluster_uuid': cluster.uuid,
+            }
+        )
+        self.assertEqual(
+            expected_api_credentials, response['api_credentials'])
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test_errors_if_cluster_not_found(self):
+        cluster_uuid = factory.make_UUID()
+        d = call_responder(
+            Region(), GetSecrets,
+            {
+                b'cluster_uuid': cluster_uuid,
+            }
+        )
+
+        def check(error):
+            self.assertIsInstance(error, Failure)
+            self.assertIsInstance(error.value, NoSuchCluster)
+
+        yield d.addErrback(check)

=== modified file 'src/provisioningserver/rpc/exceptions.py'
--- src/provisioningserver/rpc/exceptions.py	2014-08-22 11:23:35 +0000
+++ src/provisioningserver/rpc/exceptions.py	2014-08-27 15:09:21 +0000
@@ -17,6 +17,7 @@
     "CannotCreateHostMap",
     "CannotRemoveHostMap",
     "NoConnectionsAvailable",
+    "NoSuchCluster",
     "NoSuchEventType",
     "NoSuchNode",
     "NoSuchOperatingSystem",
@@ -61,3 +62,7 @@
 
 class CannotRemoveHostMap(Exception):
     """The host map could not be removed."""
+
+
+class NoSuchCluster(Exception):
+    """The specified cluster was not found."""

=== modified file 'src/provisioningserver/rpc/region.py'
--- src/provisioningserver/rpc/region.py	2014-08-25 17:19:56 +0000
+++ src/provisioningserver/rpc/region.py	2014-08-27 15:09:21 +0000
@@ -29,6 +29,7 @@
     )
 from provisioningserver.rpc.common import Identify
 from provisioningserver.rpc.exceptions import (
+    NoSuchCluster,
     NoSuchEventType,
     NoSuchNode,
     )
@@ -208,3 +209,20 @@
         NoSuchNode: b"NoSuchNode",
         NoSuchEventType: b"NoSuchEventType"
     }
+
+
+class GetSecrets(amp.Command):
+    """Get the API secrets for a cluster.
+
+    :since: 1.7
+    """
+
+    arguments = [
+        (b"cluster_uuid", amp.Unicode()),
+    ]
+    response = [
+        (b"api_credentials", amp.Unicode()),
+    ]
+    errors = {
+        NoSuchCluster: b"NoSuchCluster",
+    }