codeclimate-services 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5df730afefd8e53147faaab840a08cc8a7b8a6e2
-  data.tar.gz: e3228551b4e7acae238ee5da6fbb3f46ea2074e2
+  metadata.gz: 82a8384d2bd2085ebf3baeb02d768ab73b2a3cf0
+  data.tar.gz: f511465926feb0bc868dd15b8e8f83524112f7ae
 SHA512:
-  metadata.gz: d40a0916c6ebf0d981f0731db49d25c1c748dc296efbd2d04e749b4fa848644e423cb3d157afd57dbbeeb825112be3ab525b67ca22549b27c476fb6ff84b545c
-  data.tar.gz: a8e1a740ba27e3c743b80e4d1245d5bc6b0a72173f799608eb57c64b36a876a8f6579338176fafebcd6ef1ca85cefb0c8c6181ac2769182cc6f4fbebf2493cf6
+  metadata.gz: bacfd0ed0c84d297d83bc7b8e294310ff2a36a1f8bb9866d2c263a357bc2db49aeeccf3d9d2b0030689a3b2cc7ec449da103dd39052940fa715f0ed0013943c3
+  data.tar.gz: e7847a25fc20c03bb5543d259fdfba706a151eece343396393f88990b9aebe36b9523af64cef0258bb2ea1e2f2e732e86e4522f2ca3a9d078afe92a9e92f40db

data/lib/cc/pull_requests.rb

@@ -0,0 +1,127 @@
+class CC::PullRequests < CC::Service
+  def receive_test
+    setup_http
+
+    receive_test_status
+  end
+
+  def receive_pull_request
+    setup_http
+    state = @payload["state"]
+
+    if %w[pending success failure skipped error].include?(state)
+      send("update_status_#{state}")
+    else
+      @response = simple_failure("Unknown state")
+    end
+
+    response
+  end
+
+  def receive_pull_request_coverage
+    setup_http
+    state = @payload["state"]
+
+    if state == "success"
+      update_coverage_status_success
+    else
+      @response = simple_failure("Unknown state")
+    end
+
+    response
+  end
+
+  private
+
+  def simple_failure(message)
+    { ok: false, message: message }
+  end
+
+  def response
+    @response || simple_failure("Nothing happened")
+  end
+
+  def update_status_skipped
+    raise NotImplementedError
+  end
+
+  def update_status_success
+    raise NotImplementedError
+  end
+
+  def update_coverage_status_success
+    raise NotImplementedError
+  end
+
+  def update_status_failure
+    raise NotImplementedError
+  end
+
+  def update_status_error
+    raise NotImplementedError
+  end
+
+  def update_status_pending
+    raise NotImplementedError
+  end
+
+  def test_status_code
+    raise NotImplementedError
+  end
+
+  def receive_test_status
+    url = base_status_url("0" * 40)
+    params = { state: "success" }
+    raw_post(url, params.to_json)
+  rescue CC::Service::HTTPError => e
+    if e.status == test_status_code
+      {
+        ok: true,
+        params: params.as_json,
+        status: e.status,
+        endpoint_url: url,
+        message: "Access token is valid"
+      }
+    else
+      raise
+    end
+  end
+
+  def presenter
+    CC::Service::PullRequestsPresenter.new(@payload)
+  end
+
+  def update_status(state, description, context = config.context)
+    params = {
+      context: context,
+      description: description,
+      state: state,
+      target_url: @payload["details_url"],
+    }
+    @response = service_post(status_url, params.to_json)
+  end
+
+  def status_url
+    base_status_url(commit_sha)
+  end
+
+  def base_status_url(_commit_sha)
+    raise NotImplementedError
+  end
+
+  def setup_http
+    raise NotImplementedError
+  end
+
+  def commit_sha
+    @payload.fetch("commit_sha")
+  end
+
+  def number
+    @payload.fetch("number")
+  end
+
+  def git_url
+    @git_url ||= URI.parse(@payload.fetch("git_url"))
+  end
+end

data/lib/cc/service.rb

@@ -42,13 +42,19 @@ module CC
       vulnerability
     ].freeze
 
+    ABSTRACT_SLUGS = %w[
+      pullrequests
+    ].freeze
+
     # Tracks the defined services.
     def self.services
       @services ||= []
     end
 
     def self.inherited(svc)
-      Service.services << svc
+      unless ABSTRACT_SLUGS.include?(svc.slug)
+        Service.services << svc
+      end
       super
     end
 

data/lib/cc/services.rb

@@ -7,3 +7,4 @@ require "active_model"
 require "active_support/core_ext"
 
 require File.expand_path('../service', __FILE__)
+require File.expand_path('../pull_requests', __FILE__)

data/lib/cc/services/github_pull_requests.rb

