gitlab-dangerfiles 0.1.0 → 0.2.0

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

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