lint_trap 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23aa32b336fd40453d65df5401d7247f0cd78e64
-  data.tar.gz: e12d4b7aa5daa29c71115a4899fac0349f412fa7
+  metadata.gz: cd8b059140d1d4487ff867109b06886cee712990
+  data.tar.gz: 546a5bf4794e33d96cce6a0caf1eb06154f657e5
 SHA512:
-  metadata.gz: 26a47d1550add4667f8df11d355b04350ba47bd31b815632bfbfb35a27743177ae5e2f21a8f49ec1d12653a9e02388c5a73de1602064fd8159057e0c9f413c80
-  data.tar.gz: 72571debf32931940a598b6893b4e120c578a844cf302c62b194e80bdcd50b1455a2e4643b73d68de868c61d3368caa6b1ea71e8c124410d09632a962b50db43
+  metadata.gz: e5da1f4256d21805a0000e717de18bb7525544d1e9951ec6dff7c0532ba03815271fc0be2f85483fcc40d05545b26eb929cdaf143f0b1469394df5c050053e6a
+  data.tar.gz: 161a54aebfc888fa3cfe6524674be8f28dcddd23d9a35df5dcc0e66b903f92e57cbcc718aeb45a88393f6ed17f9c7beea57aca28cfe0a527c7456b7279d6aa98

data/Dockerfile

@@ -121,7 +121,7 @@ ENV JAVA_HOME /usr/lib/jvm/java-7-oracle
 
 ### Go
 # SCMs for "go get", gcc for cgo
-RUN apt-get update
+RUN apt-get update \
  && apt-get install -y \
     ca-certificates \
     curl \

data/Rakefile

@@ -1,11 +1,13 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'English'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require_relative 'lib/lint_trap'
 
 $stdout.sync = true
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 task :credentials do
   require 'fileutils'
@@ -19,13 +21,17 @@ task :credentials do
 end
 
 namespace :docker do
-  module Docker
+  class Docker
     DOCKER_CACHE_PATH = File.expand_path('~/.docker')
     DOCKER_IMAGE_PATH = File.join(DOCKER_CACHE_PATH, 'image.tar')
-    IMAGE_NAME = 'lintci/spin_cycle'
 
     BuildError = Class.new(StandardError)
 
+    attr_reader :linter
+
+    def initialize(linter)
+      @linter = linter
+    end
 
     def tag
       run("docker tag -f #{image_sha} #{image_latest}")
@@ -52,11 +58,11 @@ namespace :docker do
     end
 
     def build
-      run("docker build -t #{image_sha} .")
+      run("docker build -t #{image_sha} ./docker/#{linter.name.downcase}")
     end
 
     def push
-      run("docker login -e #{ENV['DOCKER_EMAIL']} -u #{ENV['DOCKER_USER']} -p #{ENV['DOCKER_PASSWORD']}")
+      run("docker login -e #{ENV['DOCKER_EMAIL']} -u #{ENV['DOCKER_USER']} -p #{ENV['DOCKER_PASSWORD']}", true)
       run("docker push #{image_sha}")
       run("docker push #{image_version}")
       run("docker push #{image_latest}")
@@ -64,25 +70,24 @@ namespace :docker do
 
   private
 
-    def run(command)
-      puts command
+    def run(command, suppress = false)
+      puts
+      puts command unless suppress
       system(command)
 
-      raise BuildError, 'There was a problem executing the command.' unless $? == 0
+      raise BuildError, 'There was a problem executing the command.' unless $CHILD_STATUS == 0
     end
 
     def image_sha
-      "#{IMAGE_NAME}:#{sha}"
+      "#{linter.image}:#{sha}"
     end
 
     def image_version
-      require_relative 'lib/lint_trap/version'
-
-      "#{IMAGE_NAME}:#{LintTrap::VERSION}"
+      linter.image_version
     end
 
     def image_latest
-      "#{IMAGE_NAME}:latest"
+      "#{linter.image}:latest"
     end
 
     def sha
