gitlab-dangerfiles 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0819c79b914e2025eecc3b05a52227a9012ceafeac3300032e1abb129706440
-  data.tar.gz: 117a9710932852cf1845d8a8c3a27f331bbe65da0cccdf13f044858d915ea0c1
+  metadata.gz: 6889bf72a8244ec3bed24ab00bf35b61d269396c7c66c34d271c7d97209c4ea0
+  data.tar.gz: 9aee55c56805756034412d354aea50d7769bd109748109951ab2d86b812fa5ea
 SHA512:
-  metadata.gz: c93c2983a4a0ebba6f3c94d0b81a1da7ba9fad9eb98573a5862e3d6501ff76614501907bb5d492942a47472160d2db5d1a96fcebdad280379cd3e03a43c5f113
-  data.tar.gz: 734bbb0e6894d8de57f4d48546aca9f085447556662dbc64ba99f7cb39ea166b5a75f3d1099077e09d17f44d3687a9fe733451fa06310e02d906209b6003bcae
+  metadata.gz: 8c65bd8b5eb6d7cc11d6f591d14a4fac2212a4edb1cb13c7c4850f87c9b625dd41d4e8cb2b3b2fb2b076a6eba3932545c7d69f009ea3139d164d02baae8235d1
+  data.tar.gz: 3447445301d8fee2538ddb992dd4dcd7e10a4395d308e8b86c40e6a6b71b37152e46a30576d7a5e11c88d8be0803e75387313bb1a53d94a0b26f6722c3f3eaac

data/Dangerfile

@@ -1,5 +1,3 @@
 require_relative "lib/gitlab-dangerfiles"
 
-Gitlab::Dangerfiles.for_project(self) do |dangerfiles|
-  dangerfiles.import_defaults
-end
+Gitlab::Dangerfiles.for_project(self, &:import_defaults)

data/Guardfile

@@ -67,4 +67,6 @@ guard :rspec, cmd: "bundle exec rspec" do
   watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
     Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
   end
+
+  watch(%r{^lib/gitlab/dangerfiles/spec_helper.rb$}) { rspec.spec_dir }
 end

data/README.md

@@ -72,6 +72,7 @@ end
 Danger plugins are located under `lib/danger/plugins`.
 
 - `Danger::Helper` available in `Dangerfile`s as `helper`
+- `Danger::Changelog` available in `Dangerfile`s as `changelog`
 - `Danger::Roulette` available in `Dangerfile`s as `roulette`
 
 For the full documentation about the plugins, please see https://www.rubydoc.info/gems/gitlab-dangerfiles.
@@ -94,6 +95,10 @@ Alternatively, you can also get/set configuration on the engine directly via `Gi
 
 Danger rules are located under `lib/danger/rules`.
 
+#### `changelog`
+
+This rule ensures the merge request follows our [Changelog guidelines](https://docs.gitlab.com/ee/development/changelog.html#changelog-entries).
+
 #### `changes_size`
 
 ##### Available configurations
@@ -109,7 +114,7 @@ Danger rules are located under `lib/danger/rules`.
 - `max_commits_count`: The maximum number of allowed non-squashed/non-fixup commits for a given MR.
    A warning is triggered if the MR has more commits.
 
-### Reviewer Roulette
+#### `simple_roulette`
 
 The library includes a simplified default reviewer roulette that you can use in your
 project. To use it in your project, perform the following steps:
@@ -124,6 +129,10 @@ project. To use it in your project, perform the following steps:
    end
    ```
 
+#### `type_label`
+
+This rule ensures the merge request has a proper [type label](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification) set..
+
 ### CI configuration
 
 In order to run `danger` on GitLab CI, perform the following steps:
