gitlab-dangerfiles 2.11.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 708f86af0c7d76e5df58d4ea85223461f39f1f7fb4248b3236d7baa92b626ccf
-  data.tar.gz: 22f2ee0d777dbc7ab95956f5bf2191c03449bc170baf9c9bacbd1e1e4a32ed69
+  metadata.gz: 1bcd8631096b4c3a5c7c6df1c8a1c49fda0a4b4936c9f815996ca7702be99f3e
+  data.tar.gz: ce6a7cc2c2b69e49a262882eddba550d4245c578bfc235be594a27cd0d04d737
 SHA512:
-  metadata.gz: ad25c4c671fcde850a9c1740fb4e8dc847e4593cff3a55b4ef502bcb902cf84d5ddb4c7a0e64063371d252624f506b47047d32d292efa6ebee92f6db948162c5
-  data.tar.gz: '066975079aae0a2307c5b2a5734f4ff43d6556bd149c4dcdcac3586646e416c2abc1234ff3833359f24b4e5f19a1eece8af66c7c32b5b813df79cc5fb93bfbe6'
+  metadata.gz: 60b36a45528577103064018e02315f365f729c4842f77ef794001fe4697760f2baf60ecaf29a19c5a1c0be25c239832b5d93908a4d6ddb5df7dc22380968f317
+  data.tar.gz: f1591f53f037986f147f9549bfe98faeecee825c20d916e4370d9f76d562a18456fe8ac993e507987013bdaa52b95845776bac3c66fe6ab844d2f74b13084339

data/README.md

@@ -67,6 +67,8 @@ Gitlab::Dangerfiles.for_project(self, 'my-project') do |dangerfiles|
 end
 ```
 
+Note that your custom plugins and rules (unless you exclude them with `except`) are automatically imported by the gem.
+
 ### Plugins
 
 Danger plugins are located under `lib/danger/plugins`.
@@ -85,8 +87,10 @@ Alternatively, you can also get/set configuration on the engine directly via `Gi
 
 #### Available general configurations
 
+- `project_root`: The project root path. You shouldn't have to override it.
 - `project_name`: The project name. Currently used by the Roulette plugin to fetch relevant
   reviewers/maintainers based on the project name. Default to `ENV["CI_PROJECT_NAME"]`.
+- `ci_only_rules`: A list of rules that cannot run locally.
 - `files_to_category`: A hash of the form `{ filename_regex => categories, [filename_regex, changes_regex] => categories }`.
   `filename_regex` is the regex pattern to match file names. `changes_regex` is the regex pattern to
   match changed lines in files that match `filename_regex`. Used in `helper.changes_by_category`, `helper.changes`, and `helper.categories_for_file`.
@@ -166,6 +170,18 @@ include:
 
 See a [real world example](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/105).
 
+## Rake tasks
+
+You can import this gem's Rake tasks by adding the following to your project's `Rakefile`:
+
+```ruby
+require 'gitlab-dangerfiles'
+
+Gitlab::Dangerfiles.load_tasks
+```
+
+That will add the `danger_local` Rake task that allows to run Danger locally.
+
 ## Documentation
 
 Latest documentation can be found at <https://www.rubydoc.info/gems/gitlab-dangerfiles>.

data/gitlab-dangerfiles.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rake", ">= 0"
   spec.add_dependency "danger-gitlab", ">= 8.0.0"
   spec.add_dependency "danger", ">= 8.4.5"
 

data/lib/danger/plugins/changelog.rb

