kender 0.1.5 → 0.1.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDQwMWQ5ZGYwMmJjOTQ4OGUwYTA0MDE2YWNjYjY4YjJmOWUyYzUzOA==
+    YjViZmI3ZGQwMjE4YjgyYjliOGNkOWE4ZmIwMzlmZjE1YTdlYjRmZA==
   data.tar.gz: !binary |-
-    MzQzODJkYzUwY2NlOWNkMjlmZjAyZjljNGRmYTNmMjlkZTA3ZmM1OQ==
+    ZjVlMjIxYWI4NzZjYWYxZThkYmZkOTIyZjgyYWNlMTM1MWQzMmIyZg==
 SHA512:
   metadata.gz: !binary |-
-    ODgwNWZkY2M3OTIzODZiMjc2ZmRjNGVmZTNjNTRkZTgxZWQ3NDZhYWY1MmY3
-    ZGQxZTQ2ZTQwZTNlNGMxZjc4MGE0MTgyMGE5Y2YyYWM3MGI5Njc2ZWYyZjZi
-    YzkyMzlmZGUzMjNmODY2YmRhMjhiMmVlYzkzNTg2M2Y1OGNmNDU=
+    N2MwMWU2OGQ4M2Q0OWJjZGY2ZDU0ZmNhMmE0NGU3ZGNhNTcwMjU1NjllMTIx
+    ZDIzYmZhM2M3ZDI0N2Y4MTljYzYwM2Q4NDZlMWE0ZDAwNGM5ZWEyNjA4MjJk
+    YzkyM2EwN2MzY2Q1MDIxYWJlNTY2YWYyNjE3NGRmZWZlYmJjYjA=
   data.tar.gz: !binary |-
-    YWMzYzI2NWY3MGRmZTI1MGMzMmRkNDBiNmRjNThlOTFmMDk5MWMzN2EzODcy
-    ODE5OGQ2OTFhMzVjMWMwNzJmNzIzZTFlOWI3YmQ3YmQ0ODczMzNjMmQ0YWYx
-    ZjE3NTJjNjgwYjU2N2Q2ZDNmZjc4MDM3ODhjMjcyMTk4YzRhNmU=
+    MjlhZGQwZjA5M2ZiYjExZGU5ZGI1ZTIzZWQxNzU5NGQ2Y2FjNGJhZGJlNjQ3
+    YmJhYmUzZjRmMTRmN2I0YTM2NjlhMWQ4ZjFiNTY1Y2IxNmViNTI1NWFmM2Iz
+    NTU1M2M5MDY1OTQ0MDg0MDhkOTRlNThlZmVjOWY0MmYyNzFiZGU=

data/features/install.feature

@@ -0,0 +1,13 @@
+Feature: Install
+
+  In Rails projects, Kender tasks are loaded automatically. For other
+  projects, add `require 'kender/tasks'` to your `Rakefile` or wherever your
+  local rake tasks are defined.
+
+  Scenario: Require Kender tasks in Rakefile
+    Given a file named "Rakefile" with:
+      """
+      require 'kender/tasks'
+      """
+    When I run `rake ci`
+    Then the exit status should be 0

data/features/scenarios.feature

@@ -0,0 +1,49 @@
+Feature: Scenarios
+  Kender is able to run scenarios using the cucumber tool.
+
+  Background:
+    Given a file named "Gemfile" with:
+      """
+      source 'https://rubygems.org'
+      gem 'cucumber', '~>1.3'
+      """
+    And I run `bundle install`
+
+  Scenario: The project has no scenarios to run but cucumber is executed
+    When I run `rake ci`
+    Then it should pass with:
+    """
+    0 scenarios
+    0 steps
+    """
+
+  Scenario: The project has some passing scenarios to run
+    Given a file named "features/testing.feature" with:
+      """
+      Feature: test
+      This is a test of my product
+      Scenario: first test
+      """
+    When I run `rake ci`
+    Then it should pass with:
+    """
+    1 scenario (1 passed)
+    0 steps
+    """
+
+  Scenario: The project has some non passing scenarios to run
+    Given a file named "features/testing.feature" with:
+      """
+      Feature: test
+      This is a test of my product
+      Scenario: first test
+      Then failing step
+      """
+    And a file named "features/step_definitions/steps.rb" with:
+      """
+      Given(/^failing step$/) do
+        raise 'failed'
+      end
+      """
+    When I run `rake ci`
+    Then the exit status should not be 0

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require 'aruba/cucumber'
+require 'kender'
+
+Before do
+    @aruba_timeout_seconds = 10
+end

data/features/support/hooks.rb

@@ -0,0 +1,5 @@
+Before do
+  write_file("Rakefile", "require 'kender/tasks'")
+  create_dir('features')
+  create_dir('spec')
+end

data/lib/kender/command.rb

@@ -11,11 +11,11 @@ module Kender
     end
 
     def available?
-      raise RuntimeError, "Command failed: #{name}, availability status undefined."
+      abort "Command failed: #{name}, availability status undefined."
     end
 
     def execute
