Merge lp:~sinzui/juju-release-tools/build-package-print into lp:juju-release-tools

[Curtis Hovey]

Make build_package.py the only source for juju series information.

We want to stop building and testing vivid, but before we do, We want a single definition of the series Juju supports. This branch removes supported-releases.txt. To do so, assemble-streams.bash call a new build_package.py command to print the series associated with the package version.

The JujuSeries class gained three new methods, two of which I think we probably wont need. The crucial method is get_name_from_package_version() which matches a series name to a series version in the package version. This logic is simpler that the bash rules. The previous rules dealt with the case where agents were created from Ubuntu packages. The Ubuntu devel series never has a series version embedded in the package version. We no longer support Ubuntu packages, so I dropped the rule. The new method returns an empty string when no match is found. None would be preferred if other code used this method, but since it exists just for bash to make a decision, I choose the simplest path.

[Aaron Bentley (abentley)]

Nice improvement.

review: Approve

[lp:~sinzui/juju-release-tools/build-package-print]

247. By Curtis Hovey on 2016-01-08

Exit 1 when a --series-name-from-package-version has no match.

248. By Curtis Hovey on 2016-01-08

Fix quoting.

=== modified file 'Makefile'
--- Makefile	2015-08-18 22:42:15 +0000
+++ Makefile	2016-01-08 21:21:12 +0000
@@ -1,6 +1,11 @@
+p=*.py
 test:
-	TMPDIR=/tmp python -m unittest discover -vv ./tests -p '*.py'
+	TMPDIR=/tmp python -m unittest discover -vv ./tests -p "$(p)"
 lint:
-	flake8 --max-line-length=80 .
+	flake8 --max-line-length=80 $$(find . -name '*.py')
+cover:
+	python -m coverage run --source="./" --omit "./tests/*" -m unittest discover -vv ./tests
+	python -m coverage report
 clean:
 	find . -name '*.pyc' -delete
+.PHONY: lint test cover clean

=== modified file 'assemble-streams.bash'
--- assemble-streams.bash	2015-11-09 22:28:13 +0000
+++ assemble-streams.bash	2016-01-08 21:21:12 +0000
@@ -221,15 +221,10 @@
 get_series() {
     # Defines $series.
     control_version=$1
-    ubuntu_devel=$(grep DEVEL $SCRIPT_DIR/supported-releases.txt |
-        cut -d ' ' -f 1)
-    pkg_series=$(basename "$control_version" ~juju1 |
-        sed -r "s/([0-9]ubuntu[0-9])$/\1~$ubuntu_devel/;" |
-        sed -r "s/.*(ubuntu|~)([0-9][0-9]\.[0-9][0-9]).*/\2/")
-    series=$(cat $SCRIPT_DIR/supported-releases.txt |
-        grep $pkg_series | cut -d ' ' -f 2)
+    series=$($SCRIPT_DIR/build_package.py \
+        print --series-name-from-package-version $control_version || true)
     if [[ -z $series ]]; then
-        echo "Invalid series: $control_version, saw [$pkg_series]"
+        echo "Cannot get juju series from package version $control_version "
         exit 3
     fi
     if ! distro-info --all | grep $series; then

=== modified file 'build_package.py'
--- build_package.py	2015-12-17 16:19:35 +0000
+++ build_package.py	2016-01-08 21:21:12 +0000
@@ -131,10 +131,41 @@
             series = Series(*line.split())
             self.all[series.name] = series
 
+    def get_devel_version(self):
+        for series in self.all.values():
+            if series.status == 'DEVEL':
+                return series.version
+        else:
+            raise AssertionError(
+                "SUPPORTED_RELEASES is missing the DEVEL series")
+
     def get_living_names(self):
         return sorted(s.name for s in self.all.values()
                       if s.status in self.LIVING_STATUSES)
 
+    def get_name(self, version):
+        for series in self.all.values():
+            if series.version == version:
+                return series.name
+        else:
+            raise KeyError("'%s' is not a known series" % version)
+
+    def get_name_from_package_version(self, package_version):
+        """Return the series name associated with the package version.
+
+        The series is matched to the series version commonly embedded in
+        backported package versions. Official juju package versions always
+        contain the series version to indicate the tool-chain used to build.
+
+        Ubuntu devel packages do not have series versions, they cannot be
+        matched to a series. As Ubuntu packages are not built with ideal rules,
+        they are not suitable for building agents.
+        """
+        for series in self.all.values():
+            if series.version in package_version:
+                return series.name
+        return None
+
     def get_version(self, name):
         return self.all[name].version
 
@@ -421,6 +452,16 @@
     return 0
 
 
+def print_series_info(package_version=None):
+    exitcode = 1
+    if package_version:
+        version = juju_series.get_name_from_package_version(package_version)
+        if version:
+            print(version)
+            return 0
+    return exitcode
+
+
 def main(argv):
     """Execute the commands from the command line."""
     exitcode = 0
@@ -431,10 +472,13 @@
             debemail=args.debemail, debfullname=args.debfullname,
             gpgcmd=args.gpgcmd, branch=args.branch, upatch=args.upatch,
             verbose=args.verbose)
