Merge lp:~ltrager/maas/peer_proxy into lp:~maas-committers/maas/trunk

[Lee Trager]

Allow user Squid proxy config to be defined in /etc/maas/proxy/{*.acl, *.conf} or /var/snap/maas/common/proxy/{*.acl, *.conf}

[Andres Rodriguez (andreserl)]

This is a nice improvement but doesn't really solve what the real issue is. That said, this could be additional so let's discuss it.

review: Needs Information

[MAAS Lander (maas-lander)]

Transitioned to Git.

lp:maas has now moved from Bzr to Git.
Please propose your branches with Launchpad using Git.

git clone https://git.launchpad.net/maas

Unmerged revisions

6042. By Lee Trager on 2017-05-06

Allow user Squid proxy config to be defined in /etc/maas/proxy/{*.acl, *.conf} or /var/snap/maas/common/proxy/{*.acl, *.conf}

=== modified file 'src/maasserver/models/config.py'
--- src/maasserver/models/config.py	2017-04-07 21:52:35 +0000
+++ src/maasserver/models/config.py	2017-05-06 00:25:16 +0000
@@ -96,11 +96,12 @@
         'enable_analytics': True,
         # First admin journey.
         'completed_intro': False,
+        # Script results.
         'max_node_commissioning_results': 10,
         'max_node_testing_results': 10,
         'max_node_installation_results': 1,
         # Notifications.
-        'subnet_ip_exhaustion_threshold_count': 16
+        'subnet_ip_exhaustion_threshold_count': 16,
     }
 
 
 
=== modified file 'src/maasserver/proxyconfig.py'
--- src/maasserver/proxyconfig.py	2017-05-02 19:00:58 +0000
+++ src/maasserver/proxyconfig.py	2017-05-06 00:25:16 +0000
@@ -10,6 +10,7 @@
     ]
 
 import datetime
+from glob import glob
 import os
 import socket
 import sys
@@ -63,6 +64,21 @@
 def proxy_update_config(reload_proxy=True):
     """Regenerate the proxy configuration file."""
 
+    def check_user_proxy_conf(filename):
+        # Squid fails to start if instructed to source a path which does not
+        # exist. Check if the path exists, if it doesn't return None which
+        # tells the template to not source anything.
+        if snappy.running_in_snap():
+            path = os.path.join(snappy.get_snap_common_path(), 'proxy')
+        else:
+            path = os.path.join('/etc', 'maas', 'proxy')
+        if not os.path.exists(path):
+            return None
+        full_path = os.path.join(path, filename)
+        if glob(full_path) == []:
+            return None
+        return full_path
+
     @transactional
     def write_config():
         allowed_subnets = Subnet.objects.filter(allow_proxy=True)
@@ -76,6 +92,8 @@
             'snap_path': snappy.get_snap_path(),
             'snap_data_path': snappy.get_snap_data_path(),
             'snap_common_path': snappy.get_snap_common_path(),
+            'user_acls': check_user_proxy_conf('*.acl'),
+            'user_conf': check_user_proxy_conf('*.conf'),
         }
         template_path = locate_template('proxy', MAAS_PROXY_CONF_TEMPLATE)
         template = tempita.Template.from_filename(
 
=== modified file 'src/maasserver/tests/test_proxyconfig.py'
--- src/maasserver/tests/test_proxyconfig.py	2017-05-02 18:42:35 +0000
+++ src/maasserver/tests/test_proxyconfig.py	2017-05-06 00:25:16 +0000
@@ -86,6 +86,38 @@
 
     @wait_for_reactor
     @inlineCallbacks
+    def test__doesnt_include_user_config_when_not_found(self):
+        self.patch(settings, "PROXY_CONNECT", True)
+        yield proxyconfig.proxy_update_config(reload_proxy=False)
+        matcher = Not(Contains("include "))
+        self.assertThat(
+            "%s/%s" % (self.tmpdir, proxyconfig.MAAS_PROXY_CONF_NAME),
+            FileContains(matcher=matcher))
+
+    @wait_for_reactor
+    @inlineCallbacks
+    def test__includes_user_config_when_found(self):
+        self.patch(settings, "PROXY_CONNECT", True)
+        self.patch(snappy, 'running_in_snap').return_value = True
+        self.patch(snappy, 'get_snap_common_path').return_value = self.tmpdir
+        proxy_path = os.path.join(self.tmpdir, 'proxy')
+        os.makedirs(proxy_path)
+        open(os.path.join(
+            proxy_path, '%s.acl' % factory.make_name('acl')), 'w').close()
+        open(os.path.join(
+            proxy_path, '%s.conf' % factory.make_name('conf')), 'w').close()
+        yield proxyconfig.proxy_update_config(reload_proxy=False)
+        matcher = Contains("include %s/proxy/*.acl" % self.tmpdir)
+        self.assertThat(
+            "%s/%s" % (self.tmpdir, proxyconfig.MAAS_PROXY_CONF_NAME),
+            FileContains(matcher=matcher))
+        matcher = Contains("include %s/proxy/*.conf" % self.tmpdir)
+        self.assertThat(
+            "%s/%s" % (self.tmpdir, proxyconfig.MAAS_PROXY_CONF_NAME),
+            FileContains(matcher=matcher))
+
+    @wait_for_reactor
+    @inlineCallbacks
     def test__calls_reloadService(self):
         self.patch(settings, "PROXY_CONNECT", True)
         yield deferToDatabase(self.make_subnet)
@@ -99,6 +131,7 @@
     def test__calls_restartService(self):
         self.patch(settings, "PROXY_CONNECT", True)
         self.patch(snappy, 'running_in_snap').return_value = True
+        self.patch(snappy, 'get_snap_common_path').return_value = '/'
         yield deferToDatabase(self.make_subnet)
         yield proxyconfig.proxy_update_config()
         self.assertThat(
 
=== modified file 'src/provisioningserver/templates/proxy/maas-proxy.conf.template'
--- src/provisioningserver/templates/proxy/maas-proxy.conf.template	2017-04-05 14:58:22 +0000
+++ src/provisioningserver/templates/proxy/maas-proxy.conf.template	2017-05-06 00:25:16 +0000
@@ -1,4 +1,6 @@
 # DO NOT EDIT.  This file is automatically created by MAAS.
+# User defined ACLs can be defined in {{if running_in_snap}}{{snap_common_path}}{{else}}/etc/maas{{endif}}/proxy/*.acl
+# Additional user defined config can be defined in {{if running_in_snap}}{{snap_common_path}}{{else}}/etc/maas{{endif}}/proxy/*.conf
 # Last updated at {{modified}}.
 
 # Inspired by UDS's conference proxy
@@ -15,6 +17,9 @@
 acl Safe_ports port 443         # https
 acl Safe_ports port 1025-65535  # unregistered ports
 acl CONNECT method CONNECT
+{{if user_acls is not None}}
+include {{user_acls}}
+{{endif}}
 http_access allow maas_proxy_manager localhost
 http_access deny maas_proxy_manager
 http_access deny !Safe_ports
@@ -56,3 +61,6 @@
 cache_log /var/log/maas/proxy/cache.log
 cache_store_log /var/log/maas/proxy/store.log
 {{endif}}
+{{if user_conf is not None}}
+include {{user_conf}}
+{{endif}}