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

[Eric Snow]

Init the Python project for a fake-juju library.

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: 38
Branch: lp:~ericsnowcurrently/fake-juju/python-lib-init
Jenkins: https://ci.lscape.net/job/latch-test-xenial/14/

review: Approve (test results)

[Free Ekanayaka (free.ekanayaka)]

Nice job, thanks for the diligence. +1

review: Approve

[Chad Smith (chad.smith)]

I'll probably need a bit of guidance on intent here.

# seems to pull in fakejuju/__init__.py fine into the build directory.
cd python; python setup.py build

although python setup.py test chokes trying to find a distribution of txjuju, how will we be pulling txjuju dependencies?

[Chad Smith (chad.smith)]

review: Needs Information

[Eric Snow (ericsnowcurrently)]

> I'll probably need a bit of guidance on intent here.

The intent is to pull the fake-juju bits out of txjuju.testing and into a more useful fakejuju library here.

> # seems to pull in fakejuju/__init__.py fine into the build directory.
> cd python; python setup.py build
>
>
> although python setup.py test chokes trying to find a distribution of txjuju,
> how will we be pulling txjuju dependencies?

"python setup.py test"? Does that come for free? There aren't any tests in this patch. You are correct that setup.py won't work as-is. I'm okay with that. :) As long as the deb package works we're fine. The setup.py is mostly informational and useful for building the initial deb packaging code.

[Chad Smith (chad.smith)]

Thanks for the IRC discussion on this. I wrapped myself around the axle actually trying to build a deb package from this new setup.py as I thought it implied you wanted to use this in the future to generate deb packages.

review: Approve

=== added directory 'python'
=== added file 'python/LICENSE'
--- python/LICENSE	1970-01-01 00:00:00 +0000
+++ python/LICENSE	2016-10-06 21:47:41 +0000
@@ -0,0 +1,191 @@
+All files in this repository are licensed as follows. If you contribute
+to this repository, it is assumed that you license your contribution
+under the same license unless you state otherwise.
+
+All files Copyright (C) 2012-2016 Canonical Ltd. unless otherwise specified in the file.
+
+This software is licensed under the LGPLv3, included below.
+
+As a special exception to the GNU Lesser General Public License version 3
+("LGPL3"), the copyright holders of this Library give you permission to
+convey to a third party a Combined Work that links statically or dynamically
+to this Library without providing any Minimal Corresponding Source or
+Minimal Application Code as set out in 4d or providing the installation
+information set out in section 4e, provided that you comply with the other
+provisions of LGPL3 and provided that you meet, for the Application the
+terms and conditions of the license(s) which apply to the Application.
+
+Except as stated in this special exception, the provisions of LGPL3 will
+continue to comply in full to this Library. If you modify this Library, you
+may apply this exception to your version of this Library, but you are not
+obliged to do so. If you do not wish to do so, delete this exception
+statement from your version. This exception does not (and cannot) modify any
+license terms which apply to the Application, with which you must still
+comply.
+
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
 
=== added file 'python/Makefile'
--- python/Makefile	1970-01-01 00:00:00 +0000
+++ python/Makefile	2016-10-06 21:47:41 +0000
@@ -0,0 +1,9 @@
+PYTHON = python
+
+.PHONY: test
+test:
+	$(PYTHON) -m unittest discover -t $(shell pwd) -s $(shell pwd)/fakejuju
+
+.PHONY: install-dev
+install-dev:
+	ln -s $(shell pwd)/fakejuju /usr/local/lib/python2.7/dist-packages/fakejuju
 
=== added file 'python/README.md'
--- python/README.md	1970-01-01 00:00:00 +0000
+++ python/README.md	2016-10-06 21:47:41 +0000
@@ -0,0 +1,1 @@
+# fakejuju
 
