Merge lp:~lool/phablet-tools/static-checkers into lp:phablet-tools

[Loïc Minier]

Run pyflakes and pep8 static checkers in test suite and at build time; fix a pyflakes warning.

Run pyflakes and pep8 static checkers in test suite and at build time; fix a pyflakes warning.

Did a simple run against mako with files cached locally:
./phablet-flash ubuntu-system --channel daily-proposed --no-backup -d mako

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:185
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/157/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-saucy-amd64-ci/100
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-saucy-armhf-ci/100
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-saucy-i386-ci/100

Click here to trigger a rebuild:
http://s-jenkins:8080/job/phablet-tools-ci/157/rebuild

review: Approve (continuous-integration)

[Sergio Schvezov (sergiusens)]

Thanks

review: Approve

[lp:~lool/phablet-tools/static-checkers]

186. By Loïc Minier on 2013-09-07

Only run setup() when setup.py is run as a script; this allows importing it.

187. By Loïc Minier on 2013-09-07

Split out lists of bash, python and shell scripts as to import them from
testsuite.

188. By Loïc Minier on 2013-09-07

Fix typo spotted by checkbashisms.

189. By Loïc Minier on 2013-09-07

Run phablet-network with /bin/sh instead of /bin/bash; code is actually
sh-compatible and that's one less type of scripts. Did a test run with /bin/sh
and ran checkbashisms against it.

190. By Loïc Minier on 2013-09-07

Fix copy-paste typo that prevented pyflakes from running (duplicated test
name).

191. By Loïc Minier on 2013-09-07

Run pyflakes and pep8 against python scripts (these don't end in .py and aren't
seen by pyflakes / pep8); exclude some scripts from test_pep8 as these need to
be fixed first.

192. By Loïc Minier on 2013-09-07

PEP8 fixes.

193. By Loïc Minier on 2013-09-07

Test shell scripts syntax with sh -n.

194. By Loïc Minier on 2013-09-07

Factor some code in new get_output() function.

195. By Loïc Minier on 2013-09-07

Sort alphabetically.

196. By Loïc Minier on 2013-09-07

Run checkbashisms if available; don't build-dep on it though as devscripts is
fairly large.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:196
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/158/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-saucy-amd64-ci/101
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-saucy-armhf-ci/101
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-saucy-i386-ci/101

Click here to trigger a rebuild:
http://s-jenkins:8080/job/phablet-tools-ci/158/rebuild

review: Approve (continuous-integration)

[Loïc Minier (lool)]

I've pushed some more revs to include the scripts and some other
bonuses; would you mind taking another look?

On Sat, Sep 07, 2013, Sergio Schvezov wrote:
> Review: Approve
>
> Thanks
> --
> https://code.launchpad.net/~lool/phablet-tools/static-checkers/+merge/184432
> You are the owner of lp:~lool/phablet-tools/static-checkers.

--
Loïc Minier

=== modified file 'debian/control'
--- debian/control	2013-09-04 19:57:35 +0000
+++ debian/control	2013-09-07 14:22:18 +0000
@@ -3,6 +3,8 @@
 Maintainer: Ubuntu Developers <[e-mail]>
 XSBC-Original-Maintainer: Sergio Schvezov <[e-mail]>
 Build-Depends: debhelper (>= 9.0.0),
+               pep8,
+               pyflakes,
                python (>= 2.7),
                python-configobj,
                python-lzma,

