codeclimate-services 1.11.1 → 1.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8980a3e6294016d7483aedd981ee4c54f56c45f8526274e9516013825d9f626a
-  data.tar.gz: ef2aaaa203bc911dbb348b5e4f1d3e0b7b6a7eaab0e7857156e4318d6c6ac74b
+  metadata.gz: e49ecbb12d3d95c5fcf279a4d5a66042fff2349a034f864ca361c7b575e498b4
+  data.tar.gz: 1564c19d8878e7982e9a18fb66cc4ae954ec26a7cabaebf4e0e4f0f919316b49
 SHA512:
-  metadata.gz: bcf20aee515217c99ab7d09ee592bba7b3ec16f732e9bd7ffd3698b18d3a6e5bab3ab7c6f5dcf1bb0806d6e0c4f4179b551de756a545a2d93ccaef0467e7b87d
-  data.tar.gz: 3941929485b68f39e67ee5c02f03faad637e3273b16c87dc92c7b85fcf8c6025a17c40e62a1306b64b2d9ddc4d7d33e63ae4b8de5a59abd1c1d009415962673e
+  metadata.gz: 2e6a1864050ea867c58dfc8432f44a853f9563cba2bbf3a2bd9d33fee0bffcbf823115cd11811fc268bfec2049e3e002e594e916455a3a4a1839a2e52d4e34e7
+  data.tar.gz: c266bbdd933ed408284569eef1f628353dfc38f07b0d585bd85b3704396a924f0f1e01ab9018e4aee59d45afc8ec2a39cb6bd3e1ab45713eef5985f80f205153

data/.circleci/config.yml

@@ -1,16 +1,57 @@
-version: 2
+version: 2.0
+init: &init
+  run:
+    name: init
+    command: |
+      echo '. .circleci/shared.bash' >> "$BASH_ENV"
 
 jobs:
   test:
-    machine:
-      docker_layer_caching: true
+    environment:
+      CC_TEST_REPORTER_ID: ad21bc049a323138b0a88086069115e9df6dba417912095b7bb17b7a65fc6182
+    docker:
+      - image: "circleci/ruby:2.7.5"
     working_directory: ~/codeclimate/codeclimate-services
     steps:
       - checkout
-      - run: bundle install && bundle exec rake && bundle exec codeclimate-test-reporter
+      - 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..."
+
+  publish:
+    machine: true
+    steps:
+      - checkout
+      - *init
+      - run:
+          name: Install Hub dependency
+          command: install_hub
+      - run:
+          name: Login on RubyGems
+          command: login_to_rubygems
+      - run:
+          name: Publish new version
+          command: |
+            if [ `git diff --quiet HEAD~ VERSION; echo $?` -eq 1 ]; then
+              publish_new_version
+            fi
 
 workflows:
   version: 2
   test:
     jobs:
       - test
+      - publish:
+          requires:
+            - test
+          filters:
+            branches:
+              only:
+                - master

