gitlab-dangerfiles 0.1.0 → 0.6.0

data/lib/gitlab/dangerfiles.rb

@@ -2,39 +2,5 @@ require "gitlab/dangerfiles/version"
 
 module Gitlab
   module Dangerfiles
-    LOCAL_RULES ||= %w[
-      changes_size
-      commit_messages
-      database
-      documentation
-      duplicate_yarn_dependencies
-      eslint
-      frozen_string
-      karma
-      prettier
-      telemetry
-      utility_css
-    ].freeze
-    CI_ONLY_RULES ||= %w[
-      ce_ee_vue_templates
-      changelog
-      metadata
-      roulette
-      sidekiq_queues
-      specs
-    ].freeze
-    MESSAGE_PREFIX = "==>".freeze
-
-    def self.load_tasks
-      require "gitlab/dangerfiles/tasks"
-    end
-
-    def self.local_warning_message
-      "#{MESSAGE_PREFIX} Only the following Danger rules can be run locally: #{LOCAL_RULES.join(", ")}"
-    end
-
-    def self.success_message
-      "#{MESSAGE_PREFIX} No Danger rule violations!"
-    end
   end
 end

data/lib/gitlab/dangerfiles/base_linter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "title_linting"
+
+module Gitlab
+  module Dangerfiles
+    class BaseLinter
+      MIN_SUBJECT_WORDS_COUNT = 3
+      MAX_LINE_LENGTH = 72
+
+      attr_reader :commit, :problems
+
+      def self.problems_mapping
+        {
+          subject_too_short: "The %s must contain at least #{MIN_SUBJECT_WORDS_COUNT} words",
+          subject_too_long: "The %s may not be longer than #{MAX_LINE_LENGTH} characters",
+          subject_starts_with_lowercase: "The %s must start with a capital letter",
+          subject_ends_with_a_period: "The %s must not end with a period",
+        }
+      end
+
+      def self.subject_description
+        "commit subject"
+      end
+
+      def initialize(commit)
+        @commit = commit
+        @problems = {}
+      end
+
+      def failed?
+        problems.any?
+      end
+
+      def add_problem(problem_key, *args)
+        @problems[problem_key] = sprintf(self.class.problems_mapping[problem_key], *args)
+      end
+
+      def lint_subject
+        if subject_too_short?
+          add_problem(:subject_too_short, self.class.subject_description)
+        end
+
+        if subject_too_long?
+          add_problem(:subject_too_long, self.class.subject_description)
+        end
+
+        if subject_starts_with_lowercase?
+          add_problem(:subject_starts_with_lowercase, self.class.subject_description)
+        end
+
+        if subject_ends_with_a_period?
+          add_problem(:subject_ends_with_a_period, self.class.subject_description)
+        end
+
+        self
+      end
+
+      private
+
+      def subject
+        TitleLinting.remove_draft_flag(message_parts[0])
+      end
+
+      def subject_too_short?
+        subject.split(" ").length < MIN_SUBJECT_WORDS_COUNT
+      end
+
+      def subject_too_long?
+        line_too_long?(subject)
+      end
+
+      def line_too_long?(line)
+        line.length > MAX_LINE_LENGTH
+      end
+
+      def subject_starts_with_lowercase?
+        return false if ("A".."Z").cover?(subject[0])
+
+        first_char = subject.sub(/\A(\[.+\]|\w+:)\s/, "")[0]
+        first_char_downcased = first_char.downcase
+        return true unless ("a".."z").cover?(first_char_downcased)
+
+        first_char.downcase == first_char
+      end
+
+      def subject_ends_with_a_period?
+        subject.end_with?(".")
+      end
+
+      def message_parts
+        @message_parts ||= commit.message.split("\n", 3)
+      end
+    end
+  end
+end

data/lib/gitlab/dangerfiles/commit_linter.rb

@@ -1,40 +1,33 @@
 # frozen_string_literal: true
 