@@ -1,6 +1,6 @@
 require "cc/presenters/pull_requests_presenter"
 
-class CC::Service::GitHubPullRequests < CC::Service
+class CC::Service::GitHubPullRequests < CC::PullRequests
   class Config < CC::Service::Config
     attribute :oauth_token, Axiom::Types::String,
       label: "OAuth Token",
@@ -20,50 +20,7 @@ class CC::Service::GitHubPullRequests < CC::Service
   self.title = "GitHub Pull Requests"
   self.description = "Update pull requests on GitHub"
 
-  # Just make sure we can access GH using the configured token. Without
-  # additional information (github-slug, PR number, etc) we can't test much
-  # else.
-  def receive_test
-    setup_http
-
-    receive_test_status
-  end
-
-  def receive_pull_request
-    setup_http
-    state = @payload["state"]
-
-    if %w[pending success failure skipped error].include?(state)
-      send("update_status_#{state}")
-    else
-      @response = simple_failure("Unknown state")
-    end
-
-    response
-  end
-
-  def receive_pull_request_coverage
-    setup_http
-    state = @payload["state"]
-
-    if state == "success"
-      update_coverage_status_success
-    else
-      @response = simple_failure("Unknown state")
-    end
-
-    response
-  end
-
-private
-
-  def simple_failure(message)
-    { ok: false, message: message }
-  end
-
-  def response
-    @response || simple_failure("Nothing happened")
-  end
+  private
 
   def update_status_skipped
     update_status("success", presenter.skipped_message)
@@ -81,10 +38,6 @@ private
     update_status("failure", presenter.success_message)
   end
 
-  def presenter
-    CC::Service::PullRequestsPresenter.new(@payload)
-  end
-
   def update_status_error
     update_status(
       "error",
@@ -99,66 +52,25 @@ private
     )
   end
 
-  def update_status(state, description, context = config.context)
-    params = {
-      state:       state,
-      description: description,
-      target_url:  @payload["details_url"],
-      context:     context,
-    }
-    @response = service_post(status_url, params.to_json)
-  end
-
-  def receive_test_status
-    url = base_status_url("0" * 40)
-    params = {}
-    raw_post(url, params.to_json)
-  rescue CC::Service::HTTPError => e
-    if e.status == 422
-      {
-        ok: true,
-        params: params.as_json,
-        status: e.status,
-        endpoint_url: url,
-        message: "OAuth token is valid"
-      }
-    else
-      raise
-    end
-  end
-
   def setup_http
     http.headers["Content-Type"]  = "application/json"
     http.headers["Authorization"] = "token #{config.oauth_token}"
     http.headers["User-Agent"]    = "Code Climate"
   end
 
-  def status_url
-    base_status_url(commit_sha)
-  end
-
   def base_status_url(commit_sha)
     "#{config.base_url}/repos/#{github_slug}/statuses/#{commit_sha}"
   end
 
-  def user_url
-    "#{config.base_url}/user"
-  end
-
   def github_slug
     @payload.fetch("github_slug")
   end
 
-  def commit_sha
-    @payload.fetch("commit_sha")
-  end
-
-  def number
-    @payload.fetch("number")
-  end
-
   def response_includes_repo_scope?(response)
     response.headers['x-oauth-scopes'] && response.headers['x-oauth-scopes'].split(/\s*,\s*/).include?("repo")
   end
 
+  def test_status_code
+    422
+  end
 end

data/lib/cc/services/gitlab_merge_requests.rb

@@ -0,0 +1,70 @@
+require "cc/presenters/pull_requests_presenter"
+
+class CC::Service::GitlabMergeRequests < CC::PullRequests
+  class Config < CC::Service::Config
+    attribute :access_token, Axiom::Types::String,
+      label: "Access Token",
+      description: "A personal access token with permissions for the repo."
+    attribute :context, Axiom::Types::String,
+      label: "Context",
+      description: "The integration name for the merge request status",
+      default: "codeclimate"
+    attribute :base_url, Axiom::Types::String,
+      label: "GitLab API Base URL",
+      description: "Base URL for the GitLab API",
+      default: "https://gitlab.com"
+  end
+
+  self.title = "GitLab Merge Requests"
+  self.description = "Update merge requests on GitLab"
+
+  private
+
+  def update_status_skipped
+    update_status("success", presenter.skipped_message)
+  end
+
+  def update_status_success
+    update_status("success", presenter.success_message)
+  end
+
+  def update_coverage_status_success
+    update_status("success", presenter.coverage_message, "#{config.context}/coverage")
+  end
+
+  def update_status_failure
+    update_status("failed", presenter.success_message)
+  end
+
+  def update_status_error
+    update_status(
+      "failed",
+      @payload["message"] || presenter.error_message
+    )
+  end
+
+  def update_status_pending
+    update_status(
+      "running",
+      @payload["message"] || presenter.pending_message
+    )
+  end
+
+  def setup_http
+    http.headers["Content-Type"] = "application/json"
+    http.headers["PRIVATE-TOKEN"] = config.access_token
+    http.headers["User-Agent"] = "Code Climate"
+  end
+
+  def base_status_url(commit_sha)
+    "#{config.base_url}/api/v3/projects/#{CGI.escape(slug)}/statuses/#{commit_sha}"
+  end
+
+  def slug
+    git_url.path.gsub(/(^\/|.git$)/, "")
+  end
+
+  def test_status_code
+    404
+  end
+end

