Merge lp:~jameinel/lpsetup/missing_lxc_1045728 into lp:lpsetup

[John A Meinel]

Probe for lxc.so.0 in multiple locations because it exists in a different spot on Precise vs Quantal.

This is meant to address bug #1045728. It looks like 'lxc.so' has moved between Ubuntu versions. So we need to probe for it in multiple locations.

The fix is pretty straightforward, most of the churn from the patch is to make it testable so we understand *why* we try multiple locations, and avoid regressing in the future. (Also allows us to rip out some of the code when P becomes obsolete many years from now.)

[j.c.sackett (jcsackett)]

This looks ok to land. Thanks, John.

review: Approve

[Launchpad QA Bot (lpqabot)]

The attempt to merge lp:~jameinel/lpsetup/missing_lxc_1045728 into lp:lpsetup failed. Below is the output from the failed tests.

./lplxcip/tests/test_lxcip.py
      76: E301 expected 1 blank line, found 0
./lplxcip/lxcip.py
     186: local variable 'e' is assigned to but never used

+ set -o errexit
++ grep -v distribute_setup.py
++ find . -name build -prune -o -name '*.py'
+ pyfiles='./setup.py
./lplxcip/tests/utils.py
./lplxcip/tests/__init__.py
./lplxcip/tests/test_lxcip.py
./lplxcip/tests/test_helpers.py
./lplxcip/tests/test_utils.py
./lplxcip/lxcip.py
./lpsetup/utils.py
./lpsetup/__init__.py
./lpsetup/handlers.py
./lpsetup/tests/utils.py
./lpsetup/tests/__init__.py
./lpsetup/tests/test_argparser.py
./lpsetup/tests/test_cli.py
./lpsetup/tests/test_handlers.py
./lpsetup/tests/subcommands/__init__.py
./lpsetup/tests/subcommands/test_version.py
./lpsetup/tests/subcommands/test_initrepo.py
./lpsetup/tests/subcommands/test_init_target.py
./lpsetup/tests/subcommands/test_smoke.py
./lpsetup/tests/integration/common.py
./lpsetup/tests/integration/test_install_lxc.py
./lpsetup/tests/integration/test_init_target.py
./lpsetup/tests/test_utils.py
./lpsetup/subcommands/__init__.py
./lpsetup/subcommands/install_lxc.py
./lpsetup/subcommands/initlxc.py
./lpsetup/subcommands/init_target.py
./lpsetup/subcommands/update.py
./lpsetup/subcommands/initrepo.py
./lpsetup/subcommands/version.py
./lpsetup/exceptions.py
./lpsetup/argparser.py
./lpsetup/settings.py
./lpsetup/cli.py'
+ pocketlint ./setup.py ./lplxcip/tests/utils.py ./lplxcip/tests/__init__.py ./lplxcip/tests/test_lxcip.py ./lplxcip/tests/test_helpers.py ./lplxcip/tests/test_utils.py ./lplxcip/lxcip.py ./lpsetup/utils.py ./lpsetup/__init__.py ./lpsetup/handlers.py ./lpsetup/tests/utils.py ./lpsetup/tests/__init__.py ./lpsetup/tests/test_argparser.py ./lpsetup/tests/test_cli.py ./lpsetup/tests/test_handlers.py ./lpsetup/tests/subcommands/__init__.py ./lpsetup/tests/subcommands/test_version.py ./lpsetup/tests/subcommands/test_initrepo.py ./lpsetup/tests/subcommands/test_init_target.py ./lpsetup/tests/subcommands/test_smoke.py ./lpsetup/tests/integration/common.py ./lpsetup/tests/integration/test_install_lxc.py ./lpsetup/tests/integration/test_init_target.py ./lpsetup/tests/test_utils.py ./lpsetup/subcommands/__init__.py ./lpsetup/subcommands/install_lxc.py ./lpsetup/subcommands/initlxc.py ./lpsetup/subcommands/init_target.py ./lpsetup/subcommands/update.py ./lpsetup/subcommands/initrepo.py ./lpsetup/subcommands/version.py ./lpsetup/exceptions.py ./lpsetup/argparser.py ./lpsetup/settings.py ./lpsetup/cli.py

[Launchpad QA Bot (lpqabot)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[John A Meinel (jameinel)]

So... QA Bot, you rejected the submission because it had some lint, I fixed the lint, and now you say I need more review. I reject your hypothesis on trivial revisions, and submit my own fix yet again. :)

review: Approve

[Launchpad QA Bot (lpqabot)]

