codeclimate-services 1.11.0 → 1.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849571797dc28b6279e4281c3d1b5e356a9fc8150845690d82eced4fc0c000c1
-  data.tar.gz: e944d253acde61ff799b0f07f31fb8d8aca97eda479351ff304ab8188b769dfc
+  metadata.gz: 9857632046cf9409d85f8ff2429efabf13c6eb5ab1300023d52407dc381deac0
+  data.tar.gz: 65fd4acdcc300cf00472ac8c8df740d0ec75dd382014a8963117680393629578
 SHA512:
-  metadata.gz: 6ef756b1698fba1341bac6e6f05b4fdbd1286ae0afc14320245a89938392d9bfd2871035a09b9acf5529231da28f2ab955df4e11a30b5ea70941f6e12873b883
-  data.tar.gz: 7795015fad0cb95435b0a1492b90438534b0821f698715dc0d986f845a6d4c6726aec744ed9f62063e178e107579b8771f8ac85914314488683c0bc65732784b
+  metadata.gz: 51e15698f1fbe51598067be6452db4b19ff6c4f913392ef172a772d58cb2c548805f569d34f11c74cb9ab486937cc75395104ffc082966b3a2edd7ee5866d832
+  data.tar.gz: 758fea2bc59978563b7a133affb1c8fd1d63d94250e88bbcabcd1d945a406c76845065abe7f249bd4ba33c4249b6620dd129d7ccfb8288a00297aa2309426b0a

data/.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2.0
+jobs:
+  test:
+    environment:
+      CC_TEST_REPORTER_ID: ad21bc049a323138b0a88086069115e9df6dba417912095b7bb17b7a65fc6182
+    docker:
+      - image: "circleci/ruby:2.7.5"
+    working_directory: ~/codeclimate/codeclimate-services
+    steps:
+      - checkout
+      - run:
+          name: Setup Coverage
+          command: |
+           (curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > cc-test-reporter && chmod +x ./cc-test-reporter) || echo "Couldn't download test reporter"
+      - run: bundle install && bundle exec rake
+      - persist_to_workspace:
+          root: .
+          paths:
+            - coverage
+      - run: ./cc-test-reporter after-build --exit-code $? || echo "Send coverage skipped..."
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test

data/.ruby-version

@@ -1 +1 @@
-2.4.4
+2.7.5

data/Gemfile

@@ -7,5 +7,4 @@ gem "pry"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
 end

data/README.md

@@ -131,6 +131,18 @@ and always return a hash of `{ ok: true|false, message: "String (HTML ok)" }`.
 
 When you open your PR, please include an image for your service.
 
