gitlab-reviewers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 965fa0c3349af7a6b822b4b136c691b023ac400fe363efaa2dbc7cd403c74f38
+  data.tar.gz: 1095ff6b2dca3be16c3bfdbd0eab613bf7f40cdb36a01621ea74c25d98a33c6a
+SHA512:
+  metadata.gz: bfe1a35bed9c8d397c974ead3bf8fd9c547a49b97076cc0ed89592282e87e21e41c0d399d6388f26a804182d7effb053d4e661e0da23c4c9a14b07c29eb9553d
+  data.tar.gz: bc1e1ebc02564472d82942c28065cca6dcc47e9f0ac4445227fa050ce4d1a85aa86263c4a586b8532ef3ad3b421a539b89d2513446f73e9bbbc6b59baba47f49

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gitlab_roulette.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/danger/plugins/helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "gitlab_roulette"
+
+module Danger
+  class Helper < Plugin
+    include Gitlab::Danger::Helper
+  end
+end

data/danger/plugins/roulette.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "gitlab_roulette"
+
+module Danger
+  class Roulette < Plugin
+    include Gitlab::Danger::Roulette
+  end
+end

data/gitlab-reviewers.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gitlab_roulette/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlab-reviewers"
+  spec.version       = GitlabRoulette::VERSION
+  spec.authors       = ["LuizaLabs"]
+
+  spec.summary       = %q{GitlabRoulette adds a reviewer roulette to your self hosted Gitlab repository}
+  spec.description   = %q{GitlabRoulette choose reviewer and a maintainer for your merge request automatically}
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "danger-gitlab", "~> 7.0.0"
+  spec.add_development_dependency "danger", "~> 6.1.0"
+  spec.add_development_dependency "faraday", "~> 0.17.1"
+end

