Merge lp:~bac/charms/precise/juju-gui/unified-ppa into lp:charms/juju-gui

[Brad Crittenden]

Rather than have dependencies on various PPAs which are not under our control, causing the behavior of our charm to change without our input, we've created a single PPA that contains all of the packages the charm needs that are not part of the standard Ubuntu repositories for the series. Actually, there are two PPAs, 'stable' and 'devel'. The charm will use 'stable' but developers can switch to using the devel PPA by:

juju set juju-gui setting repository-location=ppa:juju-gui-charmers/devel

immediately after the deploy.

[Benji York (benji)]

Looks good.

The Dependencies.md file is an especially nice touch.

review: Approve (code)

[Brad Crittenden (bac)]

I meant to add the following:

After starting a charm and setting the repository-location config, I see the following:

ubuntu@ip-10-4-106-129:~$ ls /etc/apt/sources.list.d
juju-gui-charmers-devel-precise.list

Proof that we're getting the single PPA we want and all is well.

Also I took these notes about versions, etc:

# List of dependencies #

Source Package Use version / repo
---------------------------- ---------------- --- ----------
ppa:chris-lea/node.js-legacy nodejs base 0.8.23-1chl1~precise1
    npm base 1.2.18-1chl1~precise1

ppa:juju-gui/ppa haproxy gui 1.5-dev17-1

ppa:juju/pkgs python-charmhelpers[1] base 0.3+bzr178-3~precise1 (deprecated)
    python-shelltoolbox[2] base 0.2.1+bzr17-1~precise1~ppa1

ubuntu repositories python-yaml go 3.10-2 / main
    python-apt base 0.8.3ubuntu7.1 / main
    python-launchpadlib base 1.9.12-1 / main
    python-tempita base 0.5.1-1build1 / main
    zookeeper improv 3.3.5+dfsg1-1ubuntu1 / universe

[1] The juju/pkgs PPA is using a recipe that no longer builds
    python-charmhelpers. A new recipe is in place to build it directly into
    juju-gui-charmers/devel.
[2] The version of python-shelltoolbox in universe is 0.2.1+bzr17-1 for quantal and later.

[lp:~bac/charms/precise/juju-gui/unified-ppa]

67. By Brad Crittenden on 2013-06-03

Fixed old references.

[Nicola Larosa (teknico)]

Good stuff, thank you.

review: Approve

