Merge lp:~ericsnowcurrently/fake-juju/python-lib-helpers into lp:~landscape/fake-juju/trunk-old

[Eric Snow]

Add helper functions to the fakejuju.fakejuju module.

Add helper functions to the fakejuju.fakejuju module.

Testing instructions:

Run the unit tests.

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 42
Branch: lp:~ericsnowcurrently/fake-juju/python-lib-helpers
Jenkins: https://ci.lscape.net/job/latch-test-xenial/15/

review: Approve (test results)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 42
Branch: lp:~ericsnowcurrently/fake-juju/python-lib-helpers
Jenkins: https://ci.lscape.net/job/latch-test-xenial/16/

review: Approve (test results)

[Free Ekanayaka (free.ekanayaka)]

+1 with a couple of comments

review: Approve

[lp:~ericsnowcurrently/fake-juju/python-lib-helpers]

37. By Eric Snow on 2016-10-12

Merge python-lib-init [f=] [r=chad.smith,free.ekanayaka,landscape-builder] [a=Eric Snow]
Init the Python project for a fake-juju library.

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 44
Branch: lp:~ericsnowcurrently/fake-juju/python-lib-helpers
Jenkins: https://ci.lscape.net/job/latch-test-xenial/19/

review: Approve (test results)

[lp:~ericsnowcurrently/fake-juju/python-lib-helpers]

42. By Eric Snow on 2016-10-13

Move get_bootstrap_spec() to __init__.py.

43. By Eric Snow on 2016-10-13

Split the helper tests into separate test classes.