@@ -140,8 +149,8 @@ include:
       - '/ci/danger-review.yml'
 ```
 
-3. Create a [Project access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html)
-   with scope `api` and role `Maintainer`.
+3. Create a [Project or group access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html)
+   with scope `api` and role `Developer`.
 4. Add a [CI/CD variable](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project)
    `DANGER_GITLAB_API_TOKEN` (`Masked` but not `Protected`) and use Project access token as value.
 

data/lib/danger/plugins/changelog.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+module Danger
+  # Contains method to check the presense and validity of changelogs.
+  class Changelog < Danger::Plugin
+    NO_CHANGELOG_LABELS = [
+      "type::tooling",
+      "tooling::pipelines",
+      "tooling::workflow",
+      "ci-build",
+      "meta",
+    ].freeze
+    NO_CHANGELOG_CATEGORIES = %i[docs none].freeze
+    CHANGELOG_TRAILER_REGEX = /^(?<name>Changelog):\s*(?<category>.+)$/i.freeze
+    CHANGELOG_EE_TRAILER_REGEX = /^EE: true$/.freeze
+    CHANGELOG_MODIFIED_URL_TEXT = "**CHANGELOG.md was edited.** Please remove the additions and follow the [changelog guidelines](https://docs.gitlab.com/ee/development/changelog.html).\n\n"
+    CHANGELOG_MISSING_URL_TEXT = "**[CHANGELOG missing](https://docs.gitlab.com/ee/development/changelog.html)**:\n\n"
+
+    OPTIONAL_CHANGELOG_MESSAGE = {
+      local: "If this merge request [doesn't need a CHANGELOG entry](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry), feel free to ignore this message.",
+      ci: <<~MSG,
+        If you want to create a changelog entry for GitLab FOSS, add the `Changelog` trailer to the commit message you want to add to the changelog.
+
+        If you want to create a changelog entry for GitLab EE, also [add the `EE: true` trailer](https://docs.gitlab.com/ee/development/changelog.html#gitlab-enterprise-changes) to your commit message.
+
+        If this merge request [doesn't need a CHANGELOG entry](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry), feel free to ignore this message.
+      MSG
+    }.freeze
+    SEE_DOC = "See the [changelog documentation](https://docs.gitlab.com/ee/development/changelog.html)."
+
+    REQUIRED_CHANGELOG_REASONS = {
+      db_changes: "introduces a database migration",
+      feature_flag_removed: "removes a feature flag",
+    }.freeze
+    REQUIRED_CHANGELOG_MESSAGE = {
+      local: "This merge request requires a changelog entry because it [%<reason>s](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry).",
+      ci: <<~MSG,
+        To create a changelog entry, add the `Changelog` trailer to one of your Git commit messages.
+
+        This merge request requires a changelog entry because it [%<reason>s](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry).
+      MSG
+    }.freeze
+
+    def self.categories
+      @categories ||= YAML
+        .load_file("#{ENV["CI_PROJECT_DIR"]}/.gitlab/changelog_config.yml")
+        .fetch("categories")
+        .keys
+        .freeze rescue []
+    end
+
+    class ChangelogCheckResult
+      attr_reader :errors, :warnings, :markdowns, :messages
+
+      def initialize(errors: [], warnings: [], markdowns: [], messages: [])
+        @errors = errors
+        @warnings = warnings
+        @markdowns = markdowns
+        @messages = messages
+      end
+
+      private_class_method :new
+
+      def self.empty
+        new
+      end
+
+      def self.error(error)
+        new(errors: [error])
+      end
+
+      def self.warning(warning)
+        new(warnings: [warning])
+      end
+
+      def error(error)
+        errors << error
+      end
+
+      def warning(warning)
+        warnings << warning
+      end
+
+      def markdown(markdown)
+        markdowns << markdown
+      end
+
+      def message(message)
+        messages << message
+      end
+    end
+
+    # rubocop:disable Style/SignalException
+    def check!
+      if git.modified_files.include?("CHANGELOG.md")
+        fail modified_text
+      end
+
+      if exist?
+        add_danger_messages(check_changelog_path)
+      elsif required?
+        required_texts.each { |_, text| fail(text) } # rubocop:disable Lint/UnreachableLoop
+      elsif optional?
+        message optional_text
+      end
+
+      check_changelog_commit_categories
+    end
+
+    # rubocop:enable Style/SignalException
+
+    # rubocop:disable Style/SignalException
+    def add_danger_messages(check_result)
+      check_result.errors.each { |error| fail(error) } # rubocop:disable Lint/UnreachableLoop
+      check_result.warnings.each { |warning| warn(warning) }
+      check_result.markdowns.each { |markdown_hash| markdown(**markdown_hash) }
+      check_result.messages.each { |text| message(text) }
+    end
+
+    # rubocop:enable Style/SignalException
+
+    def check_changelog_commit_categories
+      changelog_commits.each do |commit|
+        add_danger_messages(check_changelog_trailer(commit))
+      end
+    end
+
+    def check_changelog_trailer(commit)
+      trailer = commit.message.match(CHANGELOG_TRAILER_REGEX)
+      name = trailer[:name]
+      category = trailer[:category]
+
+      unless name == "Changelog"
+        return ChangelogCheckResult.error("The changelog trailer for commit #{commit.sha} must be `Changelog` (starting with a capital C), not `#{name}`")
+      end
+
+      return ChangelogCheckResult.empty if self.class.categories.include?(category)
+
+      ChangelogCheckResult.error("Commit #{commit.sha} uses an invalid changelog category: #{category}")
+    end
+
+    def check_changelog_path
+      check_result = ChangelogCheckResult.empty
+      return check_result unless exist?
+
+      ee_changes = helper.changed_files(%r{\Aee/})
+
+      if ee_changes.any? && !ee_changelog? && !required?
+        check_result.warning("This MR changes code in `ee/`, but its Changelog commit is missing the [`EE: true` trailer](https://docs.gitlab.com/ee/development/changelog.html#gitlab-enterprise-changes). Consider adding it to your Changelog commits.")
+      end
+
+      if ee_changes.empty? && ee_changelog?
+        check_result.warning("This MR has a Changelog commit for EE, but no code changes in `ee/`. Consider removing the `EE: true` trailer from your commits.")
+      end
+
+      if ee_changes.any? && ee_changelog? && required_reasons.include?(:db_changes)
+        check_result.warning("This MR has a Changelog commit with the `EE: true` trailer, but there are database changes which [requires](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry) the Changelog commit to not have the `EE: true` trailer. Consider removing the `EE: true` trailer from your commits.")
+      end
+
+      check_result
+    end
+
+    def required_reasons
+      [].tap do |reasons|
+        reasons << :db_changes if helper.changes.added.has_category?(:migration)
+        reasons << :feature_flag_removed if helper.changes.deleted.has_category?(:feature_flag)
+      end
+    end
+
+    def required?
+      required_reasons.any?
+    end
+
+    def optional?
+      categories_need_changelog? && mr_without_no_changelog_label?
+    end
+
+    def exist?
+      valid_changelog_commits.any?
+    end
+
+    def changelog_commits
+      git.commits.select do |commit|
+        commit.message.match?(CHANGELOG_TRAILER_REGEX)
+      end
+    end
+
+    def valid_changelog_commits
+      changelog_commits.select do |commit|
+        trailer = commit.message.match(CHANGELOG_TRAILER_REGEX)
+
+        self.class.categories.include?(trailer[:category])
+      end
+    end
+
+    def ee_changelog?
+      changelog_commits.any? do |commit|
+        commit.message.match?(CHANGELOG_EE_TRAILER_REGEX)
+      end
+    end
+
+    def modified_text
+      CHANGELOG_MODIFIED_URL_TEXT +
+        (helper.ci? ? format(OPTIONAL_CHANGELOG_MESSAGE[:ci]) : OPTIONAL_CHANGELOG_MESSAGE[:local])
+    end
+
+    def required_texts
+      required_reasons.each_with_object({}) do |required_reason, memo|
+        memo[required_reason] =
+          CHANGELOG_MISSING_URL_TEXT +
+            (helper.ci? ? format(REQUIRED_CHANGELOG_MESSAGE[:ci], reason: REQUIRED_CHANGELOG_REASONS.fetch(required_reason)) : REQUIRED_CHANGELOG_MESSAGE[:local])
+      end
+    end
+
+    def optional_text
+      CHANGELOG_MISSING_URL_TEXT +
+        (helper.ci? ? format(OPTIONAL_CHANGELOG_MESSAGE[:ci]) : OPTIONAL_CHANGELOG_MESSAGE[:local])
+    end
+
+    private
+
+    def read_file(path)
+      File.read(path)
+    end
+
+    def categories_need_changelog?
+      (helper.changes.categories - NO_CHANGELOG_CATEGORIES).any?
+    end
+
+    def mr_without_no_changelog_label?
+      (helper.mr_labels & NO_CHANGELOG_LABELS).empty?
+    end
+  end
+end

