Merge lp:~allenap/maas/lint-checks-in-test-suite into lp:~maas-committers/maas/trunk

[Gavin Panella]

Run pyflakes and pep8 checks as part of the test suite.

[lp:~allenap/maas/lint-checks-in-test-suite]

918. By Gavin Panella on 2012-08-23

Require the pep8 and pyflakes packages.

[Gavin Panella (allenap)]

We're using flake8 in Makefile, and pep8+pyflakes here. Would probably be better to settle on one.

[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

918. By Gavin Panella on 2012-08-23

Require the pep8 and pyflakes packages.

917. By Gavin Panella on 2012-08-23

Do Python lint checks as part of the test suite.

=== modified file 'required-packages/dev'
--- required-packages/dev	2012-07-30 15:52:46 +0000
+++ required-packages/dev	2012-08-23 16:01:22 +0000
@@ -2,6 +2,8 @@
 curl
 firefox
 make
+pep8
+pyflakes
 python-lxml
 python-pip
 python-pocket-lint

=== added file 'src/maastesting/tests/test_lint.py'
--- src/maastesting/tests/test_lint.py	1970-01-01 00:00:00 +0000
+++ src/maastesting/tests/test_lint.py	2012-08-23 16:01:22 +0000
@@ -0,0 +1,76 @@
+# Copyright 2012 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Miscellaneous lint checks."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+__metaclass__ = type
+__all__ = []
+
+from itertools import (
+    chain,
+    imap,
+    repeat,
+    )
+from os import walk
+from os.path import (
+    dirname,
+    join,
+    pardir,
+    relpath,
+    )
+from subprocess import (
+    PIPE,
+    Popen,
+    STDOUT,
+    )
+
+from maastesting.testcase import TestCase
+
+
+root = join(dirname(__file__), pardir, pardir, pardir)
+
+
+# Predicates.
+p_python = lambda path, filename: filename.endswith(".py")
+p_not_hidden = lambda path, filename: not filename.startswith(".")
+p_not_migration = lambda path, filename: not path.endswith("/migrations")
+
+
+def gen_sources(root, combinator, *predicates):
+    for dirpath, dirnames, filenames in walk(root):
+        for filename in filenames:
+            if combinator(p(dirpath, filename) for p in predicates):
+                yield join(dirpath, filename)
+
+
+class TestPythonLint(TestCase):
+    """Check for lint in Python source files."""
+
+    @property
+    def sources(self):
+        return chain(
+            [join(root, "setup.py")],
+            gen_sources(
+                join(root, "src"), all, p_python, p_not_hidden,
+                p_not_migration),
+            gen_sources(
+                join(root, "templates"), all, p_python, p_not_hidden))
+
+    def execute(self, *command):
+        sources = imap(relpath, self.sources, repeat(root))
+        command = tuple(chain(command, sources))
+        process = Popen(command, stdout=PIPE, stderr=STDOUT, cwd=root)
+        output, ignored = process.communicate()
+        self.assertEqual(0, process.wait(), output)
+
+    def test_pyflakes(self):
+        self.execute("pyflakes")
+
+    def test_pep8(self):
+        self.execute("pep8", "--repeat", "--")