=== added file 'Dependencies.md'
--- Dependencies.md	1970-01-01 00:00:00 +0000
+++ Dependencies.md	2013-06-03 14:29:23 +0000
@@ -0,0 +1,46 @@
+# Juju GUI Charm external dependencies #
+
+The Juju GUI has a number of external dependencies including packages that are
+in the Ubuntu repositories and other packages that are collected together into
+a single PPA that the Juju GUI charm developers maintain.
+
+The packages in our devel PPA provide a superset of all software the charm may
+need for different deployment strategies, such as using the sandbox
+vs. improv, or Python Juju vs. Go Juju.
+
+# Stable and Devel #
+
+The GUI developers are members of the group ~juju-gui on Launchpad
+(http://launchpad.net/~juju-gui). We have two PPAs hosted there to support the
+GUI, `stable` and `devel`.
+
+To isolate charm deployments from upstream code changes, we have collected all
+of the external software we depend upon and stored them in the PPAs we manage.
+
+The `stable` PPA includes only versions of our dependencies that we have
+tested and found to work with the charm.  The `devel` version includes new
+versions of external software that are in the process of being tested.
+
+# Selecting the PPA #
+
+In the charm configuration file (config.yaml) there is an entry
+`repository-location` that defaults to `juju-gui/charm_stable`.  You can
+change that in your config.yaml file or do a
+
+`juju set juju-gui repository-location=ppa:juju-gui/charm_devel`,
+
+for instance, immediately after deploying the GUI charm to pull from the devel
+version.  Only Juju GUI developers doing QA for the new PPA should ever need
+to select the devel version.
+
+# Deploying for the enterprise #
+
+Organizations deploying the charm for their enterprise may have the
+requirement to not allow the installation of software from outside of their
+local network.  Typically those environments require all external software to
+be downloaded to a local server and used from there.  Our devel PPA provides a
+single starting place to obtain QA'd software.  Dev ops can grab the subset of
+packages they need, audit, test, and then serve them locally.  The
+`repository-location` config variable can be used to point to the local repo.
+
+

=== modified file 'config.yaml'
--- config.yaml	2013-05-11 00:18:47 +0000
+++ config.yaml	2013-06-03 14:29:23 +0000
@@ -18,26 +18,26 @@
     default: stable
   juju-api-branch:
     description: |
-      The Juju API Bazaar branch (implementing the WebSocket server).
-      Since juju-core includes the WebSocket API server out of the box, this
-      option is ignored if the charm is deployed using juju-core.
+      The Juju API Bazaar branch (implementing the WebSocket server).  Since
+      juju-core includes the WebSocket API server out of the box, this option
+      is ignored if the charm is deployed using juju-core.
     type: string
     default: lp:~hazmat/juju/rapi-rollup
   staging:
     description: |
-      Connect the Juju GUI to the staging backend
-      (i.e. a simulated Juju environment).
-      Currently juju-core does not support the staging backend. For this
-      reason, this option is ignored if the charm is deployed using juju-core.
+      Connect the Juju GUI to the staging backend (i.e. a simulated Juju
+      environment).  Currently juju-core does not support the staging
+      backend. For this reason, this option is ignored if the charm is
+      deployed using juju-core.
     type: boolean
     default: false
   staging-environment:
     description: |
       The environment JSON export used by the staging server. This option can
       be used to change the topology of the simulated Juju environment.
-      Possible values are 'sample' and 'large'.
-      Currently juju-core does not support the staging backend. For this
-      reason, this option is ignored if the charm is deployed using juju-core.
+      Possible values are 'sample' and 'large'.  Currently juju-core does not
+      support the staging backend. For this reason, this option is ignored if
+      the charm is deployed using juju-core.
     type: string
     default: sample
   juju-gui-console-enabled:
@@ -47,8 +47,8 @@
     default: false
   command-log-file:
     description: |
-      The log file where stdout and stderr should be sent for all
-      commands that are run by charm hooks.
+      The log file where stdout and stderr should be sent for all commands
+      that are run by charm hooks.
     type: string
     default: /var/log/juju/juju-gui.log
   ssl-cert-path:
@@ -79,43 +79,48 @@
     description: |
       Whether or not the GUI is in read-only mode. Note that read-only mode is
       advisory, and enforced only in the client. If someone can access the
-      websocket and has the password, they can send commands over the websocket
-      to mutate the environment.
+      websocket and has the password, they can send commands over the
+      websocket to mutate the environment.
     type: boolean
     default: false
   serve-tests:
     description: |
-      Whether or not the GUI unit tests are exposed. If this option is enabled,
-      unit tests can be run in the browser by visiting the URL
+      Whether or not the GUI unit tests are exposed. If this option is
+      enabled, unit tests can be run in the browser by visiting the URL
       "https://[Juju GUI address]/test/".
     type: boolean
     default: false
   secure:
     description: |
-      In order to run the GUI over a non secure connection (HTTP) set this flag
-      to false. Do not set this property unless you understand and accept the
-      risks.
+      In order to run the GUI over a non secure connection (HTTP) set this
+      flag to false. Do not set this property unless you understand and accept
+      the risks.
     type: boolean
     default: true
   sandbox:
     description: |
-      Run using an in-memory sandbox rather than a real (or even improv) Juju backend.
-      Sandbox is a client side construct running entirely in the client. Sandbox doesn't
-      currently support imported environment simulation and is exclusive to the staging: true
-      configuration. If staging is true it will be used in preference to sandbox at this time.
+      Run using an in-memory sandbox rather than a real (or even improv) Juju
+      backend.  Sandbox is a client side construct running entirely in the
+      client. Sandbox does not currently support imported environment
+      simulation and is exclusive to the staging: true configuration. If
+      staging is true it will be used in preference to sandbox at this time.
     type: boolean
     default: false
-  allow-additional-deb-repositories:
-    description: |
-      Allow access to remote PPAs. If this is False then you must have somehow
-      configured the configured package sources to include the packages that
-      the GUI needs.  This will be made more explicit soon.  For now, look in
-      the source: hooks/install and hooks/backend.py in particular.
-    type: boolean
-    default: true
   charmworld-url:
     description: |
-      The URL of the charm catalog site ("charmworld") from which charm catalog
-      data will be drawn.
+      The URL of the charm catalog site ("charmworld") from which charm
+      catalog data will be drawn.
     type: string
     default: https://manage.jujucharms.com
+  repository-location:
+    description: |
+      The charm depends on several software packages that are not packaged in
+      Ubuntu.  In order to ensure that only versions known to work with our
+      charm are used, there is a single PPA where all packages are kept.  The
+      juju-gui-charmers team supports 'stable' and 'devel' versions.  Only
+      stable should be used for production.  For enterprise deployments that
+      do not allow access to resources outside of their control, the location
+      can be any specification as long as it is recognizable by
+      'add-apt-repository'.
+    type: string
+    default: ppa:juju-gui-charmers/stable

=== modified file 'hooks/backend.py'
--- hooks/backend.py	2013-05-03 09:13:45 +0000
+++ hooks/backend.py	2013-06-03 14:29:23 +0000
@@ -31,8 +31,6 @@
         missing = utils.find_missing_packages(*backend.debs)
         if missing:
             utils.cmd_log(
-                backend.install_extra_repositories(*backend.repositories))
-            utils.cmd_log(
                 shelltoolbox.apt_get_install(*backend.debs))
 
         # If we are not using a pre-built release of the GUI (i.e., we are
@@ -87,7 +85,6 @@
 
 
 class GuiMixin(object):
-    repositories = ('ppa:juju-gui/ppa',)
 
     def start(self, backend):
         config = backend.config
@@ -191,12 +188,6 @@
                 mixins[i] = b()
         self.mixins = mixins
 
-    def install_extra_repositories(self, *packages):
-        if self.config.get('allow-additional-deb-repositories', True):
-            utils.install_extra_repositories(*packages)
-        else:
-            apt_get('update')
-
     def different(self, *keys):
         """Return a boolean indicating if the current config
         value differs from the config value passed in prev_config

=== modified file 'hooks/install'
--- hooks/install	2013-04-28 09:57:41 +0000
+++ hooks/install	2013-06-03 14:29:23 +0000
@@ -18,9 +18,9 @@
     return json.loads(output)
 
 config = get_config()
-allow_repos = config.get('allow-additional-deb-repositories', True)
-if allow_repos:
-    bootstrap_utils.install_extra_repositories('ppa:juju/pkgs')
+repo = config.get('repository-location')
+if repo:
+    bootstrap_utils.install_extra_repositories(repo)
 
 # Python dependencies must be installed here so that the charm can import and
 # use required libraries.

=== modified file 'hooks/utils.py'
--- hooks/utils.py	2013-05-17 09:07:28 +0000
+++ hooks/utils.py	2013-06-03 14:29:23 +0000
@@ -59,7 +59,6 @@
     apt_get_install,
     command,
     environ,
-    install_extra_repositories,
     run,
     script_name,
     search_file,
@@ -88,7 +87,6 @@
 JUJU_GUI_SITE = '/etc/apache2/sites-available/juju-gui'
 JUJU_GUI_PORTS = '/etc/apache2/ports.conf'
 JUJU_PEM = 'juju.includes-private-key.pem'
-BUILD_REPOSITORIES = ('ppa:chris-lea/node.js-legacy',)
 DEB_BUILD_DEPENDENCIES = (
     'bzr', 'imagemagick', 'make',  'nodejs', 'npm',
 )
@@ -111,7 +109,6 @@
 def _get_build_dependencies():
     """Install deb dependencies for building."""
     log('Installing build dependencies.')
-    cmd_log(install_extra_repositories(*BUILD_REPOSITORIES))
     cmd_log(apt_get_install(*DEB_BUILD_DEPENDENCIES))
 
 

=== modified file 'revision'
--- revision	2013-05-23 13:34:03 +0000
+++ revision	2013-06-03 14:29:23 +0000
@@ -1,1 +1,1 @@
-47
+54