tinyci 0.3.2 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8445b7ae2f18191cd7c5cb7612feba04b2f0ef20
-  data.tar.gz: 4296892877900713e20279d66cc1a0a7df8d52ed
+SHA256:
+  metadata.gz: 67c0c2cdfc2c4897dd17a0d9d3c19ea63a416726f8df3a35b355a344f7a966fd
+  data.tar.gz: b77bd08bdab867aec1c9ec02057d8519b55c9b23ca0f504afc74bb6b83e01165
 SHA512:
-  metadata.gz: 386fdbdbb0cdfd4f35632807044e35c3c7e0c36ecfba328d539d52971799168211a9a19b652631895e02e4897a7c14379a900c78565104b153a214181501fd75
-  data.tar.gz: 814edf8e891fc8810eb125b9f6cfd15164179946a56d65e06dbd4440c4b5c44eef356a9ae831d7af2bf110e7e8aa1524bfd8511d7a5a5f000ccf3f333c322729
+  metadata.gz: 66b4ef9b258a6381a78af29a69904d33655bb7d1970740449ad21c823fc084883bd12ce0d5bcdfaf1bdf364b49918156c27cc243797c6868fb0a35d8544c402e
+  data.tar.gz: 60cd46b3b67adf5473202b6d392d5b6897c7f7deb4f5017fc2f57a6433e4af4d67cec99655d22c28478f05a648338d0165f65b46ef5c99abba048e8d0dc7e4aa

data/.gitignore

@@ -6,3 +6,7 @@ spec/examples.txt
 tmp
 pkg
 coverage
+.pry_history
+.DS_Store
+rubocop.txt
+spec/support/tmp

data/.rspec

@@ -1,3 +1,5 @@
 --color
 --require spec_helper
 --order random
+--format Fuubar
+--format Nc

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+2.6.1

data/.tinyci.yml

@@ -1,8 +1,2 @@
-builder:
-  class: ScriptBuilder
-  config:
-    command: docker build -t tinyci .
-tester:
-  class: ScriptTester
-  config:
-    command: docker run tinyci bundle exec rspec --format documentation
+build: docker build -t tinyci .
+test: docker run tinyci bundle exec rspec --format documentation

data/.yardopts

@@ -1 +1 @@
---markup=markdown
+--load lib/yard_plugin.rb

data/ARCHITECTURE.md

@@ -0,0 +1,38 @@
+TinyCI Architecture
+===================
+
+This document contains details about TinyCI's implementation.
+
+### Architecture
+
+#### Requirements
+
+TinyCI is written in ruby 2. It is tested against git 2.7.4, the version packaged for ubuntu 16.04.
+
+It does not have a heavy dependency on ruby 2, mainly making use of convenient syntactic features. Porting to ruby 1.9 would be very simple.
+
+#### Eligible Commits
+
+When TinyCI is executed, it runs against all eligible commits, from oldest to newest. At the present time, all commits without any `tinyci-result` git-notes object attached are eligible. This means that the first time TinyCI executes, it will run against every commit in the repository's history. 
+
+While this is obviously suboptimal, note that if no configuration file is found, the exported copy of the commit is deleted and TinyCI moves on to the next commit, so this will not create a huge number of extraneous exports. It would be desirable to check for the presence of the config file before exporting the entire commit with a call to `git-cat-file`, see [TODO.md](TODO.md)
+
+#### Executor Classes
+
+Building and Testing are done by subclasses of {TinyCI::Executor}. An instance of each is created for every commit TinyCI runs against. This enables "pluggable backends" for TinyCI. At present there is only the `ScriptBuilder` and `ScriptTester`, which just run a command specified in the config file.
+
+#### Export Path
+
+The export path is where exported copies of commits are placed. Currently it is hardcoded: a directory called `builds` is created under the repo root, or under the the `.git` directory in the case of a non-bare repository. Within this, for each commit a directory named after the datetime along with the commit hash is created, and inside there you will find an `export` directory which contains the tree exported from that commit.
+
+#### Configuration
+
+TinyCI is configured with a YAML file named `.tinyci.yml` in the root directory of the repo. There are two sections, one for the builder and one for the tester. Each has a `class` key which specifies the {TinyCI::Executor} subclass to be used, and a `config` key which contains specific configuration for that executor. This `config` object can contain anything, it is passed wholesale to the executor object. For an example, see below, or see the example project.
+
+#### Execution Model
+
+TinyCI uses a pidfile to guarantee only a single executing process at a time. This ensures that multiple team members committing to a repository concurrently, or rapid commits in succession by a single user do not result in multiple concurrent executions of the test suite.
+
+Because TinyCI checks anew for eligible git objects to run against after each iteration of its main loop, and runs until no more are found, in the event of multiple commits being pushed concurrently, or further commits being pushed while an initial commit is still being built and tested, the first TinyCI instance will eventually execute against all commits.
+
+It is of course possible that commits might be pushed consistently faster than they can be tested, resulting in a never-to-be-cleared backlog; if this is the case the a more substantial CI solution is probably advisable for your project.

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.4 - May 27, 2019
+  New, terser configuration format
+  `after_all` hook
+  Command interpolation
 0.3.2 - October 19, 2018
   Fix hook execution order
 0.3.1 - October 19, 2018

