codeclimate-services 0.3.0

data/test/github_pull_requests_test.rb

@@ -0,0 +1,293 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestGitHubPullRequests < CC::Service::TestCase
+  def test_pull_request_status_pending
+    expect_status_update("pbrisbin/foo", "abc123", {
+      "state"       => "pending",
+      "description" => /is analyzing/,
+    })
+
+    receive_pull_request({ update_status: true }, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "pending",
+    })
+  end
+
+  def test_pull_request_status_success_detailed
+    expect_status_update("pbrisbin/foo", "abc123", {
+      "state"       => "success",
+      "description" => "Code Climate found 2 new issues and 1 fixed issue.",
+    })
+
+    receive_pull_request(
+      { update_status: true },
+      {
+        github_slug: "pbrisbin/foo",
+        commit_sha:  "abc123",
+        state:       "success"
+      }
+    )
+  end
+
+  def test_pull_request_status_failure
+    expect_status_update("pbrisbin/foo", "abc123", {
+      "state"       => "failure",
+      "description" => "Code Climate found 2 new issues and 1 fixed issue.",
+    })
+
+    receive_pull_request(
+      { update_status: true },
+      {
+        github_slug: "pbrisbin/foo",
+        commit_sha:  "abc123",
+        state:       "failure"
+      }
+    )
+  end
+
+  def test_pull_request_status_success_generic
+    expect_status_update("pbrisbin/foo", "abc123", {
+      "state"       => "success",
+      "description" => /found 2 new issues and 1 fixed issue/,
+    })
+
+    receive_pull_request({ update_status: true }, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "success",
+    })
+  end
+
+  def test_pull_request_status_error
+    expect_status_update("pbrisbin/foo", "abc123", {
+      "state"       => "error",
+      "description" => CC::Service::GitHubPullRequests::DEFAULT_ERROR,
+    })
+
+    receive_pull_request({ update_status: true }, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "error",
+      message:     nil,
+    })
+  end
+
+    def test_pull_request_status_error_message_provided
+    expect_status_update("pbrisbin/foo", "abc123", {
+      "state"       => "error",
+      "description" => "descriptive message",
+    })
+
+    receive_pull_request({ update_status: true }, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "error",
+      message:     "descriptive message",
+    })
+  end
+
+  def test_pull_request_status_skipped
+    expect_status_update("pbrisbin/foo", "abc123", {
+      "state"       => "success",
+      "description" => /skipped analysis/,
+    })
+
+    receive_pull_request({ update_status: true }, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "skipped",
+    })
+  end
+
+  def test_no_status_update_for_skips_when_update_status_config_is_falsey
+    # With no POST expectation, test will fail if request is made.
+
+    receive_pull_request({}, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "skipped",
+    })
+  end
+
+  def test_no_status_update_for_pending_when_update_status_config_is_falsey
+    # With no POST expectation, test will fail if request is made.
+
+    receive_pull_request({}, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "pending",
+    })
+  end
+
+  def test_no_status_update_for_error_when_update_status_config_is_falsey
+    # With no POST expectation, test will fail if request is made.
+
+    receive_pull_request({}, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "error",
+      message:     nil,
+    })
+  end
+
+
+  def test_no_comment_for_skips_regardless_of_add_comment_config
+    # With no POST expectation, test will fail if request is made.
+
+    receive_pull_request({ add_comment: true }, {
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "skipped",
+    })
+  end
+
+  def test_pull_request_status_test_success
+    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [422, {}, ""] }
+
+    assert receive_test({ update_status: true }, { github_slug: "pbrisbin/foo" })[:ok], "Expected test of pull request to be true"
+  end
+
+  def test_pull_request_status_test_failure
+    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [401, {}, ""] }
+
+    assert_raises(CC::Service::HTTPError) do
+      receive_test({ update_status: true }, { github_slug: "pbrisbin/foo" })
+    end
+  end
+
+  def test_pull_request_comment_test_success
+    @stubs.get("/user") { |env| [200, { "x-oauth-scopes" => "gist, user, repo" }, ""] }
+
+    assert receive_test({ add_comment: true })[:ok], "Expected test of pull request to be true"
+  end
+
+  def test_pull_request_comment_test_failure_insufficient_permissions
+    @stubs.get("/user") { |env| [200, { "x-oauth-scopes" => "gist, user" }, ""] }
+
+    assert !receive_test({ add_comment: true })[:ok], "Expected failed test of pull request"
+  end
+
+  def test_pull_request_comment_test_failure_bad_token
+    @stubs.get("/user") { |env| [401, {}, ""] }
+
+    assert !receive_test({ add_comment: true })[:ok], "Expected failed test of pull request"
+  end
+
+  def test_pull_request_failure_on_status_requesting_both
+    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [401, {}, ""] }
+
+    assert_raises(CC::Service::HTTPError) do
+      receive_test({ update_status: true, add_comment: true }, { github_slug: "pbrisbin/foo" })
+    end
+  end
+
+  def test_pull_request_failure_on_comment_requesting_both
+    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [422, {}, ""] }
+    @stubs.get("/user") { |env| [401, { "x-oauth-scopes" => "gist, user, repo" }, ""] }
+
+    assert_false receive_test({ update_status: true, add_comment: true }, { github_slug: "pbrisbin/foo" })[:ok]
+  end
+
+  def test_pull_request_success_both
+    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [422, {}, ""] }
+    @stubs.get("/user") { |env| [200, { "x-oauth-scopes" => "gist, user, repo" }, ""] }
+
+    assert receive_test({ update_status: true, add_comment: true }, { github_slug: "pbrisbin/foo" })[:ok], "Expected test of pull request to be true"
+  end
+
+  def test_pull_request_comment
+    stub_existing_comments("pbrisbin/foo", 1, %w[Hey Yo])
+
+    expect_comment("pbrisbin/foo", 1, %r{href="http://example.com">analyzed})
+
+    receive_pull_request({ add_comment: true }, {
+      github_slug: "pbrisbin/foo",
+      number:      1,
+      state:       "success",
+      compare_url: "http://example.com",
+      issue_comparison_counts: {
+        "fixed" => 2,
+        "new"   => 1,
+      }
+    })
+  end
+
+  def test_pull_request_comment_already_present
+    stub_existing_comments("pbrisbin/foo", 1, [
+      '<b>Code Climate</b> has <a href="">analyzed this pull request</a>'
+    ])
+
+    # With no POST expectation, test will fail if request is made.
+
+    response = receive_pull_request({
+      add_comment: true,
+      update_status: false
+    }, {
+      github_slug: "pbrisbin/foo",
+      number:      1,
+      state:       "success",
+    })
+
+    assert_equal({ ok: true, message: "Comment already present" }, response)
+  end
+
+  def test_pull_request_unknown_state
+    response = receive_pull_request({}, { state: "unknown" })
+
+    assert_equal({ ok: false, message: "Unknown state" }, response)
+  end
+
+  def test_pull_request_nothing_happened
+    response = receive_pull_request({}, { state: "success" })
+
+    assert_equal({ ok: false, message: "Nothing happened" }, response)
+  end
+
+private
+
+  def expect_status_update(repo, commit_sha, params)
+    @stubs.post "repos/#{repo}/statuses/#{commit_sha}" do |env|
+      assert_equal "token 123", env[:request_headers]["Authorization"]
+
+      body = JSON.parse(env[:body])
+
+      params.each do |k, v|
+        assert v === body[k],
+          "Unexpected value for #{k}. #{v.inspect} !== #{body[k].inspect}"
+      end
+    end
+  end
+
+  def stub_existing_comments(repo, number, bodies)
+    body = bodies.map { |b| { body: b } }.to_json
+
+    @stubs.get("repos/#{repo}/issues/#{number}/comments") { [200, {}, body] }
+  end
+
+  def expect_comment(repo, number, content)
+    @stubs.post "repos/#{repo}/issues/#{number}/comments" do |env|
+      body = JSON.parse(env[:body])
+      assert_equal "token 123", env[:request_headers]["Authorization"]
+      assert content === body["body"],
+        "Unexpected comment body. #{content.inspect} !== #{body["body"].inspect}"
+      [200, {}, '{"id": 2}']
+    end
+  end
+
+  def receive_pull_request(config, event_data)
+    receive(
+      CC::Service::GitHubPullRequests,
+      { oauth_token: "123" }.merge(config),
+      { name: "pull_request", issue_comparison_counts: {'fixed' => 1, 'new' => 2} }.merge(event_data)
+    )
+  end
+
+  def receive_test(config, event_data = {})
+    receive(
+      CC::Service::GitHubPullRequests,
+      { oauth_token: "123" }.merge(config),
+      { name: "test", issue_comparison_counts: {'fixed' => 1, 'new' => 2} }.merge(event_data)
+    )
+  end
+end