data/lib/cc/services/version.rb

@@ -1,5 +1,5 @@
 module CC
   module Services
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

data/test/github_pull_requests_test.rb

@@ -37,7 +37,7 @@ class TestGitHubPullRequests < CC::Service::TestCase
     })
 
     receive_pull_request(
-      { },
+      {},
       {
         github_slug: "pbrisbin/foo",
         commit_sha:  "abc123",

data/test/gitlab_merge_requests_test.rb

@@ -0,0 +1,219 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestGitlabMergeRequests < CC::Service::TestCase
+  def test_merge_request_status_pending
+    expect_status_update(
+      "hal/hal9000",
+      "abc123",
+      "state" => "running",
+      "description" => /is analyzing/,
+    )
+
+    receive_merge_request(
+      {},
+      git_url: "ssh://git@gitlab.com/hal/hal9000.git",
+      commit_sha: "abc123",
+      state: "pending",
+    )
+  end
+
+  def test_merge_request_status_success_detailed
+    expect_status_update(
+      "hal/hal9000",
+      "abc123",
+      "state" => "success",
+      "description" => "Code Climate found 2 new issues and 1 fixed issue.",
+    )
+
+    receive_merge_request(
+      {},
+      git_url: "ssh://git@gitlab.com/hal/hal9000.git",
+      commit_sha: "abc123",
+      state: "success",
+    )
+  end
+
+  def test_merge_request_status_failure
+    expect_status_update(
+      "hal/hal9000",
+      "abc123",
+      "state" => "failed",
+      "description" => "Code Climate found 2 new issues and 1 fixed issue.",
+    )
+
+    receive_merge_request(
+      {},
+      git_url: "ssh://git@gitlab.com/hal/hal9000.git",
+      commit_sha: "abc123",
+      state: "failure",
+    )
+  end
+
+  def test_merge_request_status_error
+    expect_status_update(
+      "hal/hal9000",
+      "abc123",
+      "state" => "failed",
+      "description" => "Code Climate encountered an error attempting to analyze this pull request.",
+    )
+
+    receive_merge_request(
+      {},
+      git_url: "ssh://git@gitlab.com/hal/hal9000.git",
+      commit_sha: "abc123",
+      state: "error",
+      message: nil,
+    )
+  end
+
+  def test_merge_request_status_error_message_provided
+    expect_status_update(
+      "hal/hal9000",
+      "abc123",
+      "state" => "failed",
+      "description" => "I'm sorry Dave, I'm afraid I can't do that",
+    )
+
+    receive_merge_request(
+      {},
+      git_url: "ssh://git@gitlab.com/hal/hal9000.git",
+      commit_sha: "abc123",
+      state: "error",
+      message: "I'm sorry Dave, I'm afraid I can't do that",
+    )
+  end
+
+  def test_merge_request_status_skipped
+    expect_status_update(
+      "hal/hal9000",
+      "abc123",
+      "state" => "success",
+      "description" => /skipped analysis/,
+    )
+
+    receive_merge_request(
+      {},
+      git_url: "ssh://git@gitlab.com/hal/hal9000.git",
+      commit_sha: "abc123",
+      state: "skipped",
+    )
+  end
+
+  def test_merge_request_coverage_status_success
+    expect_status_update(
+      "hal/hal9000",
+      "abc123",
+      "state" => "success",
+      "description" => "87% test coverage (+2%)",
+    )
+
+    receive_merge_request_coverage(
+      {},
+      git_url: "ssh://git@gitlab.com/hal/hal9000.git",
+      commit_sha: "abc123",
+      state: "success",
+      covered_percent: 87,
+      covered_percent_delta: 2.0,
+    )
+  end
+
+  def test_merge_request_status_test_success
+    @stubs.post("api/v3/projects/hal%2Fhal9000/statuses/#{"0" * 40}") { |env| [404, {}, ""] }
+
+    assert receive_test({}, { git_url: "ssh://git@gitlab.com/hal/hal9000.git" })[:ok], "Expected test of pull request to be true"
+  end
+
+  def test_merge_request_status_test_failure
+    @stubs.post("api/v3/projects/hal%2Fhal9000/statuses/#{"0" * 40}") { |env| [401, {}, ""] }
+
+    assert_raises(CC::Service::HTTPError) do
+      receive_test({}, { git_url: "ssh://git@gitlab.com/hal/hal9000.git" })
+    end
+  end
+
+  def test_merge_request_unknown_state
+    response = receive_merge_request({}, { state: "unknown" })
+
+    assert_equal({ ok: false, message: "Unknown state" }, response)
+  end
+
+  def test_different_base_url
+    @stubs.post("api/v3/projects/hal%2Fhal9000/statuses/#{"0" * 40}") do |env|
+      assert env[:url].to_s == "https://gitlab.hal.org/api/v3/projects/hal%2Fhal9000/statuses/#{"0" * 40}"
+      [404, {}, ""]
+    end
+
+    assert receive_test({ base_url: "https://gitlab.hal.org" }, { git_url: "ssh://git@gitlab.com/hal/hal9000.git" })[:ok], "Expected test of pull request to be true"
+  end
+
+  def test_different_context
+    expect_status_update(
+      "gordondiggs/ellis",
+      "abc123",
+      "context" => "sup",
+      "state" => "running",
+    )
+
+    response = receive_merge_request(
+      { context: "sup" },
+      git_url: "https://gitlab.com/gordondiggs/ellis.git",
+      commit_sha: "abc123",
+      state: "pending",
+    )
+  end
+
+  def test_default_context
+    expect_status_update(
+      "gordondiggs/ellis",
+      "abc123",
+      "context" => "codeclimate",
+      "state" => "running",
+    )
+
+    response = receive_merge_request(
+      {},
+      git_url: "https://gitlab.com/gordondiggs/ellis.git",
+      commit_sha: "abc123",
+      state: "pending",
+    )
+  end
+
+  private
+
+  def expect_status_update(repo, commit_sha, params)
+    @stubs.post "api/v3/projects/#{CGI.escape(repo)}/statuses/#{commit_sha}" do |env|
+      assert_equal "123", env[:request_headers]["PRIVATE-TOKEN"]
+
+      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 receive_merge_request(config, event_data)
+    receive(
+      CC::Service::GitlabMergeRequests,
+      { access_token: "123" }.merge(config),
+      { name: "pull_request", issue_comparison_counts: {'fixed' => 1, 'new' => 2} }.merge(event_data)
+    )
+  end
+
+  def receive_merge_request_coverage(config, event_data)
+    receive(
+      CC::Service::GitlabMergeRequests,
+      { access_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 = {})
+    receive(
+      CC::Service::GitlabMergeRequests,
+      { oauth_token: "123" }.merge(config),
+      { name: "test", issue_comparison_counts: {'fixed' => 1, 'new' => 2} }.merge(event_data)
+    )
+  end
+end

data/test/service_test.rb

@@ -75,4 +75,10 @@ class TestService < CC::Service::TestCase
       service_post("/my/wrong/url", {token: "1234"}.to_json, {})
     end
   end
+
+  def test_services
+    services = CC::Service.services
+
+    assert !services.include?(CC::PullRequests)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate-services
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Bryan Helmkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -168,6 +168,7 @@ files:
 - lib/cc/helpers/quality_helper.rb
 - lib/cc/helpers/vulnerability_helper.rb
 - lib/cc/presenters/pull_requests_presenter.rb
+- lib/cc/pull_requests.rb
 - lib/cc/service.rb
 - lib/cc/service/config.rb
 - lib/cc/service/formatter.rb
@@ -186,6 +187,7 @@ files:
 - lib/cc/services/flowdock.rb
 - lib/cc/services/github_issues.rb
 - lib/cc/services/github_pull_requests.rb
+- lib/cc/services/gitlab_merge_requests.rb
 - lib/cc/services/hipchat.rb
 - lib/cc/services/jira.rb
 - lib/cc/services/lighthouse.rb
@@ -203,6 +205,7 @@ files:
 - test/formatters/snapshot_formatter_test.rb
 - test/github_issues_test.rb
 - test/github_pull_requests_test.rb
+- test/gitlab_merge_requests_test.rb
 - test/helper.rb
 - test/hipchat_test.rb
 - test/invocation_error_handling_test.rb
@@ -237,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Service classes for Code Climate
@@ -250,6 +253,7 @@ test_files:
 - test/formatters/snapshot_formatter_test.rb
 - test/github_issues_test.rb
 - test/github_pull_requests_test.rb
+- test/gitlab_merge_requests_test.rb
 - test/helper.rb
 - test/hipchat_test.rb
 - test/invocation_error_handling_test.rb