=== added directory 'python/fakejuju'
=== added file 'python/fakejuju/__init__.py'
--- python/fakejuju/__init__.py	1970-01-01 00:00:00 +0000
+++ python/fakejuju/__init__.py	2016-10-06 21:47:41 +0000
@@ -0,0 +1,48 @@
+# Copyright 2016 Canonical Limited.  All rights reserved.
+
+"""Support for interaction with fake-juju.
+
+"fake-juju" is a combination of the juju and jujud commands that is
+suitable for use in integration tests.  It exposes a limited subset
+of the standard juju subcommands (see FakeJuju in this module for
+specifics).  When called without any arguments it runs jujud (using
+the dummy provider) with extra logging and testing hooks available to
+control failures.  See https://launchpad.net/fake-juju for the project.
+
+The binary is named with the Juju version for which it was built.
+For example, for version 1.25.6 the file is named "fake-juju-1.25.6".
+
+fake-juju uses the normal Juju local config directory.  This defaults
+to ~/.local/shared/juju and may be set using the JUJU_DATA environment
+variable (in 2.x, for 1.x it is JUJU_HOME).
+
+In addition to all the normal Juju environment variables (e.g.
+JUJU_DATA), fake-juju uses the following:
+
+  FAKE_JUJU_FAILURES - the path to the failures file
+      The Failures class below sets this to $JUJU_DATA/juju-failures.
+  FAKE_JUJU_LOGS_DIR - the path to the logs directory
+      This defaults to $JUJU_DATA.
+
+fake-juju also creates several extra files:
+
+  $FAKE_JUJU_LOGS_DIR/fake-juju.log - where fake-juju logs are written
+  $JUJU_DATA/fakejuju - fake-juju's data cache
+  $JUJU_DATA/fifo - a FIFO file that triggers jujud shutdown
+  $JUJU_DATA/cert.ca - the API's CA certificate
+
+Normal Juju logging for is written to $JUJU_DATA/fake-juju.log.
+
+Failures may be injected into a running fake-juju (or set before
+running).  They may be injected by adding them to the file identified
+by $FAKE_JUJU_FAILURES.  The format is a single failure definition per
+line.  The syntax of the failure definition depends on the failure.
+The currently supported failures (with their definition syntax) are
+listed here:
+
+  * when adding a unit with a specific ID
+    format: "unit-<ID>"  (e.g. unit-mysql/0)
+
+"""
+
+__version__ = "0.9.0b1"
 
=== added file 'python/setup.py'
--- python/setup.py	1970-01-01 00:00:00 +0000
+++ python/setup.py	2016-10-06 21:47:41 +0000
@@ -0,0 +1,69 @@
+import os
+from importlib import import_module
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+
+basedir = os.path.abspath(os.path.dirname(__file__) or '.')
+
+# required data
+
+package_name = 'fakejuju'
+NAME = package_name
+SUMMARY = 'A limited adaptation of Juju\'s client, with testing hooks.'
+AUTHOR = 'Canonical Landscape team'
+EMAIL = '[e-mail]'
+PROJECT_URL = 'https://launchpad.net/fake-juju'
+LICENSE = 'LGPLv3'
+
+with open(os.path.join(basedir, 'README.md')) as readme_file:
+    DESCRIPTION = readme_file.read()
+
+# dymanically generated data
+
+VERSION = import_module(package_name).__version__
+
+# set up packages
+
+exclude_dirs = [
+        'tests',
+        ]
+
+PACKAGES = []
+for path, dirs, files in os.walk(package_name):
+    if "__init__.py" not in files:
+        continue
+    path = path.split(os.sep)
+    if path[-1] in exclude_dirs:
+        continue
+    PACKAGES.append(".".join(path))
+
+# dependencies
+
+DEPS = ['yaml',
+        # for testing
+        'txjuju',
+        'fixtures',
+        'testtools',
+        ]
+
+
+if __name__ == "__main__":
+    setup(name=NAME,
+          version=VERSION,
+          author=AUTHOR,
+          author_email=EMAIL,
+          url=PROJECT_URL,
+          license=LICENSE,
+          description=SUMMARY,
+          long_description=DESCRIPTION,
+          packages=PACKAGES,
+
+          # for distutils
+          requires=DEPS,
+
+          # for setuptools
+          install_requires=DEPS,
+          )