-      raise RuntimeError, "Command failed: #{command}" unless run.success?
+      abort "Command failed: #{command}" unless run.success?
     end
 
     #TODO: system reload all the gems again, avoid this.
@@ -43,9 +43,17 @@ module Kender
       end
 
     end
+
+    private
+
+    def in_gemfile?(gem_name)
+      Bundler.definition.specs.any?{ |spec| spec.name == gem_name }
+    end
+
   end
 end
 
+require_relative 'commands/consistency_fail'
 require_relative 'commands/jasmine'
 require_relative 'commands/brakeman'
 require_relative 'commands/bundle_audit'

data/lib/kender/commands/brakeman.rb

@@ -2,7 +2,7 @@ module Kender
   class Brakeman < Command
 
     def available?
-      defined?(::Brakeman)
+      in_gemfile?('brakeman')
     end
 
     def command

data/lib/kender/commands/bundle_audit.rb

@@ -2,7 +2,7 @@ module Kender
   class BundleAudit < Command
 
     def available?
-      defined?(::Bundler::Audit)
+      in_gemfile?('bundler-audit')
     end
 
     def command

data/lib/kender/commands/consistency_fail.rb

@@ -0,0 +1,13 @@
+module Kender
+  class ConsistencyFail < Command
+
+    def available?
+      in_gemfile?("consistency_fail")
+    end
+
+    def command
+      'bundle exec consistency_fail'
+    end
+
+  end
+end

data/lib/kender/commands/cucumber.rb

@@ -2,7 +2,7 @@ module Kender
   class Cucumber < Command
 
     def available?
-      defined?(Cucumber) and not(ENV['VALIDATE_PROJECT'])
+      in_gemfile?("cucumber") and not(ENV['VALIDATE_PROJECT'])
     end
 
     def command

data/lib/kender/commands/rspec.rb

@@ -2,7 +2,7 @@ module Kender
   class Rspec < Command
 
     def available?
-      defined?(RSpec) and not(ENV['VALIDATE_PROJECT'])
+      in_gemfile?("rspec") and not(ENV['VALIDATE_PROJECT'])
     end
 
     def command

data/lib/kender/commands/shamus.rb

@@ -2,7 +2,7 @@ module Kender
   class Shamus < Command
 
     def available?
-      defined?(Shamus) and ENV['VALIDATE_PROJECT']
+      in_gemfile?("shamus") and ENV['VALIDATE_PROJECT']
     end
 
     def command

data/lib/kender/commands/test_unit.rb

@@ -2,7 +2,7 @@ module Kender
   class TestUnit < Command
 
     def available?
-      defined?(Test::Unit) and not(ENV['VALIDATE_PROJECT'])
+      in_gemfile?('test-unit') and not(ENV['VALIDATE_PROJECT'])
     end
 
     def command

data/lib/kender/github.rb

@@ -21,6 +21,11 @@ module Kender
       # TODO: Refactor the following code to use gems like git/grit/rugged and
       # octokit. ~asmith
 
+      unless config.github_auth_token
+        puts "Skipping setting the status on Github to #{state} because the access token is not configured"
+        return
+      end
+
       body = %Q({
         "state": "#{state.to_s}",
         "target_url": "#{config.build_url}",
@@ -28,28 +33,39 @@ module Kender
       })
       commit = `git log -1 --format=format:%H`
       remotes = `git remote --verbose`
+      remote_name = ENV['GITHUB_REMOTE'] || 'origin'
 
-      unless repo = /^origin\s+git@github.com:(\w+\/\w+)\b/.match(remotes)[1]
-        put "Could not establish GitHub repo name from 'origin' remote"
+      unless repo = /^#{remote_name}\s+git@(\w+\.)?github.com:([\w-]+\/[\w-]+)\b/.match(remotes).to_a.last
+        puts "Could not establish GitHub repo name from '#{remote_name}' remote"
         return
       end
-
       uri = URI("https://api.github.com/repos/#{repo}/statuses/#{commit}?access_token=#{config.github_auth_token}")
 
-      if config.github_auth_token
-        puts "Setting #{repo} commit #{commit} status to '#{state}' on GitHub"
-      else
-        puts "Skipping setting #{repo} commit #{commit} status to '#{state}' on GitHub because access token not configured"
-        return
-      end
+      puts "Setting #{repo} commit #{commit} status to '#{state}' on GitHub"
 
-      Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
-        response = http.post(uri.request_uri, body)
-        unless response.is_a?(Net::HTTPCreated)
-          puts "Setting commit status FAILED", response
+      ensure_real_connection do
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+          response = http.post(uri.request_uri, body)
+          unless response.is_a?(Net::HTTPCreated)
+            puts "Setting commit status FAILED", response
+          end
         end
       end
     end
+
+    def ensure_real_connection
+      if !defined?(WebMock)
+        return yield
+      end
+      if !WebMock.net_connect_allowed?
+        WebMock.allow_net_connect!
+        yield
+        WebMock.disable_net_connect!
+      else
+        yield
+      end
+    end
+
   end
 end
 

data/lib/kender/tasks/ci.rake

