Add jshint

discover_jenkins/settings.py

@@ -15,3 +15,7 @@ COVERAGE_MEASURE_BRANCH = getattr(settings, 'TEST_COVERAGE_MEASURE_BRANCH', True
 COVERAGE_EXCLUDES = getattr(settings, 'TEST_COVERAGE_EXCLUDES', [])
 COVERAGE_EXCLUDES_FOLDERS = getattr(settings, 'TEST_COVERAGE_EXCLUDES_FOLDERS', [])
 COVERAGE_RCFILE = getattr(settings, 'TEST_COVERAGE_RCFILE', 'coverage.rc')
+
+JSHINT_CHECKED_FILES = getattr(settings, 'TEST_JSHINT_CHECKED_FILES', None)
+JSHINT_RCFILE = getattr(settings, 'TEST_JSHINT_RCFILE', None)
+JSHINT_EXCLUDE = getattr(settings, 'TEST_JSHINT_EXCLUDE', [])

discover_jenkins/tasks/run_jshint.py

@@ -0,0 +1,134 @@
+# -*- coding: utf-8 -*-
+import os
+import sys
+import codecs
+import fnmatch
+import subprocess
+from optparse import make_option
+
+from django.conf import settings as django_settings
+
+from ..utils import CalledProcessError, get_app_locations
+from ..settings import JSHINT_CHECKED_FILES, JSHINT_RCFILE, JSHINT_EXCLUDE
+
+
+class Task(object):
+    option_list = (
+        make_option(
+            "--jshint-no-staticdirs",
+            dest="jshint-no-staticdirs",
+            default=False,
+            action="store_true",
+            help="Don't check js files located in STATICFILES_DIRS settings"
+        ),
+        make_option(
+            "--jshint-with-minjs",
+            dest="jshint_with-minjs",
+            default=False,
+            action="store_true",
+            help="Do not ignore .min.js files"
+        ),
+        make_option(
+            "--jshint-exclude",
+            dest="jshint_exclude",
+            default=JSHINT_EXCLUDE,
+            help="Exclude patterns"
+        ),
+        make_option(
+            '--jshint-stdout',
+            action='store_true',
+            dest='jshint_stdout',
+            default=False,
+            help='Print the jshint output instead of storing it in a file'
+        ),
+        make_option(
+            '--jshint-rcfile',
+            dest='jshint_rcfile',
+            default=JSHINT_RCFILE,
+            help='Provide an rcfile for jshint'
+        ),
+    )
+
+    def __init__(self, **options):
+        self.to_stdout = options['jshint_stdout']
+        self.no_static_dirs = options['jshint-no-staticdirs']
+        self.jshint_with_minjs = options['jshint_with-minjs']
+        self.jshint_rcfile = options['jshint_rcfile']
+
+        if self.to_stdout:
+            self.output = sys.stdout
+        else:
+            output_dir = options['output_dir']
+            if not os.path.exists(output_dir):
+                os.makedirs(output_dir)
+            self.output = codecs.open(os.path.join(output_dir,
+                                                   'jshint.xml'), 'w', 'utf-8')
+
+        self.exclude = options['jshint_exclude']
+        if isinstance(self.exclude, str):
+            self.exclude = self.exclude.split(',')
+
+    def teardown_test_environment(self, **kwargs):
+        files = [path for path in self.static_files_iterator()]
+
+        cmd = ['jshint']
+        if not self.to_stdout:
+            cmd += ['--jslint-reporter']
+        if self.jshint_rcfile is not None:
+            cmd += ['--config=%s' % self.jshint_rcfile]
+        cmd += files
+
+        process = subprocess.Popen(cmd, stdout=subprocess.PIPE)
+        output, err = process.communicate()
+        retcode = process.poll()
+        if retcode not in [0, 2]:  # normal jshint return codes
+            raise CalledProcessError(retcode, cmd, output=output + '\n' + err)
+
+        self.output.write(output.decode('utf-8'))
+
+    def static_files_iterator(self):
+        locations = get_app_locations()
+
+        def in_tested_locations(path):
+            if not self.jshint_with_minjs and path.endswith('.min.js'):
+                return False
+
+            for location in list(locations):
+                if path.startswith(location):
+                    return True
+            if not self.no_static_dirs:
+                for location in list(django_settings.STATICFILES_DIRS):
+                    if path.startswith(location):
+                        return True
+            return False
+
+        def is_excluded(path):
+            for pattern in self.exclude:
+                if fnmatch.fnmatchcase(path, pattern):
+                    return True
+            return False
+
+        if JSHINT_CHECKED_FILES:
+            for path in JSHINT_CHECKED_FILES:
+                yield path
+
+        if 'django.contrib.staticfiles' in django_settings.INSTALLED_APPS:
+            # use django.contrib.staticfiles
+            from django.contrib.staticfiles import finders
+
+            for finder in finders.get_finders():
+                for path, storage in finder.list(self.exclude):
+                    path = os.path.join(storage.location, path)
+                    if path.endswith('.js') and in_tested_locations(path):
+                        yield path
+        else:
+            # scan apps directories for static folders
+            for location in locations:
+                for dirpath, dirnames, filenames in \
+                        os.walk(os.path.join(location, 'static')):
+                    for filename in filenames:
+                        path = os.path.join(dirpath, filename)
+                        if filename.endswith('.js') and \
+                                in_tested_locations(path) and not \
+                                    is_excluded(path):
+                            yield path