+## Release
+
+1. Bump the version on `lib/cc/services/version`
+2. A gem owner developer should run the following: (check owners here https://rubygems.org/gems/codeclimate-services)
+```shell
+bundle install
+gem build codeclimate-services.gemspec
+gem push codeclimate-services-<VERSION>.gem
+git tag v<VERSION>
+git push origin master --tags
+```
+
 ## License
 
 See LICENSE.txt. This incorporates code from bugsnag-notification-plugins and

data/lib/cc/presenters/pull_requests_presenter.rb

@@ -36,9 +36,11 @@ module CC
       def coverage_message
         message = "#{formatted_percent(@covered_percent)}%"
 
-        if @covered_percent_delta > 0
+        return message if @covered_percent_delta.nil?
+
+        if @covered_percent_delta.round(2) > 0
           message += " (+#{formatted_percent(@covered_percent_delta)}%)"
-        elsif @covered_percent_delta < 0
+        elsif @covered_percent_delta.round(2) < 0
           message += " (#{formatted_percent(@covered_percent_delta)}%)"
         end
 

data/lib/cc/pull_requests.rb

@@ -6,29 +6,15 @@ class CC::PullRequests < CC::Service
   end
 
   def receive_pull_request
-    setup_http
-    state = @payload["state"]
-
-    if %w[pending success failure skipped error].include?(state) && report_status?
-      send("update_status_#{state}")
-    else
-      @response = simple_failure("Unknown state")
-    end
-
-    response
+    receive_request(%w[pending success failure skipped error], :update_status)
   end
 
   def receive_pull_request_coverage
-    setup_http
-    state = @payload["state"]
-
-    if state == "success" && report_status?
-      update_coverage_status_success
-    else
-      @response = simple_failure("Unknown state")
-    end
+    receive_request("success", :update_coverage_status)
+  end
 
-    response
+  def receive_pull_request_diff_coverage
+    receive_request("skipped", :update_diff_coverage_status)
   end
 
   private
@@ -57,6 +43,10 @@ class CC::PullRequests < CC::Service
     raise NotImplementedError
   end
 
+  def update_diff_coverage_status_skipped
+    raise NotImplementedError
+  end
+
   def update_status_failure
     raise NotImplementedError
   end
@@ -91,6 +81,19 @@ class CC::PullRequests < CC::Service
     end
   end
 
+  def receive_request(*permitted_statuses, call_method)
+    setup_http
+    state = @payload["state"]
+
+    if permitted_statuses.flatten.include?(state) && report_status?
+      send(call_method.to_s + "_#{state}")
+    else
+      @response = simple_failure("Unknown state")
+    end
+
+    response
+  end
+
   def presenter
     CC::Service::PullRequestsPresenter.new(@payload)
   end

data/lib/cc/service/formatter.rb

@@ -19,7 +19,7 @@ class CC::Service::Formatter < SimpleDelegator
   end
 
   def message_prefix
-    prefix = options.fetch(:prefix, "").to_s
+    prefix = (options[:prefix] || "").to_s
 
     if options[:prefix_with_repo]
       prefix << "[#{repo_name}]"

data/lib/cc/service.rb

@@ -36,6 +36,7 @@ module CC
       issue
       pull_request
       pull_request_coverage
+      pull_request_diff_coverage
       quality
       snapshot
       test

data/lib/cc/services/github_pull_requests.rb

@@ -71,6 +71,11 @@ class CC::Service::GitHubPullRequests < CC::PullRequests
     update_status("success", presenter.coverage_message, "#{config.context}/coverage")
   end
 
+  def update_diff_coverage_status_skipped
+    update_status("success", presenter.skipped_message, "#{config.context}/diff-coverage")
+    update_status("success", presenter.skipped_message, "#{config.context}/total-coverage")
+  end
+
   def update_status_failure
     update_status("failure", presenter.success_message)
   end

data/lib/cc/services/jira.rb

@@ -3,7 +3,7 @@ require "base64"
 class CC::Service::Jira < CC::Service
   class Config < CC::Service::Config
     attribute :domain, Axiom::Types::String,
-      description: "Your JIRA host domain (e.g. yourjira.com:PORT, please exclude https://)"
+      description: "Your JIRA host domain (e.g. yourjira.com[:PORT], please exclude https:// and only add PORT if you are using a different port number to access your own server that is not the default)"
 
     attribute :username, Axiom::Types::String,
       description: "Must exactly match the 'username' that appears on your JIRA profile page."

data/lib/cc/services/version.rb

@@ -1,5 +1,5 @@
 module CC
   module Services
-    VERSION = "1.11.0".freeze
+    VERSION = "1.11.3".freeze
   end
 end

data/spec/cc/presenters/pull_requests_presenter_spec.rb

@@ -30,12 +30,20 @@ describe CC::Service::PullRequestsPresenter, type: :service do
     expect("85%").to eq(build_presenter({}, "covered_percent" => 85, "covered_percent_delta" => 0).coverage_message)
   end
 
+  it "message coverage without delta" do
+    expect("85%").to eq(build_presenter({}, "covered_percent" => 85, "covered_percent_delta" => nil).coverage_message)
+  end
+
+  it "message coverage the same when rounded" do
+    expect("85%").to eq(build_presenter({}, "covered_percent" => 85, "covered_percent_delta" => 0.0005).coverage_message)
+  end
+
   it "message coverage up" do
     expect("85.5% (+2.46%)").to eq(build_presenter({}, "covered_percent" => 85.5, "covered_percent_delta" => 2.4567).coverage_message)
   end
 
   it "message coverage down" do
-    expect("85.35% (-3%)").to eq( build_presenter({}, "covered_percent" => 85.348, "covered_percent_delta" => -3.0).coverage_message)
+    expect("85.35% (-3%)").to eq(build_presenter({}, "covered_percent" => 85.348, "covered_percent_delta" => -3.0).coverage_message)
   end
 
   it "message approved" do

data/spec/cc/pull_requests_spec.rb

@@ -0,0 +1,123 @@
+require "spec_helper"
+
+describe CC::PullRequests do
+  shared_examples "receive method" do
+    before do
+      allow(instance).to receive(:report_status?).and_return(true)
+      expect(instance).to receive(:setup_http)
+    end
+
+    context "when the status is valid" do
+      let(:instance) { CC::PullRequests.new({}, name: "test", state: payload_status) }
+      let(:response) do
+        {
+          ok: true,
+          state: 201,
+          message: "Success",
+        }
+      end
+
+      it "calls the corresponding method" do
+        expect(instance).to receive(expected_method_name) do
+          instance.instance_variable_set(:@response, response)
+        end
+        result = instance.send(method_to_call)
+
+        expect(result).to eq(response)
+      end
+
+      context "when report_status? is false" do
+        before { expect(instance).to receive(:report_status?).and_return(false) }
+
+        it "returns unknown status message" do
+          expect(instance).not_to receive(expected_method_name)
+          result = instance.send(method_to_call)
+
+          expect(result).to eq({ ok: false, message: "Unknown state" })
+        end
+      end
+    end
+
+    context "when the status is not valid" do
+      let(:instance) { CC::PullRequests.new({}, name: "test", status: "invalid_status") }
+
+      it "returns unknown status message" do
+        expect(instance).not_to receive(expected_method_name)
+        result = instance.send(method_to_call)
+
+        expect(result).to eq({ ok: false, message: "Unknown state" })
+      end
+    end
+  end
+
+  describe "#receive_test" do
+    let(:instance) { CC::PullRequests.new({}, name: "test") }
+
+    before do
+      expect(instance).to receive(:base_status_url) do |param|
+        "some_url" + param
+      end
+      expect(instance).to receive(:setup_http)
+    end
+
+    it "makes a raw http test post" do
+      expect_any_instance_of(CC::Service::HTTP).to receive(:raw_post).with(
+        "some_url" + ("0" * 40),
+        { state: "success" }.to_json
+      )
+
+      instance.receive_test
+    end
+
+    context "when raising an HTTPError" do
+      context "when message is equal to test_status_code" do
+        it "returns an ok message" do
+          expect(instance).to receive(:test_status_code) { 777 }
+          expect(instance).to receive(:raw_post).
+            and_raise(CC::Service::HTTPError.new("error", status: 777))
+
+          result = instance.receive_test
+          expect(result).to include(
+            ok: true,
+            status: 777,
+            message: "Access token is valid"
+          )
+        end
+      end
+
+      context "when message is different than test_status_code" do
+        it "raises the error" do
+          expect(instance).to receive(:test_status_code) { 777 }
+          expect(instance).to receive(:raw_post).
+            and_raise(CC::Service::HTTPError.new("error", status: 000))
+
+          expect { instance.receive_test }.to raise_error
+        end
+      end
+    end
+  end
+
+  describe "#receive_pull_request" do
+    let(:payload_status) { "skipped" }
+    let(:expected_method_name) { :update_status_skipped }
+    let(:method_to_call) { :receive_pull_request }
+
+    it_behaves_like "receive method"
+  end
+
+  describe "#receive_pull_request_coverage" do
+    let(:payload_status) { "success" }
+    let(:expected_method_name) { :update_coverage_status_success }
+    let(:method_to_call) { :receive_pull_request_coverage }
+
+    it_behaves_like "receive method"
+  end
+
+  describe "#receive_pull_request_diff_coverage" do
+    let(:payload_status) { "skipped" }
+    let(:expected_method_name) { :update_diff_coverage_status_skipped }
+    let(:method_to_call) { :receive_pull_request_diff_coverage }
+
+    it_behaves_like "receive method"
+  end
+end

data/spec/cc/service/formatter_spec.rb

@@ -0,0 +1,21 @@
+describe CC::Service::Formatter do
+
+  class TestFormatter < described_class
+    def format_test
+      message = message_prefix
+      message << "This is a test"
+    end
+  end
+
+  FakeService = Struct.new(:receive)
+
+  it "supports passing nil as prefix" do
+    formatter = TestFormatter.new(
+      FakeService.new(:some_result),
+      prefix: nil,
+      prefix_with_repo: false,
+    )
+
+    expect(formatter.format_test).to eq("This is a test")
+  end
+end

data/spec/cc/service/github_pull_requests_spec.rb

@@ -82,6 +82,18 @@ describe CC::Service::GitHubPullRequests, type: :service do
       covered_percent_delta: 2.0)
   end
 
