codeclimate-services 1.6.1 → 1.7.0

data/{test/flowdock_test.rb → spec/cc/service/flowdock_spec.rb}

@@ -1,72 +1,70 @@
-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|
+describe CC::Service::Flowdock, type: :service do
+  it "valid project parameter" do
+    http_stubs.post "/v1/messages/team_inbox/token" do |env|
       body = Hash[URI.decode_www_form(env[:body])]
-      assert_equal "Exampleorg", body["project"]
-      [200, {}, '']
+      expect(body["project"]).to eq("Exampleorg")
+      [200, {}, ""]
     end
 
-    receive(
+    service_receive(
       CC::Service::Flowdock,
       { api_token: "token" },
-      { name: "test", repo_name: "Example.org" }
+      name: "test", repo_name: "Example.org",
     )
   end
 
-  def test_test_hook
+  it "test hook" do
     assert_flowdock_receives(
       "Test",
       { name: "test", repo_name: "Example" },
-      "This is a test of the Flowdock service hook"
+      "This is a test of the Flowdock service hook",
     )
   end
 
-  def test_coverage_improved
+  it "coverage improved" do
     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>)"
+      "(<a href=\"https://codeclimate.com/repos/1/compare\">Compare</a>)",
     ].join(" "))
   end
 
-  def test_coverage_declined
+  it "coverage declined" do
     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>)"
+      "(<a href=\"https://codeclimate.com/repos/1/compare\">Compare</a>)",
     ].join(" "))
   end
 
-  def test_quality_improved
+  it "quality improved" do
     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>)"
+      "(<a href=\"https://codeclimate.com/repos/1/compare\">Compare</a>)",
     ].join(" "))
   end
 
-  def test_quality_declined
+  it "quality declined" do
     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>)"
+      "(<a href=\"https://codeclimate.com/repos/1/compare\">Compare</a>)",
     ].join(" "))
   end
 
-  def test_single_vulnerability
+  it "single vulnerability" do
     e = event(:vulnerability, vulnerabilities: [
-      { "warning_type" => "critical" }
-    ])
+                { "warning_type" => "critical" },
+              ])
 
     assert_flowdock_receives("Vulnerability", e, [
       "New <a href=\"https://codeclimate.com/repos/1/feed\">critical</a>",
@@ -74,11 +72,11 @@ class TestFlowdock < CC::Service::TestCase
     ].join(" "))
   end
 
-  def test_single_vulnerability_with_location
+  it "single vulnerability with location" do
     e = event(:vulnerability, vulnerabilities: [{
-      "warning_type" => "critical",
-      "location" => "app/user.rb line 120"
-    }])
+                "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>",
@@ -86,14 +84,14 @@ class TestFlowdock < CC::Service::TestCase
     ].join(" "))
   end
 
-  def test_multiple_vulnerabilities
+  it "multiple vulnerabilities" do
     e = event(:vulnerability, warning_type: "critical", vulnerabilities: [{
-      "warning_type" => "unused",
-      "location" => "unused"
-    }, {
-      "warning_type" => "unused",
-      "location" => "unused"
-    }])
+                "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>",
@@ -101,14 +99,14 @@ class TestFlowdock < CC::Service::TestCase
     ].join(" "))
   end
 
-  def test_receive_test
-    @stubs.post request_url do |env|
-      [200, {}, '']
+  it "receive test" do
+    http_stubs.post request_url do |_env|
+      [200, {}, ""]
     end
 
     response = receive_event(name: "test", repo_name: "foo")
 
-    assert_equal "Test message sent", response[:message]
+    expect(response[:message]).to eq("Test message sent")
   end
 
   private
@@ -126,23 +124,23 @@ class TestFlowdock < CC::Service::TestCase
   end
 
   def assert_flowdock_receives(subject, event_data, expected_body)
