renuo-bin-check 0.2.0

data/lib/renuo_bin_check/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module RenuoBinCheck
+  VERSION = '0.2.0'
+end

data/renuo-bin-check.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'renuo_bin_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'renuo-bin-check'
+  spec.version = RenuoBinCheck::VERSION
+  spec.authors = ['Zora Fuchs']
+  spec.email = ['zora.fuchs@renuo.ch']
+
+  spec.summary = 'renuo-bin-check automates running programms to check code quality of a ruby application.'
+  spec.description = 'With this gem you can automatically check your code quality (e.g. before every commit). You can configure it to run rubocop, reek, rspec and even custom scripts. For faster runtime it makes use of cashing and parallel execution.'
+  spec.homepage = 'https://github.com/renuo/renuo-bin-check'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  spec.add_development_dependency 'awesome_print',                '~> 1.7'
+  spec.add_development_dependency 'bundler',                      '~> 1.12'
+  spec.add_development_dependency 'byebug',                       '~> 9.0'
+  spec.add_development_dependency 'codeclimate-test-reporter',    '~> 0.5'
+  spec.add_development_dependency 'factory_girl',                 '~> 4.7'
+  spec.add_development_dependency 'pry',                          '~> 0.10'
+  spec.add_development_dependency 'pry-byebug',                   '~> 3.3'
+  spec.add_development_dependency 'rubocop',                      '~> 0.40'
+  spec.add_development_dependency 'rake',                         '~> 10.0'
+  spec.add_development_dependency 'reek',                         '~> 4.0'
+  spec.add_development_dependency 'rspec',                        '~> 3.4'
+  spec.add_development_dependency 'simplecov',                    '~> 0.11'
+end

data/spec/code_climate.travis.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+SimpleCov.add_filter 'config'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start

data/spec/factories/cacher.rb

@@ -0,0 +1,16 @@
+require './lib/renuo_bin_check/result'
+FactoryGirl.define do
+  factory :cacher, class: RenuoBinCheck::Cacher do
+    command 'script_name'
+    paths ['./spec/spec-files/file1', './spec/spec-files/file2']
+    initialize_with { new(command, paths) }
+
+    factory :not_found_cacher do
+      command 'script_name2'
+    end
+
+    factory :copy_found_cacher do
+      paths ['./spec/spec-files/file1', './spec/spec-files/file2_copy']
+    end
+  end
+end

data/spec/factories/result.rb

@@ -0,0 +1,29 @@
+require './lib/renuo_bin_check/result'
+FactoryGirl.define do
+  factory :result, class: RenuoBinCheck::Result do
+    standard_output "I passed\nThis is the second line\n"
+    error_output "I failed\nThis is the second line\n"
+    exit_code 0
+    initialize_with { new(standard_output, error_output, exit_code) }
+
+    factory :reversed_exit_result do
+      error_output "I passed\nThis is the second line\n"
+      standard_output "I failed\nThis is the second line\n"
+      exit_code 1
+    end
+
+    factory :overridden_output_result do
+      standard_output 'overridden standard_output'
+      error_output 'overridden error_output'
+    end
+
+    factory :appended_output_result do
+      standard_output "I passed\nThis is the second line\noverridden standard_output"
+      error_output "I failed\nThis is the second line\noverridden error_output"
+    end
+
+    factory :failed_result do
+      exit_code 1
+    end
+  end
+end

data/spec/factories/script_config.rb