+  it "pull request diff coverage skipped" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "success",
+      "description" => /skipped analysis/, "context" => /diff-coverage/)
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "success",
+    "description" => /skipped analysis/, "context" => /total-coverage/)
+
+    receive_pull_request_diff_coverage({},
+      github_slug:     "pbrisbin/foo",
+      commit_sha:      "abc123",
+      state:           "skipped")
+  end
+
   it "pull request status test success" do
     http_stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |_env| [422, {}, ""] }
 
@@ -213,6 +225,14 @@ describe CC::Service::GitHubPullRequests, type: :service do
     )
   end
 
+  def receive_pull_request_diff_coverage(config, event_data)
+    service_receive(
+      CC::Service::GitHubPullRequests,
+      { oauth_token: "123" }.merge(config),
+      { name: "pull_request_diff_coverage" }.merge(event_data),
+    )
+  end
+
   def receive_test(config, event_data = {})
     service_receive(
       CC::Service::GitHubPullRequests,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate-services
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.3
 platform: ruby
 authors:
 - Bryan Helmkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -129,6 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
@@ -144,7 +145,6 @@ files:
 - bin/nokogiri
 - bin/pry
 - bin/rake
-- circle.yml
 - codeclimate-services.gemspec
 - config/cacert.pem
 - config/load.rb
@@ -194,10 +194,12 @@ files:
 - spec/axiom/types/token_spec.rb
 - spec/cc/formatters/snapshot_formatter_spec.rb
 - spec/cc/presenters/pull_requests_presenter_spec.rb
+- spec/cc/pull_requests_spec.rb
 - spec/cc/resolve_spec.rb
 - spec/cc/service/asana_spec.rb
 - spec/cc/service/campfire_spec.rb
 - spec/cc/service/flowdock_spec.rb
+- spec/cc/service/formatter_spec.rb
 - spec/cc/service/github_issues_spec.rb
 - spec/cc/service/github_pull_requests_spec.rb
 - spec/cc/service/gitlab_merge_requests_spec.rb
@@ -237,8 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Service classes for Code Climate
@@ -247,10 +248,12 @@ test_files:
 - spec/axiom/types/token_spec.rb
 - spec/cc/formatters/snapshot_formatter_spec.rb
 - spec/cc/presenters/pull_requests_presenter_spec.rb
+- spec/cc/pull_requests_spec.rb
 - spec/cc/resolve_spec.rb
 - spec/cc/service/asana_spec.rb
 - spec/cc/service/campfire_spec.rb
 - spec/cc/service/flowdock_spec.rb
+- spec/cc/service/formatter_spec.rb
 - spec/cc/service/github_issues_spec.rb
 - spec/cc/service/github_pull_requests_spec.rb
 - spec/cc/service/gitlab_merge_requests_spec.rb

data/circle.yml

@@ -1,3 +0,0 @@
-test:
-  override:
-    - bundle exec rake && bundle exec codeclimate-test-reporter