codeclimate-services 0.3.0

data/test/invocation_test.rb

@@ -0,0 +1,167 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestInvocation < Test::Unit::TestCase
+  def test_success
+    service = FakeService.new(:some_result)
+
+    result = CC::Service::Invocation.invoke(service)
+
+    assert_equal 1, service.receive_count
+    assert_equal :some_result, result
+  end
+
+  def test_success_with_return_values
+    service = FakeService.new(:some_result)
+
+    result = CC::Service::Invocation.invoke(service) do |i|
+      i.with :return_values, "error"
+    end
+
+    assert_equal 1, service.receive_count
+    assert_equal :some_result, result
+  end
+
+  def test_failure_with_return_values
+    service = FakeService.new(nil)
+
+    result = CC::Service::Invocation.invoke(service) do |i|
+      i.with :return_values, "error"
+    end
+
+    assert_equal 1, service.receive_count
+    assert_equal( {ok: false, message: "error"}, result )
+  end
+
+  def test_retries
+    service = FakeService.new
+    service.fake_error = RuntimeError.new
+    error_occurred = false
+
+    begin
+      CC::Service::Invocation.invoke(service) do |i|
+        i.with :retries, 3
+      end
+    rescue
+      error_occurred = true
+    end
+
+    assert error_occurred
+    assert_equal 1 + 3, service.receive_count
+  end
+
+  def test_metrics
+    statsd = FakeStatsd.new
+
+    CC::Service::Invocation.invoke(FakeService.new) do |i|
+      i.with :metrics, statsd, "a_prefix"
+    end
+
+    assert_equal 1, statsd.incremented_keys.length
+    assert_equal "services.invocations.a_prefix", statsd.incremented_keys.first
+  end
+
+  def test_metrics_on_errors
+    statsd = FakeStatsd.new
+    service = FakeService.new
+    service.fake_error = RuntimeError.new
+    error_occurred = false
+
+    begin
+      CC::Service::Invocation.invoke(service) do |i|
+        i.with :metrics, statsd, "a_prefix"
+      end
+    rescue
+      error_occurred = true
+    end
+
+    assert error_occurred
+    assert_equal 1, statsd.incremented_keys.length
+    assert_match /^services\.errors\.a_prefix/, statsd.incremented_keys.first
+  end
+
+  def test_user_message
+    service = FakeService.new
+    service.fake_error = CC::Service::HTTPError.new("Boom", {})
+    service.override_user_message = "Hey do this"
+    logger = FakeLogger.new
+
+    result = CC::Service::Invocation.invoke(service) do |i|
+      i.with :error_handling, logger, "a_prefix"
+    end
+
+    assert_equal "Hey do this", result[:message]
+    assert_match /Boom/, result[:log_message]
+  end
+
+  def test_error_handling
+    service = FakeService.new
+    service.fake_error = RuntimeError.new("Boom")
+    logger = FakeLogger.new
+
+    result = CC::Service::Invocation.invoke(service) do |i|
+      i.with :error_handling, logger, "a_prefix"
+    end
+
+    assert_equal({ok: false, message: "Boom", log_message: "Exception invoking service: [a_prefix] (RuntimeError) Boom"}, result)
+    assert_equal 1, logger.logged_errors.length
+    assert_match /^Exception invoking service: \[a_prefix\]/, logger.logged_errors.first
+  end
+
+  def test_multiple_middleware
+    service = FakeService.new
+    service.fake_error = RuntimeError.new("Boom")
+    logger = FakeLogger.new
+
+    result = CC::Service::Invocation.invoke(service) do |i|
+      i.with :retries, 3
+      i.with :error_handling, logger
+    end
+
+    assert_equal({ok: false, message: "Boom", log_message: "Exception invoking service: (RuntimeError) Boom"}, result)
+    assert_equal 1 + 3, service.receive_count
+    assert_equal 1, logger.logged_errors.length
+  end
+
+  private
+
+  class FakeService
+    attr_reader :receive_count
+    attr_accessor :fake_error, :override_user_message
+
+    def initialize(result = nil)
+      @result = result
+      @receive_count = 0
+    end
+
+    def receive
+      @receive_count += 1
+
+      begin
+        raise @fake_error if @fake_error
+      rescue => e
+        if override_user_message
+          e.user_message = override_user_message
+        end
+        raise e
+      end
+
+      @result
+    end
+  end
+
+  class FakeStatsd
+    attr_reader :incremented_keys
+
+    def initialize
+      @incremented_keys = Set.new
+    end
+
+    def increment(key)
+      @incremented_keys << key
+    end
+
+    def timing(key, value)
+    end
+  end
+
+end