@@ -5,6 +5,15 @@ require 'kender/configuration'
 require 'kender/github'
 require 'kender/command'
 
+# Helper method to call rake tasks without blowing up when they do not exists
+# @Return: false when it could not be executed or there was some error.
+def run_successfully?(tasks)
+  [*tasks].all? do |task|
+    Rake::Task.task_defined?(task) && Rake::Task[task].invoke
+  end
+end
+
+# This is the task we want the user to use all the time.
 desc "Configure and run continuous integration tests then clean up"
 task :ci => ['ci:status:pending'] do
   begin
@@ -13,7 +22,6 @@ task :ci => ['ci:status:pending'] do
     Rake::Task["ci:status:success"].invoke
   rescue Exception => e
     Rake::Task["ci:status:failure"].invoke
-
     # Ensure that this task still fails.
     raise e
   ensure
@@ -23,11 +31,9 @@ end
 
 namespace :ci do
 
+  # UI for the user, these are tasks the user can use
   desc "Configure the app to run continuous integration tests"
-  # Could depend on 'db:schema:load' or 'db:setup' here instead of 'db:migrate'
-  # if the 'db/schema.rb' file was committed to the repo (as per Rails
-  # recommendations).
-  task :config => ['ci:env', 'config:all', 'ci:setup_db']
+  task :config => ['ci:env', 'ci:config_project', 'ci:setup_db']
 
   desc "Run continuous integration tests with the current configuration"
   task :run =>  ['ci:env'] + Kender::Command.all_tasks
@@ -35,6 +41,15 @@ namespace :ci do
   desc "Destroy resources created externally for the continuous integration run, e.g. drops databases"
   task :clean => ['ci:env', 'ci:drop_db']
 
+  # Automatically create rake task for each individual command.
+  Kender::Command.all.each do |command|
+    desc "Individual task for #{command.name}, in parallel if available."
+    task command.name do
+      command.execute
+    end
+  end
+
+  # The following tasks are internal to us, without description, the user can not discover them
   task :env do
     if defined?(Rails)
       # Default to the 'test' environment unless otherwise specified. This
@@ -47,33 +62,40 @@ namespace :ci do
     end
   end
 
-  # Automatically create rake task for each individual command.
-  Kender::Command.all.each do |command|
-    desc "Individual task for #{command.name}, in parallel if available."
-    task command.name do
-      command.execute
+  task :config_project do
+    unless run_successfully?('config:all')
+      puts 'Your project could not be configured, a config:all task needed. Consider installing dice_bag'
     end
   end
 
-  desc "Generic task to setup your databases, in parallel if available."
   task :setup_db do
-    if !defined?(ParallelTests)
-      Rake::Task['db:create'].invoke
-      Rake::Task['db:migrate'].invoke
+    if Rake::Task.task_defined?('db:create')
+      if !defined?(ParallelTests)
+        unless run_successfully?(['db:create', 'db:migrate'])
+          puts 'The DB could not be set up successfully.'
+        end
+      else
+        #TODO: invoke on the task did not work. Why?
+        system('bundle exec rake parallel:create')
+        system('bundle exec rake parallel:prepare')
+      end
     else
-      #TODO: invoke on the task did not work. Why?
-      system('bundle exec rake parallel:create')
-      system('bundle exec rake parallel:prepare')
+      puts "no databases tasks found."
     end
   end
 
-  desc "Generic task to drop your databases, in parallel if available."
   task :drop_db do
-    if !defined?(ParallelTests)
-      Rake::Task['db:drop'].invoke
+    if Rake::Task.task_defined?('db:drop')
+      if !defined?(ParallelTests)
+        unless run_successfully?('db:drop')
+          puts 'The DB could not be dropped.'
+        end
+      else
+        #TODO: invoke on the task did not work. Why?
+        system('bundle exec rake parallel:drop')
+      end
     else
-      #TODO: invoke on the task did not work. Why?
-      system('bundle exec rake parallel:drop')
+      puts "no databases tasks found."
     end
   end
 

data/lib/kender/version.rb

@@ -1,3 +1,3 @@
 module Kender
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kender
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Andrew Smith
@@ -25,6 +25,34 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 
 email:
 - asmith@mdsol.com
@@ -33,10 +61,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- features/install.feature
+- features/scenarios.feature
+- features/support/env.rb
+- features/support/hooks.rb
 - lib/kender.rb
 - lib/kender/command.rb
 - lib/kender/commands/brakeman.rb
 - lib/kender/commands/bundle_audit.rb
+- lib/kender/commands/consistency_fail.rb
 - lib/kender/commands/cucumber.rb
 - lib/kender/commands/jasmine.rb
 - lib/kender/commands/rspec.rb
@@ -72,5 +105,9 @@ signing_key:
 specification_version: 4
 summary: Kender is a library of rake tasks that provides a consistent framework for
   continuous integration (CI).
-test_files: []
+test_files:
+- features/install.feature
+- features/scenarios.feature
+- features/support/env.rb
+- features/support/hooks.rb
 has_rdoc: