RubyGems - ci_in_a_can - Versions diffs - 0.0.10 → 0.0.11 - Mend

ci_in_a_can 0.0.10 → 0.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

data/README.md +32 -9
data/ci_in_a_can.gemspec +1 -0
data/lib/ci_in_a_can/app.rb +44 -10
data/lib/ci_in_a_can/build.rb +6 -2
data/lib/ci_in_a_can/last_run_list.rb +17 -0
data/lib/ci_in_a_can/persistence.rb +7 -0
data/lib/ci_in_a_can/test_result.rb +12 -2
data/lib/ci_in_a_can/test_result_notifier.rb +1 -0
data/lib/ci_in_a_can/version.rb +1 -1
data/lib/ci_in_a_can/web_content.rb +22 -0
data/spec/ci_in_a_can/build_spec.rb +16 -0
data/spec/ci_in_a_can/last_run_list_spec.rb +49 -0
data/spec/ci_in_a_can/test_result_notifier_spec.rb +10 -0
data/spec/ci_in_a_can/test_result_spec.rb +33 -0
data/spec/spec_helper.rb +7 -0
metadata +25 -5

data/README.md CHANGED Viewed

@@ -1,24 +1,47 @@
-# CiInACan
+# CI In a Can
-TODO: Write a gem description
+Super-easy continuous integration.  With one command, you can turn a cloud server (AWS, Digital Ocean) into a CI server for Ruby apps. Others (like node, .Net) coming soon.
-## Installation
+This currently only hooks to Github repos.  More later.
+## Philosophy
-Add this line to your application's Gemfile:
+CI should be as easy as running tests on your own computer.  When a change is made, your CI server should download the changes, run the tests, and report the results.
-    gem 'ci_in_a_can'
+So that's what this application does.  It handles the basics... receiving notifications of new pushes, running the tests, and reporting back the results.
-And then execute:
+And just like running the tests on your own computer... you'll have to set up your server to run your app.  That's outside the scope of CI In a Can.  But once your server can run the tests, CI In a Can will work for you.
-    $ bundle
+## Installation
-Or install it yourself as:
+Install with:
     $ gem install ci_in_a_can
 ## Usage
-TODO: Write usage instructions here
+Run:
+````
+ciinacan YOUR_NAME
+cd YOUR_NAME
+rake start &
+disown
+````
+This will create a directory named YOUR_NAME, start up a Sinatra app on port 80, and start a backend service for running builds.  **You now have a running CI server.**
+For any project you want to hook to a CI server, add a Github webhook to "http://YOUR_WEBSITE".
+When any push is made to your Github repository, Github will send a notification to your Sinatra site.  This will initiate a clone, run the usual stuff you need "bundle install, etc.", then run "bundle exec rake" to run your tests.
+## Requirements
+1.  A default rake task that runs all of your tests.
+2.  An environment variable named GITHUB_AUTH_TOKEN.  This is used to report results back to Github.
+3.  An environment variable named SITE_URL.  This will be the URL of your site, for things like providing Github with a link back to the site to show test results.
+2.  A server that will "just run" your application.  Set up your own server with whatever dependencies your application needs.
 ## Contributing

data/ci_in_a_can.gemspec CHANGED Viewed

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "subtle"
   spec.add_development_dependency "contrast"
+  spec.add_development_dependency "timecop"
   spec.add_runtime_dependency "rake"
   spec.add_runtime_dependency "sinatra"

data/lib/ci_in_a_can/app.rb CHANGED Viewed

@@ -9,25 +9,59 @@ module CiInACan
     end
     get '/test_result/:id' do
-      CiInACan::TestResult.find(params[:id]).to_json
+      test_result = CiInACan::TestResult.find(params[:id]).to_json
+      CiInACan::WebContent.full_page_of(
+<<EOF
+    <table class="table table-bordered">
+      <tbody>
+      <tr>
+        <td>
+          Id
+        </td>
+        <td>
+          #{test_result.id}
+        </td>
+      </tr>
+      <tr>
+        <td>
+          Created At
+        </td>
+        <td>
+          #{test_result.id}
+        </td>
+      </tr>
+      <tr>
+        <td>
+          Passed
+        </td>
+        <td>
+          #{test_result.passed ? 'Yes' : 'No'}
+        </td>
+      </tr>
+      <tr>
+        <td>
+          Output
+        </td>
+        <td>
+          #{test_result.output.to_s.gsub("\n", '<br />')}
+        </td>
+      </tr>
+      </tbody>
+    </table>
+EOF
+)
     end
     get '/' do
+      CiInACan::WebContent.full_page_of(
 <<EOF
-<html>
-  <head>
-    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.0/css/bootstrap.min.css">
-    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.0/css/bootstrap-theme.min.css">
-    <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.0/js/bootstrap.min.js"></script>
-  </head>
-  <body>
     <table class="table table-bordered">
       <tbody>
       </tbody>
     </table>
-  </body>
-</html>
 EOF
+)
     end
     post '/' do

