Merge lp:~frankban/charms/precise/juju-gui/separate-staging-debug into lp:~juju-gui/charms/precise/juju-gui/trunk

[Francesco Banconi]

Create a new option for GUI debug mode.

Setting the juju-gui-debug option to true is
now possible to serve the GUI source files
individually (uncompressed). As a consequence,
setting staging to true no longer activates
debug mode as a side effect.

QA:
- deploy the GUI from this branch (make deploy);
- run `juju set juju-gui juju-gui-debug=true`,
  wait a minute and then verify the uncompressed
  files are served by Apache;
- run `juju set juju-gui builtin-server=true`,
  wait a minute and then verify the uncompressed
  files are correctly served by the Tornado server
  (tailf /var/log/upstart/guiserver.log can help).

https://codereview.appspot.com/13301047/

[Francesco Banconi (frankban)]

Reviewers: mp+185307_code.launchpad.net,

Message:
Please take a look.

Description:
Create a new option for GUI debug mode.

Setting the juju-gui-debug option to true is
now possible to serve the GUI source files
individually (uncompressed). As a consequence,
setting staging to true no longer activates
debug mode as a side effect.

QA:
- deploy the GUI from this branch (make deploy);
- run `juju set juju-gui juju-gui-debug=true`,
   wait a minute and then verify the uncompressed
   files are served by Apache;
- run `juju set juju-gui builtin-server=true`,
   wait a minute and then verify the uncompressed
   files are correctly served by the Tornado server
   (tailf /var/log/upstart/guiserver.log can help).

https://code.launchpad.net/~frankban/charms/precise/juju-gui/separate-staging-debug/+merge/185307

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/13301047/

Affected files (+20, -13 lines):
   A [revision details]
   M config.yaml
   M hooks/backend.py
   M hooks/utils.py
   M revision
   M tests/test_utils.py

Index: [revision details]
=== added file '[revision details]'
--- [revision details] 2012-01-01 00:00:00 +0000
+++ [revision details] 2012-01-01 00:00:00 +0000
@@ -0,0 +1,2 @@
+Old revision:
<email address hidden>
+New revision:
<email address hidden>

Index: config.yaml
=== modified file 'config.yaml'
--- config.yaml 2013-08-26 12:18:19 +0000
+++ config.yaml 2013-09-12 14:29:45 +0000
@@ -32,6 +32,11 @@
          to pull a release from.
      type: string
      default: stable
+ juju-gui-debug:
+ description: |
+ Run Juju GUI in debug mode, serving the uncompressed GUI source
files.
+ type: boolean
+ default: false
    juju-api-branch:
      description: |
        The Juju API Bazaar branch (implementing the WebSocket server).
Since
@@ -42,9 +47,9 @@
    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.
+ environment). Currently juju-core does not support the staging
backend.
+ For this reason, an error is raised if this option is enabled in a
+ juju-core environment.
      type: boolean
      default: false
    staging-environment:

Index: revision
=== modified file 'revision'
--- revision 2013-09-04 09:05:19 +0000
+++ revision 2013-09-12 14:29:45 +0000
@@ -1,1 +1,1 @@
-82
+83

