gitlab-dangerfiles 0.1.0 → 0.6.0

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

data/lib/gitlab/dangerfiles/specs/Dangerfile

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-NO_SPECS_LABELS = [
-  'backstage', # To be removed by https://gitlab.com/gitlab-org/gitlab/-/issues/222360.
-  'tooling',
-  'tooling::pipelines',
-  'tooling::workflow',
-  'documentation',
-  'QA'
-].freeze
-NO_NEW_SPEC_MESSAGE = <<~MSG
-You've made some app changes, but didn't add any tests.
-That's OK as long as you're refactoring existing code,
-but please consider adding any of the %<labels>s labels.
-MSG
-EE_CHANGE_WITH_FOSS_SPEC_CHANGE_MESSAGE = <<~MSG
-You've made some EE-specific changes, but only made changes to FOSS tests.
-This could be a sign that you're testing an EE-specific behavior in a FOSS test.
-
-Please make sure the spec files pass in AS-IF-FOSS mode either:
-
-1. Locally with `FOSS_ONLY=1 bin/rspec -- %<spec_files>s`.
-1. In the MR pipeline by verifying that the `rspec foss-impact` job has passed.
-1. In the MR pipelines by including `RUN AS-IF-FOSS` in the MR title (you can do it with the ``/title %<mr_title>s [RUN AS-IF-FOSS]`` quick action) and start a new MR pipeline.
-
-MSG
-
-has_app_changes = helper.all_changed_files.grep(%r{\A(app|lib|db/(geo/)?(post_)?migrate)/}).any?
-has_ee_app_changes = helper.all_changed_files.grep(%r{\Aee/(app|lib|db/(geo/)?(post_)?migrate)/}).any?
-spec_changes = helper.all_changed_files.grep(%r{\Aspec/})
-has_spec_changes = spec_changes.any?
-has_ee_spec_changes = helper.all_changed_files.grep(%r{\Aee/spec/}).any?
-new_specs_needed = (gitlab.mr_labels & NO_SPECS_LABELS).empty?
-
-if (has_app_changes || has_ee_app_changes) && !(has_spec_changes || has_ee_spec_changes) && new_specs_needed
-  warn format(NO_NEW_SPEC_MESSAGE, labels: helper.labels_list(NO_SPECS_LABELS)), sticky: false
-end
-
-# The only changes outside `ee/` are in `spec/`
-if has_ee_app_changes && has_spec_changes && !(has_app_changes || has_ee_spec_changes)
-  warn format(EE_CHANGE_WITH_FOSS_SPEC_CHANGE_MESSAGE, spec_files: spec_changes.join(" "), mr_title: gitlab.mr_json['title']), sticky: false
-end

data/lib/gitlab/dangerfiles/tasks.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-desc "Run local Danger rules"
-task :danger_local do
-  require "gitlab/dangerfiles"
-  require "popen/danger/popen"
-
-  puts("#{Gitlab::Dangerfiles.local_warning_message}\n")
-
-  # _status will _always_ be 0, regardless of failure or success :(
-  output, _status = Gitlab::Dangerfiles::Popen.popen(%w{danger dry_run})
-
-  if output.empty?
-    puts(Gitlab::Dangerfiles.success_message)
-  else
-    puts(output)
-    exit(1)
-  end
-end

data/lib/gitlab/dangerfiles/telemetry/Dangerfile

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-TELEMETRY_CHANGED_FILES_MESSAGE = <<~MSG
-For the following files, a review from the [Data team and Telemetry team](https://gitlab.com/groups/gitlab-org/growth/telemetry/engineers/-/group_members?with_inherited_permissions=exclude) is recommended
-Please check the ~telemetry [guide](https://docs.gitlab.com/ee/development/telemetry/usage_ping.html) and reach out to @gitlab-org/growth/telemetry/engineers group for a review.
-
-%<changed_files>s
-
-MSG
-
-tracking_files = [
-  'lib/gitlab/tracking.rb',
-  'spec/lib/gitlab/tracking_spec.rb',
-  'app/helpers/tracking_helper.rb',
-  'spec/helpers/tracking_helper_spec.rb',
-  'app/assets/javascripts/tracking.js',
-  'spec/frontend/tracking_spec.js'
-]
-
-usage_data_changed_files = git.modified_files.grep(%r{usage_data})
-snowplow_events_changed_files = git.modified_files & tracking_files
-
-changed_files = (usage_data_changed_files + snowplow_events_changed_files)
-
-if changed_files.any?
-  warn format(TELEMETRY_CHANGED_FILES_MESSAGE, changed_files: helper.markdown_list(changed_files))
-
-  telemetry_labels = ['telemetry']
-  telemetry_labels << 'telemetry::review pending' unless helper.mr_has_labels?('telemetry::reviewed')
-
-  markdown(helper.prepare_labels_for_mr(telemetry_labels))
-end

data/lib/gitlab/dangerfiles/utility_css/Dangerfile

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-common = 'app/assets/stylesheets/framework/common.scss'
-utilities = 'app/assets/stylesheets/utilities.scss'
-
-def get_css_files(files, common_filepath, utilities_filepath)
-  files.select do |file|
-    file.include?(common_filepath) ||
-    file.include?(utilities_filepath)
-  end
-end
-
-changed_util_files = get_css_files(helper.all_changed_files.to_a, common, utilities)
-
-unless changed_util_files.empty?
-
-  markdown(<<~MARKDOWN)
-  ## Changes to utility SCSS files
-  MARKDOWN
-
-  if changed_util_files.include?(common)
-
-    markdown(<<~MARKDOWN)
-    ### Addition to `#{common}`
-
-    You have added a new rule to `#{common}`. Are you sure you need this rule?
-
-    If it is a component class shared across items, could it be added to the component as a utility class or to the component's stylesheet? If not, you can ignore this warning.
-
-    If it is a new utility class, is there another class that shares the same values in either this file or in `#{utilities}`? If not, please add it to `#{utilities}`, following the [Gitlab UI naming style](https://unpkg.com/browse/@gitlab/ui/src/scss/utilities.scss).
-
-    MARKDOWN
-
-  end
-
-  if changed_util_files.include?(utilities)
-    markdown(<<~MARKDOWN)
-    ### Addition to `#{utilities}`
-
-    You have added a new rule to `#{utilities}`. Are you sure you need this rule?
-
-    If it is a component class shared across items, could it be added to the component as a utility class or to the component's stylesheet? If not, consider adding it to `#{common}`
-
-    If it is a new utility class, is there another class that shares the same values in either this file or in `#{utilities}`? If not, please be sure this addition follows the [Gitlab UI naming style](https://unpkg.com/browse/@gitlab/ui/src/scss/utilities.scss) so it may be removed when these rules are included. See [Include gitlab-ui utility-class library](https://gitlab.com/gitlab-org/gitlab/issues/36857) for more about this project.
-
-    MARKDOWN
-  end
-
-  warn "This merge request adds a new rule to #{common} or #{utilities}."
-
-end