@@ -0,0 +1,41 @@
+require './lib/renuo_bin_check/script_config'
+FactoryGirl.define do
+  factory :script, class: RenuoBinCheck::ScriptConfig do
+    script_command 'cool command'
+    script_name 'script_name'
+    script_files %w(cool_file1 cool_file1)
+
+    factory :failing_script do
+      script_command './spec/spec-files/test_script_exit1'
+      script_name 'exit1'
+    end
+
+    factory :passing_script do
+      script_command './spec/spec-files/test_script_exit0'
+      script_name 'exit0'
+
+      factory :without_files_script do
+        script_files nil
+      end
+
+      factory :with_overridden_output_script do
+        script_standard_output 'overridden standard_output'
+        script_error_output 'overridden error_output'
+      end
+
+      factory :with_appended_output_script do
+        appended_standard_output 'overridden standard_output'
+        appended_error_output 'overridden error_output'
+      end
+
+      factory :reversed_exit_script do
+        script_reversed_exit true
+      end
+    end
+
+    factory :cached_script do
+      script_command 'script_name'
+      script_files ['./spec/spec-files/file1', './spec/spec-files/file2']
+    end
+  end
+end

data/spec/integration/initializer_spec.rb

@@ -0,0 +1,209 @@
+require 'spec_helper'
+require './lib/renuo_bin_check/initializer'
+
+RSpec.describe RenuoBinCheck::Initializer do
+  let(:bin_check) { RenuoBinCheck::Initializer.new }
+
+  context 'without caching' do
+    it 'returns exit-code 0 and expected output' do
+      bin_check.check do |config|
+        config.command './spec/spec-files/test_script_exit0'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(0)
+        end
+      end.to output("I passed\nThis is the second line\n").to_stdout
+    end
+
+    it 'returns exit-code 0 and expected output' do
+      bin_check.check do |config|
+        config.command 'echo hello'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(0)
+        end
+      end.to output("hello\n").to_stdout
+    end
+
+    it 'returns exit-code 0 and expected overridden output' do
+      bin_check.check do |config|
+        config.command 'echo hello'
+        config.success_message 'I passed :)'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(0)
+        end
+      end.to output("I passed :)\n").to_stdout
+    end
+
+    it 'returns exit-code 0 and expected appended output' do
+      bin_check.check do |config|
+        config.command 'echo hello'
+        config.success_message '+I passed :)'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(0)
+        end
+      end.to output("hello\nI passed :)\n").to_stdout
+    end
+
+    it 'returns exit-code 1 and expected error-output' do
+      bin_check.check do |config|
+        config.command './spec/spec-files/test_script_exit1'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(1)
+        end
+      end.to output("I failed\nThis is the second line\n").to_stderr
+    end
+
+    it 'returns exit-code 1 and expected non-error-output' do
+      bin_check.check do |config|
+        config.command './spec/spec-files/test_script_exit1_no_error_output'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(1)
+        end
+      end.to output("I failed\nThis is the second line\n").to_stderr
+    end
+
+    it 'returns exit-code 1 and expected overridden error-output' do
+      bin_check.check do |config|
+        config.command './spec/spec-files/test_script_exit1'
+        config.error_message 'it failed...'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(1)
+        end
+      end.to output("it failed...\n").to_stderr
+    end
+
+    it 'returns exit-code 1 and expected appended error-output' do
+      bin_check.check do |config|
+        config.command './spec/spec-files/test_script_exit1'
+        config.error_message '+it failed...'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(1)
+        end
+      end.to output("I failed\nThis is the second line\nit failed...\n").to_stderr
+    end
+
+    it 'runns scripts parallel' do
+      start_time = Time.now
+      bin_check.check { |config| config.command './spec/spec-files/test_script_sleep1' }
+      bin_check.check { |config| config.command './spec/spec-files/test_script_sleep2' }
+      begin
+        bin_check.run
+      rescue SystemExit => se
+        expect(se.status).to eq(0)
+      end
+      end_time = Time.now
+      expect(end_time - start_time).to be_within(0.4).of(2)
+    end
+  end
+
+  context 'cached script' do
+    before(:each) do
+      FileUtils.mkdir_p 'tmp/bin-check/exit0/df57ab93c06ded11a01f2de950307019'
+      File.write 'tmp/bin-check/exit0/df57ab93c06ded11a01f2de950307019/standard_output',
+                 "I'm cached\npassed\n"
+      File.write 'tmp/bin-check/exit0/df57ab93c06ded11a01f2de950307019/error_output',
+                 "I'm cached\npassed\n"
+      File.write 'tmp/bin-check/exit0/df57ab93c06ded11a01f2de950307019/exit_code', 0
+    end
+
+    after(:each) { FileUtils.remove_dir('./tmp/bin-check') }
+
+    it 'returns cached output and exit-code' do
+      bin_check.check do |config|
+        config.command './spec/spec-files/test_script_exit0'
+        config.files %w(./spec/spec-files/file1 ./spec/spec-files/file2)
+        config.name 'exit0'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(0)
+        end
+      end.to output("I'm cached\npassed\n").to_stdout
+    end
+  end
+
+  context 'saving to exit0 folder' do
+    after(:each) { FileUtils.remove_dir('./tmp/bin-check') }
+
+    it 'saves output and exit-code to files in folder named by given name' do
+      bin_check.check do |config|
+        config.command './spec/spec-files/test_script_exit0'
+        config.files %w(./spec/spec-files/file1 ./spec/spec-files/file2)
+        config.name 'exit0'
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(0)
+        end
+      end.to output("I passed\nThis is the second line\n").to_stdout
+
+      expect(File.read('./tmp/bin-check/exit0/df57ab93c06ded11a01f2de950307019/error_output'))
+        .to eq("I failed\nThis is the second line\n")
+      expect(File.read('./tmp/bin-check/exit0/df57ab93c06ded11a01f2de950307019/standard_output'))
+        .to eq("I passed\nThis is the second line\n")
+      expect(File.read('./tmp/bin-check/exit0/df57ab93c06ded11a01f2de950307019/exit_code').to_i).to eq(0)
+    end
+  end
+
+  context 'saving to 65a98809d7447e9857b9acf1fbc89dcc folder' do
+    after(:each) { FileUtils.remove_dir('./tmp/bin-check') }
+
+    it 'saves output and exit-code to files in folder named by hashed command' do
+      bin_check.check do |config|
+        config.command './spec/spec-files/test_script_exit0'
+        config.files %w(./spec/spec-files/file1 ./spec/spec-files/file2)
+      end
+      expect do
+        begin
+          bin_check.run
+        rescue SystemExit => se
+          expect(se.status).to eq(0)
+        end
+      end.to output("I passed\nThis is the second line\n").to_stdout
+
+      expect(File.read('./tmp/bin-check/65a98809d7447e9857b9acf1fbc89dcc/'\
+                        'df57ab93c06ded11a01f2de950307019/error_output'))
+        .to eq("I failed\nThis is the second line\n")
+      expect(File.read('./tmp/bin-check/65a98809d7447e9857b9acf1fbc89dcc/'\
+                        'df57ab93c06ded11a01f2de950307019/standard_output'))
+        .to eq("I passed\nThis is the second line\n")
+      expect(File.read('./tmp/bin-check/65a98809d7447e9857b9acf1fbc89dcc/df57ab93c06ded11a01f2de950307019/exit_code')
+               .to_i).to eq(0)
+    end
+  end
+end

data/spec/renuo/bin-check/cacher_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require './lib/renuo_bin_check/cacher'
+
+RSpec.describe RenuoBinCheck::Cacher do
+  let(:result_attributes) { attributes_for(:result) }
+  let(:result) { build(:result) }
+  let(:cacher) { build(:cacher) }
+
+  context 'results are cashed' do
+    before(:each) do
+      FileUtils.mkdir_p 'tmp/bin-check/script_name/df57ab93c06ded11a01f2de950307019'
+      File.write 'tmp/bin-check/script_name/df57ab93c06ded11a01f2de950307019/standard_output',
+                 "I passed\nThis is the second line\n"
+      File.write 'tmp/bin-check/script_name/df57ab93c06ded11a01f2de950307019/error_output',
+                 "I failed\nThis is the second line\n"
+      File.write 'tmp/bin-check/script_name/df57ab93c06ded11a01f2de950307019/exit_code', 0
+    end
+
+    after(:each) { FileUtils.remove_dir('./tmp/bin-check') }
+
+    it 'returns result' do
+      expect(cacher.result).to have_attributes(result_attributes)
+    end
+
+    it 'recognizes different file names' do
+      cacher = build(:copy_found_cacher)
+      expect(cacher.exists?).to be_falsey
+    end
+  end
+
+  context 'cashes do not exist' do
+    let(:cacher) { build(:not_found_cacher) }
+    it 'returns new hash' do
+      expect(cacher.exists?).to be_falsey
+    end
+  end
+
+  context 'save results' do
+    after(:each) { FileUtils.remove_dir('./tmp/bin-check') }
+
+    it 'saves result to files' do
+      cacher.cache(result)
+      expect(File.read('./tmp/bin-check/script_name/df57ab93c06ded11a01f2de950307019/error_output'))
+        .to eq(result.error_output)
+      expect(File.read('./tmp/bin-check/script_name/df57ab93c06ded11a01f2de950307019/standard_output'))
+        .to eq(result.standard_output)
+      expect(File.read('./tmp/bin-check/script_name/df57ab93c06ded11a01f2de950307019/exit_code').to_i)
+        .to eq(result.exit_code)
+    end
+  end
+end