@@ -90,12 +95,17 @@ namespace :docker do
     end
   end
 
-  include Docker
+  def for_each_linter(method)
+    LintTrap::Linter.all.each do |linter|
+      puts '', '#' * 80, linter.name, '#' * 80
+      Docker.new(linter).send(method)
+    end
+  end
 
-  task(:tag){tag}
-  task(:pull){pull}
-  task(:load){load}
-  task(:dump){dump}
-  task(:build){build}
-  task(:push){push}
+  task(:tag){for_each_linter(:tag)}
+  task(:pull){for_each_linter(:pull)}
+  task(:load){for_each_linter(:load)}
+  task(:dump){for_each_linter(:dump)}
+  task(:build){for_each_linter(:build)}
+  task(:push){for_each_linter(:push)}
 end

data/circle.yml

@@ -1,8 +1,6 @@
 machine:
   services:
     - docker
-  environment:
-    # DEBUG_LINTING: true
 checkout:
   pre:
     - git config --global user.email "circleci@lintci.com"

data/config/checkstyle/sun_checks.xml

@@ -39,6 +39,8 @@
         <property name="basedir" value="${basedir}"/>
     -->
 
+    <property name="fileExtensions" value="java, properties, xml"/>
+
     <!-- Checks that a package-info.java file exists for each package.     -->
     <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
     <!-- <module name="JavadocPackage"/> -->
@@ -152,7 +154,6 @@
         <module name="InnerAssignment"/>
         <module name="MagicNumber"/>
         <module name="MissingSwitchDefault"/>
-        <module name="RedundantThrows"/>
         <module name="SimplifyBooleanExpression"/>
         <module name="SimplifyBooleanReturn"/>
 

data/docker/checkstyle/Dockerfile

@@ -0,0 +1,19 @@
+FROM java:8u45-jre
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+# Bundled as config
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/coffeelint/Dockerfile

@@ -0,0 +1,21 @@
+FROM node:0.12.3-slim
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+ENV COFFEELINT_VERSION 1.9.7
+
+RUN npm install -g coffeelint@$COFFEELINT_VERSION
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/cppcheck/Dockerfile

