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

[Daniel Holbach]

[Martin Albisetti (beuno)]

review: Approve

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

236. By Daniel Holbach on 2014-09-01

merge lp:~dholbach/click-reviewers-tools/click-review-refactor again

237. By Daniel Holbach on 2014-09-01

indicate which section is being printed out

238. By Daniel Holbach on 2014-09-01

simplify --sdk output format, fix pep8 issues

239. By Daniel Holbach on 2014-09-01

fix typo in comment

[Benjamin Zeller (zeller-benjamin)]

OK!

review: Approve

=== modified file 'bin/click-review'
--- bin/click-review	2014-09-01 14:52:40 +0000
+++ bin/click-review	2014-09-01 14:52:40 +0000
@@ -35,7 +35,7 @@
         self.click_fn = self.args.filename
         self.cr_modules = modules.get_modules()
 
-    def _analyse_results(self):
+    def _sumarise_results(self):
         for module in self.results:
             for key in self.results[module]['error']:
                 self.errors[key] = self.results[module]['error'][key]
@@ -45,10 +45,13 @@
                 for key in self.results[module]['info']:
                     self.info[key] = self.results[module]['info'][key]
 
-    def _report(self):
-        self._analyse_results()
+    def _complete_report(self):
+        self._sumarise_results()
 
-        if not self.args.json:
+        if self.args.json:
+            print(json.dumps(self.results, sort_keys=True, indent=2,
+                             separators=(',', ': ')))
+        else:
             print_findings(self.errors, 'Errors')
             print_findings(self.warnings, 'Warnings')
             if self.args.verbose:
@@ -57,12 +60,23 @@
                 print('%s: FAIL' % self.args.filename)
             else:
                 print('%s: pass' % self.args.filename)
-        else:
-            print(json.dumps(self.results, sort_keys=True, indent=2,
-                             separators=(',', ': ')))
         if self.warnings or self.errors:
             self.rc = 1
 
+    def _report_module(self, section):
+        '''
+        This is currently only used in the --sdk option.
+        It will print the output for each section when it's
+        available. This will prevent the SDK from having to wait
+        until all checks have been run.
+        '''
+        output = self.results[section]
+        print('= %s =' % section)
+        print(json.dumps(output, sort_keys=True, indent=2,
+                         separators=(',', ': ')))
+        if output['error'] or output['warn']:
+            self.rc = 1
+
     def _run_module_checks(self, module):
         # What we are doing here is basically what all the
         # ./bin/click-check-* scripts do as well, so for
@@ -72,14 +86,21 @@
         #     review.do_checks()
         #     rc = review.do_report()
         #
+        section = module.replace('cr_', '')
         review = modules.init_main_class(module, self.click_fn)
         review.do_checks()
-        self.results[module.replace('cr_', '')] = review.click_report
+        self.results[section] = review.click_report
+        return section
 
     def run_all_checks(self):
-        for module in self.cr_modules:
-            self._run_module_checks(module)
-        self._report()
+        if self.args.sdk:
+            for module in self.cr_modules:
+                section = self._run_module_checks(module)
+                self._report_module(section)
+        else:
+            for module in self.cr_modules:
+                self._run_module_checks(module)
+            self._complete_report()
 
 
 def main():
@@ -91,6 +112,9 @@
                         action='store_true')
     parser.add_argument('--json', help='print json output',
                         action='store_true')
+    parser.add_argument('--sdk',
+                        help='use output format suitable for the Ubuntu SDK',
+                        action='store_true')
     args = parser.parse_args()
 
     if not os.path.exists(args.filename):

=== modified file 'debian/changelog'
--- debian/changelog	2014-09-01 14:52:40 +0000
+++ debian/changelog	2014-09-01 14:52:40 +0000
@@ -3,6 +3,7 @@
   * Split out code to find Click*Review classes in the clickreviews package
     into its own module, add tests for it.
   * Refactor bin/click-review to make it easier to extend.
+  * Add --sdk option, so the SDK can start using it. (LP: #1363857)
 
  -- Daniel Holbach <[e-mail]>  Wed, 27 Aug 2014 16:22:03 +0200