Merge lp:~dholbach/click-reviewers-tools/1355215 into lp:click-reviewers-tools

[Daniel Holbach]

daniel@daydream:~/bzr/click/click-reviewers-tools.1355215$ ./bin/click-review ~/fr.skimbo.skimbou_1.3_armhf.click
Errors
------
 - lint_control_click_version_up_to_date
 Click-Version is too old, has '0.3', needs '0.4' or newer
 http://askubuntu.com/questions/417366/what-does-lint-control-click-version-up-to-date-mean/417367
 - lint_package_filename_arch_match
 'armhf' != 'all' from DEBIAN/control
Warnings
--------
 - lint_framework
 'ubuntu-sdk-13.10' is deprecated. Please use a newer framework
 http://askubuntu.com/questions/460512/what-framework-should-i-use-in-my-manifest-file
 - functional_qml_application_uses_QtWebKit
 Found files that use unsupported QtWebKit (should use UbuntuWebview (Ubuntu.Components.Extras.Browser >= 0.2) or Oxide instead): debian/skimbou/usr/share/skimbou/WebViewPage.qml ,debian/skimbou/usr/share/skimbou/pages/WebViewPage.qml ,pages/WebViewPage.qml
 http://askubuntu.com/questions/417342/what-does-functional-qml-application-uses-qtwebkit-mean/417343
daniel@daydream:~/bzr/click/click-reviewers-tools.1355215$

daniel@daydream:~/bzr/click/click-reviewers-tools.1355215$ ./bin/click-review ~/bzr/apps/randomcats/com.ubuntu.developer.dholbach.randomcats_0.8_all.click
Passed!
daniel@daydream:~/bzr/click/click-reviewers-tools.1355215$

[lp:~dholbach/click-reviewers-tools/1355215]

224. By Daniel Holbach on 2014-08-20

split out obtaining of module names into separate function, add doc_strings

[Alan Pope 🍺🐧🐱 🦄 (popey)]

Works nicely, thanks.

alan@deep-thought:/tmp/1355215⟫ bin/click-review ~/Downloads/com.ubuntu.music_1.3.586_all.click
Errors
------
 - content_hub_valid_music_source
        'source' is empty
 - security_template_valid (apparmor.json)
        (MANUAL REVIEW) 'unconfined' not allowed
Warnings
--------
 - lint_click_local_extensions
        found unofficial extensions: x-source, x-test

[lp:~dholbach/click-reviewers-tools/1355215]

225. By Daniel Holbach on 2014-08-20

add another more general comment

226. By Daniel Holbach on 2014-08-20

simplify for loop somewhat

227. By Daniel Holbach on 2014-08-20

split out report into its own function and simplify it

228. By Daniel Holbach on 2014-08-20

parse arguments, add -v/--verbose option

229. By Daniel Holbach on 2014-08-21

implement --json option, fix pep8 issues

230. By Daniel Holbach on 2014-08-21

bring final report line in sync with with what click-run-checks does

231. By Daniel Holbach on 2014-08-21

move sys.exit() to main() function

232. By Daniel Holbach on 2014-08-22

merge from trunk, resolve conflicts

[Martin Albisetti (beuno)]

review: Approve

