add options for apt_ftp_proxy, apt_https_proxy and apt_config

This adds ability to explicitly set http, https, ftp proxy for apt.  Also
generically adds ability to give a apt config.

apt-config could be done via write_files, but this is more specific to it.

LP: #1057195

4 files changed, 135 insertions, 33 deletions

diff --git a/cloudinit/config/cc_apt_configure.py b/cloudinit/config/cc_apt_configure.py
index 3ce3b351..5a407016 100644
--- a/cloudinit/config/cc_apt_configure.py
+++ b/cloudinit/config/cc_apt_configure.py
@@ -27,7 +27,8 @@ from cloudinit import util
 distros = ['ubuntu', 'debian']
 
 PROXY_TPL = "Acquire::HTTP::Proxy \"%s\";\n"
-PROXY_FN = "/etc/apt/apt.conf.d/95cloud-init-proxy"
+APT_CONFIG_FN = "/etc/apt/apt.conf.d/94cloud-init-config"
+APT_PROXY_FN = "/etc/apt/apt.conf.d/95cloud-init-proxy"
 
 # A temporary shell program to get a given gpg key
 # from a given keyserver
@@ -67,18 +68,10 @@ def handle(name, cfg, cloud, log, _args):
                                "security": "security.ubuntu.com/ubuntu"})
         rename_apt_lists(old_mirrors, mirrors)
 
-    # Set up any apt proxy
-    proxy = cfg.get("apt_proxy", None)
-    proxy_filename = PROXY_FN
-    if proxy:
-        try:
-            # See man 'apt.conf'
-            contents = PROXY_TPL % (proxy)
-            util.write_file(proxy_filename, contents)
-        except Exception as e:
-            util.logexc(log, "Failed to write proxy to %s", proxy_filename)
-    elif os.path.isfile(proxy_filename):
-        util.del_file(proxy_filename)
+    try:
+        apply_apt_config(cfg, APT_PROXY_FN, APT_CONFIG_FN)
+    except Exception as e:
+        log.warn("failed to proxy or apt config info: %s", e)
 
     # Process 'apt_sources'
     if 'apt_sources' in cfg:
@@ -256,3 +249,22 @@ def find_apt_mirror_info(cloud, cfg):
         mirror_info.update({'primary': mirror})
 
     return mirror_info
+
+
+def apply_apt_config(cfg, proxy_fname, config_fname):
+    # Set up any apt proxy
+    cfgs = (('apt_proxy', 'Acquire::HTTP::Proxy "%s";'),
+            ('apt_http_proxy', 'Acquire::HTTP::Proxy "%s";'),
+            ('apt_ftp_proxy', 'Acquire::FTP::Proxy "%s";'),
+            ('apt_https_proxy', 'Acquire::HTTPS::Proxy "%s";'))
+
+    proxies = [fmt % cfg.get(name) for (name, fmt) in cfgs if cfg.get(name)]
+    if len(proxies):
+        util.write_file(proxy_fname, '\n'.join(proxies) + '\n')
+    elif os.path.isfile(proxy_fname):
+        util.del_file(proxy_fname)
+
+    if cfg.get('apt_config', None):
+        util.write_file(config_fname, cfg.get('apt_config'))
+    elif os.path.isfile(config_fname):
+        util.del_file(config_fname)
diff --git a/doc/examples/cloud-config-TODO.txt b/doc/examples/cloud-config-TODO.txt
deleted file mode 100644
index c7ed54ab..00000000
--- a/doc/examples/cloud-config-TODO.txt
+++ /dev/null
@@ -1,20 +0,0 @@
-# Add apt configuration files
-#  Add an apt.conf.d/ file with the relevant content
-#
-#  See apt.conf man page for more information.
-# 
-#  Defaults:
-#   + filename: 00-boot-conf
-#
-apt_conf:
-
- # Creates an apt proxy configuration in /etc/apt/apt.conf.d/01-proxy
- - filename: "01-proxy"
-   content: |
-    Acquire::http::Proxy "http://proxy.example.org:3142/ubuntu";
-
- # Add the following line to /etc/apt/apt.conf.d/00-boot-conf
- #  (run debconf at a critical priority)
- - content: |
-    DPkg::Pre-Install-Pkgs:: "/usr/sbin/dpkg-preconfigure --apt -p critical|| true";
-
diff --git a/doc/examples/cloud-config.txt b/doc/examples/cloud-config.txt
index 24b4b36c..bcfd7917 100644
--- a/doc/examples/cloud-config.txt
+++ b/doc/examples/cloud-config.txt
@@ -53,6 +53,9 @@ apt_mirror_search:
 apt_mirror_search_dns: False
 
 # apt_proxy (configure Acquire::HTTP::Proxy)
+# 'apt_http_proxy' is an alias for 'apt_proxy'.
+# Also, available are 'apt_ftp_proxy' and 'apt_https_proxy'.
+# These affect Acquire::FTP::Proxy and Acquire::HTTPS::Proxy respectively
 apt_proxy: http://my.apt.proxy:3128
 
 # apt_pipelining (configure Acquire::http::Pipeline-Depth)