=== modified file 'phablet-demo-setup'
--- phablet-demo-setup	2013-05-29 14:39:31 +0000
+++ phablet-demo-setup	2013-09-07 14:22:18 +0000
@@ -30,6 +30,7 @@
 apt-get update
 '''
 
+
 def parse_arguments():
     '''Parses arguments passed in to script.'''
     parser = argparse.ArgumentParser(
@@ -64,7 +65,7 @@
 
 def setup_fake_pictures(script):
     script.write('tar -C /home/phablet/Pictures/ --strip-components=1 -xzf '
-               '/usr/share/demo-assets/pictures.tgz\n')
+                 '/usr/share/demo-assets/pictures.tgz\n')
     script.write('chown -R phablet:phablet /home/phablet/Pictures\n')
     return script
 
@@ -102,15 +103,16 @@
         script = setup_fake_conversations(script)
     if not args.disable_fake_messages:
         log.info('Setting up for demo message notifications')
-        script.write('/usr/bin/apt-get install -y indicators-client-examples\n')
+        script.write(
+            '/usr/bin/apt-get install -y indicators-client-examples\n')
     if not args.disable_fake_pictures:
         log.info('Setting up for demo pictures')
         script.write('/usr/bin/apt-get install -y demo-assets-pictures\n')
         script = setup_fake_pictures(script)
-    script_file = tempfile.NamedTemporaryFile(delete=False) 
+    script_file = tempfile.NamedTemporaryFile(delete=False)
     with script_file as f:
         f.write(script.getvalue())
-    script.close() 
+    script.close()
     provision_device(args.serial, script_file.name)
 
 

=== modified file 'phablet-dev-bootstrap'
--- phablet-dev-bootstrap	2013-08-09 15:08:06 +0000
+++ phablet-dev-bootstrap	2013-09-07 14:22:18 +0000
@@ -39,7 +39,7 @@
 
 
 class StringSplitAction(argparse.Action):
-     def __call__(self, parser, namespace, values, option_string=None):
+    def __call__(self, parser, namespace, values, option_string=None):
         setattr(namespace, self.dest, values.split(','))
 
 
@@ -56,16 +56,16 @@
         try:
             if os.path.isfile(target_directory):
                 raise OSError('%s is not a directory' %
-                             target_directory)
+                              target_directory)
             elif not os.path.isdir(target_directory):
                 log.debug('Creating sync directory %s' % target_directory)
                 os.mkdir(target_directory)
             elif os.listdir(target_directory):
                 raise OSError('%s is not empty and not using -c' %
-                             target_directory)
+                              target_directory)
         except OSError as e:
             if not e.message:
-                log.error('Cannot setup environment in %s' % 
+                log.error('Cannot setup environment in %s' %
                           target_directory)
             else:
                 log.error(e.message)
@@ -86,7 +86,7 @@
         subprocess.check_call(['repo',
                                'sync',
                                '-j%s' % jobs]
-                             )
+                              )
     except subprocess.CalledProcessError:
         log.error('Error while trying to sync repository')
         exit(1)
@@ -126,28 +126,29 @@
                         help='''Comma separated list of devices to Setup
                         such as maguro, manta, mako, grouper''',
                         action=StringSplitAction,
-                       )
+                        )
     parser.add_argument('-j',
                         '--jobs',
                         dest='jobs',
                         help='''Ammount of sync jobs''',
                         default='1',
-                       )
+                        )
     parser.add_argument('-c',
                         '--continue',
                         dest='continue_sync',
                         action='store_true',
                         help='''Continue a previously started sync''',
                         default=False,
-                       )
+                        )
     parser.add_argument('-r',
                         '--reference',
-                        help='''Use another dev environment as reference for git''',
+                        help='Use another dev environment as reference for '
+                             'git',
                         default='',
-                       )
+                        )
     parser.add_argument('target_directory',
                         help='Target directory for sources',
-                       )
+                        )
     return parser.parse_args()
 
 
@@ -165,4 +166,3 @@
 if __name__ == "__main__":
     args = parse_arguments()
     main(args)
-

=== modified file 'phablet-network'
--- phablet-network	2013-08-26 18:52:46 +0000
+++ phablet-network	2013-09-07 14:22:18 +0000
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the the GNU General Public License version 3, as
 # published by the Free Software Foundation.
@@ -87,7 +87,7 @@
 
 find_active_network() {
     wireless_adapter="$(nmcli -t -f device,type dev | egrep wireless | cut -d: -f1)"
-    network_active_uuid="$(nmcli -t -f name,uuid,devices,vpn con status | grep $wireless_adapter | egrep ":no$"| cut -d: -f2)"
+    network_active_uuid="$(nmcli -t -f name,uuid,devices,vpn con status | grep $wireless_adapter | egrep ':no$'| cut -d: -f2)"
     network_file=$(sudo grep "$network_active_uuid" $NETWORK_MANAGER/* | grep uuid | cut -d: -f1)
 
     if [ -z "$network_active_uuid" ]

=== modified file 'phabletutils/environment.py'
--- phabletutils/environment.py	2013-09-06 05:33:58 +0000
+++ phabletutils/environment.py	2013-09-07 14:22:18 +0000
@@ -156,10 +156,6 @@
         settings.download_dir, args.project))
     uri = settings.system_image_uri
     files, command_part = ubuntuimage.get_files(download_dir, uri, json)
-    recovery = cdimage.get_file(file_key='recovery_img',
-                                series=args.series,
-                                download_dir=download_dir,
-                                device=device)
     return projects.UbuntuTouchSystem(
         file_list=files,
         command_part=command_part,

=== modified file 'setup.py'
--- setup.py	2013-08-26 18:52:46 +0000
+++ setup.py	2013-09-07 14:22:18 +0000
@@ -3,21 +3,28 @@
 from setuptools import find_packages
 from setuptools import setup
 
-setup(
-    name='phablet-tools',
-    version='0.1',
-    description='Scripts to deploy Ubuntu on mobile devices',
-    author='Sergio Schvezov',
-    author_email='[e-mail]',
-    license='GPLv3',
-    packages=find_packages(exclude=("tests",)),
-    scripts=['phablet-flash',
-             'phablet-click-test-setup',
-             'phablet-demo-setup',
-             'phablet-network',
-             'phablet-dev-bootstrap',
-             'phablet-test-run',
-             'repo',
-             ],
-    test_suite='tests',
-)
+PYTHON_SCRIPTS = [
+    'phablet-click-test-setup',
+    'phablet-demo-setup',
+    'phablet-dev-bootstrap',
+    'phablet-flash',
+    'repo',
+    ]
+
+SH_SCRIPTS = [
+    'phablet-network',
+    'phablet-test-run',
+    ]
+
+if __name__ == "__main__":
+    setup(
+        name='phablet-tools',
+        version='0.1',
+        description='Scripts to deploy Ubuntu on mobile devices',
+        author='Sergio Schvezov',
+        author_email='[e-mail]',
+        license='GPLv3',
+        packages=find_packages(exclude=("tests",)),
+        scripts=PYTHON_SCRIPTS + SH_SCRIPTS,
+        test_suite='tests',
+    )

=== added file 'tests/test_static_checkers.py'
--- tests/test_static_checkers.py	1970-01-01 00:00:00 +0000
+++ tests/test_static_checkers.py	2013-09-07 14:22:18 +0000
@@ -0,0 +1,67 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright (C) 2013 Canonical Ltd.
+# Author: Loïc Minier <[e-mail]>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY 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/>.
+
+"""Static checkers against source files."""
+
+import subprocess
+import testtools
+
+from setup import PYTHON_SCRIPTS, SH_SCRIPTS
+
+
+# external script which is only pyflakes-clean, not pep8-clean
+PEP8_EXCLUDES = ["repo", ]
+
+
+def has_command(command):
+    """Returns whether a command is in  the PATH or not."""
+    returncode = subprocess.call(['which', command],
+                                 stdout=open('/dev/null', 'w'))
+    return returncode == 0
+
+
+def get_output(command):
+        proc = subprocess.Popen(command,
+                                stdout=subprocess.PIPE,
+                                stderr=subprocess.PIPE)
+        return proc.communicate()
+
+
+class TestStaticCheckers(testtools.TestCase):
+    @testtools.skipUnless(has_command("checkbashisms"),
+                          "checkbashisms not found")
+    def test_bashisms(self):
+        (stdout, stderr) = get_output(['checkbashisms', ] + SH_SCRIPTS)
+        self.assertEquals('', stdout)
+        self.assertEquals('', stderr)
+
+    @testtools.skipUnless(has_command("pep8"), "pep8 not found")
+    def test_pep8(self):
+        scripts = [p for p in PYTHON_SCRIPTS if p not in PEP8_EXCLUDES]
+        (stdout, stderr) = get_output(['pep8', '.'] + scripts)
+        self.assertEquals('', stdout)
+        self.assertEquals('', stderr)
+
+    @testtools.skipUnless(has_command("pyflakes"), "pyflakes not found")
+    def test_pyflakes(self):
+        (stdout, stderr) = get_output(['pyflakes', '.'] + PYTHON_SCRIPTS)
+        self.assertEquals('', stdout)
+        self.assertEquals('', stderr)
+
+    def test_sh_syntax(self):
+        (stdout, stderr) = get_output(['sh', '-n'] + SH_SCRIPTS)
+        self.assertEquals('', stdout)
+        self.assertEquals('', stderr)