danger-dangermattic 1.0.0

data/spec/labels_checker_spec.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+module Danger
+  describe Danger::LabelsChecker do
+    it 'is a plugin' do
+      expect(described_class.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @plugin = @dangerfile.labels_checker
+      end
+
+      context 'with required labels' do
+        it 'reports a custom error when a PR does not have at least one label' do
+          allow(@plugin.github).to receive(:pr_labels).and_return([])
+
+          error = 'PR is missing at least one label.'
+          @plugin.check(required_labels: [//], required_labels_error: error)
+
+          expect(@dangerfile).to report_errors([error])
+        end
+
+        it 'does nothing when a PR has at least one label' do
+          pr_labels = ['my-label']
+          allow(@plugin.github).to receive(:pr_labels).and_return(pr_labels)
+
+          @plugin.check(required_labels: [//])
+
+          expect(@dangerfile).to not_report
+        end
+
+        it 'reports an error containing the required labels when a PR does not meet the label requirements' do
+          pr_labels = ['random other label', '[feature] magic', 'wizard needed', 'type: fantasy']
+          allow(@plugin.github).to receive(:pr_labels).and_return(pr_labels)
+
+          @plugin.check(
+            required_labels: [/^\[feature\]/, /^\[type\]:/]
+          )
+
+          expect(@dangerfile).to report_errors(['PR is missing label(s) matching: `^\[type\]:`'])
+        end
+
+        it 'reports a custom error when a PR has custom label requirements' do
+          pr_labels = ['random label', 'feature: magic', 'wizard needed', 'another type: test']
+          allow(@plugin.github).to receive(:pr_labels).and_return(pr_labels)
+
+          custom_labels_error = 'Please add at least one of the required labels.'
+
+          @plugin.check(
+            required_labels: [/^feature:/, /^type:/],
+            required_labels_error: custom_labels_error
+          )
+
+          expect(@dangerfile).to report_errors([custom_labels_error])
+        end
+
+        it 'does nothing when custom required labels are correctly set in the PR' do
+          pr_labels = [
+            'some other label',
+            'type: fantasy',
+            'milestone: 1.0',
+            'feature: time travel',
+            'wizard needed'
+          ]
+          allow(@plugin.github).to receive(:pr_labels).and_return(pr_labels)
+
+          @plugin.check(
+            required_labels: [/^feature:/, /^type:/]
+          )
+
+          expect(@dangerfile).to not_report
+        end
+      end
+
+      context 'with recommended labels' do
+        it 'reports a warning containing the recommended labels when a PR does not meet the label requirements' do
+          pr_labels = ['random other label', 'milestone: rc']
+          allow(@plugin.github).to receive(:pr_labels).and_return(pr_labels)
+
+          @plugin.check(
+            recommended_labels: [/^feature:/, /^milestone:/, /^\[type\]/]
+          )
+
+          expect(@dangerfile).to report_warnings(['PR is missing label(s) matching: `^feature:`, `^\[type\]`'])
+        end
+
+        it 'reports a custom warning when a PR has custom label requirements' do
+          pr_labels = ['random other label', 'feature: myFeature', 'Milestone: beta']
+          allow(@plugin.github).to receive(:pr_labels).and_return(pr_labels)
+
+          custom_labels_warning = 'Please add at least one feature and milestone label in the expected formats.'
+
+          @plugin.check(
+            recommended_labels: [/^feature:/, /^milestone:/],
+            recommended_labels_warning: custom_labels_warning
+          )
+
+          expect(@dangerfile).to report_warnings([custom_labels_warning])
+        end
+
+        it 'does nothing when custom recommended labels are correctly set in the PR' do
+          pr_labels = [
+            '[feature]: time travel',
+            '[type]: prototype',
+            '[milestone]: prototype',
+            'another random label'
+          ]
+          allow(@plugin.github).to receive(:pr_labels).and_return(pr_labels)
+
+          @plugin.check(
+            recommended_labels: [/^\[feature\]:/, /^\[type\]:/]
+          )
+
+          expect(@dangerfile).to not_report
+        end
+      end
+
+      context 'with \'do not merge\' labels' do
+        it 'reports an error when a PR has a single \'do not merge\' label' do
+          pr_label = 'DO NOT MERGE'
+          allow(@plugin.github).to receive(:pr_labels).and_return([pr_label])
+
+          @plugin.check(do_not_merge_labels: [pr_label])
+
+          expect(@dangerfile).to report_errors(["This PR is tagged with `#{pr_label}` label(s)."])
+        end
+
+        it 'reports an error when a PR has a custom label for not merging' do
+          pr_label = 'please dont merge'
+          allow(@plugin.github).to receive(:pr_labels).and_return([pr_label])
+
+          labels = ['blocked', pr_label]
+          @plugin.check(
+            do_not_merge_labels: labels
+          )
+
+          expect(@dangerfile).to report_errors(["This PR is tagged with `#{pr_label}` label(s)."])
+        end
+      end
+
+      it 'reports the right errors and warning when combining the check parameters' do
+        do_not_merge_label = 'blocked'
+        pr_labels = [do_not_merge_label, 'type: test', 'milestone: alpha']
+        allow(@plugin.github).to receive(:pr_labels).and_return(pr_labels)
+
+        custom_labels_error = "Please add at least one label in the 'type: issueType' format."
+        custom_labels_warning = "Please add at least one label in the 'feature: myFeatureName' format."
+
+        @plugin.check(
+          do_not_merge_labels: [do_not_merge_label],
+          required_labels: [/^type:/, /^feature:/],
+          required_labels_error: custom_labels_error,
+          recommended_labels: [/^bug-triage$/],
+          recommended_labels_warning: custom_labels_warning
+        )
+
+        expect(@dangerfile.status_report[:warnings]).to eq([custom_labels_warning])
+        expect(@dangerfile.status_report[:errors]).to contain_exactly(
+          "This PR is tagged with `#{do_not_merge_label}` label(s).",
+          custom_labels_error
+        )
+      end
+    end
+  end
+end

data/spec/manifest_pr_checker_spec.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+module Danger
+  describe Danger::ManifestPRChecker do
+    it 'is a plugin' do
+      expect(described_class.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @plugin = @dangerfile.manifest_pr_checker
+      end
+
+      describe 'Bundler' do
+        it 'reports a warning when a PR changed the Gemfile but not the Gemfile.lock' do
+          modified_files = ['Gemfile']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_gemfile_lock_updated
+
+          expected_warning = format(ManifestPRChecker::MESSAGE, 'Gemfile', 'Gemfile.lock', 'Please run `bundle install` or `bundle update <updated_gem>`')
+          expect(@dangerfile).to report_warnings([expected_warning])
+        end
+
+        it 'reports no warnings when both the Gemfile and the Gemfile.lock were updated' do
+          modified_files = ['Gemfile', 'Gemfile.lock']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_gemfile_lock_updated
+
+          expect(@dangerfile).to not_report
+        end
+
+        it 'reports no warnings when only the Gemfile.lock was updated' do
+          modified_files = ['Gemfile.lock']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_gemfile_lock_updated
+
+          expect(@dangerfile).to not_report
+        end
+      end
+
+      describe 'CocoaPods' do
+        it 'reports a warning when a PR changed the Podfile but not the Podfile.lock' do
+          modified_files = ['Podfile']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_podfile_lock_updated
+
+          expected_warning = format(ManifestPRChecker::MESSAGE, 'Podfile', 'Podfile.lock', 'Please run `bundle exec pod install`')
+          expect(@dangerfile).to report_warnings([expected_warning])
+        end
+
+        it 'reports no warnings when both the Podfile and the Podfile.lock were updated' do
+          modified_files = ['Podfile', 'Podfile.lock']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_podfile_lock_updated
+
+          expect(@dangerfile).to not_report
+        end
+
+        it 'reports a warning when a PR changed a custom located Podfile but not the corresponding Podfile.lock' do
+          modified_files = ['./path/to/Podfile', './my/Podfile.lock']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_podfile_lock_updated
+
+          expected_warning = format(ManifestPRChecker::MESSAGE, './path/to/Podfile', 'Podfile.lock', 'Please run `bundle exec pod install`')
+          expect(@dangerfile).to report_warnings([expected_warning])
+        end
+
+        it 'reports multiple warnings when a PR changed multiple custom located Podfiles but not the corresponding Podfile.lock' do
+          modified_files = ['./dir1/Podfile', './dir2/Podfile', './dir3/Podfile', './dir1/Podfile.lock']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_podfile_lock_updated
+
+          expected_warnings = [
+            format(ManifestPRChecker::MESSAGE, './dir2/Podfile', 'Podfile.lock', 'Please run `bundle exec pod install`'),
+            format(ManifestPRChecker::MESSAGE, './dir3/Podfile', 'Podfile.lock', 'Please run `bundle exec pod install`')
+          ]
+          expect(@dangerfile).to report_warnings(expected_warnings)
+        end
+
+        it 'reports no warnings when both custom located Podfile`s and their corresponding Podfile.lock were updated' do
+          modified_files = ['./my/path/to/Podfile', './another/path/to/Podfile', './my/path/to/Podfile.lock', './another/path/to/Podfile.lock']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_podfile_lock_updated
+
+          expect(@dangerfile).to not_report
+        end
+
+        it 'reports no warnings when only the Podfile.lock was updated' do
+          modified_files = ['Podfile.lock']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_podfile_lock_updated
+
+          expect(@dangerfile).to not_report
+        end
+      end
+
+      describe 'Swift Package Manager' do
+        it 'reports a warning when a PR changed the Package.swift but not the Package.resolved' do
+          modified_files = ['Package.swift']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_swift_package_resolved_updated
+
+          expected_warning = format(ManifestPRChecker::MESSAGE, 'Package.swift', 'Package.resolved', 'Please resolve the Swift packages in Xcode')
+          expect(@dangerfile).to report_warnings([expected_warning])
+        end
+
+        it 'reports no warnings when both the Package.swift and the Package.resolved were updated' do
+          modified_files = ['Package.swift', 'Package.resolved']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_swift_package_resolved_updated
+
+          expect(@dangerfile).to not_report
+        end
+
+        it 'reports no warnings when only the Package.resolved was updated' do
+          modified_files = ['Package.resolved']
+          allow(@plugin.git).to receive(:modified_files).and_return(modified_files)
+
+          @plugin.check_swift_package_resolved_updated
+
+          expect(@dangerfile).to not_report
+        end
+      end
+    end
+  end
+end

data/spec/milestone_checker_spec.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+module Danger
+  describe Danger::MilestoneChecker do
+    it 'is a plugin' do
+      expect(described_class.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @plugin = @dangerfile.milestone_checker
+      end
+
+      describe '#check_milestone_set' do
+        context 'when there is no milestone set' do
+          it "reports a warning when a PR doesn't have a milestone set" do
+            allow(@plugin.github).to receive(:pr_json).and_return({})
+
+            @plugin.check_milestone_set
+
+            expected_warning = ['PR is not assigned to a milestone.']
+            expect(@dangerfile).to report_warnings(expected_warning)
+          end
+
+          it "reports an error when a PR doesn't have a milestone set" do
+            allow(@plugin.github).to receive(:pr_json).and_return({})
+
+            @plugin.check_milestone_set(report_type: :error)
+
+            expected_error = ['PR is not assigned to a milestone.']
+            expect(@dangerfile).to report_errors(expected_error)
+          end
+        end
+
+        context 'when there is a milestone set' do
+          it 'does nothing when a PR has a milestone set' do
+            pr_json = {
+              'milestone' => {
+                'title' => 'Release Day'
+              }
+            }
+
+            allow(@plugin.github).to receive(:pr_json).and_return(pr_json)
+
+            @plugin.check_milestone_set
+
+            expect(@dangerfile).to not_report
+          end
+
+          it 'does nothing when an error is expected but the PR has a milestone set' do
+            pr_json = {
+              'milestone' => {
+                'title' => 'Release Day'
+              }
+            }
+
+            allow(@plugin.github).to receive(:pr_json).and_return(pr_json)
+
+            @plugin.check_milestone_set(report_type: :error)
+
+            expect(@dangerfile).to not_report
+          end
+        end
+      end
+
+      describe '#check_milestone_due_date' do
+        it 'reports a warning when a PR has a milestone with due date within the warning days threshold' do
+          pr_json = {
+            'milestone' => {
+              'title' => 'Release Day',
+              'html_url' => 'https://wp.com',
+              'due_on' => DateTime.parse('2023-06-30T23:59:01Z')
+            },
+            'state' => 'open'
+          }
+
+          date_one_day_before_due = DateTime.parse('2023-06-29T23:59:01Z')
+
+          allow(@plugin.github).to receive(:pr_json).and_return(pr_json)
+          allow(DateTime).to receive(:now).and_return(date_one_day_before_due)
+
+          @plugin.check_milestone_due_date(days_before_due: 5)
+
+          expected_warning = ["This PR is assigned to the milestone [Release Day](https://wp.com). This milestone is due in less than 5 days.\nPlease make sure to get it merged by then or assign it to a milestone with a later deadline."]
+          expect(@dangerfile).to report_warnings(expected_warning)
+        end
+
+        it 'does nothing when a PR has a milestone before the warning days threshold' do
+          pr_json = {
+            'milestone' => {
+              'title' => 'Release Day',
+              'html_url' => 'https://wp.com',
+              'due_on' => DateTime.parse('2023-06-30T23:59:01Z')
+            },
+            'state' => 'open'
+          }
+
+          more_than_five_days_before_due = DateTime.parse('2023-06-25T23:00:01Z')
+
+          allow(@plugin.github).to receive(:pr_json).and_return(pr_json)
+          allow(DateTime).to receive(:now).and_return(more_than_five_days_before_due)
+
+          @plugin.check_milestone_due_date(days_before_due: 5)
+
+          expect(@dangerfile).to not_report
+        end
+
+        it 'reports an error when a PR has a milestone with due date after the warning days threshold' do
+          pr_json = {
+            'milestone' => {
+              'title' => 'Release Day',
+              'html_url' => 'https://wp.com',
+              'due_on' => DateTime.parse('2023-06-30T23:59:01Z')
+            },
+            'state' => 'open'
+          }
+
+          date_one_day_after_due = DateTime.parse('2023-07-01T23:00:01Z')
+
+          allow(@plugin.github).to receive(:pr_json).and_return(pr_json)
+          allow(DateTime).to receive(:now).and_return(date_one_day_after_due)
+
+          @plugin.check_milestone_due_date(days_before_due: 5, report_type: :error)
+
+          expected_warning = ["This PR is assigned to the milestone [Release Day](https://wp.com). The due date for this milestone has already passed.\nPlease assign it to a milestone with a later deadline or check whether the release for this milestone has already been finished."]
+          expect(@dangerfile).to report_errors(expected_warning)
+        end
+
+        it 'reports a warning when a PR has a milestone with due date within a custom warning days threshold' do
+          pr_json = {
+            'milestone' => {
+              'title' => 'Release Day',
+              'html_url' => 'https://wp.com',
+              'due_on' => DateTime.parse('2023-06-30T23:59:01Z')
+            },
+            'state' => 'open'
+          }
+
+          date_nine_days_before_due = DateTime.parse('2023-06-21T23:59:01Z')
+
+          allow(@plugin.github).to receive(:pr_json).and_return(pr_json)
+          allow(DateTime).to receive(:now).and_return(date_nine_days_before_due)
+
+          @plugin.check_milestone_due_date(days_before_due: 10)
+
+          expected_warning = ["This PR is assigned to the milestone [Release Day](https://wp.com). This milestone is due in less than 10 days.\nPlease make sure to get it merged by then or assign it to a milestone with a later deadline."]
+          expect(@dangerfile).to report_warnings(expected_warning)
+        end
+
+        it 'does nothing when a PR has a milestone without a due date' do
+          pr_json = {
+            'milestone' => {
+              'title' => 'Release Day',
+              'html_url' => 'https://wp.com'
+            },
+            'state' => 'open'
+          }
+
+          allow(@plugin.github).to receive(:pr_json).and_return(pr_json)
+
+          @plugin.check_milestone_due_date(days_before_due: 5)
+
+          expect(@dangerfile).to not_report
+        end
+
+        it 'does nothing when a PR has a milestone but it has already passed the due date' do
+          pr_json = {
+            'milestone' => {
+              'title' => 'Release Day',
+              'html_url' => 'https://wp.com',
+              'due_on' => DateTime.parse('2023-06-30T23:59:01Z')
+            },
+            'state' => 'closed'
+          }
+
+          allow(@plugin.github).to receive(:pr_json).and_return(pr_json)
+
+          @plugin.check_milestone_due_date(days_before_due: 5)
+
+          expect(@dangerfile).to not_report
+        end
+
+        it "reports a warning when asked to do so when a PR doesn't have a milestone set" do
+          allow(@plugin.github).to receive(:pr_json).and_return({})
+
+          @plugin.check_milestone_due_date(days_before_due: 5, report_type_if_no_milestone: :warning)
+
+          expected_warning = ['PR is not assigned to a milestone.']
+          expect(@dangerfile).to report_warnings(expected_warning)
+        end
+
+        it "reports an error when asked to do so when a PR doesn't have a milestone set" do
+          allow(@plugin.github).to receive(:pr_json).and_return({})
+
+          @plugin.check_milestone_due_date(days_before_due: 5, report_type_if_no_milestone: :error)
+
+          expected_error = ['PR is not assigned to a milestone.']
+          expect(@dangerfile).to report_errors(expected_error)
+        end
+
+        it "does nothing when asked to do so when a PR doesn't have a milestone set" do
+          allow(@plugin.github).to receive(:pr_json).and_return({})
+
+          @plugin.check_milestone_due_date(days_before_due: 5, report_type_if_no_milestone: :none)
+
+          expect(@dangerfile).to not_report
+        end
+
+        it "does nothing when nil is used and a PR doesn't have a milestone set" do
+          allow(@plugin.github).to receive(:pr_json).and_return({})
+
+          @plugin.check_milestone_due_date(days_before_due: 5, report_type_if_no_milestone: nil)
+
+          expect(@dangerfile).to not_report
+        end
+      end
+    end
+  end
+end