@@ -0,0 +1,24 @@
+FROM debian:jessie
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+ENV CPPCHECK_VERSION 1.67-1
+
+RUN apt-get update \
+ && apt-get install -y \
+    cppcheck=$CPPCHECK_VERSION \
+ && rm -rf /var/lib/apt/lists/*
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/csslint/Dockerfile

@@ -0,0 +1,21 @@
+FROM node:0.12.3-slim
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+ENV CSSLINT_VERSION 0.10.0
+
+RUN npm install -g csslint@$CSSLINT_VERSION
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/golint/Dockerfile

@@ -0,0 +1,19 @@
+FROM golang:1.4.2
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+RUN go get github.com/golang/lint/golint
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/jshint/Dockerfile

@@ -0,0 +1,21 @@
+FROM node:0.12.3-slim
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+ENV JSHINT_VERSION 2.5.11
+
+RUN npm install -g jshint@$JSHINT_VERSION
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/jsonlint/Dockerfile

@@ -0,0 +1,21 @@
+FROM node:0.12.3-slim
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+ENV JSONLINT_VERSION 0.0.4
+
+RUN npm install -g durable-json-lint-cli@$JSONLINT_VERSION
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/pylint/Dockerfile

@@ -0,0 +1,24 @@
+FROM debian:jessie
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+ENV PYLINT_VERSION 1.3.1-3
+
+RUN apt-get update \
+ && apt-get install -y \
+    pylint=$PYLINT_VERSION \
+ && rm -rf /var/lib/apt/lists/*
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/rubocop/Dockerfile

@@ -0,0 +1,21 @@
+FROM ruby:2.2.2-slim
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+ENV RUBOCOP_VERSION 0.31.0
+
+RUN gem install rubocop:$RUBOCOP_VERSION
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/docker/scsslint/Dockerfile

@@ -0,0 +1,21 @@
+FROM ruby:2.2.2-slim
+MAINTAINER LintCI
+
+### Setup User ###
+ENV user lint_trap
+ENV group linters
+ENV homedir /src/
+
+RUN mkdir -p $homedir \
+ && groupadd -r $group -g 777 \
+ && useradd -u 666 -r -g $group -d $homedir -s /sbin/nologin -c "Docker image user" $user \
+ && chown -R $user:$group $homedir
+
+### Setup Linter ###
+ENV SCSSLINT_VERSION 0.38.0
+
+RUN gem install scss-lint:$SCSSLINT_VERSION
+
+### Defaults ###
+USER $user
+WORKDIR $homedir

data/lib/lint_trap/command.rb

@@ -14,11 +14,10 @@ module LintTrap
 
     def run(container)
       Bundler.with_clean_env do
-        puts command(container) if ENV['DEBUG_LINTING']
         Open3.popen2e(command(container)) do |_, stdout, thread|
-          yield stdout
+          yield stdout if block_given?
 
-          thread.join
+          thread.value.success?
         end
       end
     end

data/lib/lint_trap/container/base.rb

@@ -1,8 +1,11 @@
 require 'pathname'
+require_relative '../execution_error'
 
 module LintTrap
   module Container
     class Base
+      ImagePullError = Class.new(ExecutionError)
+
       LOCAL_CONFIG_PATH = Pathname.new(File.expand_path('../../../../config', __FILE__))
 
       def initialize(image, repo_path)
@@ -10,16 +13,20 @@ module LintTrap
         @repo_path = Pathname.new(repo_path)
       end
 
+      def pull
+        raise NotImplementedError, 'Must implement pull.'
+      end
+
       def wrap(_command)
-        raise NotImplementedError
+        raise NotImplementedError, 'Must implement wrap.'
       end
 
       def config_path(_path)
-        raise NotImplementedError
+        raise NotImplementedError, 'Must implement config_path.'
       end
 
       def file_path(_path)
-        raise NotImplementedError
+        raise NotImplementedError, 'Must implement file_path.'
       end
 
     protected

data/lib/lint_trap/container/docker.rb

@@ -1,12 +1,24 @@
 require_relative 'base'
 require 'pathname'
+require 'open3'
 
 module LintTrap
   module Container
     # Acts like a container, without actually requiring a container.
     class Docker < Base
-      CONFIG_PATH = Pathname.new('/opt/lint_trap/config')
-      CODE_PATH = Pathname.new('/home/spin_cycle')
+      CONFIG_PATH = Pathname.new('/config')
+      CODE_PATH = Pathname.new('/src')
+
+      def pull
+        command = "docker pull #{image}"
+        Open3.popen2e(command) do |_, stdout, thread|
+          if thread.value.success?
+            true
+          else
+            raise ImagePullError.new(command, stdout.read)
+          end
+        end
+      end
 
       def wrap(command)
         "docker run #{flags} #{image} #{command}"
@@ -34,11 +46,12 @@ module LintTrap
         [
           # '-m', '50m', # memory
           # '-c', '1', # number of cpus
+          '--net="none"',
           '--privileged=false',
           '-v', "#{LOCAL_CONFIG_PATH}:#{CONFIG_PATH}",
           '-v', "#{repo_path}:#{CODE_PATH}",
           "--workdir=#{CODE_PATH}",
-          '--user=spin_cycle'
+          '--user=lint_trap'
         ].join(' ')
       end
     end

data/lib/lint_trap/container/fake.rb

@@ -8,6 +8,9 @@ module LintTrap
         super('no/image', 'local')
       end
 
+      def pull
+      end
+
       def wrap(command)
         command
       end

data/lib/lint_trap/execution_error.rb

@@ -0,0 +1,12 @@
+module LintTrap
+  # Error thrown from code that executes an external command.
+  class ExecutionError < StandardError
+    attr_reader :command, :output
+
+    def initialize(command, output)
+      super("An error occurred while running `#{command}`. The output was:\n#{output}")
+      @command = command
+      @output = output
+    end
+  end
+end

data/lib/lint_trap/linter/base.rb

@@ -1,8 +1,11 @@
 require_relative '../parser/standard'
 require_relative '../command'
+require_relative '../execution_error'
 
 module LintTrap
   module Linter
+    LintError = Class.new(ExecutionError)
+
     # The base class for all linters. Provides a template for linter execution.
     class Base
       CONFIG_PATH = File.expand_path('../../../../config', __FILE__)
@@ -10,19 +13,35 @@ module LintTrap
       def lint(files, container, options)
         return unless known?
 
-        @container, @options = container, options
-
-        command(files).run(container) do |stdout|
-          parser(stdout).parse do |violation|
+        violations_found, remaining_output = false, ''
+        success = command(files, container, options).run(container) do |stdout|
+          remaining_output = parser(stdout, container).parse do |violation|
+            violations_found = true
             yield violation
           end
         end
+
+        if !violations_found && !success
+          raise LintError.new(command(files, container, options).to_s(container), remaining_output)
+        end
       end
 
       def name
         self.class.name.split('::').last
       end
 
+      def version
+        raise NotImplementedError, 'Must implement version.'
+      end
+
+      def image
+        "lintci/#{name.downcase}"
+      end
+
+      def image_version
+        "#{image}:#{version}"
+      end
+
       def languages(*classes)
         classes.map(&:new)
       end
@@ -41,29 +60,21 @@ module LintTrap
         "<#{name}>"
       end
 
-    protected
-
-      attr_reader :container, :options
-
     private
 
-      def command(files)
-        Command.new(command_name, flags, files)
+      def command(files, container, options)
+        Command.new(command_name(container), flags(container, options), files)
       end
 
-      def parser(stdout)
+      def parser(stdout, container)
         LintTrap::Parser::Standard.new(stdout, container)
       end
 
-      def config_path(path)
-        container.config_path(path)
-      end
-
-      def flags(options)
-        raise NotImplementedError, 'Method flags must be implemented.'
+      def flags(_container, _options)
+        raise NotImplementedError, 'Must implement flags.'
       end
 
-      def command_name
+      def command_name(_container)
         name.downcase
       end
     end

data/lib/lint_trap/linter/checkstyle.rb

@@ -4,23 +4,30 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to checkstyle command line tool.
     class CheckStyle < Base
-      JAR = 'checkstyle/checkstyle_logger-all.jar'
       CHECKS_XML = 'checkstyle/sun_checks.xml'
 
       def languages
         super(Language::Java)
       end
 
+      def version
+        '6.6'
+      end
+
+      def jar
+        "checkstyle/checkstyle_logger-#{version}-all.jar"
+      end
+
     private
 
-      def command_name
+      def command_name(_container)
         'java'
       end
 
-      def flags
+      def flags(container, options)
         [
-          '-jar', config_path(JAR),
-          '-c', options[:config] || config_path(CHECKS_XML)
+          '-jar', container.config_path(jar),
+          '-c', options[:config] || container.config_path(CHECKS_XML)
         ]
       end
     end

data/lib/lint_trap/linter/coffeelint.rb

@@ -10,11 +10,15 @@ module LintTrap
         super(Language::CoffeeScript)
       end
 
+      def version
+        '1.9.7'
+      end
+
     private
 
-      def flags
+      def flags(container, options)
         [
-          "--reporter=#{config_path(REPORTER)}",
+          "--reporter=#{container.config_path(REPORTER)}",
           '--nocolor'
         ].tap do |flags|
           flags.concat(["--file=#{options[:config]}"]) if options[:config]

data/lib/lint_trap/linter/cppcheck.rb

@@ -8,9 +8,13 @@ module LintTrap
         super(Language::CPP)
       end
 
+      def version
+        '1.67-1'
+      end
+
     private
 
-      def flags
+      def flags(_container, _options)
         [
           '--enable=all',
           '--error-exitcode=1',