data/test/helper.rb

@@ -0,0 +1,50 @@
+require 'test/unit'
+require 'mocha/test_unit'
+require 'pp'
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+cwd = File.expand_path(File.dirname(__FILE__))
+require "#{cwd}/../config/load"
+require "#{cwd}/fixtures"
+Dir["#{cwd}/support/*.rb"].sort.each do |helper|
+  require helper
+end
+CC::Service.load_services
+
+
+class CC::Service::TestCase < Test::Unit::TestCase
+  def setup
+    @stubs = Faraday::Adapter::Test::Stubs.new
+
+    I18n.enforce_available_locales = true
+  end
+
+  def teardown
+    @stubs.verify_stubbed_calls
+  end
+
+  def service(klass, data, payload)
+    service = klass.new(data, payload)
+    service.http :adapter => [:test, @stubs]
+    service
+  end
+
+  def receive(*args)
+    service(*args).receive
+  end
+
+  def service_post(*args)
+    service(
+      CC::Service,
+      { data: "my data" },
+      event(:quality, to: "D", from: "C")
+    ).service_post(*args)
+  end
+
+  def stub_http(url, response = nil, &block)
+    block ||= lambda{|*args| response }
+    @stubs.post(url, &block)
+  end
+end

data/test/hipchat_test.rb