diff --git a/tests/unittests/test_handler/test_handler_apt_configure.py b/tests/unittests/test_handler/test_handler_apt_configure.py
new file mode 100644
index 00000000..22c0db80
--- /dev/null
+++ b/tests/unittests/test_handler/test_handler_apt_configure.py
@@ -0,0 +1,107 @@
+from mocker import MockerTestCase
+
+from cloudinit import cloud
+from cloudinit import util
+
+from cloudinit.config import cc_apt_configure
+
+import os
+import re
+
+
+class TestAptProxyConfig(MockerTestCase):
+    def setUp(self):
+        super(TestAptProxyConfig, self).setUp()
+        self.tmp = self.makeDir()
+        self.pfile = os.path.join(self.tmp, "proxy.cfg")
+        self.cfile = os.path.join(self.tmp, "config.cfg")
+
+    def _search_apt_config(self, contents, ptype, value):
+        print(
+            r"acquire::%s::proxy\s+[\"']%s[\"'];\n" % (ptype, value),
+            contents, "flags=re.IGNORECASE")
+        return(re.search(
+            r"acquire::%s::proxy\s+[\"']%s[\"'];\n" % (ptype, value),
+            contents, flags=re.IGNORECASE))
+
+    def test_apt_proxy_written(self):
+        cfg = {'apt_proxy': 'myproxy'}
+        cc_apt_configure.apply_apt_config(cfg, self.pfile, self.cfile)
+
+        self.assertTrue(os.path.isfile(self.pfile))
+        self.assertFalse(os.path.isfile(self.cfile))
+
+        contents = str(util.read_file_or_url(self.pfile))
+        self.assertTrue(self._search_apt_config(contents, "http", "myproxy"))
+
+    def test_apt_http_proxy_written(self):
+        cfg = {'apt_http_proxy': 'myproxy'}
+        cc_apt_configure.apply_apt_config(cfg, self.pfile, self.cfile)
+
+        self.assertTrue(os.path.isfile(self.pfile))
+        self.assertFalse(os.path.isfile(self.cfile))
+
+        contents = str(util.read_file_or_url(self.pfile))
+        self.assertTrue(self._search_apt_config(contents, "http", "myproxy"))
+
+    def test_apt_all_proxy_written(self):
+        cfg = {'apt_http_proxy': 'myproxy_http_proxy',
+               'apt_https_proxy': 'myproxy_https_proxy',
+               'apt_ftp_proxy': 'myproxy_ftp_proxy'}
+
+        values = {'http': cfg['apt_http_proxy'],
+                  'https': cfg['apt_https_proxy'],
+                  'ftp': cfg['apt_ftp_proxy'],
+                  }
+
+        cc_apt_configure.apply_apt_config(cfg, self.pfile, self.cfile)
+
+        self.assertTrue(os.path.isfile(self.pfile))
+        self.assertFalse(os.path.isfile(self.cfile))
+
+        contents = str(util.read_file_or_url(self.pfile))
+
+        for ptype, pval in values.iteritems():
+            self.assertTrue(self._search_apt_config(contents, ptype, pval))
+
+    def test_proxy_deleted(self):
+        util.write_file(self.cfile, "content doesnt matter")
+        cc_apt_configure.apply_apt_config({}, self.pfile, self.cfile)
+        self.assertFalse(os.path.isfile(self.pfile))
+        self.assertFalse(os.path.isfile(self.cfile))
+
+    def test_proxy_replaced(self):
+        util.write_file(self.cfile, "content doesnt matter")
+        cc_apt_configure.apply_apt_config({'apt_proxy': "foo"},
+                                          self.pfile, self.cfile)
+        self.assertTrue(os.path.isfile(self.pfile))
+        contents = str(util.read_file_or_url(self.pfile))
+        self.assertTrue(self._search_apt_config(contents, "http", "foo"))
+
+    def test_config_written(self):
+        payload = 'this is my apt config'
+        cfg = {'apt_config': payload}
+
+        cc_apt_configure.apply_apt_config(cfg, self.pfile, self.cfile)
+
+        self.assertTrue(os.path.isfile(self.cfile))
+        self.assertFalse(os.path.isfile(self.pfile))
+
+        self.assertEqual(str(util.read_file_or_url(self.cfile)), payload)
+
+    def test_config_replaced(self):
+        util.write_file(self.pfile, "content doesnt matter")
+        cc_apt_configure.apply_apt_config({'apt_config': "foo"},
+                                          self.pfile, self.cfile)
+        self.assertTrue(os.path.isfile(self.cfile))
+        self.assertEqual(str(util.read_file_or_url(self.cfile)), "foo")
+
+    def test_config_deleted(self):
+        # if no 'apt_config' is provided, delete any previously written file
+        util.write_file(self.pfile, "content doesnt matter")
+        cc_apt_configure.apply_apt_config({}, self.pfile, self.cfile)
+        self.assertFalse(os.path.isfile(self.pfile))
+        self.assertFalse(os.path.isfile(self.cfile))
+
+
+# vi: ts=4 expandtab