gitlab-dangerfiles 0.1.0 → 0.6.0

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "0.1.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/gitlab/dangerfiles/weightage.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Dangerfiles
+    module Weightage
+      CAPACITY_MULTIPLIER = 2 # change this number to change what it means to be a reduced capacity reviewer 1/this number
+      BASE_REVIEWER_WEIGHT = 1
+    end
+  end
+end

data/lib/gitlab/dangerfiles/weightage/maintainers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "../weightage"
+
+module Gitlab
+  module Dangerfiles
+    module Weightage
+      class Maintainers
+        def initialize(maintainers)
+          @maintainers = maintainers
+        end
+
+        def execute
+          maintainers.each_with_object([]) do |maintainer, weighted_maintainers|
+            add_weighted_reviewer(weighted_maintainers, maintainer, Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT)
+          end
+        end
+
+        private
+
+        attr_reader :maintainers
+
+        def add_weighted_reviewer(reviewers, reviewer, weight)
+          if reviewer.reduced_capacity
+            reviewers.fill(reviewer, reviewers.size, weight)
+          else
+            reviewers.fill(reviewer, reviewers.size, weight * Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/dangerfiles/weightage/reviewers.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "../weightage"
+
+module Gitlab
+  module Dangerfiles
+    module Weightage
+      # Weights after (current multiplier of 2)
+      #
+      # +------------------------------+--------------------------------+
+      # |        reviewer type         | weight(times in reviewer pool) |
+      # +------------------------------+--------------------------------+
+      # | reduced capacity reviewer    |                              1 |
+      # | reviewer                     |                              2 |
+      # | hungry reviewer              |                              4 |
+      # | reduced capacity traintainer |                              3 |
+      # | traintainer                  |                              6 |
+      # | hungry traintainer           |                              8 |
+      # +------------------------------+--------------------------------+
+      #
+      class Reviewers
+        DEFAULT_REVIEWER_WEIGHT = Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER * Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT
+        TRAINTAINER_WEIGHT = 3
+
+        def initialize(reviewers, traintainers)
+          @reviewers = reviewers
+          @traintainers = traintainers
+        end
+
+        def execute
+          # TODO: take CODEOWNERS into account?
+          # https://gitlab.com/gitlab-org/gitlab/issues/26723
+
+          weighted_reviewers + weighted_traintainers
+        end
+
+        private
+
+        attr_reader :reviewers, :traintainers
+
+        def weighted_reviewers
+          reviewers.each_with_object([]) do |reviewer, total_reviewers|
+            add_weighted_reviewer(total_reviewers, reviewer, Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT)
+          end
+        end
+
+        def weighted_traintainers
+          traintainers.each_with_object([]) do |reviewer, total_traintainers|
+            add_weighted_reviewer(total_traintainers, reviewer, TRAINTAINER_WEIGHT)
+          end
+        end
+
+        def add_weighted_reviewer(reviewers, reviewer, weight)
+          if reviewer.reduced_capacity
+            reviewers.fill(reviewer, reviewers.size, weight)
+          elsif reviewer.hungry
+            reviewers.fill(reviewer, reviewers.size, weight * Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER + DEFAULT_REVIEWER_WEIGHT)
+          else
+            reviewers.fill(reviewer, reviewers.size, weight * Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Rémy Coutable
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -130,37 +130,21 @@ files:
 - fixtures/emojis/aliases.json
 - fixtures/emojis/digests.json
 - gitlab-dangerfiles.gemspec
-- lib/danger/changelog.rb
 - lib/danger/helper.rb
 - lib/danger/roulette.rb
-- lib/danger/sidekiq_queues.rb
 - lib/gitlab-dangerfiles.rb
 - lib/gitlab/Dangerfile
 - lib/gitlab/dangerfiles.rb
-- lib/gitlab/dangerfiles/bundle_size/Dangerfile
-- lib/gitlab/dangerfiles/ce_ee_vue_templates/Dangerfile
-- lib/gitlab/dangerfiles/changelog/Dangerfile
-- lib/gitlab/dangerfiles/changes_size/Dangerfile
+- lib/gitlab/dangerfiles/base_linter.rb
 - lib/gitlab/dangerfiles/commit_linter.rb
-- lib/gitlab/dangerfiles/commit_messages/Dangerfile
-- lib/gitlab/dangerfiles/database/Dangerfile
-- lib/gitlab/dangerfiles/documentation/Dangerfile
-- lib/gitlab/dangerfiles/duplicate_yarn_dependencies/Dangerfile
 - lib/gitlab/dangerfiles/emoji_checker.rb
-- lib/gitlab/dangerfiles/eslint/Dangerfile
-- lib/gitlab/dangerfiles/frozen_string/Dangerfile
-- lib/gitlab/dangerfiles/karma/Dangerfile
-- lib/gitlab/dangerfiles/metadata/Dangerfile
-- lib/gitlab/dangerfiles/popen.rb
-- lib/gitlab/dangerfiles/prettier/Dangerfile
-- lib/gitlab/dangerfiles/roulette/Dangerfile
-- lib/gitlab/dangerfiles/sidekiq_queues/Dangerfile
-- lib/gitlab/dangerfiles/specs/Dangerfile
-- lib/gitlab/dangerfiles/tasks.rb
+- lib/gitlab/dangerfiles/merge_request_linter.rb
 - lib/gitlab/dangerfiles/teammate.rb
-- lib/gitlab/dangerfiles/telemetry/Dangerfile
-- lib/gitlab/dangerfiles/utility_css/Dangerfile
+- lib/gitlab/dangerfiles/title_linting.rb
 - lib/gitlab/dangerfiles/version.rb
+- lib/gitlab/dangerfiles/weightage.rb
+- lib/gitlab/dangerfiles/weightage/maintainers.rb
+- lib/gitlab/dangerfiles/weightage/reviewers.rb
 homepage: https://gitlab.com/gitlab-org/gitlab-dangerfiles
 licenses:
 - MIT
@@ -184,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: This gem provides common Dangerfile and plugins for GitLab projects.

data/lib/danger/changelog.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Danger
-  # Common helper functions for our danger scripts. See Danger::Helper
-  # for more details
-  class Changelog < Danger::Plugin
-    NO_CHANGELOG_LABELS = [
-      "backstage", # To be removed by https://gitlab.com/gitlab-org/gitlab/-/issues/222360.
-      "tooling",
-      "tooling::pipelines",
-      "tooling::workflow",
-      "ci-build",
-      "meta",
-    ].freeze
-    NO_CHANGELOG_CATEGORIES = %i[docs none].freeze
-
-    def needed?
-      categories_need_changelog? && (gitlab.mr_labels & NO_CHANGELOG_LABELS).empty?
-    end
-
-    def found
-      @found ||= git.added_files.find { |path| path =~ %r{\A(ee/)?(changelogs/unreleased)(-ee)?/} }
-    end
-
-    def sanitized_mr_title
-      gitlab.mr_json["title"].gsub(/^WIP: */, "").gsub(/`/, '\\\`')
-    end
-
-    def ee_changelog?
-      found.start_with?("ee/")
-    end
-
-    private
-
-    def categories_need_changelog?
-      (helper.changes_by_category.keys - NO_CHANGELOG_CATEGORIES).any?
-    end
-  end
-end

data/lib/danger/sidekiq_queues.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Danger
-  # Common helper functions for our danger scripts. See Danger::Helper
-  # for more details
-  class SidekiqQueues < Danger::Plugin
-    def changed_queue_files
-      @changed_queue_files ||= git.modified_files.grep(%r{\A(ee/)?app/workers/all_queues\.yml})
-    end
-
-    def added_queue_names
-      @added_queue_names ||= new_queues.keys - old_queues.keys
-    end
-
-    def changed_queue_names
-      @changed_queue_names ||=
-        (new_queues.values_at(*old_queues.keys) - old_queues.values)
-          .compact.map { |queue| queue[:name] }
-    end
-
-    private
-
-    def old_queues
-      @old_queues ||= queues_for(gitlab.base_commit)
-    end
-
-    def new_queues
-      @new_queues ||= queues_for(gitlab.head_commit)
-    end
-
-    def queues_for(branch)
-      changed_queue_files
-        .flat_map { |file| YAML.safe_load(`git show #{branch}:#{file}`, permitted_classes: [Symbol]) }
-        .to_h { |queue| [queue[:name], queue] }
-    end
-  end
-end

data/lib/gitlab/dangerfiles/bundle_size/Dangerfile

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-analysis_result = "./bundle-size-review/analysis.json"
-markdown_result = "./bundle-size-review/comparison.md"
-
-# Executing the webpack-entry-point-analyser
-# We would like to do that in the CI file directly,
-# but unfortunately the head_commit SHA is not available
-# as a CI variable due to our merge into master simulation
-analyze_cmd = [
-  "webpack-entry-point-analyser",
-  "--from-file ./webpack-report/stats.json",
-  "--json #{analysis_result}",
-  " --sha #{gitlab&.head_commit}"
-].join(" ")
-
-# execute analysis
-`#{analyze_cmd}`
-
-# We are executing the comparison by comparing the start_sha
-# to the current pipeline result. The start_sha is the commit
-# from master that was merged into for the merged pipeline.
-comparison_cmd = [
-  "webpack-compare-reports",
-  "--job #{ENV["CI_JOB_ID"]}",
-  "--to-file #{analysis_result}",
-  "--html ./bundle-size-review/comparison.html",
-  "--markdown #{markdown_result}"
-].join(" ")
-
-# execute comparison
-`#{comparison_cmd}`
-
-comment = `cat #{markdown_result}`
-
-markdown(<<~MARKDOWN)
-    #{comment}
-MARKDOWN

data/lib/gitlab/dangerfiles/ce_ee_vue_templates/Dangerfile

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-require 'cgi'
-
-def get_vue_files_with_ce_and_ee_versions(files)
-  files.select do |file|
-    if file.end_with?('.vue')
-      counterpart_path = if file.start_with?('ee/')
-                           file.delete_prefix('ee/')
-                         else
-                           "ee/#{file}"
-                         end
-
-      escaped_path = CGI.escape(counterpart_path)
-      api_endpoint = "https://gitlab.com/api/v4/projects/gitlab-org%2Fgitlab-ee/repository/files/#{escaped_path}?ref=master"
-      response = HTTParty.get(api_endpoint) # rubocop:disable Gitlab/HTTParty
-      response.code != 404
-    else
-      false
-    end
-  end
-end
-
-vue_candidates = get_vue_files_with_ce_and_ee_versions(helper.all_changed_files)
-
-return if vue_candidates.empty?
-
-message 'This merge request includes changes to Vue files that have both CE and EE versions.'
-
-markdown(<<~MARKDOWN)
-  ## Vue `<template>` in CE and EE
-
-  Some Vue files in CE have a counterpart in EE.
-  (For example, `path/to/file.vue` and `ee/path/to/file.vue`.)
-
-  When run in the context of CE, the `<template>` of the CE Vue file is used.
-  When run in the context of EE, the `<template>` of the EE Vue file is used.
-
-  It's easy to accidentally make a change to a CE `<template>` that _should_
-  appear in both CE and EE without making the change in both places.
-  When this happens, the change only takes effect in CE.
-
-  The following Vue files were changed as part of this merge request that
-  include both a CE and EE version of the file:
-
-  * #{vue_candidates.map { |path| "`#{path}`" }.join("\n* ")}
-
-  If you made a change to the `<template>` of any of these Vue files that
-  should be visible in both CE and EE, please ensure you have made your
-  change to both versions of the file.
-
-  ### A better alternative
-
-  An even _better_ alternative is to refactor this component to only use
-  a single template for both CE and EE.  More info on this approach here:
-  https://docs.gitlab.com/ee/development/ee_features.html#template-tag
-MARKDOWN

data/lib/gitlab/dangerfiles/changelog/Dangerfile

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-# rubocop:disable Style/SignalException
-
-require 'yaml'
-
-SEE_DOC = "See the [changelog documentation](https://docs.gitlab.com/ee/development/changelog.html)."
-CREATE_CHANGELOG_MESSAGE = <<~MSG
-If you want to create a changelog entry for GitLab FOSS, run the following:
-
-```
-bin/changelog -m %<mr_iid>s "%<mr_title>s"
-```
-
-If you want to create a changelog entry for GitLab EE, run the following instead:
-
-```
-bin/changelog --ee -m %<mr_iid>s "%<mr_title>s"
-```
-
-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
-
-SUGGEST_MR_COMMENT = <<~SUGGEST_COMMENT
-```suggestion
-merge_request: %<mr_iid>s
-```
-
-#{SEE_DOC}
-SUGGEST_COMMENT
-
-def check_changelog_yaml(path)
-  raw_file = File.read(path)
-  yaml = YAML.safe_load(raw_file)
-
-  fail "`title` should be set, in #{helper.html_link(path)}! #{SEE_DOC}" if yaml["title"].nil?
-  fail "`type` should be set, in #{helper.html_link(path)}! #{SEE_DOC}" if yaml["type"].nil?
-
-  return if helper.security_mr?
-
-  cherry_pick_against_stable_branch = helper.cherry_pick_mr? && helper.stable_branch?
-
-  if yaml["merge_request"].nil?
-    mr_line = raw_file.lines.find_index("merge_request:\n")
-
-    if mr_line
-      markdown(format(SUGGEST_MR_COMMENT, mr_iid: gitlab.mr_json["iid"]), file: path, line: mr_line.succ)
-    else
-      message "Consider setting `merge_request` to #{gitlab.mr_json["iid"]} in #{helper.html_link(path)}. #{SEE_DOC}"
-    end
-  elsif yaml["merge_request"] != gitlab.mr_json["iid"] && !cherry_pick_against_stable_branch
-    fail "Merge request ID was not set to #{gitlab.mr_json["iid"]}! #{SEE_DOC}"
-  end
-rescue Psych::SyntaxError, Psych::DisallowedClass, Psych::BadAlias
-  # YAML could not be parsed, fail the build.
-  fail "#{helper.html_link(path)} isn't valid YAML! #{SEE_DOC}"
-rescue StandardError => e
-  warn "There was a problem trying to check the Changelog. Exception: #{e.class.name} - #{e.message}"
-end
-
-def check_changelog_path(path)
-  ee_changes = helper.all_ee_changes.dup
-  ee_changes.delete(path)
-
-  if ee_changes.any? && !changelog.ee_changelog?
-    warn "This MR has a Changelog file outside `ee/`, but code changes in `ee/`. Consider moving the Changelog file into `ee/`."
-  end
-
-  if ee_changes.empty? && changelog.ee_changelog?
-    warn "This MR has a Changelog file in `ee/`, but no code changes in `ee/`. Consider moving the Changelog file outside `ee/`."
-  end
-end
-
-def sanitized_mr_title
-  helper.sanitize_mr_title(gitlab.mr_json["title"])
-end
-
-if git.modified_files.include?("CHANGELOG.md")
-  fail "**CHANGELOG.md was edited.** Please remove the additions and create a CHANGELOG entry.\n\n" +
-    format(CREATE_CHANGELOG_MESSAGE, mr_iid: gitlab.mr_json["iid"], mr_title: sanitized_mr_title)
-end
-
-changelog_found = changelog.found
-
-if changelog_found
-  check_changelog_yaml(changelog_found)
-  check_changelog_path(changelog_found)
-elsif changelog.needed?
-  message "**[CHANGELOG missing](https://docs.gitlab.com/ee/development/changelog.html)**:\n\n" +
-          format(CREATE_CHANGELOG_MESSAGE, mr_iid: gitlab.mr_json["iid"], mr_title: sanitized_mr_title)
-end