data/test/jira_test.rb

@@ -0,0 +1,80 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestJira < CC::Service::TestCase
+  def test_successful_receive
+    response = assert_jira_receives(
+      event(:quality, to: "D", from: "C"),
+      "Refactor User from a D on Code Climate",
+      "https://codeclimate.com/repos/1/feed"
+    )
+    assert_equal "10000", response[:id]
+  end
+
+  def test_quality
+    assert_jira_receives(
+      event(:quality, to: "D", from: "C"),
+      "Refactor User from a D on Code Climate",
+      "https://codeclimate.com/repos/1/feed"
+    )
+  end
+
+  def test_vulnerability
+    assert_jira_receives(
+      event(:vulnerability, vulnerabilities: [{
+        "warning_type" => "critical",
+        "location" => "app/user.rb line 120"
+      }]),
+      "New critical issue found in app/user.rb line 120",
+      "A critical vulnerability was found by Code Climate in app/user.rb line 120.\n\nhttps://codeclimate.com/repos/1/feed"
+    )
+  end
+
+  def test_issue
+    payload = {
+      issue: {
+        "check_name" => "Style/LongLine",
+        "description" => "Line is too long [1000/80]"
+      },
+      constant_name: "foo.rb",
+      details_url: "http://example.com/repos/id/foo.rb#issue_123"
+    }
+
+    assert_jira_receives(
+      event(:issue, payload),
+      "Fix \"Style/LongLine\" issue in foo.rb",
+      "Line is too long [1000/80]\n\nhttp://example.com/repos/id/foo.rb#issue_123"
+    )
+  end
+
+  def test_receive_test
+    @stubs.post '/rest/api/2/issue' do |env|
+      [200, {}, '{"id": 12345, "key": "CC-123", "self": "http://foo.bar"}']
+    end
+
+    response = receive_event(name: "test")
+
+    assert_equal "Ticket <a href='http://foo.bar'>12345</a> created.", response[:message]
+  end
+
+  private
+
+  def assert_jira_receives(event_data, title, ticket_body)
+    @stubs.post '/rest/api/2/issue' do |env|
+      body = JSON.parse(env[:body])
+      assert_equal "Basic Zm9vOmJhcg==", env[:request_headers]["Authorization"]
+      assert_equal title, body["fields"]["summary"]
+      assert_equal ticket_body, body["fields"]["description"]
+      [200, {}, '{"id":"10000"}']
+    end
+
+    receive_event(event_data)
+  end
+
+  def receive_event(event_data = nil)
+    receive(
+      CC::Service::Jira,
+      { domain: "foo.com", username: "foo", password: "bar", project_id: "100" },
+      event_data || event(:quality, from: "C", to: "D")
+    )
+  end
+end