data/lib/ci_in_a_can/build.rb CHANGED Viewed

@@ -1,10 +1,14 @@
 module CiInACan
   class Build
-    params_constructor
+    params_constructor do
+      @created_at = Time.now unless @created_at
+    end
     attr_accessor :id, :git_ssh, :sha,
-                  :local_location, :repo
+                  :local_location, :repo,
+                  :created_at
     def self.parse content
       GithubBuildParser.new.parse content

data/lib/ci_in_a_can/last_run_list.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module CiInACan
+  module LastRunList
+    def self.add build, test_result
+      data = { created_at: test_result.created_at, test_result_id: test_result.id }
+      CiInACan::Persistence.save("test_run_list", test_result.created_at, data)
+    end
+    def self.all
+      blah = CiInACan::Persistence.hash_for("test_run_list")
+      blah.sort_by { |x| x[0] }.reverse.map { |x| x[1] }
+    end
+  end
+end

data/lib/ci_in_a_can/persistence.rb CHANGED Viewed

@@ -14,6 +14,13 @@ module CiInACan
       store.transaction(true) { store[id] }
     end
+    def self.hash_for type
+      store = store_for(type)
+      store.transaction do
+        store.roots.inject({}) { |t, i| t[i] = store[i]; t }
+      end
+    end
     private
     def self.store_for type

data/lib/ci_in_a_can/test_result.rb CHANGED Viewed

@@ -1,12 +1,17 @@
+require 'subtle'
 module CiInACan
   class TestResult
     PERSISTENCE_TYPE = 'test_result'
-    params_constructor
+    params_constructor do
+      @created_at = Time.now unless @created_at
+    end
     attr_accessor :id
     attr_accessor :passed, :output
+    attr_accessor :created_at
     def self.create values
       test_result = create_the_test_result_from values
@@ -19,7 +24,12 @@ module CiInACan
     end
     def to_json
-      { id: id, passed: passed, output: output }.to_json
+      {
+        id:         id,
+        passed:     passed,
+        output:     output,
+        created_at: created_at
+      }.to_json
     end
     private

data/lib/ci_in_a_can/test_result_notifier.rb CHANGED Viewed

@@ -9,6 +9,7 @@ module CiInACan
     private
     def self.report_results_to_github build, test_result
+      CiInACan::LastRunList.add build, test_result
       CiInACan::Github.report_complete_status_for build, test_result
     end

data/lib/ci_in_a_can/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module CiInACan
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/ci_in_a_can/web_content.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module CiInACan
+  module WebContent
+    def self.full_page_of content
+<<EOF
+<html>
+  <head>
+    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.0/css/bootstrap.min.css">
+    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.0/css/bootstrap-theme.min.css">
+    <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.0/js/bootstrap.min.js"></script>
+  </head>
+  <body>
+  #{content}
+  </body>
+</html>
+EOF
+    end
+  end
+end

data/spec/ci_in_a_can/build_spec.rb CHANGED Viewed

@@ -2,6 +2,22 @@ require_relative '../spec_helper'
 describe CiInACan::Build do
+  after do
+    Timecop.return
+  end
+  it "should default created_at to the current date" do
+    now = Time.now
+    ::Timecop.freeze now
+    CiInACan::Build.new.created_at.must_equal now
+  end
+  it "should allow the created_at to be set" do
+    now = Object.new
+    build = CiInACan::Build.new(created_at: now)
+    build.created_at.must_be_same_as now
+  end
   it "should default commands to the basic ruby conventions" do
     result = CiInACan::Build.new.commands
     result.count.must_equal 2

data/spec/ci_in_a_can/last_run_list_spec.rb ADDED Viewed

@@ -0,0 +1,49 @@
+require_relative '../spec_helper'
+describe CiInACan::LastRunList do
+  before do
+    clear_all_persisted_data
+  end
+  describe "add" do
+    let(:build)       { CiInACan::Build.new }
+    let(:test_result) { CiInACan::TestResult.new }
+    it "should store information that we can pull out later" do
+      CiInACan::LastRunList.add build, test_result
+      results = CiInACan::LastRunList.all
+      results.count.must_equal 1
+      expected = { created_at: test_result.created_at }
+      results.first.contrast_with! expected
+    end
+  end
+  describe "all" do
+    describe "sorting" do
+      let(:build) { CiInACan::Build.new }
+      it "should sort by created_at in DESC order" do
+        test_results = [CiInACan::TestResult.new(id: 'c', created_at: Time.parse('1/3/2014')),
+                        CiInACan::TestResult.new(id: 'a', created_at: Time.parse('1/1/2014')),
+                        CiInACan::TestResult.new(id: 'b', created_at: Time.parse('1/2/2014'))]
+        test_results.each { |t| CiInACan::LastRunList.add build, t }
+        results = CiInACan::LastRunList.all
+        results[0][:test_result_id].must_equal 'c'
+        results[1][:test_result_id].must_equal 'b'
+        results[2][:test_result_id].must_equal 'a'
+      end
+    end
+  end
+end

