Merge lp:~dobey/ubuntu/precise/ubuntuone-dev-tools/release-2-99-2 into lp:ubuntu/precise/ubuntuone-dev-tools

[dobey]

[Charlie_Smotherman (cjsmo)]

Looks good except for a few nit pics.

in debian/rules "dh --with python2 $@" should be "dh $@ --with python2

And some lintian errors that need to be addressed

W: ubuntuone-dev-tools source: brace-expansion-in-debhelper-config-file debian/ubuntuone-dev-tools.install
N:
N: This debhelper config file appears to use shell brace expansion (such as
N: {foo,bar}) to specify files. This happens to work due to an accident of
N: implementation but is not a supported feature. Only ?, *, and [...] are
N: supported.
N:
N: Refer to the debhelper(1) manual page for details.
N:
N: Severity: normal, Certainty: possible
N:
N: Check: debhelper, Type: source
N:
W: ubuntuone-dev-tools source: obsolete-field-in-dep5-copyright format-specification format
N:
N: The machine-readable copyright file uses a field, that used to be
N: defined by the specification, but has been renamed since then.
N:
N: Please use Format instead of Format-Specification.
N:
N: Please use Upstream-Contact instead of Contact, Maintainer or
N: Upstream-Maintainer.
N:
N: Please use Upstream-Name instead of Name.
N:
N: Refer to http://dep.debian.net/deps/dep5/ for details.
N:
N: Severity: normal, Certainty: possible
N:
N: Check: source-copyright, Type: source
N:

[dobey (dobey)]

Charlie, I have fixed these issues now. Thanks.

[lp:~dobey/ubuntu/precise/ubuntuone-dev-tools/release-2-99-2]

9. By dobey on 2012-01-20

Fix a few lintian warnings and dh argument ordering.

[Andrew Starr-Bochicchio (andrewsomething)]

You introduced a typo in debian/rules:

dh #@ --with python2

Which of course comments out every thing after "dh" It should be:

dh $@ --with python2

review: Needs Fixing

[dobey (dobey)]

So I did. Sorry about that. Fixed now.

[lp:~dobey/ubuntu/precise/ubuntuone-dev-tools/release-2-99-2]

10. By dobey on 2012-01-21

Fix the typo of # instead of $

[Martin Pitt (pitti)]

Thanks!

review: Approve

=== modified file 'PKG-INFO'
--- PKG-INFO	2012-01-04 17:55:14 +0000
+++ PKG-INFO	2012-01-21 19:50:29 +0000
@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: ubuntuone-dev-tools
-Version: 2.99.1
+Version: 2.99.2
 Summary: Ubuntu One development tools and utilities
 Home-page: http://launchpad.net/ubuntuone-dev-tools
 Author: UNKNOWN

=== added file 'data/squid.conf.in'
--- data/squid.conf.in	1970-01-01 00:00:00 +0000
+++ data/squid.conf.in	2012-01-21 19:50:29 +0000
@@ -0,0 +1,120 @@
+auth_param basic casesensitive on
+# Use a default auth using ncsa and the passed generated file.
+auth_param basic program ${auth_process} ${auth_file}
+#Recommended minimum configuration:
+acl manager proto cache_object
+acl localhost src 127.0.0.1/32
+acl to_localhost dst 127.0.0.0/32
+#
+# Example rule allowing access from your local networks.
+# Adapt to list your (internal) IP networks from where browsing
+# should be allowed
+acl all src all
+acl localnet src 10.0.0.0/8	# RFC1918 possible internal network
+acl localnet src 172.16.0.0/12	# RFC1918 possible internal network
+acl localnet src 192.168.0.0/16	# RFC1918 possible internal network
+#
+acl SSL_ports port 443		# https
+acl SSL_ports port 563		# snews
+acl SSL_ports port 873		# rsync
+acl Safe_ports port 80		# http
+acl Safe_ports port 21		# ftp
+acl Safe_ports port 443		# https
+acl Safe_ports port 70		# gopher
+acl Safe_ports port 210		# wais
+acl Safe_ports port 1025-65535	# unregistered ports
+acl Safe_ports port 280		# http-mgmt
+acl Safe_ports port 488		# gss-http
+acl Safe_ports port 591		# filemaker
+acl Safe_ports port 777		# multiling http
+acl Safe_ports port 631		# cups
+acl Safe_ports port 873		# rsync
+acl Safe_ports port 901		# SWAT
+acl purge method PURGE
+acl CONNECT method CONNECT
+
+# make an acl for users that have auth
+acl password proxy_auth REQUIRED myportname ${auth_port_number}
+acl auth_port_connected myportname ${auth_port_number}
+acl nonauth_port_connected myportname ${noauth_port_number}
+
+# Settings used for the tests:
+# Allow users connected to the nonauth port
+# Allow users authenticated AND connected to the auth port
+http_access allow nonauth_port_connected
+http_access allow password
+
+#Recommended minimum configuration:
+#
+# Only allow cachemgr access from localhost
+http_access allow manager localhost
+http_access deny manager
+# Only allow purge requests from localhost
+http_access allow purge localhost
+http_access deny purge
+# Deny requests to unknown ports
+http_access deny !Safe_ports
+# Deny CONNECT to other than SSL ports
+http_access deny CONNECT !SSL_ports
+# Example rule allowing access from your local networks.
+# Adapt localnet in the ACL section to list your (internal) IP networks
+# from where browsing should be allowed
+#http_access allow localnet
+http_access allow localhost
+
+# And finally deny all other access to this proxy
+http_access deny all
+
+icp_access allow localnet
+icp_access deny all
+
+# Squid normally listens to port 3128 but we are going to listento two
+# different ports, one for auth one for nonauth.
+http_port ${noauth_port_number}
+http_port ${auth_port_number}
+
+#We recommend you to use at least the following line.
+hierarchy_stoplist cgi-bin ?
+
+# Default cache settings.
+cache_dir ufs ${spool_temp} 1000 16 256
+
+# access log settings
+access_log ${squid_temp}/access.log squid
+
+# cache log settings
+cache_log ${squid_temp}/cache.log
+
+# cache store log settings
+cache_store_log ${squid_temp}/store.log
+
+# mime table conf
+# mime_table /usr/share/squid/mime.conf
+
+#Default pid file name
+pid_filename ${squid_temp}/squid.pid
+
+# debug options (Full debugging)
+debug_options ALL,1
+
+#Default netdb_filename
+
+#Suggested default:
+refresh_pattern ^ftp:		1440	20%	10080
+refresh_pattern ^gopher:	1440	0%	1440
+refresh_pattern -i (/cgi-bin/|\?) 0	0%	0
+refresh_pattern (Release|Packages(.gz)*)$	0	20%	2880
+# example line deb packages
+refresh_pattern .		0	20%	4320
+
+# Don't upgrade ShoutCast responses to HTTP
+acl shoutcast rep_header X-HTTP09-First-Line ^ICY.[0-9]
+
+# Apache mod_gzip and mod_deflate known to be broken so don't trust
+# Apache to signal ETag correctly on such responses
+acl apache rep_header Server ^Apache
+
+hosts_file /etc/hosts
+
+# Leave coredumps in the first cache dir
+coredump_dir ${spool_temp}/squid

=== modified file 'debian/changelog'
--- debian/changelog	2012-01-04 20:59:13 +0000
+++ debian/changelog	2012-01-21 19:50:29 +0000
@@ -1,3 +1,12 @@
+ubuntuone-dev-tools (2.99.2-0ubuntu1) precise; urgency=low
+
+  * New upstream release.
+    - Provide SquidTestCase for testing proxy support. (LP: #884963)
+    - Provide batch scripts for u1trial and u1lint on Windows. (LP: #816020)
+  * Fix a few lintian warnings and dh argument ordering.
+
+ -- Rodney Dawes <[e-mail]>  Fri, 20 Jan 2012 17:02:51 -0500
+
 ubuntuone-dev-tools (2.99.1-0ubuntu1) precise; urgency=low
 
   * New upstream release.

=== modified file 'debian/copyright'
--- debian/copyright	2010-08-02 13:45:54 +0000
+++ debian/copyright	2012-01-21 19:50:29 +0000
@@ -1,7 +1,7 @@
-Format-Specification: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn
+Format: http://svn.debian.org/wsvn/dep/web/deps/dep5.mdwn
 
 Files: *
-Copyright: 2009-2010 Canonical Ltd.
+Copyright: 2009-2012 Canonical Ltd.
 License: GPL-3
  This program is free software: you can redistribute it and/or modify it 
  under the terms of the GNU General Public License version 3, as published 

=== modified file 'debian/rules'
--- debian/rules	2011-12-22 21:33:15 +0000
+++ debian/rules	2012-01-21 19:50:29 +0000
@@ -1,7 +1,7 @@
 #!/usr/bin/make -f
 
 %:
-	dh --with python2 $@
+	dh $@ --with python2
 
 override_dh_auto_test:
 	./run-tests

=== modified file 'debian/ubuntuone-dev-tools.install'
--- debian/ubuntuone-dev-tools.install	2010-08-02 13:45:54 +0000
+++ debian/ubuntuone-dev-tools.install	2012-01-21 19:50:29 +0000
@@ -1,3 +1,4 @@
 usr/bin
 usr/share/ubuntuone-dev-tools
-usr/share/man/man1/{u1lint,u1trial}.*
+usr/share/man
+

=== modified file 'run-tests'
--- run-tests	2011-12-22 21:20:09 +0000
+++ run-tests	2012-01-21 19:50:29 +0000
@@ -20,6 +20,6 @@
 bin/u1trial --reactor=twisted ubuntuone
 echo "Running style checks..."
 bin/u1lint
-pep8 --repeat . bin/*
+pep8 --repeat . bin/* --exclude=*.bat
 rm -rf _trial_temp
 rm -rf .coverage

=== modified file 'setup.py'
--- setup.py	2012-01-04 17:55:14 +0000
+++ setup.py	2012-01-21 19:50:29 +0000
@@ -21,7 +21,7 @@
 from distutils.core import setup, Command
 
 PACKAGE = 'ubuntuone-dev-tools'
-VERSION = '2.99.1'
+VERSION = '2.99.2'
 
 U1LINT = 'bin/u1lint'
 
@@ -44,6 +44,15 @@
         if retcode != 0:
             sys.exit(retcode)
 
+# pylint: disable=C0103
+scripts = ['bin/u1lint',
+           'bin/u1trial']
+# pylint: enable=C0103
+
+if sys.platform == 'win32':
+    # lets add the .bat so that windows users are happy
+    scripts.extend(['bin/u1lint.bat', 'bin/u1trial.bat'])
+
 setup(name=PACKAGE,
       version=VERSION,
       description='Ubuntu One development tools and utilities',
@@ -55,12 +64,11 @@
                 'ubuntuone.devtools.testing',
                 'ubuntuone.devtools.testcases'],
       extra_path='ubuntuone-dev-tools',
-      scripts=['bin/u1lint',
-               'bin/u1trial',
-               ],
+      scripts=scripts,
       data_files=[('share/%s' % PACKAGE,
                    ['pylintrc',
-                    'data/dbus-session.conf.in']),
+                    'data/dbus-session.conf.in',
+                    'data/squid.conf.in']),
                   ('share/man/man1',
                    ['man/u1lint.1',
                     'man/u1trial.1']),

=== modified file 'ubuntuone/devtools/services/__init__.py'
--- ubuntuone/devtools/services/__init__.py	2010-11-29 18:43:05 +0000
+++ ubuntuone/devtools/services/__init__.py	2012-01-21 19:50:29 +0000
@@ -1,1 +1,54 @@
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Service runners for testing."""
+
+import os
+import socket
+
+from dirspec.basedir import load_data_paths
+
+
+def find_config_file(in_config_file):
+    """Find the first appropriate conf to use."""
+    # In case we're running from within the source tree
+    path = os.path.abspath(os.path.join(os.path.dirname(__file__),
+                                            os.path.pardir, os.path.pardir,
+                                            os.path.pardir,
+                                            "data", in_config_file))
+    if not os.path.exists(path):
+        # Use the installed file in $pkgdatadir as source
+        for path in load_data_paths("ubuntuone-dev-tools",
+                                    in_config_file):
+            if os.path.exists(path):
+                break
+
+    # Check to make sure we didn't just fall out of the loop
+    if not os.path.exists(path):
+        raise IOError('Could not locate suitable %s' % in_config_file)
+    return path
+
+
+def get_arbitrary_port():
+    """
+    Find an unused port, and return it.
+
+    There might be a small race condition here, but we aren't
+    worried about it.
+    """
+    sock = socket.socket()
+    sock.bind(('localhost', 0))
+    _, port = sock.getsockname()
+    sock.close()
+    return port

=== modified file 'ubuntuone/devtools/services/dbus.py'
--- ubuntuone/devtools/services/dbus.py	2011-12-22 21:20:09 +0000
+++ ubuntuone/devtools/services/dbus.py	2012-01-21 19:50:29 +0000
@@ -20,10 +20,12 @@
 import signal
 import subprocess
 
-from dirspec.basedir import load_data_paths
 from distutils.spawn import find_executable
 from urllib import quote
 
+from ubuntuone.devtools.services import find_config_file
+DBUS_CONFIG_FILE = 'dbus-session.conf.in'
+
 
 class DBusLaunchError(Exception):
     """Error while launching dbus-daemon"""
@@ -44,42 +46,25 @@
         self.running = False
         self.config_file = None
 
-    def _find_config_file(self, tempdir=None):
+    def _generate_config_file(self, tempdir=None):
         """Find the first appropriate dbus-session.conf to use."""
-        # In case we're running from within the source tree
-        path = os.path.abspath(os.path.join(os.path.dirname(__file__),
-                                            os.path.pardir, os.path.pardir,
-                                            os.path.pardir,
-                                            "data", "dbus-session.conf.in"))
-        if not os.path.exists(path):
-            # Use the installed file in $pkgdatadir as source
-            for path in load_data_paths("ubuntuone-dev-tools",
-                                        "dbus-session.conf.in"):
-                if os.path.exists(path):
-                    break
-
-        # Check to make sure we didn't just fall out of the loop
-        if not os.path.exists(path):
-            raise IOError('Could not locate suitable dbus-session.conf.in')
-
+        # load the config file
+        path = find_config_file(DBUS_CONFIG_FILE)
+        # replace config settings
         self.config_file = os.path.join(tempdir, 'dbus-session.conf')
         dbus_address = 'unix:tmpdir=%s' % quote(tempdir)
         with open(path) as in_file:
             content = in_file.read()
             with open(self.config_file, 'w') as out_file:
                 out_file.write(content.replace('@ADDRESS@', dbus_address))
-                out_file.close()
-            in_file.close()
 
     def start_service(self, tempdir=None):
         """Start our own session bus daemon for testing."""
-        if not tempdir:
-            tempdir = os.path.join(os.getcwd(), '_trial_temp')
         dbus = find_executable("dbus-daemon")
         if not dbus:
             raise NotFoundError("dbus-daemon was not found.")
 
-        self._find_config_file(tempdir)
+        self._generate_config_file(tempdir)
 
         dbus_args = ["--fork",
                      "--config-file=" + self.config_file,

=== added file 'ubuntuone/devtools/services/squid.py'
--- ubuntuone/devtools/services/squid.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/devtools/services/squid.py	2012-01-21 19:50:29 +0000
@@ -0,0 +1,245 @@
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Utilities for finding and running a squid proxy for testing."""
+
+import random
+import signal
+# pylint:disable=W0402
+import string
+# pylint:enable=W0402
+import subprocess
+import time
+
+from json import dumps, loads
+from os import environ, makedirs, kill, unlink
+from os.path import abspath, exists, join
+
+from distutils.spawn import find_executable
+
+from ubuntuone.devtools.services import (
+    find_config_file,
+    get_arbitrary_port,
+)
+
+SQUID_CONFIG_FILE = 'squid.conf.in'
+SQUID_DIR = 'squid'
+AUTH_PROCESS_PATH = '/usr/lib/%s/ncsa_auth'
+SPOOL_DIR = 'spool'
+AUTH_FILE = 'htpasswd'
+PROXY_ENV_VAR = 'SQUID_PROXY_SETTINGS'
+
+
+def get_squid_executable():
+    """Return the squid executable of the system."""
+    # try with squid and if not present try with squid3 for newer systems
+    # (Ubuntu P). We also return the path to the auth process so that we can
+    # point to the correct one.
+    squid = find_executable('squid3')
+    auth_process = AUTH_PROCESS_PATH % 'squid3'
+    if squid is None:
+        squid = find_executable('squid')
+        auth_process = AUTH_PROCESS_PATH % 'squid'
+    return squid, auth_process
+
+
+def get_htpasswd_executable():
+    """Return the htpasswd executable."""
+    return find_executable('htpasswd')
+
+
+def _make_random_string(count):
+    """Make a random string of the given length."""
+    entropy = random.SystemRandom()
+    return ''.join([entropy.choice(string.letters) for _ in
+                   range(count)])
+
+
+def _get_basedir(tempdir):
+    """Return the base squid config."""
+    basedir = join(tempdir, SQUID_DIR)
+    basedir = abspath(basedir)
+    if not exists(basedir):
+        makedirs(basedir)
+    return basedir
+
+
+def _get_spool_temp_path(tempdir=''):
+    """Return the temp dir to be used for spool."""
+    basedir = _get_basedir(tempdir)
+    path = join(basedir, SPOOL_DIR)
+    path = abspath(path)
+    if not exists(path):
+        makedirs(path)
+    return path
+
+
+def _get_squid_temp_path(tempdir=''):
+    """Return the temp dir to be used by squid."""
+    basedir = _get_basedir(tempdir)
+    path = join(basedir, SQUID_DIR)
+    path = abspath(path)
+    if not exists(path):
+        makedirs(path)
+    return path
+
+
+def _get_auth_temp_path(tempdir=''):
+    """Return the path for the auth file."""
+    basedir = _get_basedir(tempdir)
+    auth_file = join(basedir, AUTH_FILE)
+    if not exists(basedir):
+        makedirs(basedir)
+    return auth_file
+
+
+def store_proxy_settings(settings):
+    """Store the proxy setting in an env var."""
+    environ[PROXY_ENV_VAR] = dumps(settings)
+
+
+def retrieve_proxy_settings():
+    """Return the proxy settings of the env."""
+    if PROXY_ENV_VAR in environ:
+        return loads(environ[PROXY_ENV_VAR])
+    return None
+
+
+def delete_proxy_settings():
+    """Delete the proxy env settings."""
+    if PROXY_ENV_VAR in environ:
+        del environ[PROXY_ENV_VAR]
+
+
+class SquidLaunchError(Exception):
+    """Error while launching squid."""
+
+
+class SquidRunner(object):
+    """Class for running a squid proxy with the local config."""
+
+    def __init__(self):
+        """Create a new instance."""
+        self.squid, self.auth_process = get_squid_executable()
+        if self.squid is None:
+            raise SquidLaunchError('Could not locate "squid".')
+
+        self.htpasswd = get_htpasswd_executable()
+        if self.htpasswd is None:
+            raise SquidLaunchError('Could not locate "htpasswd".')
+
+        self.settings = dict(noauth_port=None, auth_port=None,
+                             username=None, password=None)
+        self.squid_pid = None
+        self.running = False
+        self.config_file = None
+        self.auth_file = None
+
+    def _generate_config_file(self, tempdir=''):
+        """Find the first appropiate squid.conf to use."""
+        # load the config file
+        path = find_config_file(SQUID_CONFIG_FILE)
+        # replace config settings
+        basedir = join(tempdir, 'squid')
+        basedir = abspath(basedir)
+        if not exists(basedir):
+            makedirs(basedir)
+        self.config_file = join(basedir, 'squid.conf')
+        with open(path) as in_file:
+            template = string.Template(in_file.read())
+
+        self.settings['noauth_port'] = get_arbitrary_port()
+        self.settings['auth_port'] = get_arbitrary_port()
+        spool_path = _get_spool_temp_path(tempdir)
+        squid_path = _get_squid_temp_path(tempdir)
+        with open(self.config_file, 'w') as out_file:
+            out_file.write(template.safe_substitute(
+                              auth_file=self.auth_file,
+                              auth_process=self.auth_process,
+                              noauth_port_number=self.settings['noauth_port'],
+                              auth_port_number=self.settings['auth_port'],
+                              spool_temp=spool_path,
+                              squid_temp=squid_path))
+
+    def _generate_swap(self, config_file):
+        """Generate the squid swap files."""
+        squid_args = ['-z', '-f', config_file]
+        sp = subprocess.Popen([self.squid] + squid_args,
+                              stdout=subprocess.PIPE,
+                              stderr=subprocess.PIPE)
+        sp.wait()
+
+    def _generate_auth_file(self, tempdir=''):
+        """Generates a auth file using htpasswd."""
+        if self.settings['username'] is None:
+            self.settings['username'] = _make_random_string(10)
+        if self.settings['password'] is None:
+            self.settings['password'] = _make_random_string(10)
+
+        self.auth_file = _get_auth_temp_path(tempdir)
+        # remove possible old auth file
+        if exists(self.auth_file):
+            unlink(self.auth_file)
+        # create a new htpasswrd
+        htpasswd_args = ['-bc',
+                         self.auth_file,
+                         self.settings['username'],
+                         self.settings['password']]
+        sp = subprocess.Popen([self.htpasswd] + htpasswd_args,
+                              stdout=subprocess.PIPE,
+                              stderr=subprocess.PIPE)
+        sp.wait()
+
+    def _is_squid_running(self):
+        """Return if squid is running."""
+        squid_args = ['-k', 'check', '-f', self.config_file]
+        print 'Starting squid version...'
+        message = 'Waiting for squid to start...'
+        for timeout in (0.4, 0.1, 0.1, 0.2, 0.5, 1, 3, 5):
+            try:
+                #  Do not use stdout=PIPE or stderr=PIPE with this function.
+                subprocess.check_call([self.squid] + squid_args,
+                                       stdout=subprocess.PIPE,
+                                       stderr=subprocess.PIPE)
+                return True
+            except subprocess.CalledProcessError:
+                message += '.'
+                print message
+                time.sleep(timeout)
+        return False
+
+    def start_service(self, tempdir=None):
+        """Start our own proxy."""
+        # generate auth, config and swap dirs
+        self._generate_auth_file(tempdir)
+        self._generate_config_file(tempdir)
+        self._generate_swap(self.config_file)
+        squid_args = ['-N', '-X', '-f', self.config_file]
+        sp = subprocess.Popen([self.squid] + squid_args,
+                              stdout=subprocess.PIPE,
+                              stderr=subprocess.PIPE)
+        store_proxy_settings(self.settings)
+        if not self._is_squid_running():
+            raise SquidLaunchError('Could not start squid.')
+        self.squid_pid = sp.pid
+        self.running = True
+
+    def stop_service(self):
+        """Stop our proxy,"""
+        kill(self.squid_pid, signal.SIGKILL)
+        delete_proxy_settings()
+        self.running = False
+        unlink(self.config_file)
+        unlink(self.auth_file)
+        self.config_file = None

=== modified file 'ubuntuone/devtools/testcases/dbus.py'
--- ubuntuone/devtools/testcases/dbus.py	2011-12-22 21:20:09 +0000
+++ ubuntuone/devtools/testcases/dbus.py	2012-01-21 19:50:29 +0000
@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Base tests cases and test utilities."""
+"""Base dbus tests cases and test utilities."""
 
 from __future__ import absolute_import, with_statement
 

=== added file 'ubuntuone/devtools/testcases/squid.py'
--- ubuntuone/devtools/testcases/squid.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/devtools/testcases/squid.py	2012-01-21 19:50:29 +0000
@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Base squid tests cases and test utilities."""
+
+from ubuntuone.devtools.testcase import BaseTestCase, skipIf
+from ubuntuone.devtools.services.squid import (
+    SquidRunner,
+    SquidLaunchError,
+    get_squid_executable,
+    get_htpasswd_executable,
+    retrieve_proxy_settings)
+
+# pylint: disable=C0103
+squid, _ = get_squid_executable()
+htpasswd = get_htpasswd_executable()
+# pylint: enable=C0103
+
+
+@skipIf(squid is None or htpasswd is None,
+        'The test requires squid and htpasswd.')
+class SquidTestCase(BaseTestCase):
+    """Test that uses a proxy."""
+
+    def required_services(self):
+        """Return the list of required services for DBusTestCase."""
+        services = super(SquidTestCase, self).required_services()
+        services.extend([SquidRunner])
+        return services
+
+    def get_nonauth_proxy_settings(self):
+        """Return the settings of the noneauth proxy."""
+        settings = retrieve_proxy_settings()
+        if settings is None:
+            raise SquidLaunchError('Proxy is not running.')
+        return dict(host='localhost', port=settings['noauth_port'])
+
+    def get_auth_proxy_settings(self):
+        """Return the settings of the auth proxy."""
+        settings = retrieve_proxy_settings()
+        if settings is None:
+            raise SquidLaunchError('Proxy is not running.')
+        return dict(host='localhost', port=settings['auth_port'],
+                    username=settings['username'],
+                    password=settings['password'])