gitlab-dangerfiles 0.1.0 → 0.6.0

data/lib/gitlab/dangerfiles/changes_size/Dangerfile

@@ -1,17 +0,0 @@
-# FIXME: git.info_for_file raises the following error
-# /usr/local/bundle/gems/git-1.4.0/lib/git/lib.rb:956:in `command':  (Danger::DSLError)
-# [!] Invalid `Dangerfile` file:
-# [!] Invalid `Dangerfile` file: git '--git-dir=/builds/gitlab-org/gitlab/.git' '--work-tree=/builds/gitlab-org/gitlab' cat-file '-t' ''  2>&1:fatal: Not a valid object name
-# This seems to be the same as https://github.com/danger/danger/issues/535.
-
-# locale_files_updated = git.modified_files.select { |path| path.start_with?('locale') }
-# locale_files_updated.each do |locale_file_updated|
-#   git_stats = git.info_for_file(locale_file_updated)
-#   message "Git stats for #{locale_file_updated}: #{git_stats[:insertions]} insertions, #{git_stats[:deletions]} insertions"
-# end
-
-if git.lines_of_code > 2_000
-  warn "This merge request is definitely too big (more than #{git.lines_of_code} lines changed), please split it into multiple merge requests."
-elsif git.lines_of_code > 500
-  warn "This merge request is quite big  (more than #{git.lines_of_code} lines changed), please consider splitting it into multiple merge requests."
-end

data/lib/gitlab/dangerfiles/commit_messages/Dangerfile

@@ -1,135 +0,0 @@
-# frozen_string_literal: true
-
-require_relative File.expand_path("../../danger/commit_linter", __dir__)
-
-COMMIT_MESSAGE_GUIDELINES = "https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#commit-messages-guidelines"
-MORE_INFO = "For more information, take a look at our [Commit message guidelines](#{COMMIT_MESSAGE_GUIDELINES})."
-THE_DANGER_JOB_TEXT = "the `danger-review` job"
-MAX_COMMITS_COUNT = 10
-MAX_COMMITS_COUNT_EXCEEDED_MESSAGE = <<~MSG
-This merge request includes more than %<max_commits_count>d commits. Each commit should meet the following criteria:
-
-1. Have a well-written commit message.
-1. Has all tests passing when used on its own (e.g. when using git checkout SHA).
-1. Can be reverted on its own without also requiring the revert of commit that came before it.
-1. Is small enough that it can be reviewed in isolation in under 30 minutes or so.
-
-If this merge request contains commits that do not meet this criteria and/or contains intermediate work, please rebase these commits into a smaller number of commits or split this merge request into multiple smaller merge requests.
-MSG
-
-def fail_commit(commit, message, more_info: true)
-  self.fail(build_message(commit, message, more_info: more_info))
-end
-
-def warn_commit(commit, message, more_info: true)
-  self.warn(build_message(commit, message, more_info: more_info))
-end
-
-def build_message(commit, message, more_info: true)
-  [message].tap do |full_message|
-    full_message << ". #{MORE_INFO}" if more_info
-    full_message.unshift("#{commit.sha}: ") if commit.sha
-  end.join
-end
-
-def squash_mr?
-  helper.ci? ? gitlab.mr_json['squash'] : false
-end
-
-def wip_mr?
-  helper.ci? ? gitlab.mr_json['work_in_progress'] : false
-end
-
-def danger_job_link
-  helper.ci? ? "[#{THE_DANGER_JOB_TEXT}](#{ENV['CI_JOB_URL']})" : THE_DANGER_JOB_TEXT
-end
-
-# Perform various checks against commits. We're not using
-# https://github.com/jonallured/danger-commit_lint because its output is not
-# very helpful, and it doesn't offer the means of ignoring merge commits.
-def lint_commit(commit)
-  linter = Gitlab::Dangerfiles::CommitLinter.new(commit)
-
-  # For now we'll ignore merge commits, as getting rid of those is a problem
-  # separate from enforcing good commit messages.
-  return linter if linter.merge?
-
-  # We ignore revert commits as they are well structured by Git already
-  return linter if linter.revert?
-
-  # If MR is set to squash, we ignore fixup commits
-  return linter if linter.fixup? && squash_mr?
-
-  if linter.fixup?
-    msg = "Squash or fixup commits must be squashed before merge, or enable squash merge option and re-run #{danger_job_link}."
-    if wip_mr? || squash_mr?
-      warn_commit(commit, msg, more_info: false)
-    else
-      fail_commit(commit, msg, more_info: false)
-    end
-
-    # Makes no sense to process other rules for fixup commits, they trigger just more noise
-    return linter
-  end
-
-  # Fail if a suggestion commit is used and squash is not enabled
-  if linter.suggestion?
-    unless squash_mr?
-      fail_commit(commit, "If you are applying suggestions, enable squash in the merge request and re-run #{danger_job_link}.", more_info: false)
-    end
-
-    return linter
-  end
-
-  linter.lint
-end
-
-def lint_mr_title(mr_title)
-  commit = Struct.new(:message, :sha).new(mr_title)
-
-  Gitlab::Dangerfiles::CommitLinter.new(commit).lint_subject("merge request title")
-end
-
-def count_non_fixup_commits(commit_linters)
-  commit_linters.count { |commit_linter| !commit_linter.fixup? }
-end
-
-def lint_commits(commits)
-  commit_linters = commits.map { |commit| lint_commit(commit) }
-  failed_commit_linters = commit_linters.select { |commit_linter| commit_linter.failed? }
-  warn_or_fail_commits(failed_commit_linters, default_to_fail: !squash_mr?)
-
-  if count_non_fixup_commits(commit_linters) > MAX_COMMITS_COUNT
-    self.warn(format(MAX_COMMITS_COUNT_EXCEEDED_MESSAGE, max_commits_count: MAX_COMMITS_COUNT))
-  end
-
-  if squash_mr?
-    multi_line_commit_linter = commit_linters.detect { |commit_linter| !commit_linter.merge? && commit_linter.multi_line? }
-
-    if multi_line_commit_linter && multi_line_commit_linter.failed?
-      warn_or_fail_commits(multi_line_commit_linter)
-    else
-      title_linter = lint_mr_title(gitlab.mr_json['title'])
-      if title_linter.failed?
-        warn_or_fail_commits(title_linter)
-      end
-    end
-  end
-end
-
-def warn_or_fail_commits(failed_linters, default_to_fail: true)
-  level = default_to_fail ? :fail : :warn
-
-  Array(failed_linters).each do |linter|
-    linter.problems.each do |problem_key, problem_desc|
-      case problem_key
-      when :subject_above_warning
-        warn_commit(linter.commit, problem_desc)
-      else
-        self.__send__("#{level}_commit", linter.commit, problem_desc) # rubocop:disable GitlabSecurity/PublicSend
-      end
-    end
-  end
-end
-
-lint_commits(git.commits)