@@ -0,0 +1,130 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestHipChat < CC::Service::TestCase
+  def test_test_hook
+    assert_hipchat_receives(
+      "green",
+      { name: "test", repo_name: "Rails" },
+      "[Rails] This is a test of the HipChat service hook"
+    )
+  end
+
+  def test_coverage_improved
+    e = event(:coverage, to: 90.2, from: 80)
+
+    assert_hipchat_receives("green", e, [
+      "[Example]",
+      "<a href=\"https://codeclimate.com/repos/1/feed\">Test coverage</a>",
+      "has improved to 90.2% (+10.2%)",
+      "(<a href=\"https://codeclimate.com/repos/1/compare\">Compare</a>)"
+    ].join(" "))
+  end
+
+  def test_coverage_declined
+    e = event(:coverage, to: 88.6, from: 94.6)
+
+    assert_hipchat_receives("red", e, [
+      "[Example]",
+      "<a href=\"https://codeclimate.com/repos/1/feed\">Test coverage</a>",
+      "has declined to 88.6% (-6.0%)",
+      "(<a href=\"https://codeclimate.com/repos/1/compare\">Compare</a>)"
+    ].join(" "))
+  end
+
+  def test_quality_improved
+    e = event(:quality, to: "A", from: "B")
+
+    assert_hipchat_receives("green", e, [
+      "[Example]",
+      "<a href=\"https://codeclimate.com/repos/1/feed\">User</a>",
+      "has improved from a B to an A",
+      "(<a href=\"https://codeclimate.com/repos/1/compare\">Compare</a>)"
+    ].join(" "))
+  end
+
+  def test_quality_declined_without_compare_url
+    e = event(:quality, to: "D", from: "C")
+
+    assert_hipchat_receives("red", e, [
+      "[Example]",
+      "<a href=\"https://codeclimate.com/repos/1/feed\">User</a>",
+      "has declined from a C to a D",
+      "(<a href=\"https://codeclimate.com/repos/1/compare\">Compare</a>)"
+    ].join(" "))
+  end
+
+  def test_single_vulnerability
+    e = event(:vulnerability, vulnerabilities: [
+      { "warning_type" => "critical" }
+    ])
+
+    assert_hipchat_receives("red", e, [
+      "[Example]",
+      "New <a href=\"https://codeclimate.com/repos/1/feed\">critical</a>",
+      "issue found",
+    ].join(" "))
+  end
+
+  def test_single_vulnerability_with_location
+    e = event(:vulnerability, vulnerabilities: [{
+      "warning_type" => "critical",
+      "location" => "app/user.rb line 120"
+    }])
+
+    assert_hipchat_receives("red", e, [
+      "[Example]",
+      "New <a href=\"https://codeclimate.com/repos/1/feed\">critical</a>",
+      "issue found in app/user.rb line 120",
+    ].join(" "))
+  end
+
+  def test_multiple_vulnerabilities
+    e = event(:vulnerability, warning_type: "critical", vulnerabilities: [{
+      "warning_type" => "unused",
+      "location" => "unused"
+    }, {
+      "warning_type" => "unused",
+      "location" => "unused"
+    }])
+
+    assert_hipchat_receives("red", e, [
+      "[Example]",
+      "2 new <a href=\"https://codeclimate.com/repos/1/feed\">critical</a>",
+      "issues found",
+    ].join(" "))
+  end
+
+  def test_receive_test
+    @stubs.post '/v1/rooms/message' do |env|
+      [200, {}, '']
+    end
+
+    response = receive_event(name: "test")
+
+    assert_equal "Test message sent", response[:message]
+  end
+
+  private
+
+  def assert_hipchat_receives(color, event_data, expected_body)
+    @stubs.post '/v1/rooms/message' do |env|
+      body = Hash[URI.decode_www_form(env[:body])]
+      assert_equal "token", body["auth_token"]
+      assert_equal "123", body["room_id"]
+      assert_equal "true", body["notify"]
+      assert_equal color, body["color"]
+      assert_equal expected_body, body["message"]
+      [200, {}, '']
+    end
+
+    receive_event(event_data)
+  end
+
+  def receive_event(event_data = nil)
+    receive(
+      CC::Service::HipChat,
+      { auth_token: "token", room_id: "123", notify: true },
+      event_data || event(:quality, from: "C", to: "D")
+    )
+  end
+end

