tinyci 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47b37576bb6ac9c337d92fa29e1967320e9ca355
-  data.tar.gz: 3e68ee67c57669dcc988ebc90e68a0788661fffc
+  metadata.gz: 5531654099be53cbad1500af1c180555e4453396
+  data.tar.gz: 4f90146f6f2aaf50b78fa162a363a8d80666f810
 SHA512:
-  metadata.gz: 38eebd3406dfc95334e81af417ceeb5d0cf1e3d5b20c3122a038ba53d11fc6f2425e169f94ce7e28b64fee00ed31d65e33a238eb4772523457324efd82646e03
-  data.tar.gz: a0a96088a883f5f7d8a5d9f93e7aaa7ede84b7419215e1bf6e85459e6e59b1f54c72bc272274edf477461e1cbcf1c9d05953e08cf838b109b49171136d9bff73
+  metadata.gz: 697dbb6e5e32e9bede86917e1466093180c87a0a327946ffcc12fab7fcc7c06aad91be64d11004cccef9f127a96dd892bdfbaf1783dce2ca233eb5b779efd355
+  data.tar.gz: 48097b1dc7213415c2d462dc055beb50ab77b6467f71f488dd12e34870ec59f7e2ce4abb41e00d5a135b2c8a0eafff37b69221c409c39aef2058448c67f9d17b

data/.gitignore

@@ -5,3 +5,4 @@ spec/support/repos/*
 spec/examples.txt
 tmp
 pkg
+coverage

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  
+Metrics/LineLength:
+  Max: 100
+

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+0.2.0 - October 13, 2018
+  Add hooks
+0.1.2 - August 16, 2018
+  Make runner tests platform independent
+  Remove unneccesary concurrency from Subprocesses#execute_stream
+0.1.1 - May 09, 2018
+  Update executors to use the shell so relative paths are resolved properly
+0.1.0 - May 01, 2018
+  Initial release

data/Gemfile

@@ -1,13 +1,4 @@
 # frozen_string_literal: true
 source "https://rubygems.org"
 
-gem 'pry-byebug'
-# gem 'byebug'
-# gem 'pry-doc'
-gem 'pry'
-gem 'guard-rspec'
-gem 'fuubar'
-gem 'rspec-nc'
-gem 'terminal-notifier', '1.7.1'
-
 gemspec

data/Gemfile.lock

@@ -1,16 +1,18 @@
 PATH
   remote: .
   specs:
-    tinyci (0.1.2)
+    tinyci (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     awesome_print (1.8.0)
     barrier (1.0.2)
     byebug (9.1.0)
     coderay (1.1.2)
     diff-lcs (1.3)
+    docile (1.3.1)
     ffi (1.9.18)
     formatador (0.2.5)
     fuubar (2.2.0)
@@ -30,6 +32,8 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -40,38 +44,57 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
     pry (0.11.1)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-byebug (3.5.0)
       byebug (~> 9.1)
       pry (~> 0.10)
+    rainbow (3.0.0)
     rake (12.1.0)
     rb-fsevent (0.10.2)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
     redcarpet (3.4.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
+      rspec-support (~> 3.8.0)
     rspec-nc (0.3.0)
       rspec (>= 3)
       terminal-notifier (>= 1.4)
-    rspec-support (3.6.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
     ruby_dep (1.5.0)
     shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     terminal-notifier (1.7.1)
     thor (0.20.0)
+    unicode-display_width (1.4.0)
     yard (0.9.12)
 
 PLATFORMS
@@ -89,9 +112,11 @@ DEPENDENCIES
   redcarpet
   rspec
   rspec-nc
+  rubocop
+  simplecov
   terminal-notifier (= 1.7.1)
   tinyci!
   yard
 
 BUNDLED WITH
-   1.16.2
+   1.16.3

data/Guardfile

@@ -2,6 +2,6 @@ interactor :off
 
 guard :rspec, cmd: "bundle exec rspec", all_after_pass: true, all_on_start: true do
   watch(%r{^lib\/tinyci\/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  # watch(%r{spec\/support\/.+})       { "spec" }
+  watch(%r{spec\/support\/.+})       { "spec" }
   watch(%r{^spec\/.+_spec\.rb$})
 end

data/README.md

@@ -69,6 +69,44 @@ It is of course possible that commits might be pushed consistently faster than t
 
 If you look in the source code you will also find `RktBuilder` and `RktTester`, these were experimental attempts to integrate the Rkt container runtime. They are not recommended for use but are left for users to examine.
 
+#### Hooks
+
+TinyCI supports hooks/callbacks, much like git itself. Here is the order of execution:
+
+```
+  * clean
+  * export
+
+  before_build
+  
+  * build
+  
+  after_build
+  after_build_success
+  after_build_failure
+  
+  before_test
+  
+  * test
+  
+  after_test
+  after_test_success
+  after_test_failure
+```
+
+`*` indicates an actual phase of TinyCI's execution, the rest are callbacks.
+
+Note that the `before_build` and `before_test` hooks will halt the processing of the commit completely if they fail (ie. return a status > 0)
+
+To setup hooks, define a section like this in your config file:
+
+```
+hooker:
+  class: ScriptHooker
+  config:
+    after_build: ./after_build.sh
+```
+
 #### Logging/Output
 
 TinyCI is executed in a `post-update` git hook. As such, the output is shown to the user as part of the local call to `git push`. Once the TinyCI hook is running, the local git process can be freely killed if the user does not wish to watch the output - this will not affect the remote execution of TinyCI.
@@ -77,8 +115,6 @@ As well as logging to stdout, the TinyCI process writes a `tinyci.log` file in e
 
 #### Limitations/TODO
 
-* TinyCI currently has no support for running a script on success or failure of the test script. This feature would allow for notifications to be sent, eg. slack bots, email, etc. It would also enable TinyCI to act as part of an automated deployment system.
-
 * As mentioned above, when TinyCI is executed against a commit without a configuration file, it exports the whole directory, finds the config file to be missing, then deletes the export. As such, when TinyCI installed against an existing project with many commits, this process will happen for every commit, wasting a lot of time and churning the disk.  
 Instead, it would be preferable to check for the config file before doing the export, with a call to `git-cat-file`. An additional way to handle this would be to prevent the processing of commits created prior to the installation of TinyCI, perhaps by marking them with git-notes at install time, or by checking the creation date of the hook file.
  

data/lib/tinyci/hookers/script_hooker.rb

@@ -0,0 +1,59 @@
+require 'tinyci/executor'
+
+module TinyCI
+  module Hookers
+    class ScriptHooker < TinyCI::Executor
+      # All the hooks
+      HOOKS = %w{
+        before_build
+        
+        after_build
+        after_build_success
+        after_build_failure
+        
+        before_test
+        
+        after_test
+        after_test_success
+        after_test_failure
+      }
+      
+      # Those hooks that will halt exectution if they fail
+      BLOCKING_HOOKS = %w{
+        before_build
+        before_test
+      }
+      
+      HOOKS.each do |hook|
+        define_method hook+"_present?" do
+          @config.key? hook.to_sym
+        end
+        
+        define_method hook+"!" do
+          return unless send("#{hook}_present?")
+          
+          log_info "executing #{hook} hook..."
+          begin
+            execute_stream(script_location(hook), label: hook, pwd: @config[:target])
+            
+            return true
+          rescue SubprocessError => e
+            if BLOCKING_HOOKS.include? hook
+              raise e if ENV['TINYCI_ENV'] == 'test'
+              
+              log_error e
+              
+              return false
+            else
+              return true
+            end
+          end
+        end
+      end
+      
+      def script_location(hook)
+        ['/bin/sh', '-c', "'#{@config[hook.to_sym]}'"]
+      end
+    end
+  end
+end

data/lib/tinyci/runner.rb

@@ -11,6 +11,7 @@ require 'tinyci/testers/rkt_tester'
 
 require 'tinyci/builders/script_builder'
 require 'tinyci/testers/script_tester'
+require 'tinyci/hookers/script_hooker'
 
 require 'fileutils'
 
@@ -24,7 +25,7 @@ module TinyCI
     include GitUtils
     include Logging
     
-    attr_accessor :builder, :tester
+    attr_accessor :builder, :tester, :hooker
     
     # Constructor, allows injection of generic configuration params.
     # 
@@ -69,29 +70,77 @@ module TinyCI
         end
         @builder ||= instantiate_builder
         @tester  ||= instantiate_tester
+        @hooker  ||= instantiate_hooker
         
         log_info "Building..."
-        @builder.build
+        run_hook! :before_build
+        begin
+          @builder.build
+          run_hook! :after_build_success
+        rescue => e
+          run_hook! :after_build_failure
+          
+          raise e if ENV['TINYCI_ENV'] == 'test'
+          
+          log_error e
+          log_error e.backtrace
+          
+          return false
+        ensure
+          run_hook! :after_build
+        end
         
-        log_info "Testing..."
-        @tester.test
         
-        log_info "Finished #{@commit}"
-      rescue => e
+        log_info "Testing..."
+        run_hook! :before_test
+        begin
+          @tester.test
+        rescue => e
+          run_hook! :after_test_failure
+          
           raise e if ENV['TINYCI_ENV'] == 'test'
           
           log_error e
           log_error e.backtrace
+          
+          return false
+        ensure
+          run_hook! :after_test
+        end
+        
+        run_hook! :after_test_success
+        
+        
+        log_info "Finished #{@commit}"
+      rescue => e
+        raise e if ENV['TINYCI_ENV'] == 'test'
+        
+        log_error e
+        log_error e.backtrace
         return false
-      ensure
-
       end
       
       true
     end
     
+    # Build the absolute target path
+    def target_path
+      File.absolute_path("#{@working_dir}/builds/#{@time.to_i}_#{@commit}/")
+    end
+    
+    # Build the export path
+    def export_path
+      File.join(target_path, 'export')
+    end
+    
     private
     
+    def run_hook!(name)
+      return unless @hooker
+      
+      @hooker.send("#{name}!")
+    end
+    
     # Creates log file if it doesnt exist
     def setup_log
       return unless @logger.is_a? MultiLogger
@@ -115,6 +164,14 @@ module TinyCI
       klass.new(@config[:tester][:config].merge(target: export_path), logger: @logger)
     end
     
+    # Instantiate the Hooker object according to the class named in the config
+    def instantiate_hooker
+      return nil unless @config[:hooker].is_a? Hash
+      
+      klass = TinyCI::Hookers.const_get(@config[:hooker][:class])
+      klass.new(@config[:hooker][:config].merge(target: export_path), logger: @logger)
+    end
+    
     # Instantiate the {Config} object from the `.tinyci.yml` file in the exported directory
     def load_config
       @config ||= Config.new(working_dir: export_path)
@@ -125,16 +182,6 @@ module TinyCI
       Time.at execute(git_cmd('show', '-s', '--format=%ct', @commit)).to_i
     end
 
-    # Build the absolute target path
-    def target_path
-      File.absolute_path("#{@working_dir}/builds/#{@time.to_i}_#{@commit}/")
-    end
-    
-    # Build the export path
-    def export_path
-      File.join(target_path, 'export')
-    end
-
     def ensure_path(path)
       execute 'mkdir', '-p', path
     end

data/lib/tinyci/subprocesses.rb

@@ -89,7 +89,7 @@ module TinyCI
       attr_reader :status
       attr_reader :command
       
-      def initialize(label, command, status, message = "`#{label || command}` failed with code #{status.to_i}")
+      def initialize(label, command, status, message = "`#{label || command}` failed with status #{status.exitstatus}")
         @status = status
         @command = command
         super(message)

data/lib/tinyci/version.rb

@@ -1,3 +1,3 @@
 module TinyCI
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/tinyci.gemspec

@@ -29,9 +29,9 @@ Gem::Specification.new do |spec|
   end
   spec.executables   = ["tinyci"]
   spec.require_paths = ["lib"]
-  
+
   LOGO = File.read(File.expand_path('lib/tinyci/logo.txt', __dir__))
-  
+
   spec.post_install_message = (LOGO % TinyCI::VERSION) + "\n"
 
   spec.add_development_dependency "bundler", "~> 1.14"
@@ -41,4 +41,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'terminal-notifier', '1.7.1'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinyci
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonathan Davies
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,118 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A minimal Continuous Integration system, written in ruby, powered by
   git
 email:
@@ -119,8 +231,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -136,6 +250,7 @@ files:
 - lib/tinyci/config.rb
 - lib/tinyci/executor.rb
 - lib/tinyci/git_utils.rb
+- lib/tinyci/hookers/script_hooker.rb
 - lib/tinyci/installer.rb
 - lib/tinyci/logging.rb
 - lib/tinyci/logo.txt
@@ -156,7 +271,7 @@ metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: " _____ _               _____  _____\n/__   (_)_ __  _   _  /
   ___/ /_  _/\n   | || | '_ \\| | | |/ /     / /\n   | || | | | | |_| / /___/\\/ /_
-  \ \n   |_||_|_| |_|\\__, \\____/\\____/  0.1.2\n               |___/\n\n"
+  \ \n   |_||_|_| |_|\\__, \\____/\\____/  0.2.0\n               |___/\n\n"
 rdoc_options: []
 require_paths:
 - lib