-    @stubs.post request_url do |env|
+    http_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, {}, '']
+      expect(body["source"]).to eq("Code Climate")
+      expect(body["from_address"]).to eq("hello@codeclimate.com")
+      expect(body["from_name"]).to eq("Code Climate")
+      expect(body["format"]).to eq("html")
+      expect(body["subject"]).to eq(subject)
+      expect(body["project"]).to eq("Example")
+      expect(body["content"]).to eq(expected_body)
+      expect(body["link"]).to eq("https://codeclimate.com")
+      [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"))
+    service_receive(CC::Service::Flowdock, { api_token: "token" }, event_data || event(:quality, from: "D", to: "C"))
   end
 end

data/{test/github_issues_test.rb → spec/cc/service/github_issues_spec.rb}

@@ -1,82 +1,80 @@
-require File.expand_path('../helper', __FILE__)
-
-class TestGitHubIssues < CC::Service::TestCase
-  def test_creation_success
+describe CC::Service::GitHubIssues, type: :service do
+  it "creation success" do
     id = 1234
     number = 123
     url = "https://github.com/#{project}/pulls/#{number}"
-    stub_http(request_url, [201, {}, %<{"id": #{id}, "number": #{number}, "html_url":"#{url}"}>])
+    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]
+    expect(response[:id]).to eq(id)
+    expect(response[:number]).to eq(number)
+    expect(response[:url]).to eq(url)
   end
 
-  def test_quality
+  it "quality" do
     assert_github_receives(
       event(:quality, to: "D", from: "C"),
       "Refactor User from a D on Code Climate",
-      "https://codeclimate.com/repos/1/feed"
+      "https://codeclimate.com/repos/1/feed",
     )
   end
 
-  def test_quality_without_rating
+  it "quality without rating" do
     assert_github_receives(
       event(:quality, to: nil),
       "Refactor User on Code Climate",
-      "https://codeclimate.com/repos/1/feed"
+      "https://codeclimate.com/repos/1/feed",
     )
   end
 
-  def test_issue
+  it "issue" do
     payload = {
       issue: {
         "check_name" => "Style/LongLine",
-        "description" => "Line is too long [1000/80]"
+        "description" => "Line is too long [1000/80]",
       },
       constant_name: "foo.rb",
-      details_url: "http://example.com/repos/id/foo.rb#issue_123"
+      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"
+      "Line is too long [1000/80]\n\nhttp://example.com/repos/id/foo.rb#issue_123",
     )
   end
 
-  def test_vulnerability
+  it "vulnerability" do
     assert_github_receives(
       event(:vulnerability, vulnerabilities: [{
-        "warning_type" => "critical",
-        "location" => "app/user.rb line 120"
-      }]),
+              "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"
+      "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|
+  it "receive test" do
+    http_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]
+    expect(response[:message]).to eq("Issue <a href='http://foo.bar'>#2</a> created.")
   end
 
-  def test_different_base_url
-    @stubs.post request_url do |env|
-      assert env[:url].to_s == "http://example.com/#{request_url}"
+  it "different base url" do
+    http_stubs.post request_url do |env|
+      expect(env[:url].to_s).to eq("http://example.com/#{request_url}")
       [200, {}, '{"number": 2, "html_url": "http://foo.bar"}']
     end
 
     response = receive_event({ name: "test" }, base_url: "http://example.com")
 
-    assert_equal "Issue <a href='http://foo.bar'>#2</a> created.", response[:message]
+    expect(response[:message]).to eq("Issue <a href='http://foo.bar'>#2</a> created.")
   end
 
   private
@@ -94,22 +92,22 @@ class TestGitHubIssues < CC::Service::TestCase
   end
 
   def assert_github_receives(event_data, title, ticket_body)
-    @stubs.post request_url do |env|
+    http_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, {}, '{}']
+      expect(env[:request_headers]["Authorization"]).to eq("token #{oauth_token}")
+      expect(body["title"]).to eq(title)
+      expect(body["body"]).to eq(ticket_body)
+      [200, {}, "{}"]
     end
 
     receive_event(event_data)
   end
 
   def receive_event(event_data = nil, config = {})
-    receive(
+    service_receive(
       CC::Service::GitHubIssues,
       { oauth_token: "123", project: project }.merge(config),
-      event_data || event(:quality, from: "D", to: "C")
+      event_data || event(:quality, from: "D", to: "C"),
     )
   end
 end

data/spec/cc/service/github_pull_requests_spec.rb

@@ -0,0 +1,223 @@
+describe CC::Service::GitHubPullRequests, type: :service do
+  it "pull request status pending" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "pending",
+      "description" => /is analyzing/)
+
+    receive_pull_request({}, github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "pending")
+  end
+
+  it "pull request status success detailed" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "success",
+      "description" => "Code Climate found 2 new issues and 1 fixed issue.")
+
+    receive_pull_request(
+      {},
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "success",
+    )
+  end
+
+  it "pull request status failure" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "failure",
+      "description" => "Code Climate found 2 new issues and 1 fixed issue.")
+
+    receive_pull_request(
+      {},
+      github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "failure",
+    )
+  end
+
+  it "pull request status success generic" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "success",
+      "description" => /found 2 new issues and 1 fixed issue/)
+
+    receive_pull_request({}, github_slug: "pbrisbin/foo",
+                             commit_sha:  "abc123",
+                             state:       "success")
+  end
+
+  it "pull request status error" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "error",
+      "description" => "Code Climate encountered an error attempting to analyze this pull request.")
+
+    receive_pull_request({}, github_slug: "pbrisbin/foo",
+                             commit_sha:  "abc123",
+                             state:       "error",
+                             message:     nil)
+  end
+
+  it "pull request status error message provided" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "error",
+      "description" => "descriptive message")
+
+    receive_pull_request({}, github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "error",
+      message:     "descriptive message")
+  end
+
+  it "pull request status skipped" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "success",
+      "description" => /skipped analysis/)
+
+    receive_pull_request({}, github_slug: "pbrisbin/foo",
+      commit_sha:  "abc123",
+      state:       "skipped")
+  end
+
+  it "pull request coverage status" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "success",
+      "description" => "87% test coverage (+2%)")
+
+    receive_pull_request_coverage({},
+      github_slug:     "pbrisbin/foo",
+      commit_sha:      "abc123",
+      state:           "success",
+      covered_percent: 87,
+      covered_percent_delta: 2.0)
+  end
+
+  it "pull request status test success" do
+    http_stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |_env| [422, {}, ""] }
+
+    expect(receive_test({}, github_slug: "pbrisbin/foo")[:ok]).to eq(true)
+  end
+
+  it "pull request status test doesnt blow up when unused keys present in config" do
+    http_stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |_env| [422, {}, ""] }
+
+    expect(receive_test({ wild_flamingo: true }, github_slug: "pbrisbin/foo")[:ok]).to eq(true)
+  end
+
+  it "pull request status test failure" do
+    http_stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |_env| [401, {}, ""] }
+
+    expect { receive_test({}, github_slug: "pbrisbin/foo") }.to raise_error(CC::Service::HTTPError)
+  end
+
+  it "pull request unknown state" do
+    response = receive_pull_request({}, state: "unknown")
+
+    expect({ ok: false, message: "Unknown state" }).to eq(response)
+  end
+
+  it "different base url" do
+    http_stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") do |env|
+      expect(env[:url].to_s).to eq("http://example.com/repos/pbrisbin/foo/statuses/#{"0" * 40}")
+      [422, { "x-oauth-scopes" => "gist, user, repo" }, ""]
+    end
+
+    expect(receive_test({ base_url: "http://example.com" }, github_slug: "pbrisbin/foo")[:ok]).to eq(true)
+  end
+
+  it "default context" do
+    expect_status_update("gordondiggs/ellis", "abc123", "context" => "codeclimate",
+                                                        "state" => "pending")
+
+    receive_pull_request({}, github_slug: "gordondiggs/ellis",
+      commit_sha:  "abc123",
+      state:       "pending")
+  end
+
+  it "different context" do
+    expect_status_update("gordondiggs/ellis", "abc123", "context" => "sup",
+      "state" => "pending")
+
+    receive_pull_request({ context: "sup" }, github_slug: "gordondiggs/ellis",
+      commit_sha:  "abc123",
+      state:       "pending")
+  end
+
+  describe "pr status rollout" do
+    it "does not send the status if username is not part of rollout" do
+      instance = service(
+        CC::Service::GitHubPullRequests,
+        { oauth_token: "123", rollout_usernames: "sup" },
+        { name: "pull_request", github_slug: "gordondiggs/ellis", commit_sha: "abc123", state: "pending", github_login: "abbynormal", github_user_id: 1234 },
+      )
+
+      expect(instance).not_to receive(:update_status_pending)
+
+      instance.receive
+    end
+
+    it "does not send the status if user not part of percentage" do
+      instance = service(
+        CC::Service::GitHubPullRequests,
+        { oauth_token: "123", rollout_percentage: 20 },
+        { name: "pull_request", github_slug: "gordondiggs/ellis", commit_sha: "abc123", state: "pending", github_login: "abbynormal", github_user_id: 1234 },
+      )
+
+      expect(instance).not_to receive(:update_status_pending)
+
+      instance.receive
+    end
+
+    it "does send the status if username is part of rollout" do
+      instance = service(
+        CC::Service::GitHubPullRequests,
+        { oauth_token: "123", rollout_usernames: "abbynormal", rollout_percentage: 0 },
+        { name: "pull_request", github_slug: "gordondiggs/ellis", commit_sha: "abc123", state: "pending", github_login: "abbynormal", github_user_id: 1234 },
+      )
+
+      expect_status_update("gordondiggs/ellis", "abc123", "state" => "pending")
+
+      instance.receive
+    end
+
+    it "does send the status if user falls under rollout percentage" do
+      instance = service(
+        CC::Service::GitHubPullRequests,
+        { oauth_token: "123", rollout_usernames: "sup", rollout_percentage: 60 },
+        { name: "pull_request", github_slug: "gordondiggs/ellis", commit_sha: "abc123", state: "pending", github_login: "abbynormal", github_user_id: 1234 },
+      )
+
+      expect_status_update("gordondiggs/ellis", "abc123", "state" => "pending")
+
+      instance.receive
+    end
+  end
+
+  private
+
+  def expect_status_update(repo, commit_sha, params)
+    http_stubs.post "repos/#{repo}/statuses/#{commit_sha}" do |env|
+      expect(env[:request_headers]["Authorization"]).to eq("token 123")
+
+      body = JSON.parse(env[:body])
+
+      params.each do |k, v|
+        expect(v).to match(body[k])
+      end
+    end
+  end
+
+  def receive_pull_request(config, event_data)
+    service_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_pull_request_coverage(config, event_data)
+    service_receive(
+      CC::Service::GitHubPullRequests,
+      { oauth_token: "123" }.merge(config),
+      { name: "pull_request_coverage", issue_comparison_counts: { "fixed" => 1, "new" => 2 } }.merge(event_data),
+    )
+  end
+
+  def receive_test(config, event_data = {})
+    service_receive(
+      CC::Service::GitHubPullRequests,
+      { oauth_token: "123" }.merge(config),
+      { name: "test", issue_comparison_counts: { "fixed" => 1, "new" => 2 } }.merge(event_data),
+    )
+  end
+end