data/.circleci/shared.bash

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+set -exuo pipefail
+
+VERSION=$(cat VERSION)
+
+function install_hub() {
+    sudo apt update && sudo apt install -y git wget
+    url="$(wget -qO- https://api.github.com/repos/github/hub/releases/latest | tr '"' '\n' | grep '.*/download/.*/hub-linux-amd64-.*.tgz')"
+    wget -qO- "$url" | sudo tar -xzvf- -C /usr/bin --strip-components=2 --wildcards "*/bin/hub"
+}
+
+function login_to_rubygems() {
+  mkdir -p "$HOME/.gem"
+  touch "$HOME/.gem/credentials"
+  chmod 0600 "$HOME/.gem/credentials"
+  printf -- "---\n:rubygems_api_key: %s\n" "$GEM_HOST_API_KEY" > "$HOME/.gem/credentials"
+}
+
+function tag_version() {
+  GITHUB_TOKEN="${GITHUB_TOKEN}" hub release create -m "v${VERSION}" "v${VERSION}"
+}
+
+
+function publish_new_version() {
+  set +x
+  # Build and push gem
+  gem build ./*.gemspec
+  gem push ./*.gem
+
+  # Create gh tag
+  tag_version
+
+  set -x
+}

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/VERSION

@@ -0,0 +1 @@
+1.11.4

data/codeclimate-services.gemspec

@@ -5,7 +5,7 @@ require "cc/services/version"
 
 Gem::Specification.new do |spec|
   spec.name = "codeclimate-services"
-  spec.version = CC::Services::VERSION
+  spec.version = CC::Services.version
   spec.authors = ["Bryan Helmkamp"]
   spec.email = ["bryan@brynary.com"]
   spec.summary = "Service classes for Code Climate"

data/lib/cc/pull_requests.rb

@@ -6,29 +6,19 @@ 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"]
+    receive_request("success", :update_coverage_status)
+  end
 
-    if state == "success" && report_status?
-      update_coverage_status_success
-    else
-      @response = simple_failure("Unknown state")
-    end
+  def receive_pull_request_diff_coverage
+    receive_request(%w[pending skipped], :update_diff_coverage_status)
+  end
 
-    response
+  def receive_pull_request_total_coverage
+    receive_request(%w[pending skipped], :update_total_coverage_status)
   end
 
   private
@@ -57,6 +47,22 @@ class CC::PullRequests < CC::Service
     raise NotImplementedError
   end
 
+  def update_diff_coverage_status_skipped
+    raise NotImplementedError
+  end
+
+  def update_diff_coverage_status_pending
+    raise NotImplementedError
+  end
+
+  def update_total_coverage_status_skipped
+    raise NotImplementedError
+  end
+
+  def update_total_coverage_status_pending
+    raise NotImplementedError
+  end
+
   def update_status_failure
     raise NotImplementedError
   end
@@ -91,6 +97,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,8 @@ module CC
       issue
       pull_request
       pull_request_coverage
+      pull_request_diff_coverage
+      pull_request_total_coverage
       quality
       snapshot
       test

data/lib/cc/services/github_pull_requests.rb

@@ -71,6 +71,31 @@ 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")
+
+  end
+
+  def update_total_coverage_status_skipped
+    update_status("success", presenter.skipped_message, "#{config.context}/total-coverage")
+  end
+
+  def update_diff_coverage_status_pending
+    update_status(
+      "pending",
+      @payload["message"] || presenter.pending_message,
+      "#{config.context}/diff-coverage"
+    )
+  end
+
+  def update_total_coverage_status_pending
+    update_status(
+      "pending",
+      @payload["message"] || presenter.pending_message,
+      "#{config.context}/total-coverage"
+    )
+  end
+
   def update_status_failure
     update_status("failure", presenter.success_message)
   end

data/lib/cc/services/version.rb

@@ -1,5 +1,9 @@
 module CC
   module Services
-    VERSION = "1.11.1".freeze
+    def version
+      path = File.expand_path("../../../../VERSION", __FILE__)
+      @version ||= File.read(path).strip
+    end
+    module_function :version
   end
 end

data/spec/cc/pull_requests_spec.rb

@@ -0,0 +1,131 @@
+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
+
+  describe "#receive_pull_request_total_coverage" do
+    let(:payload_status) { "skipped" }
+    let(:expected_method_name) { :update_total_coverage_status_skipped }
+    let(:method_to_call) { :receive_pull_request_total_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,48 @@ 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/)
+
+    receive_pull_request_diff_coverage({},
+      github_slug:     "pbrisbin/foo",
+      commit_sha:      "abc123",
+      state:           "skipped")
+  end
+
+  it "pull request total coverage skipped" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "success",
+      "description" => /skipped analysis/, "context" => /total-coverage/)
+
+    receive_pull_request_total_coverage({},
+      github_slug:     "pbrisbin/foo",
+      commit_sha:      "abc123",
+      state:           "skipped")
+  end
+
+  it "pull request diff coverage pending" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "pending",
+      "description" => /a test message/, "context" => /diff-coverage/)
+
+    receive_pull_request_diff_coverage({},
+      github_slug:     "pbrisbin/foo",
+      commit_sha:      "abc123",
+      state:           "pending",
+      message: "a test message")
+  end
+
+  it "pull request total coverage skipped" do
+    expect_status_update("pbrisbin/foo", "abc123", "state" => "pending",
+      "description" => /a test message/, "context" => /total-coverage/)
+
+    receive_pull_request_total_coverage({},
+      github_slug:     "pbrisbin/foo",
+      commit_sha:      "abc123",
+      state:           "pending",
+      message: "a test message")
+  end
+
   it "pull request status test success" do
     http_stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |_env| [422, {}, ""] }
 
@@ -213,6 +255,22 @@ 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_pull_request_total_coverage(config, event_data)
+    service_receive(
+      CC::Service::GitHubPullRequests,
+      { oauth_token: "123" }.merge(config),
+      { name: "pull_request_total_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.1
+  version: 1.11.4
 platform: ruby
 authors:
 - Bryan Helmkamp
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".circleci/shared.bash"
 - ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
@@ -139,6 +140,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- VERSION
 - base_rubocop.yml
 - bin/bundler
 - bin/coderay
@@ -194,10 +196,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
@@ -222,7 +226,7 @@ homepage: https://codeclimate.com/
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -237,8 +241,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Service classes for Code Climate
 test_files:
@@ -246,10 +250,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