Merge pull request #111 from plone/correct-exit-codes

Return correct exit codes in console scripts, fixes #66
plone · Apr 26, 2015 · bd2229b · bd2229b
2 parents b84e5c2 + ec21b08
commit bd2229b
Show file tree

Hide file tree

Showing 16 changed files with 37 additions and 14 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,6 +4,9 @@ Change history
 2.0.0 (unreleased)
 ------------------
 
+- Return correct exit codes for console-scripts, fixes #66.
+  [saily]
+
 - Refactor whole linters framework to use OO design patterns, inherit from
   ``Analyser`` abstract base class. This fixes #62
   [saily]

diff --git a/plone/recipe/codeanalysis/analyser.py b/plone/recipe/codeanalysis/analyser.py
@@ -16,6 +16,12 @@ def is_string(unknown):
     return isinstance(unknown, str)
 
 
+def console_factory(klass, options):
+    if not klass(options).run():
+        sys.exit(1)
+    sys.exit(0)
+
+
 class Analyser:
 
     __metaclass__ = ABCMeta

diff --git a/plone/recipe/codeanalysis/clean_lines.py b/plone/recipe/codeanalysis/clean_lines.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from plone.recipe.codeanalysis.analyser import Analyser
+from plone.recipe.codeanalysis.analyser import console_factory
 import re
 
 
@@ -102,4 +103,4 @@ def run(self):
 
 
 def console_script(options):
-    return CleanLines(options).run()
+    console_factory(CleanLines, options)
diff --git a/plone/recipe/codeanalysis/csslint.py b/plone/recipe/codeanalysis/csslint.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from plone.recipe.codeanalysis.analyser import Analyser
+from plone.recipe.codeanalysis.analyser import console_factory
 import re
 
 
@@ -39,4 +40,4 @@ def parse_output(self, output_file, return_code):
 
 
 def console_script(options):
-    return CSSLint(options).run()
+    console_factory(CSSLint, options)
diff --git a/plone/recipe/codeanalysis/debug_statements.py b/plone/recipe/codeanalysis/debug_statements.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from plone.recipe.codeanalysis.analyser import console_factory
 from plone.recipe.codeanalysis.clean_lines import CleanLines
 
 
@@ -24,4 +25,4 @@ class DebugStatements(CleanLines):
 
 
 def console_script(options):
-    return DebugStatements(options).run()
+    console_factory(DebugStatements, options)
diff --git a/plone/recipe/codeanalysis/deprecated_aliases.py b/plone/recipe/codeanalysis/deprecated_aliases.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from plone.recipe.codeanalysis.analyser import console_factory
 from plone.recipe.codeanalysis.clean_lines import CleanLines
 
 
@@ -45,4 +46,4 @@ def check(self, file_path, fail={}, **kwargs):
 
 
 def console_script(options):
-    return DeprecatedAliases(options).run()
+    console_factory(DeprecatedAliases, options)
diff --git a/plone/recipe/codeanalysis/flake8.py b/plone/recipe/codeanalysis/flake8.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from plone.recipe.codeanalysis.analyser import Analyser
+from plone.recipe.codeanalysis.analyser import console_factory
 import os
 
 
@@ -37,4 +38,4 @@ def open_output_file(self):
 
 
 def console_script(options):
-    return Flake8(options).run()
+    console_factory(Flake8, options)
diff --git a/plone/recipe/codeanalysis/i18ndude.py b/plone/recipe/codeanalysis/i18ndude.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from plone.recipe.codeanalysis.analyser import Analyser
+from plone.recipe.codeanalysis.analyser import console_factory
 
 
 class I18NDude(Analyser):
@@ -21,4 +22,4 @@ def cmd(self):
 
 
 def console_script(options):
-    return I18NDude(options).run()
+    console_factory(I18NDude, options)
diff --git a/plone/recipe/codeanalysis/imports.py b/plone/recipe/codeanalysis/imports.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from plone.recipe.codeanalysis.analyser import console_factory
 from plone.recipe.codeanalysis.clean_lines import CleanLines
 import re
 
@@ -78,4 +79,4 @@ def check(self, file_path, fail={}, **kwargs):
 
 
 def console_script(options):
-    return Imports(options).run()
+    console_factory(Imports, options)
diff --git a/plone/recipe/codeanalysis/jscs.py b/plone/recipe/codeanalysis/jscs.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from plone.recipe.codeanalysis.analyser import Analyser
+from plone.recipe.codeanalysis.analyser import console_factory
 import re
 
 
@@ -52,4 +53,4 @@ def parse_output(self, output_file, return_code):
 
 
 def console_script(options):
-    return JSCS(options).run()
+    console_factory(JSCS, options)
diff --git a/plone/recipe/codeanalysis/jshint.py b/plone/recipe/codeanalysis/jshint.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from plone.recipe.codeanalysis.analyser import Analyser
+from plone.recipe.codeanalysis.analyser import console_factory
 import re
 
 
@@ -43,4 +44,4 @@ def parse_output(self, output_file, return_code):
 
 
 def console_script(options):
-    return JSHint(options).run()
+    console_factory(JSHint, options)
diff --git a/plone/recipe/codeanalysis/pep3101.py b/plone/recipe/codeanalysis/pep3101.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from plone.recipe.codeanalysis.analyser import console_factory
 from plone.recipe.codeanalysis.clean_lines import CleanLines
 
 
@@ -17,4 +18,4 @@ class PEP3101(CleanLines):
 
 
 def console_script(options):
-    return PEP3101(options).run()
+    console_factory(PEP3101, options)
diff --git a/plone/recipe/codeanalysis/py_hasattr.py b/plone/recipe/codeanalysis/py_hasattr.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from plone.recipe.codeanalysis.analyser import console_factory
 from plone.recipe.codeanalysis.clean_lines import CleanLines
 
 
@@ -19,4 +20,4 @@ class HasAttr(CleanLines):
 
 
 def console_script(options):
-    return HasAttr(options).run()
+    console_factory(HasAttr, options)
diff --git a/plone/recipe/codeanalysis/python_utf8_header.py b/plone/recipe/codeanalysis/python_utf8_header.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from plone.recipe.codeanalysis.analyser import console_factory
 from plone.recipe.codeanalysis.clean_lines import CleanLines
 import re
 
@@ -31,4 +32,4 @@ def check(self, file_path, succeed, **kwargs):
 
 
 def console_script(options):
-    return UTF8Headers(options).run()
+    console_factory(UTF8Headers, options)
diff --git a/plone/recipe/codeanalysis/quoting.py b/plone/recipe/codeanalysis/quoting.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from plone.recipe.codeanalysis.analyser import console_factory
 from plone.recipe.codeanalysis.clean_lines import CleanLines
 
 
@@ -60,4 +61,4 @@ def check(self, file_path, **kwargs):
 
 
 def console_script(options):
-    return PreferSingleQuotes(options).run()
+    console_factory(PreferSingleQuotes, options)
diff --git a/plone/recipe/codeanalysis/zptlint.py b/plone/recipe/codeanalysis/zptlint.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from plone.recipe.codeanalysis.analyser import Analyser
+from plone.recipe.codeanalysis.analyser import console_factory
 
 
 class ZPTLint(Analyser):
@@ -35,4 +36,4 @@ def parse_output(self, output_file, return_code):
 
 
 def console_script(options):
-    return ZPTLint(options).run()
+    console_factory(ZPTLint, options)