Merge pull request github#286 from shiningpanda/master

technoweenie · technoweenie · commit b781a2f01eb1 · 2012-04-18T06:58:49.000-07:00
ShiningPanda Service
diff --git a/docs/shiningpanda b/docs/shiningpanda
@@ -0,0 +1,28 @@
+ShiningPanda
+============
+
+ShiningPanda is the first Hosted Continuous Integration service dedicated to Python.
+
+It allows you to build, test and deploy your projects in a matter of minutes!
+
+See https://www.shiningpanda.com for more information.
+
+Install Notes
+-------------
+
+  1. Workspace - This your workspace key. For instance if your Jenkins URL is https://jenkins.shiningpanda.com/shiningpanda.org, then your workspace key is "shiningpanda.org".
+  2. Job - This is the name of the job you want to trigger upon commit. For instance if the URL of your job in Jenkins is https://jenkins.shiningpanda.com/shiningpanda.org/job/selenose/, then your job name is selenose.
+  3. Token - This is the value of the "Authentication Token" field of the "Trigger builds remotely (e.g., from scripts)" option in the "Build Triggers" section of your job configuration.
+  4. Parameters (optional) - If your job takes parameters, this is the query string built from the parameters and their value (for instance "arg1=foo&arg2=bar"). All parameters have to be properly URL-escaped.
+
+Developer Notes
+---------------
+
+data
+  - workspace
+  - job
+  - token
+  - parameters (optional)
+
+payload
+  - refer to docs/github_payload
diff --git a/services/shiningpanda.rb b/services/shiningpanda.rb
@@ -0,0 +1,58 @@
+class Service::ShiningPanda < Service
+  string :workspace, :job, :token, :parameters
+
+  def receive_push
+    if workspace.empty?
+      raise_config_error 'Workspace not set'
+    end
+    if job.empty?
+      raise_config_error "Job not set"
+    end
+    if token.empty?
+      raise_config_error "Token not set"
+    end
+    if query.has_key?('token')
+      raise_config_error "Illegal parameter: token"
+    end
+    if query.has_key?('cause')
+      raise_config_error "Illegal parameter: cause"
+    end
+    Rack::Utils.parse_query(data['parameters']).each do |key, values|
+      if !values.is_a?(String) and values.length > 1
+        raise_config_error "Only one parameter value allowed for " + key
+      end
+    end
+    query[:token] = token
+    query[:cause] = "Triggered by a push of #{payload['pusher']['name']} (commit: #{payload['after']})"
+    http_post url, query
+  end
+
+  def cleanup(key)
+    ( data.has_key?(key) and data[key] != nil ) ? data[key] : ''
+  end
+  
+  def workspace
+    @workspace ||= cleanup('workspace').strip
+  end
+    
+  def job
+    @job ||= cleanup('job').strip
+  end
+
+  def token
+    @token ||= cleanup('token').strip
+  end
+  
+  def parameters
+    @parameters ||= Rack::Utils.parse_nested_query(cleanup('parameters'))
+  end
+  
+  def query
+    @query ||= parameters.clone
+  end
+  
+  def url
+    @url ||= "https://jenkins.shiningpanda.com/#{workspace}/job/#{job}/#{parameters.empty? ? 'build' : 'buildWithParameters'}"
+  end
+  
+end
diff --git a/test/shiningpanda_test.rb b/test/shiningpanda_test.rb
@@ -0,0 +1,158 @@
+require File.expand_path('../helper', __FILE__)
+
+class ShiningPandaTest < Service::TestCase
+  def setup
+    @stubs = Faraday::Adapter::Test::Stubs.new
+  end
+
+  def test_receive_push_without_parameters
+    @stubs.post '/shiningpanda.org/job/pygments/build' do |env|
+      form = Rack::Utils.parse_query(env[:body])
+      assert_equal 'PWFm8c2T', form['token']
+      assert_equal 'Triggered by a push of omansion (commit: 83d9205e73c25092ce7cb7ce530d2414e6d068cb)', form['cause']
+    end
+    svc = service(data, payload)
+    svc.receive_push
+  end
+
+  def test_receive_push_with_parameters
+    @stubs.post '/shiningpanda.org/job/pygments/buildWithParameters' do |env|
+      form = Rack::Utils.parse_query(env[:body])
+      assert_equal 'PWFm8c2T', form['token']
+      assert_equal 'Triggered by a push of omansion (commit: 83d9205e73c25092ce7cb7ce530d2414e6d068cb)', form['cause']
+      assert_equal 'bar', form['foo']
+    end
+    svc = service(data.merge({'parameters' => 'foo=bar'}), payload)
+    svc.receive_push
+  end
+  
+  def test_workspace_missing
+    svc = service({ 'job' => 'pygments', 'token' => 'PWFm8c2T' }, payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+
+  def test_workspace_nil
+    svc = service(data.merge({'workspace' => nil}), payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+
+  def test_workspace_blank
+    svc = service(data.merge({'workspace' => ''}), payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+  
+  def test_job_missing
+    svc = service({ 'workspace' => 'shiningpanda.org', 'token' => 'PWFm8c2T' }, payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+
+  def test_job_nil
+    svc = service(data.merge({'job' => nil}), payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+  
+  def test_job_blank
+    svc = service(data.merge({'job' => ''}), payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+  
+  def test_token_missing
+    svc = service({ 'workspace' => 'shiningpanda.org', 'job' => 'pygments' }, payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+
+  def test_token_nil
+    svc = service(data.merge({'token' => nil}), payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+  
+  def test_token_blank
+    svc = service(data.merge({'token' => ''}), payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+  
+  def test_url_without_parameters
+    svc = service(data, payload)
+    assert_equal "https://jenkins.shiningpanda.com/shiningpanda.org/job/pygments/build", svc.url
+  end
+
+  def test_url_nil_parameters
+    svc = service(data.merge({'parameters' => nil}), payload)
+    assert_equal "https://jenkins.shiningpanda.com/shiningpanda.org/job/pygments/build", svc.url
+  end
+  
+  def test_url_blank_parameters
+    svc = service(data.merge({'parameters' => ''}), payload)
+    assert_equal "https://jenkins.shiningpanda.com/shiningpanda.org/job/pygments/build", svc.url
+  end
+  
+  def test_url_with_parameters
+    svc = service(data.merge({'parameters' => 'foo=bar'}), payload)
+    assert_equal "https://jenkins.shiningpanda.com/shiningpanda.org/job/pygments/buildWithParameters", svc.url
+  end
+  
+  def test_url_strip_workspace
+    svc = service(data.merge({'workspace' => ' shiningpanda.org '}), payload)
+    assert_equal "https://jenkins.shiningpanda.com/shiningpanda.org/job/pygments/build", svc.url
+  end
+
+  def test_url_strip_job
+    svc = service(data.merge({'job' => ' pygments '}), payload)
+    assert_equal "https://jenkins.shiningpanda.com/shiningpanda.org/job/pygments/build", svc.url
+  end
+
+  def test_strip_token
+    @stubs.post '/shiningpanda.org/job/pygments/build' do |env|
+      assert_equal 'PWFm8c2T', Rack::Utils.parse_query(env[:body])['token']
+    end
+    svc = service(data.merge({'token' => ' PWFm8c2T '}), payload)
+    svc.receive_push
+  end
+
+  def test_multi_valued_parameter
+    svc = service(data.merge({'parameters' => 'foo=bar&foo=toto'}), payload)
+    assert_raise Service::ConfigurationError do
+      svc.receive_push
+    end
+  end
+  
+  def service(*args)
+    super Service::ShiningPanda, *args
+  end
+
+  def payload
+    {
+      'after'  => '83d9205e73c25092ce7cb7ce530d2414e6d068cb',
+      'pusher' => {
+        'name'   => 'omansion',
+      }
+    }
+  end
+  
+  def data
+    {
+      'workspace' => 'shiningpanda.org',
+      'job'       => 'pygments',
+      'token'     => 'PWFm8c2T',
+    }
+  end
+end
+