data/spec/ci_in_a_can/test_result_notifier_spec.rb CHANGED Viewed

@@ -7,6 +7,11 @@ describe CiInACan::TestResultNotifier do
     let(:build)       { CiInACan::Build.new }
     let(:test_result) { CiInACan::TestResult.new }
+    before do
+      CiInACan::LastRunList.stubs(:add)
+      CiInACan::Github.stubs(:report_complete_status_for)
+    end
     it "should mark the results in github" do
       test_result.passed = true
@@ -19,6 +24,11 @@ describe CiInACan::TestResultNotifier do
       CiInACan::TestResultNotifier.send_for build, test_result
     end
+    it "should add the build and test result to the last run list" do
+      CiInACan::LastRunList.expects(:add).with build, test_result
+      CiInACan::TestResultNotifier.send_for build, test_result
+    end
   end
 end

data/spec/ci_in_a_can/test_result_spec.rb CHANGED Viewed

@@ -2,6 +2,20 @@ require_relative '../spec_helper'
 describe CiInACan::TestRunner do
+  after { ::Timecop.return }
+  it "should default created_at to now" do
+    now = Time.now
+    ::Timecop.freeze now
+    CiInACan::TestResult.new.created_at.must_equal now
+  end
+  it "should allow the created_at to be set" do
+    now = Object.new
+    test_result = CiInACan::TestResult.new(created_at: now)
+    test_result.created_at.must_be_same_as now
+  end
   describe "create" do
     it "should set a unique id" do
       id   = Object.new
@@ -60,6 +74,25 @@ describe CiInACan::TestRunner do
     end
+    describe "to_json" do
+      let(:fields) do
+        [:id, :passed, :output, :created_at]
+      end
+      it "should return json that contains the values" do
+        uuid = ::UUID.new
+        values = fields.reduce({}) { |t, i| t[i] = uuid.generate; t }
+        test_result = CiInACan::TestResult.new values
+        json = JSON.parse(test_result.to_json)
+        fields.each { |f| json[f.to_s].must_equal values[f] }
+      end
+    end
   end
 end

data/spec/spec_helper.rb CHANGED Viewed

@@ -4,8 +4,15 @@ require 'minitest/spec'
 require 'minitest/pride'
 require 'subtle'
 require 'contrast'
+require 'timecop'
 require 'mocha/setup'
 def CiInACan.results_location
   File.expand_path(File.dirname(__FILE__) + '/temp')
 end
+def clear_all_persisted_data
+  Dir["#{CiInACan.results_location}/*.yml"].each do |file|
+    File.delete file
+  end
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ci_in_a_can
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -227,6 +243,7 @@ files:
 - lib/ci_in_a_can/daemon.rb
 - lib/ci_in_a_can/github.rb
 - lib/ci_in_a_can/github_build_parser.rb
+- lib/ci_in_a_can/last_run_list.rb
 - lib/ci_in_a_can/persistence.rb
 - lib/ci_in_a_can/runner.rb
 - lib/ci_in_a_can/test_result.rb
@@ -234,6 +251,7 @@ files:
 - lib/ci_in_a_can/test_runner.rb
 - lib/ci_in_a_can/version.rb
 - lib/ci_in_a_can/watcher.rb
+- lib/ci_in_a_can/web_content.rb
 - sample.json
 - spec/ci_in_a_can/bash_result_spec.rb
 - spec/ci_in_a_can/bash_spec.rb
@@ -241,6 +259,7 @@ files:
 - spec/ci_in_a_can/cloner_spec.rb
 - spec/ci_in_a_can/github_build_parser_spec.rb
 - spec/ci_in_a_can/github_spec.rb
+- spec/ci_in_a_can/last_run_list_spec.rb
 - spec/ci_in_a_can/runner_spec.rb
 - spec/ci_in_a_can/test_result_notifier_spec.rb
 - spec/ci_in_a_can/test_result_spec.rb
@@ -263,7 +282,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 673563719843692982
+      hash: 2564814720268167254
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -272,10 +291,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 673563719843692982
+      hash: 2564814720268167254
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key:
 specification_version: 3
 summary: Fast CI. Still a WIP.
@@ -286,6 +305,7 @@ test_files:
 - spec/ci_in_a_can/cloner_spec.rb
 - spec/ci_in_a_can/github_build_parser_spec.rb
 - spec/ci_in_a_can/github_spec.rb
+- spec/ci_in_a_can/last_run_list_spec.rb
 - spec/ci_in_a_can/runner_spec.rb
 - spec/ci_in_a_can/test_result_notifier_spec.rb
 - spec/ci_in_a_can/test_result_spec.rb