data/lib/gitlab/dangerfiles/database/Dangerfile

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-SCHEMA_NOT_UPDATED_MESSAGE_SHORT = <<~MSG
-New %<migrations>s added but %<schema>s wasn't updated.
-MSG
-
-SCHEMA_NOT_UPDATED_MESSAGE_FULL = <<~MSG
-**#{SCHEMA_NOT_UPDATED_MESSAGE_SHORT}**
-
-Usually, when adding new %<migrations>s, %<schema>s should be
-updated too (unless the migration isn't changing the DB schema
-and isn't the most recent one).
-MSG
-
-DB_MESSAGE = <<~MSG
-This merge request requires a database review. To make sure these
-changes are reviewed, take the following steps:
-
-1. Ensure the merge request has ~database and ~"database::review pending" labels.
-   If the merge request modifies database files, Danger will do this for you.
-1. Prepare your MR for database review according to the
-   [docs](https://docs.gitlab.com/ee/development/database_review.html#how-to-prepare-the-merge-request-for-a-database-review).
-1. Assign and mention the database reviewer suggested by Reviewer Roulette.
-MSG
-
-DB_FILES_MESSAGE = <<~MSG
-The following files require a review from the Database team:
-MSG
-
-DATABASE_APPROVED_LABEL = 'database::approved'
-
-non_geo_db_schema_updated = !git.modified_files.grep(%r{\Adb/structure\.sql}).empty?
-geo_db_schema_updated = !git.modified_files.grep(%r{\Aee/db/geo/schema\.rb}).empty?
-
-non_geo_migration_created = !git.added_files.grep(%r{\A(db/(post_)?migrate)/}).empty?
-geo_migration_created = !git.added_files.grep(%r{\Aee/db/geo/(post_)?migrate/}).empty?
-
-format_str = helper.ci? ? SCHEMA_NOT_UPDATED_MESSAGE_FULL : SCHEMA_NOT_UPDATED_MESSAGE_SHORT
-
-if non_geo_migration_created && !non_geo_db_schema_updated
-  warn format(format_str, migrations: 'migrations', schema: helper.html_link("db/structure.sql"))
-end
-
-if geo_migration_created && !geo_db_schema_updated
-  warn format(format_str, migrations: 'Geo migrations', schema: helper.html_link("ee/db/geo/schema.rb"))
-end
-
-return unless helper.ci?
-return if gitlab.mr_labels.include?(DATABASE_APPROVED_LABEL)
-
-db_paths_to_review = helper.changes_by_category[:database]
-
-if gitlab.mr_labels.include?('database') || db_paths_to_review.any?
-  message 'This merge request adds or changes files that require a ' \
-    'review from the [Database team](https://gitlab.com/groups/gl-database/-/group_members).'
-
-  markdown(DB_MESSAGE)
-  markdown(DB_FILES_MESSAGE + helper.markdown_list(db_paths_to_review)) if db_paths_to_review.any?
-
-  database_labels = helper.missing_database_labels(gitlab.mr_labels)
-
-  if database_labels.any?
-    gitlab.api.update_merge_request(gitlab.mr_json['project_id'],
-                                        gitlab.mr_json['iid'],
-                                        labels: (gitlab.mr_labels + database_labels).join(','))
-  end
-end

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