data/test/lighthouse_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestLighthouse < CC::Service::TestCase
+  def test_quality
+    response = assert_lighthouse_receives(
+      event(:quality, to: "D", from: "C"),
+      "Refactor User from a D on Code Climate",
+      "https://codeclimate.com/repos/1/feed"
+    )
+    assert_equal "123", response[:id]
+    assert_equal "http://lighthouse.com/projects/123/tickets/123.json",
+      response[:url]
+  end
+
+  def test_vulnerability
+    assert_lighthouse_receives(
+      event(:vulnerability, vulnerabilities: [{
+        "warning_type" => "critical",
+        "location" => "app/user.rb line 120"
+      }]),
+      "New critical issue found in app/user.rb line 120",
+      "A critical vulnerability was found by Code Climate in app/user.rb line 120.\n\nhttps://codeclimate.com/repos/1/feed"
+    )
+  end
+
+  def test_issue
+    payload = {
+      issue: {
+        "check_name" => "Style/LongLine",
+        "description" => "Line is too long [1000/80]"
+      },
+      constant_name: "foo.rb",
+      details_url: "http://example.com/repos/id/foo.rb#issue_123"
+    }
+
+    assert_lighthouse_receives(
+      event(:issue, payload),
+      "Fix \"Style/LongLine\" issue in foo.rb",
+      "Line is too long [1000/80]\n\nhttp://example.com/repos/id/foo.rb#issue_123"
+    )
+  end
+
+  def test_receive_test
+    @stubs.post 'projects/123/tickets.json' do |env|
+      [200, {}, '{"ticket":{"number": "123", "url":"http://foo.bar"}}']
+    end
+
+    response = receive_event(name: "test")
+
+    assert_equal "Ticket <a href='http://foo.bar'>123</a> created.", response[:message]
+  end
+
+  private
+
+  def assert_lighthouse_receives(event_data, title, ticket_body)
+    @stubs.post 'projects/123/tickets.json' do |env|
+      body = JSON.parse(env[:body])
+      assert_equal "token", env[:request_headers]["X-LighthouseToken"]
+      assert_equal title, body["ticket"]["title"]
+      assert_equal ticket_body, body["ticket"]["body"]
+      [200, {}, '{"ticket":{"number": "123", "url":"http://lighthouse.com/projects/123/tickets/123.json"}}']
+    end
+
+    receive_event(event_data)
+  end
+
+  def receive_event(event_data = nil)
+    receive(
+      CC::Service::Lighthouse,
+      { subdomain: "foo", api_token: "token", project_id: "123" },
+      event_data || event(:quality, from: "C", to: "D")
+    )
+  end
+end

data/test/pivotal_tracker_test.rb

@@ -0,0 +1,73 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestPivotalTracker < CC::Service::TestCase
+  def test_quality
+    response = assert_pivotal_receives(
+      event(:quality, to: "D", from: "C"),
+      "Refactor User from a D on Code Climate",
+      "https://codeclimate.com/repos/1/feed"
+    )
+    assert_equal "123", response[:id]
+    assert_equal "http://pivotaltracker.com/n/projects/123/stories/123",
+      response[:url]
+  end
+
+  def test_vulnerability
+    assert_pivotal_receives(
+      event(:vulnerability, vulnerabilities: [{
+        "warning_type" => "critical",
+        "location" => "app/user.rb line 120"
+      }]),
+      "New critical issue found in app/user.rb line 120",
+      "A critical vulnerability was found by Code Climate in app/user.rb line 120.\n\nhttps://codeclimate.com/repos/1/feed"
+    )
+  end
+
+  def test_issue
+    payload = {
+      issue: {
+        "check_name" => "Style/LongLine",
+        "description" => "Line is too long [1000/80]"
+      },
+      constant_name: "foo.rb",
+      details_url: "http://example.com/repos/id/foo.rb#issue_123"
+    }
+
+    assert_pivotal_receives(
+      event(:issue, payload),
+      "Fix \"Style/LongLine\" issue in foo.rb",
+      "Line is too long [1000/80]\n\nhttp://example.com/repos/id/foo.rb#issue_123"
+    )
+  end
+
+  def test_receive_test
+    @stubs.post 'services/v3/projects/123/stories' do |env|
+      [200, {}, '<story><id>123</id><url>http://foo.bar</url></story>']
+    end
+
+    response = receive_event(name: "test")
+
+    assert_equal "Ticket <a href='http://foo.bar'>123</a> created.", response[:message]
+  end
+
+  private
+
+  def assert_pivotal_receives(event_data, name, description)
+    @stubs.post 'services/v3/projects/123/stories' do |env|
+      body = Hash[URI.decode_www_form(env[:body])]
+      assert_equal "token", env[:request_headers]["X-TrackerToken"]
+      assert_equal name, body["story[name]"]
+      assert_equal description, body["story[description]"]
+      [200, {}, '<doc><story><id>123</id><url>http://pivotaltracker.com/n/projects/123/stories/123</url></story></doc>']
+    end
+    receive_event(event_data)
+  end
+
+  def receive_event(event_data = nil)
+    receive(
+      CC::Service::PivotalTracker,
+      { api_token: "token", project_id: "123" },
+      event_data || event(:quality, from: "C", to: "D")
+    )
+  end
+end