-emoji_checker_path = File.expand_path("emoji_checker", __dir__)
-defined?(Rails) ? require_dependency(emoji_checker_path) : require_relative(emoji_checker_path)
+require_relative "emoji_checker"
 
 module Gitlab
   module Dangerfiles
     class CommitLinter
-      MIN_SUBJECT_WORDS_COUNT = 3
-      MAX_LINE_LENGTH = 72
-      MAX_CHANGED_FILES_IN_COMMIT = 3
       MAX_CHANGED_LINES_IN_COMMIT = 30
-      SHORT_REFERENCE_REGEX = %r{([\w\-\/]+)?(#|!|&|%)\d+\b}.freeze
-      DEFAULT_SUBJECT_DESCRIPTION = "commit subject"
-      WIP_PREFIX = "WIP: "
-      PROBLEMS = {
-        subject_too_short: "The %s must contain at least #{MIN_SUBJECT_WORDS_COUNT} words",
-        subject_too_long: "The %s may not be longer than #{MAX_LINE_LENGTH} characters",
-        subject_starts_with_lowercase: "The %s must start with a capital letter",
-        subject_ends_with_a_period: "The %s must not end with a period",
-        separator_missing: "The commit subject and body must be separated by a blank line",
-        details_too_many_changes: "Commits that change #{MAX_CHANGED_LINES_IN_COMMIT} or more lines across " \
-        "at least #{MAX_CHANGED_FILES_IN_COMMIT} files must describe these changes in the commit body",
-        details_line_too_long: "The commit body should not contain more than #{MAX_LINE_LENGTH} characters per line",
-        message_contains_text_emoji: "Avoid the use of Markdown Emoji such as `:+1:`. These add limited value " \
-        "to the commit message, and are displayed as plain text outside of GitLab",
-        message_contains_unicode_emoji: "Avoid the use of Unicode Emoji. These add no value to the commit " \
-        "message, and may not be displayed properly everywhere",
-        message_contains_short_reference: "Use full URLs instead of short references (`gitlab-org/gitlab#123` or " \
-        "`!123`), as short references are displayed as plain text outside of GitLab",
-      }.freeze
-
-      attr_reader :commit, :problems
+      SHORT_REFERENCE_REGEX = %r{([\w\-\/]+)?(?<!`)(#|!|&|%)\d+(?<!`)}.freeze
+
+      def self.problems_mapping
+        super.merge(
+          {
+            separator_missing: "The commit subject and body must be separated by a blank line",
+            details_too_many_changes: "Commits that change #{MAX_CHANGED_LINES_IN_COMMIT} or more lines across " \
+            "at least #{MAX_CHANGED_FILES_IN_COMMIT} files must describe these changes in the commit body",
+            details_line_too_long: "The commit body should not contain more than #{MAX_LINE_LENGTH} characters per line",
+            message_contains_text_emoji: "Avoid the use of Markdown Emoji such as `:+1:`. These add limited value " \
+            "to the commit message, and are displayed as plain text outside of GitLab",
+            message_contains_unicode_emoji: "Avoid the use of Unicode Emoji. These add no value to the commit " \
+            "message, and may not be displayed properly everywhere",
+            message_contains_short_reference: "Use full URLs instead of short references (`gitlab-org/gitlab#123` or " \
+            "`!123`), as short references are displayed as plain text outside of GitLab",
+          }
+        )
+      end
 
       def initialize(commit)
-        @commit = commit
-        @problems = {}
+        super
+
         @linted = false
       end
 
@@ -58,19 +51,11 @@ module Gitlab
         !details.nil? && !details.empty?
       end
 
-      def failed?
-        problems.any?
-      end
-
-      def add_problem(problem_key, *args)
-        @problems[problem_key] = sprintf(PROBLEMS[problem_key], *args)
-      end
-
-      def lint(subject_description = "commit subject")
+      def lint
         return self if @linted
 
         @linted = true
-        lint_subject(subject_description)
+        lint_subject
         lint_separator
         lint_details
         lint_message
@@ -78,26 +63,6 @@ module Gitlab
         self
       end
 
-      def lint_subject(subject_description)
-        if subject_too_short?
-          add_problem(:subject_too_short, subject_description)
-        end
-
-        if subject_too_long?
-          add_problem(:subject_too_long, subject_description)
-        end
-
-        if subject_starts_with_lowercase?
-          add_problem(:subject_starts_with_lowercase, subject_description)
-        end
-
-        if subject_ends_with_a_period?
-          add_problem(:subject_ends_with_a_period, subject_description)
-        end
-
-        self
-      end
-
       private
 
       def lint_separator
@@ -114,15 +79,11 @@ module Gitlab
         end
 
         details&.each_line do |line|
-          line = line.strip
-
-          next unless line_too_long?(line)
-
-          url_size = line.scan(%r((https?://\S+))).sum { |(url)| url.length } # rubocop:disable CodeReuse/ActiveRecord
+          line_without_urls = line.strip.gsub(%r{https?://\S+}, "")
 
           # If the line includes a URL, we'll allow it to exceed MAX_LINE_LENGTH characters, but
           # only if the line _without_ the URL does not exceed this limit.
-          next unless line_too_long?(line.length - url_size)
+          next unless line_too_long?(line_without_urls)
 
           add_problem(:details_line_too_long)
           break
@@ -159,10 +120,6 @@ module Gitlab
         files_changed > MAX_CHANGED_FILES_IN_COMMIT && lines_changed > MAX_CHANGED_LINES_IN_COMMIT
       end
 
-      def subject
-        message_parts[0].delete_prefix(WIP_PREFIX)
-      end
-
       def separator
         message_parts[1]
       end
@@ -171,37 +128,6 @@ module Gitlab
         message_parts[2]&.gsub(/^Signed-off-by.*$/, "")
       end
 
-      def line_too_long?(line)
-        case line
-        when String
-          line.length > MAX_LINE_LENGTH
-        when Integer
-          line > MAX_LINE_LENGTH
-        else
-          raise ArgumentError, "The line argument (#{line}) should be a String or an Integer! #{line.class} given."
-        end
-      end
-
-      def subject_too_short?
-        subject.split(" ").length < MIN_SUBJECT_WORDS_COUNT
-      end
-
-      def subject_too_long?
-        line_too_long?(subject)
-      end
-
-      def subject_starts_with_lowercase?
-        first_char = subject.sub(/\A\[.+\]\s/, "")[0]
-        first_char_downcased = first_char.downcase
-        return true unless ("a".."z").cover?(first_char_downcased)
-
-        first_char.downcase == first_char
-      end
-
-      def subject_ends_with_a_period?
-        subject.end_with?(".")
-      end
-
       def message_contains_text_emoji?
         emoji_checker.includes_text_emoji?(commit.message)
       end
@@ -217,10 +143,6 @@ module Gitlab
       def emoji_checker
         @emoji_checker ||= Gitlab::Dangerfiles::EmojiChecker.new
       end
-
-      def message_parts
-        @message_parts ||= commit.message.split("\n", 3)
-      end
     end
   end
 end

data/lib/gitlab/dangerfiles/merge_request_linter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "base_linter"
+
+module Gitlab
+  module Dangerfiles
+    class MergeRequestLinter < BaseLinter
+      alias_method :lint, :lint_subject
+
+      def self.subject_description
+        "merge request title"
+      end
+
+      def self.mr_run_options_regex
+        [
+          "RUN AS-IF-FOSS",
+          "UPDATE CACHE",
+          "RUN ALL RSPEC",
+          "SKIP RSPEC FAIL-FAST",
+        ].join("|")
+      end
+
+      private
+
+      def subject
+        super.gsub(/\[?(#{self.class.mr_run_options_regex})\]?/, "").strip
+      end
+    end
+  end
+end

data/lib/gitlab/dangerfiles/teammate.rb

@@ -3,27 +3,42 @@
 module Gitlab
   module Dangerfiles
     class Teammate
-      attr_reader :username, :name, :role, :projects, :available, :tz_offset_hours
+      attr_reader :options, :username, :name, :role, :projects, :available, :hungry, :reduced_capacity, :tz_offset_hours
 
       # The options data are produced by https://gitlab.com/gitlab-org/gitlab-roulette/-/blob/master/lib/team_member.rb
       def initialize(options = {})
+        @options = options
         @username = options["username"]
         @name = options["name"]
         @markdown_name = options["markdown_name"]
         @role = options["role"]
         @projects = options["projects"]
         @available = options["available"]
+        @hungry = options["hungry"]
+        @reduced_capacity = options["reduced_capacity"]
         @tz_offset_hours = options["tz_offset_hours"]
       end
 
+      def to_h
+        options
+      end
+
+      def ==(other)
+        return false unless other.respond_to?(:username)
+
+        other.username == username
+      end
+
       def in_project?(name)
         projects&.has_key?(name)
       end
 
-      # Traintainers also count as reviewers
+      def any_capability?(project, category)
+        capabilities(project).any? { |capability| capability.end_with?(category.to_s) }
+      end
+
       def reviewer?(project, category, labels)
-        has_capability?(project, category, :reviewer, labels) ||
-          traintainer?(project, category, labels)
+        has_capability?(project, category, :reviewer, labels)
       end
 
       def traintainer?(project, category, labels)
@@ -34,9 +49,7 @@ module Gitlab
         has_capability?(project, category, :maintainer, labels)
       end
 
-      def markdown_name(timezone_experiment: false, author: nil)
-        return @markdown_name unless timezone_experiment
-
+      def markdown_name(author: nil)
         "#{@markdown_name} (#{utc_offset_text(author)})"
       end
 
@@ -68,9 +81,9 @@ module Gitlab
 
       def offset_diff_compared_to_author(author)
         diff = floored_offset_hours - author.floored_offset_hours
-        return "same timezone as `@#{author.username}`" if diff.zero?
+        return "same timezone as `@#{author.username}`" if diff == 0
 
-        ahead_or_behind = diff < 0 ? "behind" : "ahead"
+        ahead_or_behind = diff < 0 ? "behind" : "ahead of"
         pluralized_hours = pluralize(diff.abs, "hour", "hours")
 
         "#{pluralized_hours} #{ahead_or_behind} `@#{author.username}`"
@@ -85,6 +98,7 @@ module Gitlab
         when :engineering_productivity
           return false unless role[/Engineering Productivity/]
           return true if kind == :reviewer
+          return true if capabilities(project).include?("#{kind} engineering_productivity")
 
           capabilities(project).include?("#{kind} backend")
         else

data/lib/gitlab/dangerfiles/title_linting.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Dangerfiles
+    module TitleLinting
+      DRAFT_REGEX = /\A*#{Regexp.union(/(?i)(\[WIP\]\s*|WIP:\s*|WIP$)/, /(?i)(\[draft\]|\(draft\)|draft:|draft\s\-\s|draft$)/)}+\s*/i.freeze
+      CHERRY_PICK_REGEX = /cherry[\s-]*pick/i.freeze
+      RUN_ALL_RSPEC_REGEX = /RUN ALL RSPEC/i.freeze
+      RUN_AS_IF_FOSS_REGEX = /RUN AS-IF-FOSS/i.freeze
+
+      module_function
+
+      def sanitize_mr_title(title)
+        remove_draft_flag(title).gsub(/`/, '\\\`')
+      end
+
+      def remove_draft_flag(title)
+        title.gsub(DRAFT_REGEX, "")
+      end
+
+      def has_draft_flag?(title)
+        DRAFT_REGEX.match?(title)
+      end
+
+      def has_cherry_pick_flag?(title)
+        CHERRY_PICK_REGEX.match?(title)
+      end
+
+      def has_run_all_rspec_flag?(title)
+        RUN_ALL_RSPEC_REGEX.match?(title)
+      end
+
+      def has_run_as_if_foss_flag?(title)
+        RUN_AS_IF_FOSS_REGEX.match?(title)
+      end
+    end
+  end
+end