Index: hooks/backend.py
=== modified file 'hooks/backend.py'
--- hooks/backend.py 2013-09-03 08:24:30 +0000
+++ hooks/backend.py 2013-09-12 14:29:45 +0000
@@ -141,7 +141,7 @@
          charmhelpers.log('Starting Juju GUI.')
          config = backend.config
          build_dir = utils.compute_build_dir(
- config['staging'], config['serve-tests'])
+ config['juju-gui-debug'], config['serve-tests'])
          utils.write_gui_config(
              config['juju-gui-console-enabled'], config['login-help'],
              config['read-on...

[Richard Harding (rharding)]

LGTM qa ok. Thanks so much for this!

https://codereview.appspot.com/13301047/

[Francesco Banconi (frankban)]

*** Submitted:

Create a new option for GUI debug mode.

Setting the juju-gui-debug option to true is
now possible to serve the GUI source files
individually (uncompressed). As a consequence,
setting staging to true no longer activates
debug mode as a side effect.

QA:
- deploy the GUI from this branch (make deploy);
- run `juju set juju-gui juju-gui-debug=true`,
   wait a minute and then verify the uncompressed
   files are served by Apache;
- run `juju set juju-gui builtin-server=true`,
   wait a minute and then verify the uncompressed
   files are correctly served by the Tornado server
   (tailf /var/log/upstart/guiserver.log can help).

R=rharding
CC=
https://codereview.appspot.com/13301047

https://codereview.appspot.com/13301047/

[Francesco Banconi (frankban)]

Hi Rick, thanks for the review!

https://codereview.appspot.com/13301047/

=== modified file 'config.yaml'
--- config.yaml	2013-08-26 12:18:19 +0000
+++ config.yaml	2013-09-12 15:51:47 +0000
@@ -32,6 +32,11 @@
         to pull a release from.
     type: string
     default: stable
+  juju-gui-debug:
+    description: |
+      Run Juju GUI in debug mode, serving the uncompressed GUI source files.
+    type: boolean
+    default: false
   juju-api-branch:
     description: |
       The Juju API Bazaar branch (implementing the WebSocket server).  Since
@@ -42,9 +47,9 @@
   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.
+      environment).  Currently juju-core does not support the staging backend.
+      For this reason, an error is raised if this option is enabled in a
+      juju-core environment.
     type: boolean
     default: false
   staging-environment:

=== modified file 'hooks/backend.py'
--- hooks/backend.py	2013-09-03 08:24:30 +0000
+++ hooks/backend.py	2013-09-12 15:51:47 +0000
@@ -141,7 +141,7 @@
         charmhelpers.log('Starting Juju GUI.')
         config = backend.config
         build_dir = utils.compute_build_dir(
-            config['staging'], config['serve-tests'])
+            config['juju-gui-debug'], config['serve-tests'])
         utils.write_gui_config(
             config['juju-gui-console-enabled'], config['login-help'],
             config['read-only'], config['staging'], config['charmworld-url'],
@@ -181,7 +181,7 @@
     def start(self, backend):
         config = backend.config
         build_dir = utils.compute_build_dir(
-            config['staging'], config['serve-tests'])
+            config['juju-gui-debug'], config['serve-tests'])
         utils.start_haproxy_apache(
             build_dir, config['serve-tests'], config['ssl-cert-path'],
             config['secure'])
@@ -204,7 +204,7 @@
     def start(self, backend):
         config = backend.config
         build_dir = utils.compute_build_dir(
-            config['staging'], config['serve-tests'])
+            config['juju-gui-debug'], config['serve-tests'])
         utils.start_builtin_server(
             build_dir, config['ssl-cert-path'], config['serve-tests'],
             config['sandbox'], config['builtin-server-logging'],

=== modified file 'hooks/utils.py'
--- hooks/utils.py	2013-09-03 14:14:02 +0000
+++ hooks/utils.py	2013-09-12 15:51:47 +0000
@@ -387,7 +387,7 @@
     cmd_log(run('rm', '-f', AGENT_INIT_PATH))
 
 
-def compute_build_dir(in_staging, serve_tests):
+def compute_build_dir(juju_gui_debug, serve_tests):
     """Compute the build directory."""
     with su('root'):
         run('chown', '-R', 'ubuntu:', JUJU_GUI_DIR)
@@ -395,7 +395,7 @@
         # External insecure resources are still loaded when testing in the
         # debug environment. For now, switch to the production environment if
         # the charm is configured to serve tests.
-    if in_staging and not serve_tests:
+    if juju_gui_debug and not serve_tests:
         build_dirname = 'build-debug'
     else:
         build_dirname = 'build-prod'

=== modified file 'revision'
--- revision	2013-09-04 09:05:19 +0000
+++ revision	2013-09-12 15:51:47 +0000
@@ -1,1 +1,1 @@
-82
+83

=== modified file 'tests/test_utils.py'
--- tests/test_utils.py	2013-09-03 14:14:02 +0000
+++ tests/test_utils.py	2013-09-12 15:51:47 +0000
@@ -669,16 +669,16 @@
         self.assertEqual(self.actions, [charmhelpers.STOP])
 
     def test_compute_build_dir(self):
-        for (in_staging, serve_tests, result) in (
+        for (juju_gui_debug, serve_tests, result) in (
             (False, False, 'build-prod'),
             (True, False, 'build-debug'),
             (False, True, 'build-prod'),
             (True, True, 'build-prod'),
         ):
-            build_dir = compute_build_dir(in_staging, serve_tests)
+            build_dir = compute_build_dir(juju_gui_debug, serve_tests)
             self.assertIn(
-                result, build_dir, 'in_staging: {}, serve_tests: {}'.format(
-                    in_staging, serve_tests))
+                result, build_dir, 'debug: {}, serve_tests: {}'.format(
+                    juju_gui_debug, serve_tests))
 
     def test_setup_haproxy_config(self):
         setup_haproxy_config(self.ssl_cert_path)