gitlab-dangerfiles 0.1.0 → 0.2.0

data/lib/gitlab/dangerfiles/documentation/Dangerfile

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-docs_paths_to_review = helper.changes_by_category[:docs]
-
-return if docs_paths_to_review.empty?
-
-message 'This merge request adds or changes files that require a review ' \
-  'from the Technical Writing team.'
-
-return unless helper.ci?
-
-markdown(<<~MARKDOWN)
-  ## Documentation review
-
-  The following files require a review from a technical writer:
-
-  * #{docs_paths_to_review.map { |path| "`#{path}`" }.join("\n* ")}
-
-  The review does not need to block merging this merge request. See the:
-
-  - [Technical Writers assignments](https://about.gitlab.com/handbook/engineering/technical-writing/#designated-technical-writers) for the appropriate technical writer for this review.
-  - [Documentation workflows](https://docs.gitlab.com/ee/development/documentation/workflow.html) for information on when to assign a merge request for review.
-MARKDOWN
-
-unless gitlab.mr_labels.include?('documentation')
-  gitlab.api.update_merge_request(gitlab.mr_json['project_id'],
-                                  gitlab.mr_json['iid'],
-                                  labels: (gitlab.mr_labels + ['documentation']).join(','))
-end

data/lib/gitlab/dangerfiles/duplicate_yarn_dependencies/Dangerfile

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-return unless helper.all_changed_files.include?('yarn.lock')
-
-duplicate = `node_modules/.bin/yarn-deduplicate --list --strategy fewer yarn.lock`
-             .split(/$/)
-             .map(&:strip)
-             .reject(&:empty?)
-
-return if duplicate.empty?
-
-warn 'This merge request has introduced duplicated yarn dependencies.'
-
-if helper.ci?
-  markdown(<<~MARKDOWN)
-    ## Duplicate yarn dependencies
-
-    The following dependencies should be de-duplicated:
-
-    * #{duplicate.map { |path| "`#{path}`" }.join("\n* ")}
-
-    Please run the following command and commit the changes to `yarn.lock`:
-
-    ```
-    node_modules/.bin/yarn-deduplicate --strategy fewer yarn.lock \\
-      && yarn install
-    ```
-  MARKDOWN
-end

data/lib/gitlab/dangerfiles/eslint/Dangerfile

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-def get_eslint_files(files)
-  files.select do |file|
-    file.end_with?('.js', '.vue') &&
-      File.read(file).include?('/* eslint-disable')
-  end
-end
-
-eslint_candidates = get_eslint_files(helper.all_changed_files)
-
-return if eslint_candidates.empty?
-
-warn 'This merge request changed files with disabled eslint rules. Please consider fixing them.'
-
-if helper.ci?
-  markdown(<<~MARKDOWN)
-    ## Disabled eslint rules
-
-    The following files have disabled `eslint` rules. Please consider fixing them:
-
-    * #{eslint_candidates.map { |path| "`#{path}`" }.join("\n* ")}
-
-    Run the following command for more details
-
-    ```
-    node_modules/.bin/eslint --report-unused-disable-directives --no-inline-config \\
-    #{eslint_candidates.map { |path| "  '#{path}'" }.join(" \\\n")}
-    ```
-  MARKDOWN
-end

data/lib/gitlab/dangerfiles/frozen_string/Dangerfile

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-FILE_EXTENSION = ".rb"
-MAGIC_COMMENT = "# frozen_string_literal: true"
-
-def get_files_with_no_magic_comment(files)
-  files.select do |file|
-    file.end_with?(FILE_EXTENSION) &&
-      !File.open(file, &:gets)&.start_with?(MAGIC_COMMENT)
-  end
-end
-
-files_to_fix = get_files_with_no_magic_comment(git.added_files)
-
-if files_to_fix.any?
-  warn 'This merge request adds files that do not enforce frozen string literal. ' \
-    'See https://gitlab.com/gitlab-org/gitlab-foss/issues/47424 for more information.'
-
-  if helper.ci?
-    markdown(<<~MARKDOWN)
-      ## Enable Frozen String Literal
-
-      The following files should have `#{MAGIC_COMMENT}` on the first line:
-
-      * #{files_to_fix.map { |path| "`#{path}`" }.join("\n* ")}
-    MARKDOWN
-  end
-end

data/lib/gitlab/dangerfiles/karma/Dangerfile

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-# rubocop:disable Style/SignalException
-
-def get_karma_files(files)
-  files.select do |file|
-    file.start_with?('ee/spec/javascripts', 'spec/javascripts') &&
-    file.end_with?('_spec.js') &&
-    !file.end_with?('browser_spec.js')
-  end
-end
-
-new_karma_files = get_karma_files(git.added_files.to_a)
-
-unless new_karma_files.empty?
-
-  if helper.ci?
-    markdown(<<~MARKDOWN)
-    ## New karma spec file
-
-    New frontend specs ([except `browser_specs`](https://gitlab.com/gitlab-org/gitlab/blob/3b6fe2f1077eedb0b8aff02a7350234f0b7dc4f9/spec/javascripts/lib/utils/browser_spec.js#L2)) should be
-    [written in jest](https://docs.gitlab.com/ee/development/testing_guide/frontend_testing.html#jest).
-
-    You have created the following tests, please migrate them over to jest:
-
-    * #{new_karma_files.map { |path| "`#{path}`" }.join("\n* ")}
-    MARKDOWN
-  end
-
-  fail "You have created a new karma spec file"
-
-end
-
-changed_karma_files = get_karma_files(helper.all_changed_files) - new_karma_files
-
-return if changed_karma_files.empty?
-
-warn 'You have edited karma spec files. Please consider migrating them to jest.'
-
-if helper.ci?
-  markdown(<<~MARKDOWN)
-    ## Edited karma files
-
-    You have edited the following karma spec files. Please consider migrating them to jest:
-
-    * #{changed_karma_files.map { |path| "`#{path}`" }.join("\n* ")}
-
-    In order to align with our Iteration value, migration can also be done as a follow-up.
-
-    For more information: [Jestodus epic](https://gitlab.com/groups/gitlab-org/-/epics/895)
-  MARKDOWN
-end

data/lib/gitlab/dangerfiles/metadata/Dangerfile

@@ -1,50 +0,0 @@
-# rubocop:disable Style/SignalException
-
-THROUGHPUT_LABELS = [
-  'Community contribution',
-  'security',
-  'bug',
-  'backstage', # To be removed by https://gitlab.com/gitlab-org/gitlab/-/issues/222360.
-  'feature',
-  'feature::addition',
-  'feature::maintenance',
-  'tooling',
-  'tooling::pipelines',
-  'tooling::workflow',
-  'documentation'
-].freeze
-
-if gitlab.mr_body.size < 5
-  fail "Please provide a proper merge request description."
-end
-
-if gitlab.mr_labels.empty?
-  fail "Please add labels to this merge request."
-end
-
-if (THROUGHPUT_LABELS & gitlab.mr_labels).empty?
-  warn 'Please add a [throughput label](https://about.gitlab.com/handbook/engineering/management/throughput/#implementation) to this merge request.'
-end
-
-unless gitlab.mr_json["assignee"]
-  warn "This merge request does not have any assignee yet. Setting an assignee clarifies who needs to take action on the merge request at any given time."
-end
-
-has_milestone = !gitlab.mr_json["milestone"].nil?
-
-unless has_milestone
-  warn "This merge request does not refer to an existing milestone.", sticky: false
-end
-
-has_pick_into_stable_label = gitlab.mr_labels.find { |label| label.start_with?('Pick into') }
-
-if gitlab.branch_for_base != "master" && !has_pick_into_stable_label && !helper.security_mr?
-  warn "Most of the time, merge requests should target `master`. Otherwise, please set the relevant `Pick into X.Y` label."
-end
-
-if gitlab.mr_json['title'].length > 72
-  warn 'The title of this merge request is longer than 72 characters and ' \
-    'would violate our commit message rules when using the Squash on Merge ' \
-    'feature. Please consider adjusting the title, or rebase the ' \
-    "commits manually and don't use Squash on Merge."
-end

data/lib/gitlab/dangerfiles/popen.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require "fileutils"
-require "open3"
-
-module Gitlab
-  module Dangerfiles
-    class Popen
-      Result = Struct.new(:cmd, :stdout, :stderr, :status, :duration)
-
-      # Returns [stdout + stderr, status]
-      def popen(cmd, path = nil, vars = {}, &block)
-        result = popen_with_detail(cmd, path, vars, &block)
-
-        ["#{result.stdout}#{result.stderr}", result.status&.exitstatus]
-      end
-
-      # Returns Result
-      def popen_with_detail(cmd, path = nil, vars = {})
-        unless cmd.is_a?(Array)
-          raise "System commands must be given as an array of strings"
-        end
-
-        path ||= Dir.pwd
-        vars["PWD"] = path
-        options = { chdir: path }
-
-        unless File.directory?(path)
-          FileUtils.mkdir_p(path)
-        end
-
-        cmd_stdout = ""
-        cmd_stderr = ""
-        cmd_status = nil
-        start = Time.now
-
-        Open3.popen3(vars, *cmd, options) do |stdin, stdout, stderr, wait_thr|
-          # stderr and stdout pipes can block if stderr/stdout aren't drained: https://bugs.ruby-lang.org/issues/9082
-          # Mimic what Ruby does with capture3: https://github.com/ruby/ruby/blob/1ec544695fa02d714180ef9c34e755027b6a2103/lib/open3.rb#L257-L273
-          out_reader = Thread.new { stdout.read }
-          err_reader = Thread.new { stderr.read }
-
-          yield(stdin) if block_given?
-          stdin.close
-
-          cmd_stdout = out_reader.value
-          cmd_stderr = err_reader.value
-          cmd_status = wait_thr.value
-        end
-
-        Result.new(cmd, cmd_stdout, cmd_stderr, cmd_status, Time.now - start)
-      end
-    end
-  end
-end

data/lib/gitlab/dangerfiles/prettier/Dangerfile

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-def get_prettier_files(files)
-  files.select do |file|
-    file.end_with?('.js', '.scss', '.vue')
-  end
-end
-
-prettier_candidates = get_prettier_files(helper.all_changed_files)
-
-return if prettier_candidates.empty?
-
-unpretty = `node_modules/prettier/bin-prettier.js --list-different #{prettier_candidates.join(" ")}`
-             .split(/$/)
-             .map(&:strip)
-             .reject(&:empty?)
-
-return if unpretty.empty?
-
-warn 'This merge request changed frontend files without pretty printing them.'
-
-if helper.ci?
-  markdown(<<~MARKDOWN)
-    ## Pretty print Frontend files
-
-    The following files should have been pretty printed with `prettier`:
-
-    * #{unpretty.map { |path| "`#{path}`" }.join("\n* ")}
-
-    Please run
-
-    ```
-    node_modules/.bin/prettier --write \\
-    #{unpretty.map { |path| "  '#{path}'" }.join(" \\\n")}
-    ```
-
-    Also consider auto-formatting [on-save].
-
-    [on-save]: https://docs.gitlab.com/ee/development/fe_guide/tooling.html#formatting-with-prettier
-  MARKDOWN
-end

data/lib/gitlab/dangerfiles/roulette/Dangerfile

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest/md5'
-
-MESSAGE = <<MARKDOWN
-## Reviewer roulette
-
-Changes that require review have been detected! A merge request is normally
-reviewed by both a reviewer and a maintainer in its primary category (e.g.
-~frontend or ~backend), and by a maintainer in all other categories.
-MARKDOWN
-
-CATEGORY_TABLE_HEADER = <<MARKDOWN
-
-To spread load more evenly across eligible reviewers, Danger has picked a candidate for each
-review slot, based on their timezone. Feel free to
-[override these selections](https://about.gitlab.com/handbook/engineering/projects/#gitlab)
-if you think someone else would be better-suited, or the chosen person is unavailable.
-
-To read more on how to use the reviewer roulette, please take a look at the
-[Engineering workflow](https://about.gitlab.com/handbook/engineering/workflow/#basics)
-and [code review guidelines](https://docs.gitlab.com/ee/development/code_review.html).
-Please consider assigning a reviewer or maintainer who is a
-[domain expert](https://about.gitlab.com/handbook/engineering/projects/#gitlab) in the area of the merge request.
-
-Once you've decided who will review this merge request, mention them as you
-normally would! Danger does not automatically notify them for you.
-
-| Category | Reviewer | Maintainer |
-| -------- | -------- | ---------- |
-MARKDOWN
-
-UNKNOWN_FILES_MESSAGE = <<MARKDOWN
-
-These files couldn't be categorised, so Danger was unable to suggest a reviewer.
-Please consider creating a merge request to
-[add support](https://gitlab.com/gitlab-org/gitlab-dangerfiles/blob/master/lib/danger/helper.rb)
-for them.
-MARKDOWN
-
-OPTIONAL_REVIEW_TEMPLATE = "%{role} review is optional for %{category}".freeze
-NOT_AVAILABLE_TEMPLATE = 'No %{role} available'.freeze
-TIMEZONE_EXPERIMENT = true
-
-def mr_author
-  roulette.team.find { |person| person.username == gitlab.mr_author }
-end
-
-def note_for_category_role(spin, role)
-  if spin.optional_role == role
-    return OPTIONAL_REVIEW_TEMPLATE % { role: role.capitalize, category: helper.label_for_category(spin.category) }
-  end
-
-  spin.public_send(role)&.markdown_name(timezone_experiment: TIMEZONE_EXPERIMENT, author: mr_author) || NOT_AVAILABLE_TEMPLATE % { role: role } # rubocop:disable GitlabSecurity/PublicSend
-end
-
-def markdown_row_for_spin(spin)
-  reviewer_note = note_for_category_role(spin, :reviewer)
-  maintainer_note = note_for_category_role(spin, :maintainer)
-
-  "| #{helper.label_for_category(spin.category)} | #{reviewer_note} | #{maintainer_note} |"
-end
-
-changes = helper.changes_by_category
-
-# Ignore any files that are known but uncategorized. Prompt for any unknown files
-changes.delete(:none)
-# To reinstate roulette for documentation, remove this line.
-changes.delete(:docs)
-categories = changes.keys - [:unknown]
-
-# Ensure to spin for database reviewer/maintainer when ~database is applied (e.g. to review SQL queries)
-categories << :database if gitlab.mr_labels.include?('database') && !categories.include?(:database)
-
-if changes.any?
-  project = helper.project_name
-  branch_name = gitlab.mr_json['source_branch']
-
-  markdown(MESSAGE)
-
-  roulette_spins = roulette.spin(project, categories, branch_name, timezone_experiment: TIMEZONE_EXPERIMENT)
-  rows = roulette_spins.map do |spin|
-    # MR includes QA changes, but also other changes, and author isn't an SET
-    if spin.category == :qa && categories.size > 1 && !mr_author.reviewer?(project, spin.category, [])
-      spin.optional_role = :maintainer
-    end
-
-    spin.optional_role = :maintainer if spin.category == :test
-
-    markdown_row_for_spin(spin)
-  end
-
-  markdown(CATEGORY_TABLE_HEADER + rows.join("\n")) unless rows.empty?
-
-  unknown = changes.fetch(:unknown, [])
-  markdown(UNKNOWN_FILES_MESSAGE + helper.markdown_list(unknown)) unless unknown.empty?
-end

data/lib/gitlab/dangerfiles/sidekiq_queues/Dangerfile

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-SCALABILITY_REVIEW_MESSAGE = <<~MSG
-## Sidekiq queue changes
-
-This merge request contains changes to Sidekiq queues. Please follow the [documentation on changing a queue's urgency](https://docs.gitlab.com/ee/development/sidekiq_style_guide.html#changing-a-queues-urgency).
-MSG
-
-ADDED_QUEUES_MESSAGE = <<~MSG
-These queues were added:
-MSG
-
-CHANGED_QUEUES_MESSAGE = <<~MSG
-These queues had their attributes changed:
-MSG
-
-if sidekiq_queues.added_queue_names.any? || sidekiq_queues.changed_queue_names.any?
-  markdown(SCALABILITY_REVIEW_MESSAGE)
-
-  if sidekiq_queues.added_queue_names.any?
-    markdown(ADDED_QUEUES_MESSAGE + helper.markdown_list(sidekiq_queues.added_queue_names))
-  end
-
-  if sidekiq_queues.changed_queue_names.any?
-    markdown(CHANGED_QUEUES_MESSAGE + helper.markdown_list(sidekiq_queues.changed_queue_names))
-  end
-end