codeclimate-services 0.3.0

data/service_test.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+#
+# Ad-hoc script for sending the test event to service classes
+#
+# Usage:
+#
+#   $ <SERVICE>_<CONFIG_ATTR_1>="..." \
+#     <SERVICE>_<CONFIG_ATTR_2>="..." \
+#     ... ... bundle exec ruby service_test.rb
+#
+# Example:
+#
+#   $ SLACK_WEBHOOK_URL="http://..." bundle exec ruby service_test.rb
+#   $ GITHUBPULLREQUESTS_UPDATE_STATUS=false GITHUBPULLREQUESTS_ADD_COMMENT=true GITHUBPULLREQUESTS_OAUTH_TOKEN=06083a4a060d358ca709939b1f00645777661c44 bundle exec ruby service_test.rb
+#
+# Other Environment variables used:
+#
+#   REPO_NAME  Defaults to "App"
+#
+###
+require 'cc/services'
+CC::Service.load_services
+
+class WithResponseLogging
+  def initialize(invocation)
+    @invocation = invocation
+  end
+
+  def call
+    @invocation.call.tap { |r| p r }
+  end
+end
+
+class ServiceTest
+  def initialize(klass, *params)
+    @klass = klass
+    @params = params
+  end
+
+  def test(payload = {})
+    config = {}
+
+    puts "-"*80
+    puts @klass
+
+    @params.each do |param|
+      if var = ENV[to_env_var(param)]
+        config[param] = var
+      else
+        puts "  -> skipping"
+        return false
+      end
+    end
+
+    puts "  -> testing"
+    puts "  -> #{config.inspect}"
+    print "  => "
+
+    test_service(@klass, config, payload)
+  end
+
+private
+
+  def to_env_var(param)
+    "#{@klass.to_s.split("::").last}_#{param}".upcase
+  end
+
+  def test_service(klass, config, payload)
+    repo_name = ENV["REPO_NAME"] || "App"
+
+    service = klass.new(
+      config,
+      { name: :test, repo_name: repo_name }.merge(payload)
+    )
+
+    CC::Service::Invocation.new(service) do |i|
+      i.wrap(WithResponseLogging)
+    end
+  end
+end
+
+ServiceTest.new(CC::Service::Slack, :webhook_url).test
+ServiceTest.new(CC::Service::Flowdock, :api_token).test
+ServiceTest.new(CC::Service::Jira, :username, :password, :domain, :project_id).test
+ServiceTest.new(CC::Service::Asana, :api_key, :workspace_id, :project_id).test
+ServiceTest.new(CC::Service::GitHubPullRequests, :oauth_token, :update_status, :add_comment).test({ github_slug: "codeclimate/codeclimate" })