=== added file 'bin/click-review'
--- bin/click-review	1970-01-01 00:00:00 +0000
+++ bin/click-review	2014-08-22 13:22:57 +0000
@@ -0,0 +1,130 @@
+#!/usr/bin/python3
+
+import argparse
+import imp
+import inspect
+import json
+import pkgutil
+import sys
+
+
+def get_modules():
+    '''
+    Here we have a look at all the modules in the
+    clickreviews package and filter out a few which
+    are not relevant.
+
+    Basically we look at all the ones which are
+    derived from cr_common, where we can later on
+    instantiate a *Review* object and run the
+    necessary checks.
+    '''
+
+    all_modules = [name for _, name, _ in
+                   pkgutil.iter_modules(['clickreviews'])]
+    narrow_down_modules = \
+        lambda a: a.startswith('cr_') and \
+        a not in ['cr_common', 'cr_tests', 'cr_skeleton']
+    return list(filter(narrow_down_modules, all_modules))
+
+
+def init_main_class(module_name, click_file):
+    '''
+    This function will find the Click*Review class in
+    the specified module and instantiate it with the
+    location of the .click file we want to inspect.
+    '''
+
+    module = imp.load_source(module_name,
+                             'clickreviews/%s.py' % module_name)
+
+    classes = inspect.getmembers(module, inspect.isclass)
+    find_main_class = lambda a: a[0].startswith('Click') and \
+        not a[0].endswith('Exception') and \
+        a[1].__module__ == module_name
+    main_class = list(filter(find_main_class, classes))
+    init_object = getattr(module, main_class[0][0])
+    return init_object(click_file)
+
+
+def print_findings(which, kind):
+    '''
+    Print a summary of the issues found.
+    '''
+
+    if not which:
+        return ''
+    print(kind)
+    print(''.center(len(kind), '-'))
+    for key in which.keys():
+        print(' - %s' % key)
+        print('\t%s' % which[key]['text'])
+        if 'link' in which[key]:
+            print('\t%s' % which[key]['link'])
+
+
+def report(results, args):
+    errors = {}
+    warnings = {}
+    info = {}
+
+    for module in results:
+        for key in results[module]['error']:
+            errors[key] = results[module]['error'][key]
+        for key in results[module]['warn']:
+            warnings[key] = results[module]['warn'][key]
+        if args.verbose:
+            for key in results[module]['info']:
+                info[key] = results[module]['info'][key]
+
+    if not args.json:
+        print_findings(errors, 'Errors')
+        print_findings(warnings, 'Warnings')
+        if args.verbose:
+            print_findings(info, 'Info')
+        if warnings or errors:
+            print('%s: FAILED' % args.filename)
+        else:
+            print('%s: passed' % args.filename)
+    else:
+        print(json.dumps(results, sort_keys=True, indent=2,
+                         separators=(',', ': ')))
+    if warnings or errors:
+        return 1
+    return 0
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('filename', type=str,
+                        help='.click file to be inspected')
+    parser.add_argument('-v', '--verbose', help='increase output verbosity',
+                        action='store_true')
+    parser.add_argument('--json', help='print json output',
+                        action='store_true')
+    args = parser.parse_args()
+    click_file = args.filename
+
+    # What we are doing here is basically what all the
+    # ./bin/click-check-* scripts do as well, so for
+    # example something like:
+    #
+    #     review = cr_push_helper.ClickReviewPushHelper(sys.argv[1])
+    #     review.do_checks()
+    #     rc = review.do_report()
+    #
+    results = {}
+    for module in get_modules():
+        review = init_main_class(module, click_file)
+        review.do_checks()
+        results[module.replace('cr_', '')] = review.click_report
+    rc = report(results, args)
+    sys.exit(rc)
+
+
+if __name__ == '__main__':
+    try:
+        main()
+    except KeyboardInterrupt:
+        print("Aborted.")
+        sys.exit(1)

=== modified file 'debian/changelog'
--- debian/changelog	2014-08-04 16:34:50 +0000
+++ debian/changelog	2014-08-22 13:22:57 +0000
@@ -12,7 +12,10 @@
   * Match scope review with actual ini file specifications. (LP: #1350427)
   * Point to the correct scope ini path.
 
- -- Jamie Strandboge <[e-mail]>  Wed, 30 Jul 2014 11:31:41 -0500
+  [ Daniel Holbach ]
+  * Add 'click-review', which just prints errors/warnings. (LP: #1355215)
+
+ -- Daniel Holbach <[e-mail]>  Wed, 20 Aug 2014 16:03:35 +0200
 
 click-reviewers-tools (0.8) utopic; urgency=medium
 

=== modified file 'run-pep8'
--- run-pep8	2014-08-22 13:18:27 +0000
+++ run-pep8	2014-08-22 13:22:57 +0000
@@ -2,7 +2,7 @@
 set -e
 
 echo "= pep8 ="
-for i in ./bin/update-* ./bin/click-check-* ./bin/click-show-files \
+for i in ./bin/update-* ./bin/click-check-* ./bin/click-show-files ./bin/click-review \
 	 ./clickreviews/*py ./clickreviews/tests/*py ; do
     echo "Checking $i"
     pep8 $i