=== modified file 'python/fakejuju/__init__.py'
--- python/fakejuju/__init__.py	2016-10-06 21:43:43 +0000
+++ python/fakejuju/__init__.py	2016-10-13 18:45:47 +0000
@@ -45,4 +45,18 @@
 
 """
 
+
 __version__ = "0.9.0b1"
+
+
+def get_bootstrap_spec(name, admin_secret=None):
+    """Return the BootstrapSpec instance for the given controller.
+
+    @param name: The controller name to set up.
+    @param admin_secret: The admin user password to use.
+    """
+    import txjuju.cli
+
+    driver = "dummy"
+    default_series = None  # Use the default.
+    return txjuju.cli.BootstrapSpec(name, driver, default_series, admin_secret)

=== added file 'python/fakejuju/fakejuju.py'
--- python/fakejuju/fakejuju.py	1970-01-01 00:00:00 +0000
+++ python/fakejuju/fakejuju.py	2016-10-13 18:45:47 +0000
@@ -0,0 +1,32 @@
+# Copyright 2016 Canonical Limited.  All rights reserved.
+
+import os.path
+
+
+def get_filename(version, bindir=None):
+    """Return the full path to the fake-juju binary for the given version.
+
+    @param version: The Juju version to use.
+    @param bindir: The directory containing the fake-juju binary.
+        This defaults to /usr/bin.
+    """
+    if not version:
+        raise ValueError("version not provided")
+    filename = "fake-juju-{}".format(version)
+    if bindir is None:
+        # XXX Search $PATH.
+        bindir = "/usr/bin"
+    return os.path.join(bindir, filename)
+
+
+def set_envvars(envvars, failures_filename=None, logsdir=None):
+    """Return the environment variables with which to run fake-juju.
+
+    @param envvars: The env dict to update.
+    @param failures_filename: The path to the failures file that
+        fake-juju will use.
+    @params logsdir: The path to the directory where fake-juju will
+        write its log files.
+    """
+    envvars["FAKE_JUJU_FAILURES"] = failures_filename or ""
+    envvars["FAKE_JUJU_LOGS_DIR"] = logsdir or ""

=== added directory 'python/fakejuju/tests'
=== added file 'python/fakejuju/tests/__init__.py'
=== added file 'python/fakejuju/tests/test___init__.py'
--- python/fakejuju/tests/test___init__.py	1970-01-01 00:00:00 +0000
+++ python/fakejuju/tests/test___init__.py	2016-10-13 18:45:47 +0000
@@ -0,0 +1,24 @@
+# Copyright 2016 Canonical Limited.  All rights reserved.
+
+import unittest
+
+import txjuju.cli
+
+from fakejuju import get_bootstrap_spec
+
+
+class GetBootstrapTests(unittest.TestCase):
+
+    def test_get_bootstrap_spec_full(self):
+        """get_bootstrap_spec() works correctly when given all args."""
+        spec = get_bootstrap_spec("my-env", "pw")
+
+        self.assertEqual(
+            spec,
+            txjuju.cli.BootstrapSpec("my-env", "dummy", admin_secret="pw"))
+
+    def test_get_bootstrap_spec_minimal(self):
+        """get_bootstrap_spec() works correctly when given minimal args."""
+        spec = get_bootstrap_spec("my-env")
+
+        self.assertEqual(spec, txjuju.cli.BootstrapSpec("my-env", "dummy"))

=== added file 'python/fakejuju/tests/test_fakejuju.py'
--- python/fakejuju/tests/test_fakejuju.py	1970-01-01 00:00:00 +0000
+++ python/fakejuju/tests/test_fakejuju.py	2016-10-13 18:45:47 +0000
@@ -0,0 +1,117 @@
+# Copyright 2016 Canonical Limited.  All rights reserved.
+
+import unittest
+
+from fakejuju.fakejuju import get_filename, set_envvars
+
+
+class GetFilenameTests(unittest.TestCase):
+
+    def test_all_args(self):
+        """get_filename() works correctly when given all args."""
+        filename = get_filename("1.25.6", "/spam")
+
+        self.assertEqual(filename, "/spam/fake-juju-1.25.6")
+
+    def test_minimal_args(self):
+        """get_filename() works correctly when given minimal args."""
+        filename = get_filename("1.25.6")
+
+        self.assertEqual(filename, "/usr/bin/fake-juju-1.25.6")
+
+    def test_empty_bindir(self):
+        """get_filename() works correctly when given an empty string
+        for bindir."""
+        filename = get_filename("1.25.6", "")
+
+        self.assertEqual(filename, "fake-juju-1.25.6")
+
+    def test_missing_version(self):
+        """get_filename() fails if version is None or empty."""
+        with self.assertRaises(ValueError):
+            get_filename(None)
+        with self.assertRaises(ValueError):
+            get_filename("")
+
+
+class SetEnvvarsTests(unittest.TestCase):
+
+    def test_all_args(self):
+        """set_envvars() works correctly when given all args."""
+        envvars = {}
+        set_envvars(envvars, "/spam/failures", "/eggs/logsdir")
+
+        self.assertEqual(envvars, {
+            "FAKE_JUJU_FAILURES": "/spam/failures",
+            "FAKE_JUJU_LOGS_DIR": "/eggs/logsdir",
+            })
+
+    def test_minimal_args(self):
+        """set_envvars() works correctly when given minimal args."""
+        envvars = {}
+        set_envvars(envvars)
+
+        self.assertEqual(envvars, {
+            "FAKE_JUJU_FAILURES": "",
+            "FAKE_JUJU_LOGS_DIR": "",
+            })
+
+    def test_start_empty(self):
+        """set_envvars() sets all values on an empty dict."""
+        envvars = {}
+        set_envvars(envvars, "x", "y")
+
+        self.assertEqual(envvars, {
+            "FAKE_JUJU_FAILURES": "x",
+            "FAKE_JUJU_LOGS_DIR": "y",
+            })
+
+    def test_no_collisions(self):
+        """set_envvars() sets all values when none are set yet."""
+        envvars = {"SPAM": "eggs"}
+        set_envvars(envvars, "x", "y")
+
+        self.assertEqual(envvars, {
+            "SPAM": "eggs",
+            "FAKE_JUJU_FAILURES": "x",
+            "FAKE_JUJU_LOGS_DIR": "y",
+            })
+
+    def test_empty_to_nonempty(self):
+        """set_envvars() updates empty values."""
+        envvars = {
+            "FAKE_JUJU_FAILURES": "",
+            "FAKE_JUJU_LOGS_DIR": "",
+            }
+        set_envvars(envvars, "x", "y")
+
+        self.assertEqual(envvars, {
+            "FAKE_JUJU_FAILURES": "x",
+            "FAKE_JUJU_LOGS_DIR": "y",
+            })
+
+    def test_nonempty_to_nonempty(self):
+        """set_envvars() overwrites existing values."""
+        envvars = {
+            "FAKE_JUJU_FAILURES": "spam",
+            "FAKE_JUJU_LOGS_DIR": "ham",
+            }
+        set_envvars(envvars, "x", "y")
+
+        self.assertEqual(envvars, {
+            "FAKE_JUJU_FAILURES": "x",
+            "FAKE_JUJU_LOGS_DIR": "y",
+            })
+
+    def test_nonempty_to_empty(self):
+        """set_envvars() with no args "unsets" existing values."""
+        envvars = {
+            "FAKE_JUJU_FAILURES": "x",
+            "FAKE_JUJU_LOGS_DIR": "y",
+            }
+        set_envvars(envvars)
+
+        self.assertEqual(envvars, {
+            "FAKE_JUJU_FAILURES": "",
+            "FAKE_JUJU_LOGS_DIR": "",
+            })