Merge lp:~jtv/maas/maascli-fake-config into lp:~maas-committers/maas/trunk

[Jeroen T. Vermeulen]

Extract creation of a fake maascli ProfileConfig for testing.

This is one of those places where the code needed breaking up in order for my real work to progress. It has been remarked upon that the creation of the fake is really horrible code (or perhaps it's fairer to say that the data structure is horrible) and so I would like to avoid having to duplicate it in later tests for different modules.

Jeroen

[Raphaël Badin (rvb)]

review: Approve

[MAAS Lander (maas-lander)]

Attempt to merge into lp:maas failed due to conflicts:

text conflict in src/maascli/tests/test_api.py

[Jeroen T. Vermeulen (jtv)]

Ouch. Gavin was refactoring the same code while I was moving it. I more or less ported his changes to the new module.

=== added directory 'src/maascli/testing'
=== added file 'src/maascli/testing/__init__.py'
=== added file 'src/maascli/testing/config.py'
--- src/maascli/testing/config.py	1970-01-01 00:00:00 +0000
+++ src/maascli/testing/config.py	2012-10-08 13:38:55 +0000
@@ -0,0 +1,75 @@
+# Copyright 2012 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Fake `ProfileConfig` for testing."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+__metaclass__ = type
+__all__ = [
+    'FakeConfig',
+    'make_configs',
+    'make_profile',
+    ]
+
+from maastesting.factory import factory
+
+
+class FakeConfig(dict):
+    """Fake `ProfileConfig`.  A dict that's also a context manager."""
+    def __enter__(self, *args, **kwargs):
+        return self
+
+    def __exit__(self, *args, **kwargs):
+        pass
+
+
+def make_handler():
+    """Create a fake handler entry."""
+    return {
+        'name': factory.make_name('handler'),
+        'doc': "Short\n\nLong",
+        'params': [],
+        'actions': [{
+            'name': factory.make_name('action'),
+            'doc': "Doc\n\nstring",
+            }],
+        }
+
+
+def make_resource(anon=True, auth=True):
+    """Create a fake resource entry."""
+    auth = make_handler() if auth else None
+    anon = make_handler() if anon else None
+    name = factory.make_name('resource')
+    return {'auth': auth, 'anon': anon, 'name': name}
+
+
+def make_profile(name=None):
+    """Create a fake profile dict."""
+    if name is None:
+        name = factory.make_name('profile')
+    return {
+        'name': name,
+        'url': 'http://%s.example.com/' % name,
+        'credentials': factory.make_name('credentials'),
+        'description': {
+            'resources': [
+                make_resource(),
+                make_resource(),
+                ],
+            },
+        }
+
+
+def make_configs(number_of_configs=1):
+    """Create a dict mapping config names to `FakeConfig`."""
+    result = {}
+    while len(result) < number_of_configs:
+        profile = factory.make_name('profile')
+        result[profile] = FakeConfig(make_profile(profile))
+    return FakeConfig(result)

=== modified file 'src/maascli/tests/test_api.py'
--- src/maascli/tests/test_api.py	2012-10-08 11:18:45 +0000
+++ src/maascli/tests/test_api.py	2012-10-08 13:38:55 +0000
@@ -24,6 +24,7 @@
     )
 from maascli.command import CommandError
 from maascli.config import ProfileConfig
+from maascli.testing.config import make_configs
 from maascli.utils import (
     handler_command_name,
     safe_name,
@@ -42,55 +43,16 @@
     )
 
 
-class FakeConfig(dict):
-    """Fake `ProfileConfig`.  A dict that's also a context manager."""
-    def __enter__(self, *args, **kwargs):
-        return self
-
-    def __exit__(self, *args, **kwargs):
-        pass
-
-
 class TestRegisterAPICommands(TestCase):
     """Tests for `register_api_commands`."""
 
-    def make_handler(self):
-        return {
-            'name': factory.make_name('handler'),
-            'doc': "Short\n\nLong",
-            'params': [],
-            'actions': [
-                {'name': factory.make_name('action'),
-                 'doc': "Doc\n\nstring"},
-                ],
-            }
-
-    def make_resource(self, anon=True, auth=True):
-        auth = self.make_handler() if auth else None
-        anon = self.make_handler() if anon else None
-        name = factory.make_name("resource")
-        return {"auth": auth, "anon": anon, "name": name}
-
     def make_profile(self):
         """Fake a profile."""
-        profile_name = factory.make_name('profile')
-        profile = {
-            'name': profile_name,
-            'url': 'http://%s.example.com/' % profile_name,
-            'credentials': factory.make_name("credentials"),
-            'description': {
-                'resources': [
-                    self.make_resource(),
-                    self.make_resource(),
-                    ],
-                },
-            }
-        fake_open = self.patch(ProfileConfig, 'open')
-        fake_open.return_value = FakeConfig({profile_name: profile})
-        return profile
+        self.patch(ProfileConfig, 'open').return_value = make_configs()
+        return ProfileConfig.open.return_value
 
     def test_registers_subparsers(self):
-        profile_name = self.make_profile()["name"]
+        profile_name = self.make_profile().keys()[0]
         parser = ArgumentParser()
         self.assertIsNone(parser._subparsers)
         api.register_api_commands(parser)
@@ -101,10 +63,10 @@
         profile = self.make_profile()
         parser = ArgumentParser()
         api.register_api_commands(parser)
-        for resource in profile["description"]["resources"]:
+        for resource in profile.values()[0]["description"]["resources"]:
             for action in resource["auth"]["actions"]:
                 # Profile names are matched as-is.
-                profile_name = profile["name"]
+                profile_name = profile.keys()[0]
                 # Handler names are processed with handler_command_name before
                 # being added to the argument parser tree.
                 handler_name = handler_command_name(resource["name"])