@@ -4,6 +4,7 @@ module Danger
   # Contains method to check the presense and validity of changelogs.
   class Changelog < Danger::Plugin
     NO_CHANGELOG_LABELS = [
+      "maintenance::refactor",
       "maintenance::pipelines",
       "maintenance::workflow",
       "ci-build",
@@ -39,7 +40,6 @@ module Danger
         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
-    CHANGELOG_CONFIG_FILE = "#{ENV["CI_PROJECT_DIR"]}/.gitlab/changelog_config.yml"
     DEFAULT_CHANGELOG_CATEGORIES = %w[
       added
       fixed
@@ -235,21 +235,25 @@ module Danger
 
     private
 
+    def changelog_config_file
+      @changelog_config_file ||= File.join(helper.config.project_root, ".gitlab/changelog_config.yml")
+    end
+
     def valid_categories
       return @categories if defined?(@categories)
 
-      @categories = if File.exist?(CHANGELOG_CONFIG_FILE)
+      @categories = if File.exist?(changelog_config_file)
           begin
             YAML
-              .load_file(CHANGELOG_CONFIG_FILE)
+              .load_file(changelog_config_file)
               .fetch("categories")
               .keys
               .freeze
           rescue Psych::SyntaxError, Psych::DisallowedClass => ex
-            puts "#{CHANGELOG_CONFIG_FILE} doesn't seem to be a valid YAML file:\n#{ex.message}\nFallbacking to the default categories: #{DEFAULT_CHANGELOG_CATEGORIES}"
+            puts "#{changelog_config_file} doesn't seem to be a valid YAML file:\n#{ex.message}\nFallbacking to the default categories: #{DEFAULT_CHANGELOG_CATEGORIES}"
             DEFAULT_CHANGELOG_CATEGORIES
           rescue => ex
-            puts "Received an unexpected failure while trying to fetch categories at #{CHANGELOG_CONFIG_FILE}:\n#{ex.message}\nFallbacking to the default categories: #{DEFAULT_CHANGELOG_CATEGORIES}"
+            puts "Received an unexpected failure while trying to fetch categories at #{changelog_config_file}:\n#{ex.message}\nFallbacking to the default categories: #{DEFAULT_CHANGELOG_CATEGORIES}"
             DEFAULT_CHANGELOG_CATEGORIES
           end
         else

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

@@ -142,7 +142,7 @@ module Danger
     end
 
     def release_automation?
-      gitlab_helper&.mr_author == RELEASE_TOOLS_BOT
+      mr_author == RELEASE_TOOLS_BOT
     end
 
     # @param items [Array<String>] An array of items to transform into a bullet list.

data/lib/danger/rules/commit_messages/Dangerfile

@@ -97,7 +97,7 @@ def lint_commits(commits)
       warn_or_fail_commits(multi_line_commit_linter)
       commit_linters.delete(multi_line_commit_linter) # Don't show an error (here) and a warning (below)
     elsif helper.ci? # We don't have access to the MR title locally
-      title_linter = lint_mr_title(gitlab.mr_json['title'])
+      title_linter = lint_mr_title(helper.mr_title)
       if title_linter.failed?
         warn_or_fail_commits(title_linter)
       end

data/lib/gitlab/dangerfiles/config.rb

@@ -3,10 +3,18 @@
 module Gitlab
   module Dangerfiles
     class Config
+      # @!attribute project_root
+      #   @return [String] the project root folder path.
+      attr_accessor :project_root
+
       # @!attribute project_name
       #   @return [String] the project name. Currently used by the Roulette plugin to fetch relevant reviewers/maintainers based on the project name. Default to +ENV["CI_PROJECT_NAME"]+.
       attr_accessor :project_name
 
+      # @!attribute ci_only_rules
+      #   @return [Array<String>] rules that cannot be run locally.
+      attr_accessor :ci_only_rules
+
       # @!attribute files_to_category
       #   @return [{Regexp => Array<Symbol>}, {Array<Regexp> => Array<Symbol>}] A hash of the form +{ filename_regex => categories, [filename_regex, changes_regex] => categories }+.
       #           +filename_regex+ is the regex pattern to match file names. +changes_regex+ is the regex pattern to
@@ -26,7 +34,9 @@ module Gitlab
 
       def initialize
         @files_to_category = {}
+        @project_root = nil
         @project_name = ENV["CI_PROJECT_NAME"]
+        @ci_only_rules = []
         @code_size_thresholds = DEFAULT_CHANGES_SIZE_THRESHOLDS
         @max_commits_count = DEFAULT_COMMIT_MESSAGES_MAX_COMMITS_COUNT
       end

data/lib/gitlab/dangerfiles/spec_helper.rb

@@ -24,7 +24,9 @@ module DangerSpecHelper
   # A stubbed out Dangerfile for use in tests
   def self.testing_dangerfile
     env = Danger::EnvironmentManager.new(testing_env)
-    Danger::Dangerfile.new(env, testing_ui)
+    Danger::Dangerfile.new(env, testing_ui).tap do |dangerfile|
+      dangerfile.defined_in_file = Dir.pwd
+    end
   end
 
   def self.fake_danger

data/lib/gitlab/dangerfiles/task_loader.rb

@@ -0,0 +1,15 @@
+require "rake"
+
+module Gitlab
+  module Dangerfiles
+    module TaskLoader
+      module_function
+
+      TASKS_DIR = File.expand_path("tasks", __dir__)
+
+      def load_tasks
+        Rake.application.add_import(*Dir.glob(File.join(TASKS_DIR, "*.rake")))
+      end
+    end
+  end
+end

data/lib/gitlab/dangerfiles/tasks/main.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+desc "Run local Danger rules"
+task :danger_local do
+  require "open3"
+
+  stdout, stderr, status = Open3.capture3({}, *%w{bundle exec danger dry_run})
+
+  puts("#{stdout}#{stderr}")
+
+  exit(status.exitstatus.to_i)
+end

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "2.11.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/gitlab/dangerfiles.rb

@@ -1,18 +1,9 @@
 require "gitlab/dangerfiles/version"
+require "gitlab/dangerfiles/task_loader"
 
 module Gitlab
   module Dangerfiles
     RULES_DIR = File.expand_path("../danger/rules", __dir__)
-    EXISTING_RULES = Dir.glob(File.join(RULES_DIR, "*")).each_with_object([]) do |path, memo|
-      if File.directory?(path)
-        memo << File.basename(path)
-      end
-    end
-    LOCAL_RULES = %w[
-      changelog
-      changes_size
-      commit_messages
-    ].freeze
     CI_ONLY_RULES = %w[
       simple_roulette
       type_label
@@ -20,6 +11,10 @@ module Gitlab
       z_retry_link
     ].freeze
 
+    def self.load_tasks
+      TaskLoader.load_tasks
+    end
+
     # Utility method to construct a [Gitlab::Dangerfiles::Engine] instance,
     # which is yielded to the given block.
     #
@@ -29,6 +24,7 @@ module Gitlab
     # @return [Gitlab::Dangerfiles::Engine]
     def self.for_project(dangerfile, project_name = nil)
       Engine.new(dangerfile).tap do |engine|
+        engine.config.project_root = Pathname.new(File.dirname(dangerfile.defined_in_file))
         engine.config.project_name = project_name if project_name
 
         yield engine
@@ -60,15 +56,15 @@ module Gitlab
       #   end
       def import_plugins
         danger_plugin.import_plugin(File.expand_path("../danger/plugins/*.rb", __dir__))
+
+        Dir.glob(File.expand_path("danger/plugins/*.rb", config.project_root)).sort.each do |path|
+          puts "Importing plugin at #{path}" if dangerfile.verbose
+          danger_plugin.import_plugin(path)
+        end
       end
 
       # Import available Dangerfiles.
       #
-      # @deprecated
-      # @param rules [Symbol, Array<String>] Can be either +:all+ (default) to import all rules,
-      #   or an array of rules.
-      #   Available rules are: +changes_size+.
-      #
       # @param only [Symbol, Array<String>] An array of rules to import (defaults to all rules).
       #   Available rules are: +changes_size+.
       #
@@ -87,14 +83,15 @@ module Gitlab
       #     # Or import only a subset of rules, except a subset of rules
       #     dangerfiles.import_dangerfiles(only: %w[changes_size], except: %w[commit_messages])
       #   end
-      def import_dangerfiles(rules: nil, only: nil, except: [])
-        puts "The `:rules` parameter is deprecated in favor of `:only`." unless rules.nil?
+      def import_dangerfiles(only: nil, except: [])
+        return if helper_plugin.release_automation?
 
-        only ||= EXISTING_RULES if rules == :all
-        only ||= rules || EXISTING_RULES
+        rules = filtered_rules(only, except)
+        puts "Running rules: #{rules}\n" if dangerfile.verbose
 
-        filtered_rules(only, except).each do |rule|
-          danger_plugin.import_dangerfile(path: File.join(RULES_DIR, rule))
+        rules.each do |rule, path|
+          puts "Importing rule #{rule} at #{path}" if dangerfile.verbose
+          danger_plugin.import_dangerfile(path: path)
         end
       end
 
@@ -119,14 +116,43 @@ module Gitlab
 
       attr_reader :dangerfile
 
-      def allowed_rules
-        return LOCAL_RULES unless helper_plugin.respond_to?(:ci?)
+      def all_gem_rules
+        @all_gem_rules ||= Dir.glob(File.join(RULES_DIR, "*")).sort.each_with_object({}) do |path, memo|
+          rule_name = File.basename(path)
+          memo[rule_name] = path if File.directory?(path) && File.exist?(File.join(path, "Dangerfile"))
+        end
+      end
+
+      def custom_rules
+        @custom_rules ||= Dir.glob(File.expand_path("danger/*", config.project_root)).sort.each_with_object({}) do |path, memo|
+          rule_name = File.basename(path)
+          memo[rule_name] = path if File.directory?(path) && File.exist?(File.join(path, "Dangerfile"))
+        end
+      end
+
+      def all_rules
+        all_gem_rules.merge(custom_rules)
+      end
 
-        helper_plugin.ci? ? LOCAL_RULES | CI_ONLY_RULES : LOCAL_RULES
+      def local_rules
+        ci_only_rules = CI_ONLY_RULES | config.ci_only_rules
+        all_rules.reject { |rule, _v| ci_only_rules.include?(rule) }
       end
 
-      def filtered_rules(only, except)
-        (Array(only).map(&:to_s) & EXISTING_RULES & allowed_rules) - except
+      def allowed_rules_based_on_context
+        helper_plugin.ci? ? all_rules : local_rules
+      end
+
+      def filtered_rules(only_rules, except_rules)
+        only_rules = Array(only_rules).compact.map(&:to_s)
+
+        rules = allowed_rules_based_on_context.reject { |rule, _v| except_rules.include?(rule) }
+
+        if only_rules.any?
+          rules.select! { |rule, _v| only_rules.include?(rule) }
+        end
+
+        rules
       end
 
       def danger_plugin

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 3.0.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: danger-gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +183,8 @@ files:
 - lib/gitlab/dangerfiles/emoji_checker.rb
 - lib/gitlab/dangerfiles/merge_request_linter.rb
 - lib/gitlab/dangerfiles/spec_helper.rb
+- lib/gitlab/dangerfiles/task_loader.rb
+- lib/gitlab/dangerfiles/tasks/main.rake
 - lib/gitlab/dangerfiles/teammate.rb
 - lib/gitlab/dangerfiles/title_linting.rb
 - lib/gitlab/dangerfiles/type_label_guesser.rb