xxx-integrity-script 0.1.0

data/README.markdown

@@ -0,0 +1,47 @@
+# Integrity Script Notifier
+
+With this notifier, Integrity will call a script/program/whatever,
+passing 'pass' or 'fail' as an argument, along with other optional args.
+
+This was originally conceived so the author could have Integrity talk to a script that talks to an Arduino.
+
+
+# Installation
+
+1. (sudo) gem install xxx-integrity-script --source http://gems.github.com
+
+2. In your config.ru add:
+
+        require "integrity/notifier/script"
+
+3. Restart Integrity, then hit your project in a browser to configure the notifier from there.
+
+# Stuff
+
+There are security implications here in that this is purposely opening up an arbitrary code execution, and nothing is done to prevent bad things from happening right now. Be aware of that. Do not use this code on public CI servers.
+
+
+# License
+
+(The MIT License)
+
+Copyright (c) 2009 - M. Dungan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+task :default => :test
+
+task :test do
+  ruby "test/integrity_script_test.rb"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "integrity-script"
+    gemspec.summary = "Integrity notifier that runs an arbitrary script"
+    gemspec.description = "This notifier will execute a script of your choosing, passing pass/fail as well as any extra args you choose to it. It was originally conceived to be used to talk to an Arduino board"
+    gemspec.email = "mpd@jesters-court.net"
+    gemspec.homepage = "http://github.com/xxx/integrity-script"
+    gemspec.authors = ["Michael Dungan"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+
+#begin
+#  require "mg"
+#  MG.new("integrity-script.gemspec")
+#rescue LoadError
+#end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/integrity-script.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{integrity-script}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Dungan"]
+  s.date = %q{2009-09-14}
+  s.description = %q{This notifier will execute a script of your choosing, passing pass/fail as well as any extra args you choose to it. It was originally conceived to be used to talk to an Arduino board}
+  s.email = %q{mpd@jesters-court.net}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "VERSION"
+  ]
+  s.homepage = %q{http://github.com/xxx/integrity-script}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Integrity notifier that runs an arbitrary script}
+  s.test_files = [
+    "test/integrity_script_test.rb",
+     "test/test_script.rb"
+  ]
+
+  s.files = %w[
+    README.markdown
+    VERSION
+    Rakefile
+    integrity-script.gemspec
+    lib/integrity/notifier/config.haml
+    lib/integrity/notifier/script.rb
+    test/integrity_script_test.rb
+    test/test_script.rb
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/integrity/notifier/config.haml

@@ -0,0 +1,8 @@
+%p.normal
+  %label{ :for => "script_notifier_script_path" } Script path (make sure it's readable and executable!)
+  %input.text#script_notifier_script_path{ :name => "notifiers[Script][script_path]", :type => "text", :value => config["script_path"] }
+
+%p.normal
+  %label{ :for => "script_notifier_extra_args" } Extra args, to be added at the end of the invocation.
+  %input.text#script_notifier_extra_args{ :name => "notifiers[Script][extra_args]", :type => "text", :value => config["extra_args"] }
+

data/lib/integrity/notifier/script.rb

@@ -0,0 +1,25 @@
+require "integrity"
+
+module Integrity
+  class Notifier
+    class Script < Notifier::Base
+      attr_reader :script_path, :extra_args
+
+      def self.to_haml
+        File.read(File.dirname(__FILE__) + "/config.haml")
+      end
+
+      def initialize(commit, config={})
+        @script_path  = config.delete("script_path") || '/bin/echo'
+        @extra_args   = config.delete("extra_args") || ''
+        super(commit, config)
+      end
+
+      def deliver!
+        `#{script_path} #{commit.successful? ? "pass" : "fail"} #{extra_args}`
+      end
+    end
+
+    register Script
+  end
+end

data/test/integrity_script_test.rb

@@ -0,0 +1,79 @@
+require "test/unit"
+require "integrity/notifier/test"
+
+begin
+  require "redgreen"
+rescue LoadError
+end
+
+require File.dirname(__FILE__) + "/../lib/integrity/notifier/script"
+
+class IntegrityScriptTest < Test::Unit::TestCase
+  include Integrity::Notifier::Test
+
+  def notifier
+    "Script"
+  end
+
+  def setup
+    setup_database
+  end
+
+  def commit(status=:successful)
+    Integrity::Commit.gen(status)
+  end
+
+  def teardown
+    File.unlink(testing_file) if File.exist?(testing_file)
+  end
+
+  def test_it_passes_pass
+    line = get_arg_for_status(:successful)
+    assert_equal 'pass', line.chomp
+  end
+
+  def test_it_passes_fail
+    line = get_arg_for_status(:failed)
+    assert_equal 'fail', line.chomp
+  end
+
+  def test_it_passes_extra_args
+    line = nil
+    Integrity::Notifier::Script.new(commit,
+                                    'script_path' => testing_script,
+                                   'extra_args' => 'foobar').deliver!
+
+    File.open(testing_file, 'r') do |f|
+      f.gets # skip pass/fail
+      line = f.gets
+    end
+    assert_equal 'foobar', line.chomp
+  end
+
+  def test_configuration_form
+    assert form_have_tag? "#script_notifier_script_path"
+    assert form_have_tag? "#script_notifier_extra_args"
+  end
+
+  private
+
+  def get_arg_for_status(commit_status)
+    line = nil
+    Integrity::Notifier::Script.new(commit(commit_status),
+                                    'script_path' => testing_script,
+                                   'extra_args' => 'foobar').deliver!
+
+    File.open(testing_file, 'r') do |f|
+      line = f.gets
+    end
+    line
+  end
+
+  def testing_file
+    File.join(File.dirname(__FILE__), 'shumway.txt')
+  end
+
+  def testing_script
+    File.join(File.dirname(__FILE__), 'test_script.rb')
+  end
+end

data/test/test_script.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+@arg = ARGV.first
+@extra = ARGV.last
+
+File.open(File.join(File.dirname(__FILE__), 'shumway.txt'), 'w') do |f|
+  f.write(@arg + "\n")
+  f.write(@extra + "\n")
+end
+
+exit 69

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: xxx-integrity-script
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Dungan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This notifier will execute a script of your choosing, passing pass/fail as well as any extra args you choose to it. It was originally conceived to be used to talk to an Arduino board
+email: mpd@jesters-court.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- VERSION
+- Rakefile
+- integrity-script.gemspec
+- lib/integrity/notifier/config.haml
+- lib/integrity/notifier/script.rb
+- test/integrity_script_test.rb
+- test/test_script.rb
+has_rdoc: false
+homepage: http://github.com/xxx/integrity-script
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Integrity notifier that runs an arbitrary script
+test_files: 
+- test/integrity_script_test.rb
+- test/test_script.rb