data/Dockerfile

@@ -1,35 +1,22 @@
-FROM alpine:3.8
-
-RUN mkdir -p /etc \
-  && { \
-    echo 'install: --no-document'; \
-    echo 'update: --no-document'; \
-  } >> /etc/gemrc
-
-RUN apk add --no-cache -u \
-  ruby \
-  ruby-dev \
-  ruby-irb \
-  ruby-etc \
-  libffi-dev \
+FROM ruby:2.6.3-alpine3.9
+
+RUN apk add --no-cache \
   build-base \
   git
 
 RUN git config --global user.email "you@example.com"
 RUN git config --global user.name "Your Name"
 
-# RUN ln -sf /usr/share/zoneinfo/Europe/London /etc/localtime
-
-RUN gem install bundler
-RUN bundle config --global silence_root_warning 1
-
 WORKDIR /tmp 
 ADD Gemfile Gemfile
 ADD Gemfile.lock Gemfile.lock
 ADD tinyci.gemspec tinyci.gemspec
 ADD lib/tinyci/version.rb lib/tinyci/version.rb
 ADD lib/tinyci/logo.txt lib/tinyci/logo.txt
-RUN bundle install 
+
+RUN gem update bundler
+
+RUN bundle install --no-cache --jobs=4
 
 ADD . /tinyci
 

data/Gemfile.lock

@@ -1,27 +1,25 @@
 PATH
   remote: .
   specs:
-    tinyci (0.3.2)
+    tinyci (0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    awesome_print (1.8.0)
     barrier (1.0.2)
-    byebug (9.1.0)
+    byebug (11.0.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
-    ffi (1.9.25)
+    ffi (1.10.0)
     formatador (0.2.5)
-    fuubar (2.2.0)
+    fuubar (2.3.2)
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
-    guard (2.14.1)
+    guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
@@ -32,33 +30,30 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
+    json (2.2.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
-    method_source (0.9.0)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
     nenv (0.3.0)
     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)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.5.0)
-      byebug (~> 9.1)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
       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)
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     redcarpet (3.4.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -66,7 +61,7 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -76,15 +71,7 @@ GEM
       rspec (>= 3)
       terminal-notifier (>= 1.4)
     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-progressbar (1.10.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
     simplecov (0.16.1)
@@ -92,32 +79,28 @@ GEM
       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)
+    terminal-notifier (1.7.2)
+    thor (0.20.3)
+    yard (0.9.19)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  awesome_print
   barrier
-  bundler (~> 1.14)
-  ffi (>= 1.9.24)
   fuubar
   guard-rspec
   pry
   pry-byebug
+  pry-doc
   rake
   redcarpet
-  rspec
+  rspec (>= 3.8.0)
   rspec-nc
-  rubocop
   simplecov
-  terminal-notifier (= 1.7.1)
+  terminal-notifier (= 1.7.2)
   tinyci!
   yard
 
 BUNDLED WITH
-   1.16.3
+   2.0.1

data/Guardfile

@@ -4,4 +4,5 @@ guard :rspec, cmd: "bundle exec rspec", all_after_pass: true, all_on_start: true
   watch(%r{^lib\/tinyci\/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{spec\/support\/.+})       { "spec" }
   watch(%r{^spec\/.+_spec\.rb$})
+  ignore 'coverage'
 end

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Jonathan Davies
+Copyright (c) 2019 Jonathan Davies
 
 MIT License
 

data/README.md

@@ -16,62 +16,41 @@ RDoc documentation is available at [rubydoc.org](https://www.rubydoc.info/gems/t
 
 Existing CI solutions like [Travis](https://travis-ci.org) and [Jenkins](https://jenkins.io) run as daemons requiring large amounts of RAM, typically in their own virtual machines. In particular Travis and systems like it are designed as SaaS products, and it's not really feasible to self-host them.
 
-A more lightweight system was desired, for use with small scale personal projects.
+A more lightweight system was desired, for use with small-scale personal projects.
 
-### Architecture
-
-#### Requirements
-
-TinyCI is written in ruby 2. It is not known exactly how recent a version of git is required, however development and testing was carried out against 2.7.4, the version packaged for ubuntu 16.04.
-
-It does not have a heavy dependency on ruby 2, mainly making use of convenient syntactic features. Porting to ruby 1.9 would be very simple.
-
-#### Stages
-
-TinyCI is executed via git `post-update` hooks. When a new commit is pushed, the following steps are executed:
-
-1. Clean  
-    The [export path](#Export_Path) is removed
-2. Export  
-    A clean copy of the commit is placed at the [export path](#Export_Path). Clean in this context means without any .git directory or similar.
-3. Build  
-    The project's build command is executed
-4. Test  
-    The project's test command is executed
-
-Finally the result is stored in git using the [git-notes](https://git-scm.com/docs/git-notes) feature. This is how TinyCI determines which commits to run against.
-
-#### Eligible Commits
-
-When TinyCI is executed, it runs against all eligible commits, from oldest to newest. At the present time, all commits without any `tinyci-result` git-notes object attached are eligible. This means that the first time TinyCI executes, it will run against every commit in the repository's history. 
-
-While this is obviously suboptimal, note that if no configuration file is found, the exported copy of the commit is deleted and TinyCI moves on to the next commit, so this will not create a huge number of extraneous exports. It would be desirable to check for the presence of the config file before exporting the entire commit with a call to `git-cat-file`, see the [TODO section](#Limitations_TODO) below.
-
-#### Executor Classes
-
-Building and Testing are done by subclasses of {TinyCI::Executor}. An instance of each is created for every commit TinyCI runs against. This enables "pluggable backends" for TinyCI. At present there is only the `ScriptBuilder` and `ScriptTester`, which just run a command specified in the config file.
+### Usage
 
-#### Export Path
+TinyCI works by installing a `post-update` hook into your remote repository. When a commit containing a TinyCI config file is pushed, the commit is exported and commands are executed as defined in the config.
 
-The export path is the location where exported copies of commits are placed. Currently it is hardcoded as a directory called `builds` under the repo root, or under the the `.git` directory in the case of a non-bare repository.
+#### Instructions
 
-#### Configuration
+First, add a configuration file to your project with the name `.tinyci.yml`:
 
-TinyCI is configured with a YAML file named `.tinyci.yml` in the root directory of the repo. There are two sections, one for the builder and one for the tester. Each has a `class` key which specifies the {TinyCI::Executor} subclass to be used, and a `config` key which contains specific configuration for that executor. This `config` object can contain anything, it is passed wholesale to the executor object. For an example, see below, or see the example project.
+    cat <<EOF > .tinyci.yml
+    build: ./build.sh
+    test: ./test.sh
+    EOF
 
-#### Execution Model
+This config assumes you have files called `build.sh` and `test.sh` in the root of your project that execute the appropriate commands.
 
-TinyCI uses a pidfile to guarantee only a single executing process at a time. This ensures that multiple team members committing to a repository concurrently, or rapid commits in succession by a single user do not result in multiple concurrent executions of the test suite.
+TinyCI is distributed as a ruby gem. Install it like so:
 
-Because TinyCI checks anew for eligible git objects to run against after each iteration of its main loop, and runs until no more are found, in the event of multiple commits being pushed concurrently, or further commits being pushed while an initial commit is still being built and tested, the first TinyCI instance will eventually execute against all commits.
+    gem install tinyci
+    
+The gem should be installed on the remote server where you want the tests to execute. On that server, install TinyCI into your repository with the install command:
 
-It is of course possible that commits might be pushed consistently faster than they can be tested, resulting in a never-to-be-cleared backlog; if this is the case the a more substantial CI solution is probably advisable for your project.
+    tinyci install
+    
+Now, commit the configuration file and push it to your remote repository. After some initial extraneous output (depending on the size of your repo's history,) you will see your build and test commands executed.
 
-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.
+#### Example Project
 
-#### Hooks
+There is an example project available at https://github.com/JonnieCache/tinyci-example
+    
+See that repo for a walkthrough demonstrating various TinyCI features.
 
-TinyCI supports hooks/callbacks, much like git itself. Here is the order of execution:
+#### Stages
+Here is a brief overview of the operations TinyCI goes through when processing a commit:
 
 ```
   * clean
@@ -81,35 +60,77 @@ TinyCI supports hooks/callbacks, much like git itself. Here is the order of exec
   
   * build
   
-  after_build
   after_build_success
   after_build_failure
+  after_build
   
   before_test
   
   * test
   
-  after_test
   after_test_success
   after_test_failure
+  after_test
+  
+  after_all
 ```
-
 `*` indicates an actual phase of TinyCI's execution, the rest are callbacks.
 
+1. **Clean**  
+    The [export path](ARCHITECTURE.md#Export_Path) is removed.
+2. **Export**  
+    A clean copy of the commit is placed at the [export path](ARCHITECTURE.md#Export_Path). Clean in this context means without any `.git` directory or similar.
+3. `before_build`  
+    The `before_build` hook is executed, and processing halts if the hook fails.
+4. **Build**  
+    The project's build command is executed.
+5. `after_build_success`  
+    If the build completed successfully, the `after_build_success` hook is executed.
+6. `after_build_failure`  
+    If the build failed, the `after_build_failure` hook is executed.
+7. `before_test`  
+    The `before_test` hook is executed, and processing halts if the hook fails.
+8. **Test**  
+    The project's test command is executed.
+9. `after_test_success`  
+    If the test completed successfully, the `after_test_success` hook is executed.
+10. `after_test_failure`  
+    If the test failed, the `after_test_failure` hook is executed.
+11. `after_all`  
+    The `after_all` hook is always exectued as the final stage of processing.
+
+Finally the result is stored in git using the [git-notes](https://git-scm.com/docs/git-notes) feature. This is how TinyCI determines which commits to run against.
+
 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)
 
+The `after_all` hook runs at the end of a commit's processing, whether or not the build/test stages have succeeded or failed.
+
 To setup hooks, define a section like this in your config file:
 
 ```
-hooker:
-  class: ScriptHooker
-  config:
-    after_build: ./after_build.sh
+hooks:
+  after_build: ./after_build.sh
 ```
 
+#### Interpolation
+
+It is possible to interpolate values into the scripts defined in the TinyCI configuration file, using the [ERB](https://ruby-doc.org/stdlib/libdoc/erb/rdoc/ERB.html) syntax. Here is an example:
+
+    build: docker build -t app:<%= commit %> .
+    test: docker run app:<%= commit %> bundle exec rspec
+    hooks:
+      after_all: rm -rf <%= export %>
+      
+Here we are using the commit sha to tag our docker image, and then in our `after_all` hook we are removing the exported build directory, as in the docker use-case our build artifacts live in the local docker index.
+
+The following variables are available for interpolation:
+
+* `commit` the sha hash of the commit being processed
+* `export` the absolute path to the commits exported tree
+
 #### Compactor
 
-With continued use, the `builds` directory will grow ever larger. TinyCI provides the `compact` command to deal with this. It compresses old builds into `.tar.gz` files.
+With continued use, the [`builds`](ARCHITECTURE.md#Export_Path) directory will grow ever larger. TinyCI provides the `compact` command to deal with this. It compresses old builds into `.tar.gz` files.
 
 "Old" in this context is defined using two options to the `tinyci compact` command:
 
@@ -126,54 +147,13 @@ TinyCI is executed in a `post-update` git hook. As such, the output is shown to
 
 As well as logging to stdout, the TinyCI process writes a `tinyci.log` file in each exported directory.
 
-#### Limitations/TODO
-
-* 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.
- 
-* Presently, if a user kills their local git process while TinyCI is running, it will continue to execute on the server. If they then push another commit, the original TinyCI process will go on to test the second commit as well, as expected. However, the output from the second git push will simply consist of an error message describing the behavior.  
-Instead, this second TinyCI execution should begin tailing the output of the first process, perhaps gaining direct access to it's stdout stream.
-
-* It would be desirable to add a command to the TinyCI binary to SSH into the remote server and tail the the log output of a currently running TinyCI process, enabling functionality similar to that described in above, but without making a new commit.
-
-* More configuration options should be added, eg. specification of the export path.
-
-* In general, more local functionality for the TinyCI binary would be desirable, some way to retrieve the results of tests and query them from the local clone for example, or some way to show them in `git log` output.
-
-### Usage
-
-#### Instructions
-
-First, add a configuration file to your project:
-
-    cat <<EOF > .tinyci.yml
-    builder:
-      class: ScriptBuilder
-      config:
-        command: build.sh
-    tester:
-      class: ScriptTester
-      config:
-        command: test.sh
-    EOF
-
-This config assumes you have files called `build.sh` and `test.sh` in the root of your project that execute the appropriate commands.
-
-TinyCI is distributed as a ruby gem. Install it like so:
-
-    gem install tinyci
-    
-The gem should be installed on the remote server where you want the tests to execute. On that server, install TinyCI into your repository with the install command:
+### Architecture
 
-    tinyci install
-    
-Now, commit the configuration file and push it to your remote repository. As discussed above, this will currently result in a large amount of output as every previous commit is exported, found to be missing a config file and then the export deleted. Eventually you will see your build and test scripts executed.
+Implementation details are described in a separate document, [ARCHITECTURE.md](ARCHITECTURE.md)
 
-#### Example Project
+### Limitations/TODO
 
-There is an example project available at https://github.com/JonnieCache/tinyci-example.
-    
-See that repo for a walkthrough demonstrating various TinyCI features.
+See [TODO.md](TODO.md)
     
 ### Contributing
 
@@ -183,4 +163,4 @@ TinyCI has a suite of RSpec tests, please use them.
 
 ### Copyright
 
-Copyright (c) 2018 Jonathan Davies. See [LICENSE](LICENSE) for details.
+Copyright (c) 2019 Jonathan Davies. See [LICENSE.md](LICENSE.md) for details.

data/TODO.md

@@ -0,0 +1,11 @@
+* 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.
+ 
+* Presently, if a user kills their local git process while TinyCI is running, it will continue to execute on the server. If they then push another commit, the original TinyCI process will go on to test the second commit as well, as expected. However, the output from the second git push will simply consist of an error message describing the behavior.  
+Instead, this second TinyCI execution should begin tailing the output of the first process, perhaps gaining direct access to it's stdout stream.
+
+* It would be desirable to add a command to the TinyCI binary to SSH into the remote server and tail the the log output of a currently running TinyCI process, enabling functionality similar to that described in above, but without making a new commit.
+
+* More configuration options should be added, eg. specification of the export path.
+
+* In general, more local functionality for the TinyCI binary would be desirable, some way to retrieve the results of tests and query them from the local clone for example, or some way to show them in `git log` output.

data/lib/tinyci/builders/script_builder.rb

@@ -4,7 +4,7 @@ module TinyCI
   module Builders
     class ScriptBuilder < TinyCI::Executor
       def build
-        execute_stream(script_location, label: 'build', pwd: @config[:target])
+        execute_stream(command, label: 'build', pwd: @config[:export])
       end
     end
   end

data/lib/tinyci/cli.rb

@@ -101,7 +101,7 @@ TXT
     def self.do_install(opts)
       logger = MultiLogger.new(quiet: opts[:quiet])
     
-      TinyCI::Installer.new(logger: logger, working_dir: opts[:dir]).write!
+      TinyCI::Installer.new(logger: logger, working_dir: opts[:dir]).install!
     end
     
     def self.do_compact(opts)

data/lib/tinyci/config.rb

@@ -1,3 +1,4 @@
+require 'tinyci/config_transformer'
 require 'tinyci/symbolize'
 require 'yaml'
 
@@ -5,6 +6,9 @@ module TinyCI
   # Represents the Configuration for a repo, parsed from the `.tinyci.yml` file in the repo root.
   # Mainly a wrapper around a the hash object parsed from the yaml in the config file.
   # The keys of the hash are recursively symbolized.
+  # 
+  # As it is loaded, the configuration file data is passed through the {TinyCI::ConfigTransformer}
+  # class, which translates any definitions in the concise format into the more verbose format
   class Config
     include Symbolize
     
@@ -31,6 +35,8 @@ module TinyCI
     end
     
     # Return the raw hash representation
+    # 
+    # @return [Hash] The configuration as a hash
     def to_hash
       config_content
     end
@@ -46,7 +52,11 @@ module TinyCI
     end
     
     def config_content
-      @config_content ||= symbolize(YAML.safe_load(File.read(config_pathname))).freeze
+      @config_content ||= begin
+        config = YAML.safe_load(File.read(config_pathname))
+        transformed_config = ConfigTransformer.new(config).transform!
+        symbolize(transformed_config).freeze
+      end
     end
   end
     

data/lib/tinyci/config_transformer.rb

@@ -0,0 +1,64 @@
+module TinyCI
+  # Transforms the configuration format from the condensed format to the
+  # more verbose format accepted by the rest of the system
+  class ConfigTransformer
+    
+    # Constructor
+    # 
+    # @param [Hash] input The configuration object, in the condensed format
+    def initialize(input)
+      @input = input
+    end
+    
+    # Transforms the config object
+    # 
+    # @return [Hash] The config object in the verbose form
+    def transform!
+      @input.inject({}) do |acc, (key, value)|
+        method_name = "transform_#{key}"
+        
+        if respond_to? method_name, true
+          
+          acc.merge! send(method_name, value)
+        else
+          acc[key] = value
+        end
+        
+        acc
+      end
+    end
+    
+    private
+    
+    def transform_build(value)
+      {
+        builder: {
+          :class => "ScriptBuilder",
+          config: {
+            command: value
+          }
+        }
+      }
+    end
+    
+    def transform_test(value)
+      {
+        tester: {
+          :class => "ScriptTester",
+          config: {
+            command: value
+          }
+        }
+      }
+    end
+    
+    def transform_hooks(value)
+      {
+        hooker: {
+          :class => "ScriptHooker",
+          config: value
+        }
+      }
+    end
+  end
+end

data/lib/tinyci/executor.rb

@@ -1,5 +1,7 @@
 require 'tinyci/subprocesses'
 require 'tinyci/logging'
+require 'ostruct'
+require 'erb'
 
 module TinyCI
   # Parent class for Builder and Tester classes
@@ -18,11 +20,28 @@ module TinyCI
       @logger = logger
     end
     
+    def command
+      ['/bin/sh', '-c', "'#{interpolate(@config[:command])}'"]
+    end
+    
     private
     
-    def script_location
-      # path = File.join @config[:target], @config[:command]
-      ['/bin/sh', '-c', "'#{@config[:command]}'"]
+    def interpolate(command)
+      erb = ERB.new command
+      
+      erb.result(erb_scope)
+    end
+    
+    def template_vars
+      OpenStruct.new(
+        commit: @config[:commit],
+        export: @config[:export],
+        target: @config[:target]
+      )
+    end
+
+    def erb_scope
+      template_vars.instance_eval { binding }
     end
   end
 end

data/lib/tinyci/hookers/script_hooker.rb

@@ -7,15 +7,19 @@ module TinyCI
       HOOKS = %w{
         before_build
         
-        after_build
         after_build_success
         after_build_failure
         
+        after_build
+        
         before_test
         
-        after_test
         after_test_success
         after_test_failure
+        
+        after_test
+        
+        after_all
       }
       
       # Those hooks that will halt exectution if they fail
@@ -34,7 +38,7 @@ module TinyCI
           
           log_info "executing #{hook} hook..."
           begin
-            execute_stream(script_location(hook), label: hook, pwd: @config[:target])
+            execute_stream(script_location(hook), label: hook, pwd: @config[:export])
             
             return true
           rescue SubprocessError => e
@@ -52,7 +56,7 @@ module TinyCI
       end
       
       def script_location(hook)
-        ['/bin/sh', '-c', "'#{@config[hook.to_sym]}'"]
+        ['/bin/sh', '-c', "'#{interpolate(@config[hook.to_sym])}'"]
       end
     end
   end

data/lib/tinyci/installer.rb

@@ -17,7 +17,7 @@ module TinyCI
     end
     
     # Write the hook to the relevant path and make it executable
-    def write!
+    def install!
       unless inside_repository?
         log_error "not currently in a git repository"
         return false
@@ -47,8 +47,9 @@ module TinyCI
     def hook_content
       <<-EOF
 #!/bin/sh
+unset GIT_DIR
 
-tinyci run --all
+#{Gem.bin_path('tinyci', 'tinyci')} run --all
       EOF
     end
   end

data/lib/tinyci/multi_logger.rb

@@ -8,6 +8,8 @@ module TinyCI
       "[#{datetime.strftime "%T"}] #{msg}\n"
     end
     
+    LEVEL = Logger::INFO
+    
     attr_accessor :quiet
     
     # Constructor
@@ -21,7 +23,7 @@ module TinyCI
       
       @stdout_logger = Logger.new($stdout)
       @stdout_logger.formatter = FORMAT
-      @stdout_logger.level = Logger::INFO
+      @stdout_logger.level = LEVEL
     end
     
     def targets
@@ -36,7 +38,7 @@ module TinyCI
       if path
         @file_logger = Logger.new(path)
         @file_logger.formatter = FORMAT
-        @file_logger.level = Logger::INFO
+        @file_logger.level = LEVEL
       end
     end
 

data/lib/tinyci/runner.rb

@@ -6,9 +6,6 @@ require 'tinyci/config'
 require 'tinyci/builders/test_builder'
 require 'tinyci/testers/test_tester'
 
-require 'tinyci/builders/rkt_builder'
-require 'tinyci/testers/rkt_tester'
-
 require 'tinyci/builders/script_builder'
 require 'tinyci/testers/script_tester'
 require 'tinyci/hookers/script_hooker'
@@ -111,8 +108,6 @@ module TinyCI
           run_hook! :after_test
         end
         
-        
-        
         log_info "Finished #{@commit}"
       rescue => e
         raise e if ENV['TINYCI_ENV'] == 'test'
@@ -120,6 +115,8 @@ module TinyCI
         log_error e
         log_debug e.backtrace
         return false
+      ensure
+        run_hook! :after_all
       end
       
       true
@@ -157,13 +154,13 @@ module TinyCI
     # Instantiate the Builder object according to the class named in the config
     def instantiate_builder
       klass = TinyCI::Builders.const_get(@config[:builder][:class])
-      klass.new(@config[:builder][:config].merge(target: export_path), logger: @logger)
+      klass.new(@config[:builder][:config].merge(target: target_path, export: export_path, commit: @commit), logger: @logger)
     end
     
     # Instantiate the Tester object according to the class named in the config
     def instantiate_tester
       klass = TinyCI::Testers.const_get(@config[:tester][:class])
-      klass.new(@config[:tester][:config].merge(target: export_path), logger: @logger)
+      klass.new(@config[:tester][:config].merge(target: target_path, export: export_path, commit: @commit), logger: @logger)
     end
     
     # Instantiate the Hooker object according to the class named in the config
@@ -171,7 +168,7 @@ module TinyCI
       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)
+      klass.new(@config[:hooker][:config].merge(target: target_path, export: export_path, commit: @commit), logger: @logger)
     end
     
     # Instantiate the {Config} object from the `.tinyci.yml` file in the exported directory

data/lib/tinyci/subprocesses.rb

@@ -63,6 +63,8 @@ module TinyCI
       opts = {}
       opts[:chdir] = pwd unless pwd.nil?
       
+      log_debug "CMD: #{command.join(' ')}"
+      
       Open3.popen2e(command.join(' '), opts) do |stdin, stdout_and_stderr, wait_thr|
         stdin.close
         
@@ -89,7 +91,7 @@ module TinyCI
       attr_reader :status
       attr_reader :command
       
-      def initialize(label, command, status, message = "`#{label || command}` failed with status #{status.exitstatus}")
+      def initialize(label, command, status, message = "#{label}: `#{command}` failed with status #{status.exitstatus}")
         @status = status
         @command = command
         super(message)

data/lib/tinyci/testers/script_tester.rb

@@ -4,7 +4,7 @@ module TinyCI
   module Testers
     class ScriptTester < TinyCI::Executor
       def test
-        execute_stream(script_location, label: 'test', pwd: @config[:target])
+        execute_stream(command, label: 'test', pwd: @config[:export])
       end
     end
   end

data/lib/tinyci/version.rb

@@ -1,3 +1,3 @@
 module TinyCI
-  VERSION = "0.3.2"
+  VERSION = "0.4"
 end

data/lib/yard_plugin.rb

@@ -0,0 +1,37 @@
+require 'redcarpet'
+
+# This file fixes the mismatch between how github handles links to other
+# markdown files in the project vs. how yardoc handles them.
+
+module YARD
+  module Templates
+    module Helpers
+      module HtmlHelper
+        class MDLinkRenderer < Redcarpet::Render::HTML
+          def link(link, title, contents)
+            if link.=~(/\.md(?:#\w+)?$/)
+              %(<a href="/docs/file/#{link}">#{contents}</a>)
+            elsif title
+              %(<a href="#{link}" title="#{title}"></a>)
+            else
+              %(<a href="#{link}">#{contents}</a>)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+class CompatMarkdown
+  attr_reader :to_html
+
+  def initialize(text)
+    renderer = YARD::Templates::Helpers::HtmlHelper::MDLinkRenderer.new
+    markdown = Redcarpet::Markdown.new(renderer, no_intra_emphasis: true, gh_blockcode: true, fenced_code_blocks: true, autolink: true)
+    @to_html = markdown.render(text)
+  end
+end
+
+helper = YARD::Templates::Helpers::MarkupHelper
+helper.clear_markup_cache
+helper::MARKUP_PROVIDERS[:markdown].unshift const: 'CompatMarkdown'

data/tinyci.gemspec

@@ -34,20 +34,17 @@ Gem::Specification.new do |spec|
 
   spec.post_install_message = (LOGO % TinyCI::VERSION) + "\n"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '>= 3.8.0'
   spec.add_development_dependency 'barrier'
   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-doc'
   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'
-  spec.add_development_dependency 'ffi', '>= 1.9.24'
+  spec.add_development_dependency 'terminal-notifier', '1.7.2'
 end

metadata

@@ -1,45 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: tinyci
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: '0.4'
 platform: ruby
 authors:
 - Jonathan Davies
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2019-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: barrier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: barrier
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pry-doc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -198,42 +184,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: 1.7.2
   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'
-- !ruby/object:Gem::Dependency
-  name: ffi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.24
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.24
+        version: 1.7.2
 description: A minimal Continuous Integration system, written in ruby, powered by
   git
 email:
@@ -249,22 +207,24 @@ files:
 - ".ruby-version"
 - ".tinyci.yml"
 - ".yardopts"
+- ARCHITECTURE.md
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
 - Gemfile.lock
 - Guardfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
+- TODO.md
 - bin/tinyci
 - lib/pidfile.rb
-- lib/tinyci/builders/rkt_builder.rb
 - lib/tinyci/builders/script_builder.rb
 - lib/tinyci/builders/test_builder.rb
 - lib/tinyci/cli.rb
 - lib/tinyci/compactor.rb
 - lib/tinyci/config.rb
+- lib/tinyci/config_transformer.rb
 - lib/tinyci/executor.rb
 - lib/tinyci/git_utils.rb
 - lib/tinyci/hookers/script_hooker.rb
@@ -276,10 +236,10 @@ files:
 - lib/tinyci/scheduler.rb
 - lib/tinyci/subprocesses.rb
 - lib/tinyci/symbolize.rb
-- lib/tinyci/testers/rkt_tester.rb
 - lib/tinyci/testers/script_tester.rb
 - lib/tinyci/testers/test_tester.rb
 - lib/tinyci/version.rb
+- lib/yard_plugin.rb
 - tinyci.gemspec
 homepage: https://github.com/JonnieCache/tinyci
 licenses:
@@ -288,7 +248,7 @@ metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: " _____ _               _____  _____\n/__   (_)_ __  _   _  /
   ___/ /_  _/\n   | || | '_ \\| | | |/ /     / /\n   | || | | | | |_| / /___/\\/ /_
-  \ \n   |_||_|_| |_|\\__, \\____/\\____/  0.3.2\n               |___/\n\n"
+  \ \n   |_||_|_| |_|\\__, \\____/\\____/  0.4\n               |___/\n\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -303,8 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A minimal Continuous Integration system, written in ruby, powered by git

data/lib/tinyci/builders/rkt_builder.rb

@@ -1,31 +0,0 @@
-require 'tinyci/executor'
-
-module TinyCI
-  module Builders
-    class RktBuilder < TinyCI::Executor
-      def build
-        cmd = [
-          'sudo',
-          'rkt',
-          'run',
-          '--net=host',
-          '--insecure-options=image',
-          '--volume',
-          "src,kind=host,source=#{@config[:target]}/src,readOnly=false",
-          '--mount',
-          "volume=src,target=#{@config[:src_path]}",
-          @config[:image],
-          '--working-dir',
-          @config[:src_path],
-          '--exec',
-          @config[:command]
-        ]
-        
-        log_info "RKT build command: #{cmd.join(' ')}"
-        
-        execute_stream(*cmd, label: 'build')
-      end
-      
-    end
-  end
-end

data/lib/tinyci/testers/rkt_tester.rb

@@ -1,40 +0,0 @@
-require 'tinyci/executor'
-
-module TinyCI
-  module Testers
-    class RktTester < TinyCI::Executor
-      def test
-        cmd = [
-          'sudo',
-          'rkt',
-          'run',
-          '--net=host',
-          '--insecure-options=image',
-          '--volume',
-          "src,kind=host,source=#{@config[:target]}/src,readOnly=false",
-          '--mount',
-          "volume=src,target=#{@config[:src_path]}",
-          @config[:image],
-          '--working-dir',
-          @config[:src_path],
-          set_env,
-          '--exec',
-          @config[:command]
-        ].flatten
-        
-        log_info "RKT test command: #{cmd.join(' ')}"
-        
-        execute_stream(*cmd, label: 'test')
-        
-      end
-      
-      private
-      
-      def set_env
-        return [] if @config[:env].nil?
-        
-        @config[:env].map {|k,v| "--set-env=#{k.upcase}=#{v}"}
-      end
-    end
-  end
-end