danger-jira_sync 0.0.1

data/spec/jira_sync_spec.rb

@@ -0,0 +1,299 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+# In order to regenerate the fixtures in ./fixtures/vcr_cassettes,
+# you must ensure that your Jira Cloud development environment contains
+# projects matching all of the key prefixes in ISSUE_KEYS_IN_PR_TITLE and
+# ISSUE_KEYS_IN_PR_BODY. Similarly, there must be an issue in each project
+# with a matching key. Look at JIRA_ENVIRONMENT for hints on how  to
+# configure the development environment for VCR.
+#
+# On the GitHub side, if ./fixtures/vcr_cassettes/pull_request.yml changes, you
+# must ensure the title in the response contains the keys found in
+# ISSUE_KEYS_IN_PR_TITLE, and that the body contains the strings found in
+# ISSUE_KEYS_IN_PR_BODY. These constants reflect assumptions in the test suite.
+#
+ISSUE_KEYS_IN_PR_TITLE = ["DEV-1", "ABC-1"].freeze
+ISSUE_KEYS_IN_PR_BODY = ["XYZ-1"].freeze
+JIRA_ENVIRONMENT = {
+  projects: [
+    {
+      key: "DEV",
+      issues: [
+        {
+          key: "DEV-1",
+          components: %w(ComponentA ComponentB)
+        }
+      ]
+    },
+    {
+      key: "XYZ",
+      issues: [
+        {
+          key: "XYZ-1",
+          components: %w(ComponentC)
+        }
+      ]
+    },
+    {
+      key: "ABC",
+      issues: [
+        {
+          key: "ABC-1",
+          components: %w(ComponentB)
+        }
+      ]
+    }
+  ]
+}.freeze
+
+RSpec.describe Danger::DangerJiraSync do
+  it "should be a plugin" do
+    expect(described_class.new(nil)).to be_a Danger::Plugin
+  end
+
+  describe "with Dangerfile" do
+    let(:dangerfile) { testing_dangerfile }
+    let(:plugin) { dangerfile.jira_sync }
+    let(:jira_settings) do
+      {
+        jira_url: testing_env["DANGER_JIRA_URL"],
+        jira_username: testing_env["DANGER_JIRA_USERNAME"],
+        jira_api_token: testing_env["DANGER_JIRA_API_TOKEN"]
+      }
+    end
+
+    def stub_pull_request
+      VCR.use_cassette(:pull_request) do
+        plugin.env.request_source.fetch_details
+      end
+    end
+
+    before do
+      stub_pull_request
+    end
+
+    describe "configure" do
+      it "should return the JIRA::Client instance" do
+        value = plugin.configure(jira_settings)
+        expect(value).to be_a(JIRA::Client)
+      end
+    end
+
+    describe "autolabel_pull_request" do
+      let(:issue_prefixes) { %w(DEV ABC) }
+
+      it "raises a NotConfiguredError when #configure has not been called" do
+        expect { plugin.autolabel_pull_request(issue_prefixes) }.to(
+          raise_error(Danger::DangerJiraSync::NotConfiguredError)
+        )
+      end
+
+      context "after calling #configure" do
+        class GitHubAPIMock
+        end
+
+        let(:github_api_mock) { GitHubAPIMock.new }
+
+        before do
+          plugin.configure(jira_settings)
+        end
+
+        def stub_github_api_labelling(labels: [])
+          allow(github_api_mock).to receive(:labels).and_return(labels)
+          allow(github_api_mock).to receive(:add_label).and_return(nil)
+          allow(github_api_mock).to receive(:add_labels_to_an_issue).and_return(nil)
+
+          allow(plugin.github).to receive(:api).and_return(github_api_mock)
+        end
+
+        def extract_project_keys(prefixes)
+          return prefixes.map { |key| key.gsub(/-\d+/, "") }
+        end
+
+        def pr_title_project_keys
+          extract_project_keys(ISSUE_KEYS_IN_PR_TITLE)
+        end
+
+        def pr_body_project_keys
+          extract_project_keys(ISSUE_KEYS_IN_PR_BODY)
+        end
+
+        def pr_title_related_component_names
+          component_names = []
+
+          JIRA_ENVIRONMENT[:projects].map do |project|
+            next unless pr_title_project_keys.include? project[:key]
+            component_names += project[:issues].map { |issue| issue[:components] }
+          end
+
+          component_names.flatten.uniq
+        end
+
+        def pr_title_related_project_keys
+          project_keys = []
+
+          JIRA_ENVIRONMENT[:projects].map do |project|
+            project_keys << project[:key] if pr_title_project_keys.include? project[:key]
+          end
+
+          project_keys.compact.uniq
+        end
+
+        def stub_jira_find_issue_response(code:, message:)
+          client = plugin.configure(jira_settings)
+
+          response_mock = Object.new
+          allow(response_mock).to receive(:code).and_return(code)
+          allow(response_mock).to receive(:message).and_return(message)
+
+          issue_mock = Object.new
+          allow(issue_mock).to receive(:find).and_raise(JIRA::HTTPError.new(response_mock))
+
+          allow(client).to receive(:Issue).and_return(issue_mock)
+        end
+
+        def stub_jira_find_issue_404
+          stub_jira_find_issue_response(code: 404, message: "Not found")
+        end
+
+        def stub_jira_find_issue_unauthorized
+          stub_jira_find_issue_response(code: 503, message: "Unauthorized")
+        end
+
+        it "returns a list of labels that contains Jira component names" do
+          stub_github_api_labelling
+
+          labels = []
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            labels = plugin.autolabel_pull_request(issue_prefixes)
+          end
+
+          expect(labels).to include(*pr_title_related_component_names)
+        end
+
+        it "returns a list of labels that contains Jira issue project keys" do
+          stub_github_api_labelling
+
+          labels = []
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            labels = plugin.autolabel_pull_request(issue_prefixes)
+          end
+
+          expect(labels).to include(*pr_title_related_project_keys)
+        end
+
+        it "creates a warning when a related Jira ticket cannot be fetched" do
+          stub_jira_find_issue_404
+
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            expect(plugin.autolabel_pull_request(issue_prefixes)).to be_nil
+          end
+
+          issue_warning_count = dangerfile.status_report[:warnings].count do |warning|
+            warning.start_with?("Error while retrieving JIRA issue")
+          end
+
+          expect(issue_warning_count).to eq(issue_prefixes.length)
+        end
+
+        it "creates only one warning when the Jira credentials are invalid" do
+          stub_jira_find_issue_unauthorized
+
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            expect(plugin.autolabel_pull_request(issue_prefixes)).to be_nil
+          end
+
+          issue_warning_count = dangerfile.status_report[:warnings].count do |warning|
+            warning.start_with?("Error while retrieving JIRA issue")
+          end
+
+          expect(issue_warning_count).to eq(1)
+        end
+
+        it "adds a label to the github issue for each related jira issue component name" do
+          pr_title_related_component_names.each do |component_name|
+            expect(github_api_mock).to receive(:add_label).with(anything, component_name, anything).once.and_return(nil)
+          end
+          stub_github_api_labelling
+
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            plugin.autolabel_pull_request(issue_prefixes)
+          end
+        end
+
+        it "adds a label to the github issue for each related jira issue project key" do
+          pr_title_related_project_keys.each do |project_key|
+            expect(github_api_mock).to receive(:add_label).with(anything, project_key, anything).once.and_return(nil)
+          end
+          stub_github_api_labelling
+
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            plugin.autolabel_pull_request(issue_prefixes)
+          end
+        end
+
+        it "adds missing github labels" do
+          labels = pr_title_project_keys + pr_title_related_component_names
+          labels.each do |label|
+            expect(github_api_mock).to receive(:add_label).with(anything, label, anything)
+          end
+          stub_github_api_labelling
+
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            plugin.autolabel_pull_request(issue_prefixes)
+          end
+        end
+
+        it "does not attempt to add new github labels when they already exist" do
+          existing_labels = %w(ComponentA)
+          existing_labels.each do |existing_label|
+            expect(github_api_mock).not_to receive(:add_label).with(anything, existing_label, anything)
+          end
+          stub_github_api_labelling(labels: existing_labels)
+
+          VCR.use_cassette(:default_success) do
+            plugin.autolabel_pull_request(issue_prefixes)
+          end
+        end
+
+        it "returns nil if no issue keys are found in the pr name or body" do
+          expect(plugin.autolabel_pull_request(["NOPE"])).to be_nil
+        end
+
+        it "falls back to issue keys in the pr body if none are found in the pr title" do
+          stub_github_api_labelling
+
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            plugin.autolabel_pull_request(pr_body_project_keys)
+          end
+        end
+
+        it "ignores issue keys in the pr body if any are found in the pr title" do
+          stub_github_api_labelling
+
+          labels = []
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            labels = plugin.autolabel_pull_request(pr_body_project_keys + pr_title_project_keys)
+          end
+
+          expect(labels).to include(*pr_title_project_keys)
+          expect(labels).not_to include(*pr_body_project_keys)
+        end
+
+        it "raises an ArgumentError if no issue_prefixes are specified" do
+          expect { plugin.autolabel_pull_request([]) }.to raise_error(ArgumentError)
+        end
+
+        it "returns nil if no labels can be fetched from Jira" do
+          stub_jira_find_issue_404
+
+          VCR.use_cassette(:default_success, record: :new_episodes) do
+            expect(plugin.autolabel_pull_request(issue_prefixes)).to be_nil
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "dotenv"
+Dotenv.load
+
+# Must be required and started before danger
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require "rspec"
+require "danger"
+require "webmock"
+require "webmock/rspec"
+require "vcr"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = "#{File.dirname(__FILE__)}/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => ENV["DANGER_GITHUB_API_TOKEN"],
+    "DANGER_JIRA_URL" => ENV["DANGER_JIRA_URL"],
+    "DANGER_JIRA_USERNAME" => ENV["DANGER_JIRA_USERNAME"],
+    "DANGER_JIRA_API_TOKEN" => ENV["DANGER_JIRA_API_TOKEN"]
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,293 @@
+--- !ruby/object:Gem::Specification
+name: danger-jira_sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Menesini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Synchronizes information between Jira and GitHub
+email:
+- ben.menesini@rover.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-jira_sync.gemspec
+- lib/danger_jira_sync.rb
+- lib/danger_plugin.rb
+- lib/jira_sync/gem_version.rb
+- lib/jira_sync/plugin.rb
+- spec/fixtures/vcr_cassettes/default_success.yml
+- spec/fixtures/vcr_cassettes/pull_request.yml
+- spec/jira_sync_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/roverdotcom/danger-jira_sync
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Synchronizes information betweeh Jira and GitHub
+test_files:
+- spec/fixtures/vcr_cassettes/default_success.yml
+- spec/fixtures/vcr_cassettes/pull_request.yml
+- spec/jira_sync_spec.rb
+- spec/spec_helper.rb