data/lib/gitlab_roulette/danger/helper.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative 'teammate'
+
+module Gitlab
+  module Danger
+    module Helper
+
+      # Returns a list of all files that have been added, modified or renamed.
+      # `git.modified_files` might contain paths that already have been renamed,
+      # so we need to remove them from the list.
+      #
+      # Considering these changes:
+      #
+      # - A new_file.rb
+      # - D deleted_file.rb
+      # - M modified_file.rb
+      # - R renamed_file_before.rb -> renamed_file_after.rb
+      #
+      # it will return
+      # ```
+      # [ 'new_file.rb', 'modified_file.rb', 'renamed_file_after.rb' ]
+      # ```
+      #
+      # @return [Array<String>]
+      def all_changed_files
+        Set.new
+          .merge(git.added_files.to_a)
+          .merge(git.modified_files.to_a)
+          .merge(git.renamed_files.map { |x| x[:after] })
+          .subtract(git.renamed_files.map { |x| x[:before] })
+          .to_a
+          .sort
+      end
+
+      def categories
+        @categories ||=
+          begin
+           url = "#{ENV['CI_API_V4_URL']}/projects/#{ENV['CI_PROJECT_ID']}/variables/GITLAB_ROULETTE_CATEGORIES"
+           response = Faraday.get(url) do |req|
+             req.headers['Content-Type'] = 'application/json'
+             req.headers['PRIVATE-TOKEN'] = ENV['DANGER_GITLAB_API_TOKEN']
+           end
+
+           result = JSON.parse(response.body)
+           JSON.parse(result['value'])
+          rescue => err
+           puts "Failed to fetch categories from #{url}"
+          end
+      end
+
+      def gitlab_helper
+        # Unfortunately the following does not work:
+        # - respond_to?(:gitlab)
+        # - respond_to?(:gitlab, true)
+        gitlab
+      rescue NoMethodError
+        nil
+      end
+
+      def project_name
+        ENV["CI_PROJECT_NAME"]
+      end
+
+      def markdown_list(items)
+        list = items.map { |item| "* `#{item}`" }.join("\n")
+
+        if items.size > 10
+          "\n<details>\n\n#{list}\n\n</details>\n"
+        else
+          list
+        end
+      end
+
+      # @return [Hash<String,Array<String>>]
+      def changes_by_category
+        all_changed_files.each_with_object(Hash.new { |h, k| h[k] = [] }) do |file, hash|
+          hash[category_for_file(file)] << file
+        end
+      end
+
+      # Determines the category a file
+      # @return[Symbol]
+      def category_for_file(file)
+        category, _ = categories.find { |category, regex_list|
+          regex_list.any? { |regex_string| /#{regex_string}/.match?(file) }
+        }
+        result = category || "unknown"
+        result.to_sym
+      end
+
+      # Returns the GFM for a category label, making its best guess if it's not
+      # a category we know about.
+      #
+      # @return[String]
+      def label_for_category(category)
+        CATEGORY_LABELS.fetch(category, "~#{category}")
+      end
+
+      CATEGORY_LABELS = {
+        developer: "Random Developer",
+        ecomm: '~"Ecomm"',
+        tools: '~"Tools and MiniApps"',
+        checkout: '~"Checkout"',
+        navigation: '~"Navigation"',
+        mpay: '~"Magalu Pay"',
+      }.freeze
+
+      def new_teammates(usernames)
+        usernames.map { |u| Gitlab::Danger::Teammate.new('username' => u) }
+      end
+
+      def missing_database_labels(current_mr_labels)
+        labels = if has_database_scoped_labels?(current_mr_labels)
+                   ['database']
+                 else
+                   ['database', 'database::review pending']
+                 end
+
+        labels - current_mr_labels
+      end
+
+      private
+
+      def has_database_scoped_labels?(current_mr_labels)
+        current_mr_labels.any? { |label| label.start_with?('database::') }
+      end
+    end
+  end
+end

data/lib/gitlab_roulette/danger/request_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Gitlab
+  module Danger
+    module RequestHelper
+      HTTPError = Class.new(RuntimeError)
+
+      # @param [String] url
+      def self.http_get_json(url)
+        rsp = Net::HTTP.get_response(URI.parse(url))
+
+        unless rsp.is_a?(Net::HTTPOK)
+          raise HTTPError, "Failed to read #{url}: #{rsp.code} #{rsp.message}"
+        end
+
+        JSON.parse(rsp.body)
+      end
+    end
+  end
+end

data/lib/gitlab_roulette/danger/roulette.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative 'teammate'
+require 'faraday'
+
+module Gitlab
+  module Danger
+    module Roulette
+      ROULETTE_DATA_URL = ENV["GITLAB_ROULETTE_URL"]
+
+      # Looks up the current list of GitLab team members and parses it into a
+      # useful form
+      #
+      # @return [Array<Teammate>]
+      def team
+        @team ||= developers.sort_by { |dev| dev['reviews'] }.map { |hash| ::Gitlab::Danger::Teammate.new(hash) }
+      end
+
+      def developers
+        @developers ||=
+          begin
+            url = "#{ENV['CI_API_V4_URL']}/projects/#{ENV['CI_PROJECT_ID']}/variables/GITLAB_ROULETTE_DATA"
+            response = Faraday.get(url) do |req|
+              req.headers['Content-Type'] = 'application/json'
+              req.headers['PRIVATE-TOKEN'] = ENV['DANGER_GITLAB_API_TOKEN']
+            end
+
+            result = JSON.parse(response.body)
+            JSON.parse(result['value'])
+          rescue => err
+            puts "Failed to fetch developer from #{url}"
+          end
+      end
+
+      def update_reviews_count(developers_to_increment_reviews)
+        begin
+          developers.each do |dev|
+            username = dev["username"]
+            dev["reviews"] += 1 if developers_to_increment_reviews.include?(username)
+          end
+          url = "#{ENV['CI_API_V4_URL']}/projects/#{ENV['CI_PROJECT_ID']}/variables/GITLAB_ROULETTE_DATA"
+          response = Faraday.put(url) do |req|
+            req.headers['Content-Type'] = 'application/json'
+            req.headers['PRIVATE-TOKEN'] = ENV['DANGER_GITLAB_API_TOKEN']
+            req.params['value'] = JSON.pretty_generate(developers)
+          end
+        rescue => err
+          puts "Failed to update developer from #{url}"
+        end
+      end
+
+      # Like +team+, but only returns teammates in the current project, based on
+      # project_name.
+      #
+      # @return [Array<Teammate>]
+      def project_team(project_name)
+        team.select { |member| member.in_project?(project_name) }
+      end
+
+      # @param [Array<Teammate>] people
+      def spin_for_person(people, excludes)
+        people.select { |member| !excludes.include?(member.user_name) }.find(&method(:valid_person?))
+      end
+
+      private
+
+      # @param [Teammate] person
+      # @return [Boolean]
+      def valid_person?(person)
+        !mr_author?(person) && person.available?
+      end
+
+      # @param [Teammate] person
+      # @return [Boolean]
+      def mr_author?(person)
+        person.username == gitlab.mr_author
+      end
+    end
+  end
+end

data/lib/gitlab_roulette/danger/teammate.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Gitlab
+  module Danger
+    class Teammate
+      attr_reader :name, :username, :role, :projects
+
+      def initialize(options = {})
+        @username = options['username']
+        @name = options['name'] || @username
+        @role = options['role']
+        @projects = options['projects']
+      end
+
+      def user_name
+        username
+      end
+
+      def markdown_name
+        "[#{name}](#{gitlab_host}/#{username}) (@#{username})"
+      end
+
+      def in_project?(name)
+        projects&.has_key?(name)
+      end
+
+      # Traintainers also count as reviewers
+      def reviewer?(project, category, labels)
+        has_capability?(project, category, :reviewer, labels) ||
+          traintainer?(project, category, labels)
+      end
+
+      def traintainer?(project, category, labels)
+        has_capability?(project, category, :trainee_maintainer, labels)
+      end
+
+      # Traintainers also count as maintainer
+      def maintainer?(project, category, labels)
+        has_capability?(project, category, :maintainer, labels)  ||
+          traintainer?(project, category, labels)
+      end
+
+      # @return [Boolean]
+      def available?
+        has_capacity?
+      end
+
+      private
+
+      def gitlab_host
+        @gitlab_host ||= ENV["GITLAB_HOST"]
+      end
+
+      # @return [Boolean]
+      def has_capacity?
+        true
+      end
+
+      def has_capability?(project, category, kind, labels)
+        case category
+        when :developer
+          role[/Developer/] && capabilities(project).any? { |capability| capability.include?("#{kind}") && capability.include?("ecomm") }
+        else
+          capabilities(project).any? { |capability| capability.include?("#{kind}") && capability.include?("#{category}") }
+        end
+      end
+
+      def capabilities(project)
+        Array(projects.fetch(project, []))
+      end
+    end
+  end
+end

data/lib/gitlab_roulette/gitlab_danger.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class GitlabDanger
+  LOCAL_RULES ||= %w[
+    changes_size
+    gemfile
+    documentation
+    frozen_string
+    duplicate_yarn_dependencies
+    prettier
+    eslint
+    database
+    commit_messages
+  ].freeze
+
+  CI_ONLY_RULES ||= %w[
+    metadata
+    changelog
+    specs
+    roulette
+    single_codebase
+    gitlab_ui_wg
+    ce_ee_vue_templates
+  ].freeze
+
+  MESSAGE_PREFIX = '==>'.freeze
+
+  attr_reader :gitlab_danger_helper
+
+  def initialize(gitlab_danger_helper)
+    @gitlab_danger_helper = gitlab_danger_helper
+  end
+
+  def self.local_warning_message
+    "#{MESSAGE_PREFIX} Only the following Danger rules can be run locally: #{LOCAL_RULES.join(', ')}"
+  end
+
+  def self.success_message
+    "#{MESSAGE_PREFIX} No Danger rule violations!"
+  end
+
+  def rule_names
+    ci? ? LOCAL_RULES | CI_ONLY_RULES : LOCAL_RULES
+  end
+
+  def html_link(str)
+    self.ci? ? gitlab_danger_helper.html_link(str) : str
+  end
+
+  def ci?
+    !gitlab_danger_helper.nil?
+  end
+end

data/lib/gitlab_roulette/version.rb

@@ -0,0 +1,3 @@
+module GitlabRoulette
+  VERSION = "1.0.0"
+end

data/lib/gitlab_roulette.rb

@@ -0,0 +1,15 @@
+require "gitlab_roulette/version"
+require "faraday"
+require "ostruct"
+require "json"
+
+require "danger"
+
+require "gitlab_roulette/danger/helper"
+require "gitlab_roulette/danger/request_helper"
+require "gitlab_roulette/danger/roulette"
+require "gitlab_roulette/danger/teammate"
+
+module GitlabRoulette
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-reviewers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- LuizaLabs
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: danger-gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: GitlabRoulette choose reviewer and a maintainer for your merge request
+  automatically
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Rakefile
+- danger/plugins/helper.rb
+- danger/plugins/roulette.rb
+- gitlab-reviewers.gemspec
+- lib/gitlab_roulette.rb
+- lib/gitlab_roulette/danger/helper.rb
+- lib/gitlab_roulette/danger/request_helper.rb
+- lib/gitlab_roulette/danger/roulette.rb
+- lib/gitlab_roulette/danger/teammate.rb
+- lib/gitlab_roulette/gitlab_danger.rb
+- lib/gitlab_roulette/version.rb
+homepage:
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: GitlabRoulette adds a reviewer roulette to your self hosted Gitlab repository
+test_files: []