data/test/presenters/github_pull_requests_presenter_test.rb

@@ -0,0 +1,49 @@
+require "helper"
+require "cc/presenters/github_pull_requests_presenter"
+
+class TestGitHubPullRequestsPresenter < CC::Service::TestCase
+  def test_message_singular
+    assert_equal(
+      "Code Climate found 1 new issue and 1 fixed issue.",
+      build_presenter("fixed" => 1, "new" => 1).success_message
+    )
+  end
+
+  def test_message_plural
+    assert_equal(
+      "Code Climate found 2 new issues and 1 fixed issue.",
+      build_presenter("fixed" => 1, "new" => 2).success_message
+    )
+  end
+
+  def test_message_only_fixed
+    assert_equal(
+      "Code Climate found 1 fixed issue.",
+      build_presenter("fixed" => 1, "new" => 0).success_message
+    )
+  end
+
+  def test_message_only_new
+    assert_equal(
+      "Code Climate found 3 new issues.",
+      build_presenter("fixed" => 0, "new" => 3).success_message
+    )
+  end
+
+  def test_message_no_new_or_fixed
+    assert_equal(
+      "Code Climate didn't find any new or fixed issues.",
+      build_presenter("fixed" => 0, "new" => 0).success_message
+    )
+  end
+
+private
+
+  def build_payload(issue_counts)
+    { "issue_comparison_counts" => issue_counts }
+  end
+
+  def build_presenter(issue_counts)
+    CC::Service::GitHubPullRequestsPresenter.new(build_payload(issue_counts))
+  end
+end

data/test/service_test.rb

@@ -0,0 +1,63 @@
+require File.expand_path("../helper", __FILE__)
+
+class TestService < CC::Service::TestCase
+  def test_validates_events
+    assert_raises(ArgumentError) do
+      CC::Service.new(:foo, {}, {}, {})
+    end
+  end
+
+  def test_default_path_to_ca_file
+    s = CC::Service.new({}, {name: "test"})
+    assert_equal(File.expand_path("../../config/cacert.pem", __FILE__), s.ca_file)
+    assert File.exist?(s.ca_file)
+  end
+
+  def test_custom_path_to_ca_file
+    ENV["CODECLIMATE_CA_FILE"] = "/tmp/cacert.pem"
+    s = CC::Service.new({}, {name: "test"})
+    assert_equal("/tmp/cacert.pem", s.ca_file)
+  ensure
+    ENV.delete("CODECLIMATE_CA_FILE")
+  end
+
+  def test_nothing_has_a_handler
+    service = CC::Service.new({}, {name: "test"})
+
+    result = service.receive
+
+    assert_equal false, result[:ok]
+    assert_true true, result[:ignored]
+    assert_equal "No service handler found", result[:message]
+  end
+
+  def test_post_success
+    stub_http("/my/test/url", [200, {}, '{"ok": true, "thing": "123"}'])
+
+    response = service_post("/my/test/url", {token: "1234"}.to_json, {}) do |response|
+      body = JSON.parse(response.body)
+      { thing: body["thing"] }
+    end
+
+    assert_true response[:ok]
+    assert_equal '{"token":"1234"}', response[:params]
+    assert_equal "/my/test/url", response[:endpoint_url]
+    assert_equal 200, response[:status]
+  end
+
+  def test_post_http_failure
+    stub_http("/my/wrong/url", [404, {}, ""])
+
+    assert_raises(CC::Service::HTTPError) do
+      service_post("/my/wrong/url", {token: "1234"}.to_json, {})
+    end
+  end
+
+  def test_post_some_other_failure
+    stub_http("/my/wrong/url"){ raise ArgumentError.new("lol") }
+
+    assert_raises(ArgumentError) do
+      service_post("/my/wrong/url", {token: "1234"}.to_json, {})
+    end
+  end
+end