Merge lp:~hatch/charms/trusty/juju-gui/custom-port into lp:~juju-gui/charms/trusty/juju-gui/trunk

[Richard Harding]

WIP

[Francesco Banconi (frankban)]

Good start, thank you!
Just added some inline comments.
I'll look again when the branch is complete.

[lp:~hatch/charms/trusty/juju-gui/custom-port]

216. By Jeff Pihach on 2014-11-13

Lint fixes and cleanups from wip review

=== modified file 'config.yaml'
--- config.yaml	2014-11-04 01:31:53 +0000
+++ config.yaml	2014-11-13 19:23:32 +0000
@@ -49,6 +49,11 @@
       Whether or not the console should be enabled for the browser.
     type: boolean
     default: false
+  port:
+    description: |
+      Supply a different port to host the GUI on besides the default 80 and 443.
+    type: int
+    default:
   command-log-file:
     description: |
       The log file where stdout and stderr should be sent for all commands

=== modified file 'config/guiserver.conf.template'
--- config/guiserver.conf.template	2014-08-29 15:17:01 +0000
+++ config/guiserver.conf.template	2014-11-13 19:23:32 +0000
@@ -21,6 +21,9 @@
     --guiroot="{{gui_root}}" \
     --sslpath="{{ssl_cert_path}}" \
     --charmworldurl="{{charmworld_url}}" \
+    {{if port}}
+        --port="{{port}}" \
+    {{endif}}
     {{if sandbox}}
         --sandbox \
     {{else}}

=== modified file 'hooks/backend.py'
--- hooks/backend.py	2014-02-04 20:07:31 +0000
+++ hooks/backend.py	2014-11-13 19:23:32 +0000
@@ -44,7 +44,6 @@
 
 from charmhelpers import (
     log,
-    open_port,
 )
 
 import utils
@@ -133,9 +132,7 @@
             cached_fonts=config['cached-fonts'], ga_key=config['ga-key'],
             show_get_juju_button=config['show-get-juju-button'],
             password=config.get('password'))
-        # Expose the service.
-        open_port(80)
-        open_port(443)
+        utils.modify_open_ports(backend.config, backend.prev_config)
 
 
 class ServerInstallMixinBase(object):
@@ -193,12 +190,13 @@
 
     def start(self, backend):
         config = backend.config
+        port = config.get('port')
         build_dir = utils.compute_build_dir(
             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'],
-            not config['secure'], config['charmworld-url'])
+            not config['secure'], config['charmworld-url'], port=port)
 
     def stop(self, backend):
         utils.stop_builtin_server()

=== modified file 'hooks/utils.py'
--- hooks/utils.py	2014-09-29 14:52:52 +0000
+++ hooks/utils.py	2014-11-13 19:23:32 +0000
@@ -37,6 +37,7 @@
     'get_release_file_path',
     'install_missing_packages',
     'log_hook',
+    'modify_open_ports',
     'parse_source',
     'prime_npm_cache',
     'remove_apache_setup',
@@ -71,8 +72,10 @@
 import tempita
 
 from charmhelpers import (
+    close_port,
     get_config,
     log,
+    open_port,
     RESTART,
     service_control,
     STOP,
@@ -413,6 +416,26 @@
     render_to_file('config.js.template', context, config_js_path)
 
 
+def modify_open_ports(config, prev_config):
+    """Open or close ports based on the supplied port config value."""
+    # If a custom port was previously defined we want to make sure we close it.
+    if 'port' in prev_config:
+        log('Closing previously opened user defined port.')
+        close_port(prev_config['port'])
+    if 'port' in config:
+        log('Using user provided port instead of defaults.')
+        # Make sure that the default ports are closed when setting the custom
+        # port.
+        close_port(80)
+        close_port(443)
+        # Open the custom defined port.
+        open_port(config['port'])
+    else:
+        log('Using default ports')
+        open_port(80)
+        open_port(443)
+
+
 def setup_haproxy_config(ssl_cert_path, secure=True):
     """Generate the haproxy configuration file."""
     log('Setting up haproxy Upstart file.')
@@ -513,7 +536,8 @@
 
 def write_builtin_server_startup(
         gui_root, ssl_cert_path, serve_tests=False, sandbox=False,
-        builtin_server_logging='info', insecure=False, charmworld_url=''):
+        builtin_server_logging='info', insecure=False, charmworld_url='',
+        port=None):
     """Generate the builtin server Upstart file."""
     log('Generating the builtin server Upstart file.')
     context = {
@@ -526,7 +550,8 @@
         'charmworld_url': charmworld_url,
         'http_proxy': os.environ.get('http_proxy'),
         'https_proxy': os.environ.get('https_proxy'),
-        'no_proxy': os.environ.get('no_proxy', os.environ.get('NO_PROXY'))
+        'no_proxy': os.environ.get('no_proxy', os.environ.get('NO_PROXY')),
+        'port': port,
     }
     if not sandbox:
         api_url = 'wss://{}'.format(get_api_address())
@@ -542,12 +567,12 @@
 
 def start_builtin_server(
         build_dir, ssl_cert_path, serve_tests, sandbox, builtin_server_logging,
-        insecure, charmworld_url):
+        insecure, charmworld_url, port=None):
     """Start the builtin server."""
     write_builtin_server_startup(
         build_dir, ssl_cert_path, serve_tests=serve_tests, sandbox=sandbox,
         builtin_server_logging=builtin_server_logging, insecure=insecure,
-        charmworld_url=charmworld_url)
+        charmworld_url=charmworld_url, port=port)
     log('Starting the builtin server.')
     with su('root'):
         service_control(BUILTIN_SERVER, RESTART)

=== modified file 'server/guiserver/manage.py'
--- server/guiserver/manage.py	2014-01-24 15:38:37 +0000
+++ server/guiserver/manage.py	2014-11-13 19:23:32 +0000
@@ -120,6 +120,11 @@
     define(
         'charmworldurl', type=str,
         help='The URL to use for Charmworld.')
+    define(
+        'port', type=str,
+        help='User defined port to run the server on. If no port is defined '
+             'the server will be started on 80 and 443 as per the default '
+             'port options from the charm.')
 
     # In Tornado, parsing the options also sets up the default logger.
     parse_command_line()
@@ -133,13 +138,18 @@
 
 def run():
     """Run the server"""
+    port = options.port
     if options.insecure:
         # Run the server over an insecure HTTP connection.
-        server().listen(80)
+        if not port:
+            port = 80
+        server().listen(port)
     else:
         # Default configuration: run the server over a secure HTTPS connection.
-        server().listen(443, ssl_options=_get_ssl_options())
-        redirector().listen(80)
+        if not port:
+            port = 443
+            redirector().listen(80)
+        server().listen(port, ssl_options=_get_ssl_options())
     version = guiserver.get_version()
     logging.info('starting Juju GUI server v{}'.format(version))
     IOLoop.instance().start()