data/test/asana_test.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestAsana < CC::Service::TestCase
+  def test_quality
+    assert_asana_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_asana_receives(
+      event(:vulnerability, vulnerabilities: [{
+        "warning_type" => "critical",
+        "location" => "app/user.rb line 120"
+      }]),
+      "New critical issue found in app/user.rb line 120 - https://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_asana_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_successful_post
+    @stubs.post '/api/1.0/tasks' do |env|
+      [200, {}, '{"data":{"id":"2"}}']
+    end
+
+    response = receive_event
+
+    assert_equal "2", response[:id]
+    assert_equal "https://app.asana.com/0/1/2", response[:url]
+  end
+
+  def test_receive_test
+    @stubs.post '/api/1.0/tasks' do |env|
+      [200, {}, '{"data":{"id":"4"}}']
+    end
+
+    response = receive_event(name: "test")
+
+    assert_equal "Ticket <a href='https://app.asana.com/0/1/4'>4</a> created.", response[:message]
+  end
+
+  private
+
+  def assert_asana_receives(event_data, name, notes = nil)
+    @stubs.post '/api/1.0/tasks' do |env|
+      body = JSON.parse(env[:body])
+      data = body["data"]
+
+      assert_equal "1",             data["workspace"]
+      assert_equal "2",             data["projects"].first
+      assert_equal "jim@asana.com", data["assignee"]
+      assert_equal name,            data["name"]
+      assert_equal notes,           data["notes"]
+
+      [200, {}, '{"data":{"id":4}}']
+    end
+
+    receive_event(event_data)
+  end
+
+  def receive_event(event_data = nil)
+    receive(
+      CC::Service::Asana,
+      { api_key: "abc123", workspace_id: "1", project_id: "2", assignee: "jim@asana.com" },
+      event_data || event(:quality, to: "D", from: "C")
+    )
+  end
+end

data/test/axiom/types/password_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../../../helper', __FILE__)
+
+class Axiom::Types::PasswordTest < CC::Service::TestCase
+  class TestConfiguration < CC::Service::Config
+    attribute :password_attribute, Password
+    attribute :string_attribute, String
+  end
+
+  def test_password_type_inference
+    assert_equal(
+      Axiom::Types::Password,
+      TestConfiguration.attribute_set[:password_attribute].type
+    )
+  end
+
+  def test_string_type_inference
+    assert_equal(
+      Axiom::Types::String,
+      TestConfiguration.attribute_set[:string_attribute].type
+    )
+  end
+end

data/test/campfire_test.rb

@@ -0,0 +1,144 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestCampfire < CC::Service::TestCase
+  def test_config
+    assert_raises CC::Service::ConfigurationError do
+      service(CC::Service::Campfire, {}, {name: "test"})
+    end
+  end
+
+  def test_test_hook
+    assert_campfire_receives(
+      { name: "test", repo_name: "Rails" },
+      "[Code Climate][Rails] This is a test of the Campfire service hook"
+    )
+  end
+
+  def test_coverage_improved
+    e = event(:coverage, to: 90.2, from: 80)
+
+    assert_campfire_receives(e, [
+      "[Code Climate][Example] :sunny:",
+      "Test coverage has improved to 90.2% (+10.2%).",
+      "(https://codeclimate.com/repos/1/feed)"
+    ].join(" "))
+  end
+
+  def test_coverage_declined
+    e = event(:coverage, to: 88.6, from: 94.6)
+
+    assert_campfire_receives(e, [
+      "[Code Climate][Example] :umbrella:",
+      "Test coverage has declined to 88.6% (-6.0%).",
+      "(https://codeclimate.com/repos/1/feed)"
+    ].join(" "))
+  end
+
+  def test_quality_improved
+    e = event(:quality, to: "A", from: "B")
+
+    assert_campfire_receives(e, [
+      "[Code Climate][Example] :sunny:",
+      "User has improved from a B to an A.",
+      "(https://codeclimate.com/repos/1/feed)"
+    ].join(" "))
+  end
+
+  def test_quality_declined
+    e = event(:quality, to: "D", from: "C")
+
+    assert_campfire_receives(e, [
+      "[Code Climate][Example] :umbrella:",
+      "User has declined from a C to a D.",
+      "(https://codeclimate.com/repos/1/feed)"
+    ].join(" "))
+  end
+
+  def test_single_vulnerability
+    e = event(:vulnerability, vulnerabilities: [
+      { "warning_type" => "critical" }
+    ])
+
+    assert_campfire_receives(e, [
+      "[Code Climate][Example]",
+      "New critical issue found.",
+      "Details: https://codeclimate.com/repos/1/feed"
+    ].join(" "))
+  end
+
+  def test_single_vulnerability_with_location
+    e = event(:vulnerability, vulnerabilities: [{
+      "warning_type" => "critical",
+      "location" => "app/user.rb line 120"
+    }])
+
+    assert_campfire_receives(e, [
+      "[Code Climate][Example]",
+      "New critical issue found",
+      "in app/user.rb line 120.",
+      "Details: https://codeclimate.com/repos/1/feed"
+    ].join(" "))
+  end
+
+  def test_multiple_vulnerabilities
+    e = event(:vulnerability, warning_type: "critical", vulnerabilities: [{
+      "warning_type" => "unused",
+      "location" => "unused"
+    }, {
+      "warning_type" => "unused",
+      "location" => "unused"
+    }])
+
+    assert_campfire_receives(e, [
+      "[Code Climate][Example]",
+      "2 new critical issues found.",
+      "Details: https://codeclimate.com/repos/1/feed"
+    ].join(" "))
+  end
+
+  def test_receive_test
+    @stubs.post request_url do |env|
+      [200, {}, '']
+    end
+
+    response = receive_event(name: "test")
+
+    assert_equal "Test message sent", response[:message]
+  end
+
+  private
+
+  def speak_uri
+    "https://#{subdomain}.campfirenow.com#{request_url}"
+  end
+
+  def request_url
+    "/room/#{room}/speak.json"
+  end
+
+  def subdomain
+    "sub"
+  end
+
+  def room
+    "123"
+  end
+
+  def assert_campfire_receives(event_data, expected_body)
+    @stubs.post request_url do |env|
+      body = JSON.parse(env[:body])
+      assert_equal expected_body, body["message"]["body"]
+      [200, {}, '']
+    end
+
+    receive_event(event_data)
+  end
+
+  def receive_event(event_data = nil)
+    receive(
+      CC::Service::Campfire,
+      { token: "token", subdomain: subdomain, room_id: room},
+      event_data || event(:quality, to: "D", from: "C")
+    )
+  end
+end

data/test/fixtures.rb

@@ -0,0 +1,68 @@
+class EventFixtures
+  attr_reader :options
+
+  REMEDIATIONS = {
+    "A" => 0,
+    "B" => 10,
+    "C" => 15,
+    "D" => 20,
+    "F" => 25,
+  }
+
+  def initialize(options)
+    @options = {
+      repo_name: "Example",
+      details_url: "https://codeclimate.com/repos/1/feed",
+      compare_url: "https://codeclimate.com/repos/1/compare",
+    }.merge(options)
+  end
+
+  # Options: to, from
+  def coverage
+    to = options.delete(:to)
+    from = options.delete(:from)
+    delta = (to - from).round(1)
+
+    options.merge(
+      name: "coverage",
+      covered_percent: to,
+      previous_covered_percent: from,
+      covered_percent_delta: delta
+    )
+  end
+
+  # Options: to, from
+  def quality
+    to = options.delete(:to)
+    from = options.delete(:from)
+
+    options.merge(
+      name: "quality",
+      constant_name: "User",
+      rating: to,
+      previous_rating: from,
+      remediation_cost: REMEDIATIONS[to],
+      previous_remediation_cost: REMEDIATIONS[from]
+    )
+  end
+
+  # Options: warning_type, vulnerabilities
+  def vulnerability
+    options.merge(name: "vulnerability")
+  end
+
+  def issue
+    options.merge(name: "issue")
+  end
+
+end
+
+def event(name, options = {})
+  fixtures = EventFixtures.new(options)
+
+  if fixtures.respond_to?(name)
+    fixtures.send(name)
+  else
+    raise ArgumentError, "No such fixture: #{name}"
+  end
+end

data/test/flowdock_test.rb

@@ -0,0 +1,148 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestFlowdock < CC::Service::TestCase
+  def test_valid_project_parameter
+    @stubs.post '/v1/messages/team_inbox/token' do |env|
+      body = Hash[URI.decode_www_form(env[:body])]
+      assert_equal "Exampleorg", body["project"]
+      [200, {}, '']
+    end
+
+    receive(
+      CC::Service::Flowdock,
+      { api_token: "token" },
+      { name: "test", repo_name: "Example.org" }
+    )
+  end
+
+  def test_test_hook
+    assert_flowdock_receives(
+      "Test",
+      { name: "test", repo_name: "Example" },
+      "This is a test of the Flowdock service hook"
+    )
+  end
+
+  def test_coverage_improved
+    e = event(:coverage, to: 90.2, from: 80)
+
+    assert_flowdock_receives("Coverage", e, [
+      "<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_flowdock_receives("Coverage", e, [
+      "<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_flowdock_receives("Quality", e, [
+      "<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
+    e = event(:quality, to: "D", from: "C")
+
+    assert_flowdock_receives("Quality", e, [
+      "<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_flowdock_receives("Vulnerability", e, [
+      "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_flowdock_receives("Vulnerability", e, [
+      "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_flowdock_receives("Vulnerability", e, [
+      "2 new <a href=\"https://codeclimate.com/repos/1/feed\">critical</a>",
+      "issues found",
+    ].join(" "))
+  end
+
+  def test_receive_test
+    @stubs.post request_url do |env|
+      [200, {}, '']
+    end
+
+    response = receive_event(name: "test", repo_name: "foo")
+
+    assert_equal "Test message sent", response[:message]
+  end
+
+  private
+
+  def endpoint_url
+    "https://api.flowdock.com#{request_url}"
+  end
+
+  def request_url
+    "/v1/messages/team_inbox/#{token}"
+  end
+
+  def token
+    "token"
+  end
+
+  def assert_flowdock_receives(subject, event_data, expected_body)
+    @stubs.post request_url do |env|
+      body = Hash[URI.decode_www_form(env[:body])]
+      assert_equal "Code Climate", body["source"]
+      assert_equal "hello@codeclimate.com", body["from_address"]
+      assert_equal "Code Climate", body["from_name"]
+      assert_equal "html", body["format"]
+      assert_equal subject, body["subject"]
+      assert_equal "Example", body["project"]
+      assert_equal expected_body, body["content"]
+      assert_equal "https://codeclimate.com", body["link"]
+      [200, {}, '']
+    end
+
+    receive_event(event_data)
+  end
+
+  def receive_event(event_data = nil)
+    receive(CC::Service::Flowdock, { api_token: "token" }, event_data || event(:quality, from: "D", to: "C"))
+  end
+end

data/test/formatters/snapshot_formatter_test.rb

@@ -0,0 +1,47 @@
+require "helper"
+
+class TestSnapshotFormatter < Test::Unit::TestCase
+  def described_class
+    CC::Formatters::SnapshotFormatter::Base
+  end
+
+  def test_quality_alert_with_new_constants
+    f = described_class.new({"new_constants" => [{"to" => {"rating" => "D"}}], "changed_constants" => []})
+    refute_nil f.alert_constants_payload
+  end
+
+  def test_quality_alert_with_decreased_constants
+    f = described_class.new({"new_constants" => [],
+                             "changed_constants" => [{"to" => {"rating" => "D"}, "from" => {"rating" => "A"}}]
+    })
+    refute_nil f.alert_constants_payload
+  end
+
+  def test_quality_improvements_with_better_ratings
+    f = described_class.new({"new_constants" => [],
+                             "changed_constants" => [{"to" => {"rating" => "A"}, "from" => {"rating" => "D"}}]
+    })
+    refute_nil f.improved_constants_payload
+  end
+
+  def test_nothing_set_without_changes
+    f = described_class.new({"new_constants" => [], "changed_constants" => []})
+    assert_nil f.alert_constants_payload
+    assert_nil f.improved_constants_payload
+  end
+
+  def test_snapshot_formatter_test_with_relaxed_constraints
+    f = CC::Formatters::SnapshotFormatter::Sample.new({
+       "new_constants" => [{"name" => "foo", "to" => {"rating" => "A"}}, {"name" => "bar", "to" => {"rating" => "A"}}],
+       "changed_constants" => [
+         {"from" => {"rating" => "B"}, "to" => {"rating" => "C"}},
+         {"from" => {"rating" => "D"}, "to" => {"rating" => "D"}},
+         {"from" => {"rating" => "D"}, "to" => {"rating" => "D"}},
+         {"from" => {"rating" => "A"}, "to" => {"rating" => "B"}},
+         {"from" => {"rating" => "C"}, "to" => {"rating" => "B"}}
+       ]})
+
+    refute_nil f.alert_constants_payload
+    refute_nil f.improved_constants_payload
+  end
+end

data/test/github_issues_test.rb

@@ -0,0 +1,96 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestGitHubIssues < CC::Service::TestCase
+  def test_creation_success
+    id = 1234
+    number = 123
+    url = "https://github.com/#{project}/pulls/#{number}"
+    stub_http(request_url, [201, {}, %<{"id": #{id}, "number": #{number}, "html_url":"#{url}"}>])
+
+    response = receive_event
+
+    assert_equal id, response[:id]
+    assert_equal number, response[:number]
+    assert_equal url, response[:url]
+  end
+
+  def test_quality
+    assert_github_receives(
+      event(:quality, to: "D", from: "C"),
+      "Refactor User from a D on Code Climate",
+      "https://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_github_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_vulnerability
+    assert_github_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_receive_test
+    @stubs.post request_url do |env|
+      [200, {}, '{"number": 2, "html_url": "http://foo.bar"}']
+    end
+
+    response = receive_event(name: "test")
+
+    assert_equal "Issue <a href='http://foo.bar'>#2</a> created.", response[:message]
+  end
+
+  private
+
+  def project
+    "brynary/test_repo"
+  end
+
+  def oauth_token
+    "123"
+  end
+
+  def request_url
+    "repos/#{project}/issues"
+  end
+
+  def assert_github_receives(event_data, title, ticket_body)
+    @stubs.post request_url do |env|
+      body = JSON.parse(env[:body])
+      assert_equal "token #{oauth_token}", env[:request_headers]["Authorization"]
+      assert_equal title, body["title"]
+      assert_equal ticket_body, body["body"]
+      [200, {}, '{}']
+    end
+
+    receive_event(event_data)
+  end
+
+  def receive_event(event_data = nil)
+    receive(
+      CC::Service::GitHubIssues,
+      { oauth_token: "123", project: project },
+      event_data || event(:quality, from: "D", to: "C")
+    )
+  end
+end