data/spec/renuo/bin-check/initializer_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require './lib/renuo_bin_check/initializer'
+
+RSpec.describe RenuoBinCheck::Initializer do
+  let(:bin_check) { RenuoBinCheck::Initializer.new }
+
+  it 'creates a MasterThread when it is initialized' do
+    expect(bin_check.master_thread.class).to eq(RenuoBinCheck::MasterThread)
+  end
+
+  it 'creates ScriptConfig and adds it to runner' do
+    bin_check.check do |config|
+      config.command 'blubb'
+      config.files %w(file1 file2)
+    end
+    expect(bin_check.master_thread.threads.last.class).to eq(Thread)
+  end
+
+  it 'makes runner handle the threads' do
+    expect(bin_check.master_thread).to receive(:finalize)
+    bin_check.run
+  end
+end

data/spec/renuo/bin-check/master_thread_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require './lib/renuo_bin_check/master_thread'
+
+RSpec.describe RenuoBinCheck::MasterThread do
+  let(:script) { build :script }
+  let(:printer) { RenuoBinCheck::Printer.new }
+  let(:master) { RenuoBinCheck::MasterThread.new(printer) }
+
+  it 'should add a serventThread when add_thread is called' do
+    master.add_thread(script)
+    expect(master.threads.size).to eq(1)
+    expect(master.threads.first.class).to eq(Thread)
+  end
+
+  it 'initializes the instance variable threads as empty array' do
+    expect(master.threads.empty?).to be_truthy
+  end
+
+  context 'one script fails' do
+    after(:each) { FileUtils.remove_dir('./tmp/bin-check') }
+    it 'exits with exit code 1' do
+      master.add_thread(build(:passing_script))
+      master.add_thread(build(:failing_script))
+      expect(master.printer).to receive(:print_error_output)
+      begin
+        master.finalize
+      rescue SystemExit => se
+        expect(se.status).to eq(1)
+      end
+    end
+  end
+
+  context 'all scripts pass' do
+    after(:each) { FileUtils.remove_dir('./tmp/bin-check') }
+    it 'exits with exit code 0' do
+      master.add_thread(build(:passing_script))
+      master.add_thread(build(:passing_script))
+      expect(master.printer).to receive(:print_standard_output)
+      begin
+        master.finalize
+      rescue SystemExit => se
+        expect(se.status).to eq(0)
+      end
+    end
+  end
+end