-    if args.command == 'binary':
+    elif args.command == 'binary':
         exitcode = build_binary(
             args.dsc, args.location, args.series, args.arch,
             ppa=args.ppa, verbose=args.verbose)
+    elif args.command == 'print':
+        exitcode = print_series_info(
+            package_version=args.series_name_from_package_version)
     return exitcode
 
 
@@ -473,8 +517,12 @@
     bin_parser.add_argument("location", help="The location to build in.")
     bin_parser.add_argument("series", help="The series to build in.")
     bin_parser.add_argument("arch", help="The dpkg architecture to build in.")
+    print_parser = subparsers.add_parser('print', help='Print series info')
+    print_parser.add_argument(
+        '--series-name-from-package-version',
+        help="Print the series name associated with the package version.")
     args = parser.parse_args(argv[1:])
-    if args.series == 'LIVING':
+    if getattr(args, 'series', None) and args.series == 'LIVING':
         args.series = juju_series.get_living_names()
     return args
 

=== removed file 'supported-releases.txt'
--- supported-releases.txt	2015-11-26 16:31:28 +0000
+++ supported-releases.txt	1970-01-01 00:00:00 +0000
@@ -1,9 +0,0 @@
-# This is the list of series that must be recognised for tools.
-12.04 precise LTS
-12.10 quantal HISTORIC
-13.10 saucy HISTORIC
-14.04 trusty LTS
-14.10 utopic HISTORIC
-15.04 vivid SUPPORTED
-15.10 wily SUPPORTED
-16.04 xenial DEVEL

=== modified file 'tests/test_build_package.py'
--- tests/test_build_package.py	2015-12-17 16:19:35 +0000
+++ tests/test_build_package.py	2016-01-08 21:21:12 +0000
@@ -5,6 +5,7 @@
     patch
 )
 import os
+from StringIO import StringIO
 from textwrap import dedent
 import unittest
 
@@ -29,6 +30,7 @@
     make_ubuntu_version,
     move_debs,
     parse_dsc,
+    print_series_info,
     setup_local,
     setup_lxc,
     Series,
@@ -50,12 +52,38 @@
             Series('14.10', 'utopic', 'HISTORIC'),
             juju_series.all['utopic'])
 
+    def test_get_devel_version(self):
+        juju_series = _JujuSeries()
+        [devel] = [s.version for s in juju_series.all.values()
+                   if s.status == 'DEVEL']
+        self.assertEqual(devel, juju_series.get_devel_version())
+
     def test_get_living_names(self):
         juju_series = _JujuSeries()
         self.assertEqual(
             ['precise', 'trusty', 'vivid', 'wily', 'xenial'],
             juju_series.get_living_names())
 
+    def test_get_name(self):
+        juju_series = _JujuSeries()
+        self.assertEqual('trusty', juju_series.get_name('14.04'))
+        with self.assertRaises(KeyError):
+            juju_series.get_version('13.01')
+
+    def test_get_name_from_package_version(self):
+        juju_series = _JujuSeries()
+        self.assertEqual(
+            'xenial',
+            juju_series.get_name_from_package_version(
+                '1.26-alpha3-0ubuntu1~16.04.1~juju1'))
+        self.assertEqual(
+            'trusty',
+            juju_series.get_name_from_package_version(
+                '1.25.0-0ubuntu1~14.04.1~juju1'))
+        self.assertIs(
+            None,
+            juju_series.get_name_from_package_version('1.25.0-0ubuntu1'))
+
     def test_get_version(self):
         juju_series = _JujuSeries()
         self.assertEqual('14.04', juju_series.get_version('trusty'))
@@ -427,3 +455,35 @@
         cc_mock.assert_called_with(
             ['debsign -p /my/gpgcmd *.changes'],
             shell=True, cwd='/juju-build-trusty-all', env=env)
+
+    def test_get_args_print(self):
+        args = get_args(
+            ['prog', 'print', '--series-name-from-package-version',
+             '1.25.0-0ubuntu1~16.04.1~juju1'])
+        self.assertEqual('print', args.command)
+        self.assertEqual(
+            '1.25.0-0ubuntu1~16.04.1~juju1',
+            args.series_name_from_package_version)
+
+    def test_main_print(self):
+        with patch('build_package.print_series_info', autospec=True,
+                   return_value=0) as psi_mock:
+            code = main(
+                ['prog', 'print', '--series-name-from-package-version',
+                 '1.25.0-0ubuntu1~16.04.1~juju1'])
+        self.assertEqual(0, code)
+        psi_mock.assert_called_with(
+            package_version='1.25.0-0ubuntu1~16.04.1~juju1')
+
+    @patch('sys.stdout', new_callable=StringIO)
+    def test_print_series_info(self, so_mock):
+        # Unmatched.
+        code = print_series_info(
+            package_version='1.25.0-0ubuntu1')
+        self.assertEqual(1, code)
+        self.assertEqual('', so_mock.getvalue())
+        # Matched.
+        code = print_series_info(
+            package_version='1.25.0-0ubuntu1~16.04.1~juju1')
+        self.assertEqual(0, code)
+        self.assertEqual('xenial\n', so_mock.getvalue())