data/test/invocation_error_handling_test.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../helper', __FILE__)
+
+class InvocationErrorHandling < CC::Service::TestCase
+  def test_success_returns_upstream_result
+    handler = CC::Service::Invocation::WithErrorHandling.new(
+      lambda { :success },
+      FakeLogger.new,
+      "not important"
+    )
+
+    assert_equal :success, handler.call
+  end
+
+  def test_http_errors_return_relevant_data
+    logger = FakeLogger.new
+    env = {
+      status: 401,
+      params: "params",
+      url: "url"
+    }
+
+    handler = CC::Service::Invocation::WithErrorHandling.new(
+      lambda { raise CC::Service::HTTPError.new("foo", env) },
+      logger,
+      "prefix"
+    )
+
+    result = handler.call
+    assert_equal false, result[:ok]
+    assert_equal 401, result[:status]
+    assert_equal "params", result[:params]
+    assert_equal "url", result[:endpoint_url]
+    assert_equal "foo", result[:message]
+    assert_equal "Exception invoking service: [prefix] (CC::Service::HTTPError) foo. Response: <nil>", result[:log_message]
+  end
+
+  def test_error_returns_a_hash_with_explanations
+    logger = FakeLogger.new
+
+    handler = CC::Service::Invocation::WithErrorHandling.new(
+      lambda { raise ArgumentError.new("lol") },
+      logger,
+      "prefix"
+    )
+
+    result = handler.call
+    assert_equal false, result[:ok]
+    assert_equal "lol", result[:message]
+    assert_equal "Exception invoking service: [prefix] (ArgumentError) lol", result[:log_message]
+  end
+end

data/test/invocation_return_values_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../helper', __FILE__)
+
+class InvocationReturnValuesTest < CC::Service::TestCase
+  def test_success_returns_upstream_result
+    handler = CC::Service::Invocation::WithReturnValues.new(
+      lambda { :return_value },
+      "error message"
+    )
+
+    assert_equal :return_value, handler.call
+  end
+
+  def test_empty_results_returns_hash
+    handler = CC::Service::Invocation::WithReturnValues.new(
+      lambda { nil },
+      "error message"
+    )
+
+    assert_equal( {ok: false, message: "error message"}, handler.call )
+  end
+end