The attempt to merge lp:~jameinel/lpsetup/missing_lxc_1045728 into lp:lpsetup failed. Below is the output from the failed tests.

 * Reloading AppArmor profiles
   ...done.
WARNING: this command will destroy the 'lpsetup-testing-lxc' environment (type: local).
This includes all machines, services, data, and other resources. Continue [y/N]**********************************************************************
* Checking test environment. *
**********************************************************************
**********************************************************************
* Setting up the test environment for LXC container. *
**********************************************************************
----------------------------------------------------------------------
check_call:
juju bootstrap -e lpsetup-testing-lxc
----------------------------------------------------------------------
**********************************************************************
None
**********************************************************************
**********************************************************************
* Cleaning up. *
**********************************************************************

**********************************************************************
* Run time: 0:00:22.655719 *
**********************************************************************

+ set -o errexit
++ grep -v distribute_setup.py
++ find . -name build -prune -o -name '*.py'
+ pyfiles='./setup.py
./lplxcip/tests/utils.py
./lplxcip/tests/__init__.py
./lplxcip/tests/test_lxcip.py
./lplxcip/tests/test_helpers.py
./lplxcip/tests/test_utils.py
./lplxcip/lxcip.py
./lpsetup/utils.py
./lpsetup/__init__.py
./lpsetup/handlers.py
./lpsetup/tests/utils.py
./lpsetup/tests/__init__.py
./lpsetup/tests/test_argparser.py
./lpsetup/tests/test_cli.py
./lpsetup/tests/test_handlers.py
./lpsetup/tests/subcommands/__init__.py
./lpsetup/tests/subcommands/test_version.py
./lpsetup/tests/subcommands/test_initrepo.py
./lpsetup/tests/subcommands/test_init_target.py
./lpsetup/tests/subcommands/test_smoke.py
./lpsetup/tests/integration/common.py
./lpsetup/tests/integration/test_install_lxc.py
./lpsetup/tests/integration/test_init_target.py
./lpsetup/tests/test_utils.py
./lpsetup/subcommands/__init__.py
./lpsetup/subcommands/install_lxc.py
./lpsetup/subcommands/initlxc.py
./lpsetup/subcommands/init_target.py
./lpsetup/subcommands/update.py
./lpsetup/subcommands/initrepo.py
./lpsetup/subcommands/version.py
./lpsetup/exceptions.py
./lpsetup/argparser.py
./lpsetup/settings.py
./lpsetup/cli.py'
+ pocketlint ./setup.py ./lplxcip/tests/utils.py ./lplxcip/tests/__init__.py ./lplxcip/tests/test_lxcip.py ./lplxcip/tests/test_helpers.py ./lplxcip/tests/test_utils.py ./lplxcip/lxcip.py ./lpsetup/utils.py ./lpsetup/__init__.py ./lpsetup/handlers.py ./lpsetup/tests/utils.py ./lpsetup/tests/__init__.py ./lpsetup/tests/test_argparser.py ./lpsetup/tests/test_cli.py ./lpsetup/tests/test_handlers.py ./lpsetup/tests/subcommands/__init__.py ./lpsetup/tests/subcommands/...

[Launchpad QA Bot (lpqabot)]

The attempt to merge lp:~jameinel/lpsetup/missing_lxc_1045728 into lp:lpsetup failed. Below is the output from the failed tests.

lxc.aa_profile = lxc-container-with-nesting
WARNING: this command will destroy the 'lpsetup-testing-lxc' environment (type: local).
This includes all machines, services, data, and other resources. Continue [y/N]**********************************************************************
* Checking test environment. *
**********************************************************************
**********************************************************************
* Setting up the test environment for LXC container. *
**********************************************************************
----------------------------------------------------------------------
check_call:
juju bootstrap -e lpsetup-testing-lxc
----------------------------------------------------------------------
**********************************************************************
None
**********************************************************************
**********************************************************************
* Cleaning up. *
**********************************************************************

**********************************************************************
* Run time: 0:00:23.530643 *
**********************************************************************

+ set -o errexit
++ grep -v distribute_setup.py
++ find . -name build -prune -o -name '*.py'
+ pyfiles='./setup.py
./lplxcip/tests/utils.py
./lplxcip/tests/__init__.py
./lplxcip/tests/test_lxcip.py
./lplxcip/tests/test_helpers.py
./lplxcip/tests/test_utils.py
./lplxcip/lxcip.py
./lpsetup/utils.py
./lpsetup/__init__.py
./lpsetup/handlers.py
./lpsetup/tests/utils.py
./lpsetup/tests/__init__.py
./lpsetup/tests/test_argparser.py
./lpsetup/tests/test_cli.py
./lpsetup/tests/test_handlers.py
./lpsetup/tests/subcommands/__init__.py
./lpsetup/tests/subcommands/test_version.py
./lpsetup/tests/subcommands/test_initrepo.py
./lpsetup/tests/subcommands/test_init_target.py
./lpsetup/tests/subcommands/test_smoke.py
./lpsetup/tests/integration/common.py
./lpsetup/tests/integration/test_install_lxc.py
./lpsetup/tests/integration/test_init_target.py
./lpsetup/tests/test_utils.py
./lpsetup/subcommands/__init__.py
./lpsetup/subcommands/install_lxc.py
./lpsetup/subcommands/initlxc.py
./lpsetup/subcommands/init_target.py
./lpsetup/subcommands/update.py
./lpsetup/subcommands/initrepo.py
./lpsetup/subcommands/version.py
./lpsetup/exceptions.py
./lpsetup/argparser.py
./lpsetup/settings.py
./lpsetup/cli.py'
+ pocketlint ./setup.py ./lplxcip/tests/utils.py ./lplxcip/tests/__init__.py ./lplxcip/tests/test_lxcip.py ./lplxcip/tests/test_helpers.py ./lplxcip/tests/test_utils.py ./lplxcip/lxcip.py ./lpsetup/utils.py ./lpsetup/__init__.py ./lpsetup/handlers.py ./lpsetup/tests/utils.py ./lpsetup/tests/__init__.py ./lpsetup/tests/test_argparser.py ./lpsetup/tests/test_cli.py ./lpsetup/tests/test_handlers.py ./lpsetup/tests/subcommands/__init__.py ./lpsetup/tests/subcommands...

[j.c.sackett (jcsackett)]

John, just noticed this was still sitting in my +activereviews; are you still trying to land this, or can we mark it as abandoned?

[Colin Watson (cjwatson)]

I merged this manually (with a follow-up fix for API changes in liblxc.so.1), since I have no idea where the Tarmac instance for this lives (if anywhere now) and this surprised us when preparing buildbot for xenial.

=== modified file 'lplxcip/lxcip.py'
--- lplxcip/lxcip.py	2012-05-09 14:20:51 +0000
+++ lplxcip/lxcip.py	2012-09-07 06:30:30 +0000
@@ -169,10 +169,22 @@
 
     Raise OSError if LXC is not installed or the container is not found.
     """
+    return _get_pid(name)
+
+
+def _get_pid(name, loader=None):
+    """Return the pid of an LXC.
+
+    This is a private implementation detail, to allow for testing with a custom
+    loader.
+    """
     try:
-        liblxc = _load_library('lxc/liblxc.so.0')
+        liblxc = _load_library('lxc/liblxc.so.0', loader=loader)
     except OSError:
-        raise _error('not_installed')
+        try:
+            liblxc = _load_library('liblxc.so.0', loader=loader)
+        except OSError:
+            raise _error('not_installed')
     get_init_pid = _wrap(liblxc.get_init_pid, 'not_found')
     # Redirect the system stderr in order to get rid of the error raised by
     # the underlying C function call if the container is not found.

=== modified file 'lplxcip/tests/test_lxcip.py'
--- lplxcip/tests/test_lxcip.py	2012-05-03 11:26:37 +0000
+++ lplxcip/tests/test_lxcip.py	2012-09-07 06:30:30 +0000
@@ -67,6 +67,24 @@
     name = lxc.name
     interfaces = ['eth0']
 
+    def test__get_pid_tries_double_locations(self):
+        # See bug #1045728
+        # The location of 'lxc.so' is different on Quantal than Precise, so we
+        # make sure that the loading function checks both locations before
+        # giving up.
+        paths = []
+
+        def failing_loader(path):
+            paths.append(path)
+            raise OSError('not loading from path: %s' % (path,))
+        # The OSError we get at the end should be 'not_installed'
+        self.assertRaises(OSError,
+                          lxcip._get_pid, self.name, loader=failing_loader)
+        # The location on Precise
+        self.assertIn('/usr/lib/lxc/lxc.so.0', paths)
+        # The location on Quantal
+        self.assertIn('/usr/lib/lxc.so.0', paths)
+
     def test_ip_address(self):
         # Ensure the ip address of the container is correctly retrieved.
         pid = utils.get_pid(self.name)