data/lib/danger/plugins/internal/helper.rb

@@ -120,13 +120,7 @@ module Danger
     #   +modified_files+ might contain paths that already have been renamed,
     #   so we need to remove them from the list.
     def all_changed_files
-      Set.new
-        .merge(added_files)
-        .merge(modified_files)
-        .merge(renamed_files.map { |x| x[:after] })
-        .subtract(renamed_files.map { |x| x[:before] })
-        .to_a
-        .sort
+      changes.files - changes.renamed_before.files
     end
 
     # @param filename [String] A file name for which we want the diff.
@@ -242,6 +236,20 @@ module Danger
       CATEGORY_LABELS.fetch(category, "~#{category}")
     end
 
+    # @return [String] +""+ when not in the CI context, and the MR Source Project ID as a string otherwise.
+    def mr_source_project_id
+      return "" unless ci?
+
+      gitlab_helper.mr_json["source_project_id"].to_s
+    end
+
+    # @return [String] +""+ when not in the CI context, and the MR Target Project ID as a string otherwise.
+    def mr_target_project_id
+      return "" unless ci?
+
+      gitlab_helper.mr_json["target_project_id"].to_s
+    end
+
     # @return [String] +""+ when not in the CI context, and the MR IID as a string otherwise.
     def mr_iid
       return "" unless ci?
@@ -274,7 +282,7 @@ module Danger
     def mr_labels
       return [] unless ci?
 
-      gitlab_helper.mr_labels
+      (gitlab_helper.mr_labels + labels_to_add.to_a).uniq
     end
 
     # @return [String] +`git rev-parse --abbrev-ref HEAD`+ when not in the CI context, and the MR source branch otherwise.
@@ -330,11 +338,13 @@ module Danger
       /\A\d+-\d+-stable-ee/i.match?(mr_target_branch)
     end
 
-    # Whether a MR has any database-scoped labels (i.e. +"database::*"+) set or not.
+    # Whether a MR has a scoped label with the given scope set or not.
+    #
+    # @param scope [String] The scope for which to look for labels, e.g. +type+ would look for any +type::*+ label.
     #
     # @return [Boolean]
-    def has_database_scoped_labels?
-      mr_labels.any? { |label| label.start_with?("database::") }
+    def has_scoped_label_with_scope?(scope)
+      mr_labels.any? { |label| label.start_with?("#{scope}::") }
     end
 
     # @return [Boolean] whether a MR has any CI-related changes (i.e. +".gitlab-ci.yml"+ or +".gitlab/ci/*"+) or not.
@@ -393,6 +403,17 @@ module Danger
       mr_labels.find { |label| label.start_with?("group::") }
     end
 
+    # Accessor for storing labels to add so that other rules can check if labels will be added after Danger
+    # has evaluated all the rules.
+    # For instance, a rule might require a specific label to be set, but another rule could add this label
+    # itself. Without this method, the first rule wouldn't know that the label would be applied and would ask
+    # for it anyway.
+    #
+    # @return [Set<String>] the list of labels that Danger will add
+    def labels_to_add
+      @labels_to_add ||= Set.new
+    end
+
     private
 
     # @return [Danger::RequestSources::GitLab, nil] the +gitlab+ helper, or +nil+ when it's not available.

data/lib/danger/rules/changelog/Dangerfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+changelog.check!

data/lib/danger/rules/type_label/Dangerfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+if helper.has_scoped_label_with_scope?("type")
+  warn "Please add a [merge request type](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification) to this merge request."
+end

data/lib/danger/rules/z_add_labels/Dangerfile

@@ -0,0 +1,21 @@
+# This rule is the last one since we want to add all the labels to add at once,
+# so we let other rules adding to `helper.labels_to_add` before actually adding them via the API here.
+
+# Don't try to post anything locally.
+return unless helper.ci?
+
+def post_labels(labels)
+  gitlab.api.update_merge_request(helper.mr_target_project_id,
+                                  helper.mr_iid,
+                                  add_labels: labels.join(","))
+rescue Gitlab::Error::Forbidden
+  warn("This Merge Request needs to be labelled with #{helper.labels_list(labels)}. Please request a reviewer or maintainer to add them.")
+end
+
+post_labels(helper.labels_to_add) if helper.labels_to_add.any?
+
+anything_to_post = status_report.values.any?(&:any?)
+
+if anything_to_post
+  markdown("**If needed, you can retry the [`danger-review` job](#{ENV["CI_JOB_URL"]}) that generated this comment.**")
+end

data/lib/gitlab/dangerfiles/spec_helper.rb

@@ -53,60 +53,16 @@ RSpec.shared_context "with dangerfile" do
   let(:renamed_files) { [{ before: renamed_before_file, after: renamed_after_file }] }
   let(:change_class) { Gitlab::Dangerfiles::Change }
   let(:changes_class) { Gitlab::Dangerfiles::Changes }
+  let(:ee_change) { nil }
   let(:changes) { changes_class.new([]) }
   let(:mr_title) { "Fake Title" }
   let(:mr_labels) { [] }
-  let(:mr_changes_from_api) do
-    {
-      "changes" => [
-        {
-          "old_path" => "added-from-api",
-          "new_path" => "added-from-api",
-          "a_mode" => "100644",
-          "b_mode" => "100644",
-          "new_file" => true,
-          "renamed_file" => false,
-          "deleted_file" => false,
-          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
-        },
-        {
-          "old_path" => "modified-from-api",
-          "new_path" => "modified-from-api",
-          "a_mode" => "100644",
-          "b_mode" => "100644",
-          "new_file" => false,
-          "renamed_file" => false,
-          "deleted_file" => false,
-          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
-        },
-        {
-          "old_path" => "renamed_before-from-api",
-          "new_path" => "renamed_after-from-api",
-          "a_mode" => "100644",
-          "b_mode" => "100644",
-          "new_file" => false,
-          "renamed_file" => true,
-          "deleted_file" => false,
-          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
-        },
-        {
-          "old_path" => "deleted-from-api",
-          "new_path" => "deleted-from-api",
-          "a_mode" => "100644",
-          "b_mode" => "100644",
-          "new_file" => false,
-          "renamed_file" => false,
-          "deleted_file" => true,
-          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
-        },
-      ],
-    }
-  end
 
   let(:fake_git) { double("fake-git", added_files: added_files, modified_files: modified_files, deleted_files: deleted_files, renamed_files: renamed_files) }
   let(:fake_helper) { double("fake-helper", changes: changes, added_files: added_files, modified_files: modified_files, deleted_files: deleted_files, renamed_files: renamed_files, mr_iid: 1234, mr_title: mr_title, mr_labels: mr_labels) }
 
   before do
     allow(dangerfile).to receive(:git).and_return(fake_git)
+    allow(dangerfile.helper).to receive(:changes).and_return(changes)
   end
 end

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "2.8.0"
+    VERSION = "2.9.0"
   end
 end

data/lib/gitlab/dangerfiles.rb

@@ -9,11 +9,14 @@ module Gitlab
       end
     end
     LOCAL_RULES = %w[
+      changelog
       changes_size
       commit_messages
     ].freeze
     CI_ONLY_RULES = %w[
       simple_roulette
+      type_label
+      z_add_labels
     ].freeze
 
     # Utility method to construct a [Gitlab::Dangerfiles::Engine] instance,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-gitlab
@@ -149,11 +149,15 @@ files:
 - fixtures/emojis/aliases.json
 - fixtures/emojis/digests.json
 - gitlab-dangerfiles.gemspec
+- lib/danger/plugins/changelog.rb
 - lib/danger/plugins/internal/helper.rb
 - lib/danger/plugins/roulette.rb
+- lib/danger/rules/changelog/Dangerfile
 - lib/danger/rules/changes_size/Dangerfile
 - lib/danger/rules/commit_messages/Dangerfile
 - lib/danger/rules/simple_roulette/Dangerfile
+- lib/danger/rules/type_label/Dangerfile
+- lib/danger/rules/z_add_labels/Dangerfile
 - lib/gitlab-dangerfiles.rb
 - lib/gitlab/Dangerfile
 - lib/gitlab/dangerfiles.rb