gitlab-dangerfiles 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1376c48a26c7b3a10cc3e649d1cf28f49fdf58fd7b317713b9ac9a0f3771e5a5
-  data.tar.gz: 9ecd1d0db0f583740a73f96f6ffd14905f7a66157e427c6a11410a7bc7c70e55
+  metadata.gz: f9f8e727ceb4fd8d6a8163b5c2637cb117426e30d3002ae5772b7031c83bc98a
+  data.tar.gz: 650de232d49a5cb7a022ed53e4607ddc8941ba0615e5cc73214da44d2e838967
 SHA512:
-  metadata.gz: e1684cb0a7b5367b37f099cad0dca796cdb5cf01fc71f36e4896268b4abc8c0ee59ed122459261f47ec1b873da8aa2355644c6074b92285ddd1b3f4215bbba86
-  data.tar.gz: 8e8644fa64222def924524b8545397615f7335198e88d35f47fc07c450793879c0c710c380b496eb0c80a6bf856c855ec4bb58266670aff6a526ff3b9c84bc5a
+  metadata.gz: fe6821b98e683ead18db025365f4efe6821ca92773f8baacfec88ab12131ab1597d735a1262d2cf65928d24b9b72182a1db2d2cb3435edd6c52248eb029ecd87
+  data.tar.gz: e984610303236d5d6f964ed04c61f924560cf2e29b04c1b485434f0755dc9dd676d486b879972f02b4463da4d499fd070e2a8629bfb570cee93e88b0e4eaf531

data/gitlab-dangerfiles.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "danger"
+  spec.add_dependency "danger-gitlab"
 
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-parameterized"

data/lib/danger/helper.rb

@@ -3,6 +3,7 @@
 require "net/http"
 require "json"
 require "danger"
+require_relative "../gitlab/dangerfiles/changes"
 require_relative "../gitlab/dangerfiles/teammate"
 require_relative "../gitlab/dangerfiles/title_linting"
 
@@ -22,52 +23,6 @@ module Danger
 
     HTTPError = Class.new(StandardError)
 
-    Change = Struct.new(:file, :change_type, :category)
-
-    class Changes < ::SimpleDelegator
-      def added
-        select_by_change_type(:added)
-      end
-
-      def modified
-        select_by_change_type(:modified)
-      end
-
-      def deleted
-        select_by_change_type(:deleted)
-      end
-
-      def renamed_before
-        select_by_change_type(:renamed_before)
-      end
-
-      def renamed_after
-        select_by_change_type(:renamed_after)
-      end
-
-      def has_category?(category)
-        any? { |change| change.category == category }
-      end
-
-      def by_category(category)
-        Changes.new(select { |change| change.category == category })
-      end
-
-      def categories
-        map(&:category).uniq
-      end
-
-      def files
-        map(&:file)
-      end
-
-      private
-
-      def select_by_change_type(change_type)
-        Changes.new(select { |change| change.change_type == change_type })
-      end
-    end
-
     def gitlab_helper
       # Unfortunately the following does not work:
       # - respond_to?(:gitlab)
@@ -96,8 +51,62 @@ module Danger
       JSON.parse(rsp.body)
     end
 
+    def added_files
+      @added_files ||= if changes_from_api
+          changes_from_api.select { |file| file["new_file"] }.map { |file| file["new_path"] }
+        else
+          git.added_files.to_a
+        end
+    end
+
+    def modified_files
+      @modified_files ||= if changes_from_api
+          changes_from_api.select { |file| !file["new_file"] && !file["deleted_file"] && !file["renamed_file"] }.map { |file| file["new_path"] }
+        else
+          git.modified_files.to_a
+        end
+    end
+
+    def renamed_files
+      @renamed_files ||= if changes_from_api
+          changes_from_api.select { |file| file["renamed_file"] }.each_with_object([]) do |file, memo|
+            memo << { before: file["old_path"], after: file["new_path"] }
+          end
+        else
+          git.renamed_files.to_a
+        end
+    end
+
+    def deleted_files
+      @deleted_files ||= if changes_from_api
+          changes_from_api.select { |file| file["deleted_file"] }.map { |file| file["new_path"] }
+        else
+          git.deleted_files.to_a
+        end
+    end
+
+    def diff_for_file(filename)
+      if changes_from_api
+        changes_hash = changes_from_api.find { |file| file["new_path"] == filename }
+        changes_hash["diff"] if changes_hash
+      else
+        git.diff_for_file(filename)&.patch
+      end
+    end
+
+    def changes_from_api
+      return nil unless ci?
+      return nil if defined?(@force_changes_from_git)
+
+      @changes_from_api ||= gitlab_helper.api.merge_request_changes(gitlab_helper.mr_json["project_id"], gitlab_helper.mr_json["iid"]).to_h["changes"]
+    rescue
+      # Fallback to the Git strategy in any case
+      @force_changes_from_git = true
+      nil
+    end
+
     # Returns a list of all files that have been added, modified or renamed.
-    # `git.modified_files` might contain paths that already have been renamed,
+    # `modified_files` might contain paths that already have been renamed,
     # so we need to remove them from the list.
     #
     # Considering these changes:
@@ -115,10 +124,10 @@ module Danger
     # @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] })
+        .merge(added_files)
+        .merge(modified_files)
+        .merge(renamed_files.map { |x| x[:after] })
+        .subtract(renamed_files.map { |x| x[:before] })
         .to_a
         .sort
     end
@@ -132,10 +141,10 @@ module Danger
     #   "+      # Test change",
     #   "-      # Old change" ]
     def changed_lines(changed_file)
-      diff = git.diff_for_file(changed_file)
+      diff = diff_for_file(changed_file)
       return [] unless diff
 
-      diff.patch.split("\n").select { |line| %r{^[+-]}.match?(line) }
+      diff.split("\n").select { |line| %r{^[+-]}.match?(line) }
     end
 
     def release_automation?
@@ -159,27 +168,27 @@ module Danger
       end
     end
 
-    # @return [Changes]
+    # @return [Gitlab::Dangerfiles::Changes]
     def changes(categories)
-      Changes.new([]).tap do |changes|
-        git.added_files.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Change.new(file, :added, category) }
+      Gitlab::Dangerfiles::Changes.new([]).tap do |changes|
+        added_files.each do |file|
+          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :added, category) }
         end
 
-        git.modified_files.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Change.new(file, :modified, category) }
+        modified_files.each do |file|
+          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :modified, category) }
         end
 
-        git.deleted_files.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Change.new(file, :deleted, category) }
+        deleted_files.each do |file|
+          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :deleted, category) }
         end
 
-        git.renamed_files.map { |x| x[:before] }.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Change.new(file, :renamed_before, category) }
+        renamed_files.map { |x| x[:before] }.each do |file|
+          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :renamed_before, category) }
         end
 
-        git.renamed_files.map { |x| x[:after] }.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Change.new(file, :renamed_after, category) }
+        renamed_files.map { |x| x[:after] }.each do |file|
+          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :renamed_after, category) }
         end
       end
     end
@@ -214,31 +223,31 @@ module Danger
     end
 
     def mr_iid
-      return "" unless gitlab_helper
+      return "" unless ci?
 
       gitlab_helper.mr_json["iid"]
     end
 
     def mr_title
-      return "" unless gitlab_helper
+      return "" unless ci?
 
       gitlab_helper.mr_json["title"]
     end
 
     def mr_web_url
-      return "" unless gitlab_helper
+      return "" unless ci?
 
       gitlab_helper.mr_json["web_url"]
     end
 
     def mr_labels
-      return [] unless gitlab_helper
+      return [] unless ci?
 
       gitlab_helper.mr_labels
     end
 
     def mr_target_branch
-      return "" unless gitlab_helper
+      return "" unless ci?
 
       gitlab_helper.mr_json["target_branch"]
     end

data/lib/danger/roulette.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "helper"
 require_relative "../gitlab/dangerfiles/teammate"
 require_relative "../gitlab/dangerfiles/weightage/maintainers"
 require_relative "../gitlab/dangerfiles/weightage/reviewers"
@@ -25,7 +26,7 @@ module Danger
     # for each change category that a Merge Request contains.
     #
     # @return [Array<Spin>]
-    def spin(project, categories, timezone_experiment: false)
+    def spin(project, categories = [nil], timezone_experiment: false)
       spins = categories.sort.map do |category|
         including_timezone = INCLUDE_TIMEZONE_FOR_CATEGORY.fetch(category, timezone_experiment)
 

data/lib/gitlab/dangerfiles.rb

@@ -2,5 +2,8 @@ require "gitlab/dangerfiles/version"
 
 module Gitlab
   module Dangerfiles
+    def self.import_plugins(danger)
+      danger.import_plugin(File.expand_path("../danger/*.rb", __dir__))
+    end
   end
 end

data/lib/gitlab/dangerfiles/base_linter.rb

@@ -59,7 +59,7 @@ module Gitlab
       private
 
       def subject
-        TitleLinting.remove_draft_flag(message_parts[0])
+        @subject ||= TitleLinting.remove_draft_flag(message_parts[0])
       end
 
       def subject_too_short?
@@ -75,6 +75,7 @@ module Gitlab
       end
 
       def subject_starts_with_lowercase?
+        return false if subject.empty?
         return false if ("A".."Z").cover?(subject[0])
 
         first_char = subject.sub(/\A(\[.+\]|\w+:)\s/, "")[0]

data/lib/gitlab/dangerfiles/changes.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "title_linting"
+
+module Gitlab
+  module Dangerfiles
+    Change = Struct.new(:file, :change_type, :category)
+
+    class Changes < ::SimpleDelegator
+      def added
+        select_by_change_type(:added)
+      end
+
+      def modified
+        select_by_change_type(:modified)
+      end
+
+      def deleted
+        select_by_change_type(:deleted)
+      end
+
+      def renamed_before
+        select_by_change_type(:renamed_before)
+      end
+
+      def renamed_after
+        select_by_change_type(:renamed_after)
+      end
+
+      def has_category?(category)
+        any? { |change| change.category == category }
+      end
+
+      def by_category(category)
+        Changes.new(select { |change| change.category == category })
+      end
+
+      def categories
+        map(&:category).uniq
+      end
+
+      def files
+        map(&:file)
+      end
+
+      private
+
+      def select_by_change_type(change_type)
+        Changes.new(select { |change| change.change_type == change_type })
+      end
+    end
+  end
+end

data/lib/gitlab/dangerfiles/commit_linter.rb

@@ -6,6 +6,7 @@ require_relative "emoji_checker"
 module Gitlab
   module Dangerfiles
     class CommitLinter < BaseLinter
+      MAX_CHANGED_FILES_IN_COMMIT = 3
       MAX_CHANGED_LINES_IN_COMMIT = 30
       SHORT_REFERENCE_REGEX = %r{([\w\-\/]+)?(?<!`)(#|!|&|%)\d+(?<!`)}.freeze
 

data/lib/gitlab/dangerfiles/spec_helper.rb

@@ -0,0 +1,112 @@
+require "danger"
+require "gitlab/dangerfiles/changes"
+
+module DangerSpecHelper
+  # These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+  # If you are expanding these files, see if it's already been done ^.
+
+  # A silent version of the user interface
+  def self.testing_ui
+    Cork::Board.new(silent: true)
+  end
+
+  # Example environment (ENV) that would come from
+  # running a PR on TravisCI
+  def self.testing_env
+    {
+      "GITLAB_CI" => "true",
+      "DANGER_GITLAB_HOST" => "gitlab.example.com",
+      "CI_MERGE_REQUEST_IID" => 28_493,
+      "DANGER_GITLAB_API_TOKEN" => "123sbdq54erfsd3422gdfio",
+    }
+  end
+
+  # A stubbed out Dangerfile for use in tests
+  def self.testing_dangerfile
+    env = Danger::EnvironmentManager.new(testing_env)
+    Danger::Dangerfile.new(env, testing_ui)
+  end
+
+  def self.fake_danger
+    Class.new do
+      attr_reader :git, :gitlab, :helper
+
+      # rubocop:disable Gitlab/ModuleWithInstanceVariables
+      def initialize(git: nil, gitlab: nil, helper: nil)
+        @git = git
+        @gitlab = gitlab
+        @helper = helper
+      end
+
+      # rubocop:enable Gitlab/ModuleWithInstanceVariables
+    end
+  end
+end
+
+RSpec.shared_context "with dangerfile" do
+  let(:dangerfile) { DangerSpecHelper.testing_dangerfile }
+  let(:added_files) { %w[added-from-git] }
+  let(:modified_files) { %w[modified-from-git] }
+  let(:deleted_files) { %w[deleted-from-git] }
+  let(:renamed_before_file) { "renamed_before-from-git" }
+  let(:renamed_after_file) { "renamed_after-from-git" }
+  let(:renamed_files) { [{ before: renamed_before_file, after: renamed_after_file }] }
+  let(:change_class) { Gitlab::Dangerfiles::Change }
+  let(:changes_class) { Gitlab::Dangerfiles::Changes }
+  let(:changes) { changes_class.new([]) }
+  let(:mr_title) { "Fake Title" }
+  let(:mr_labels) { [] }
+  let(:mr_changes_from_api) do
+    {
+      "changes" => [
+        {
+          "old_path" => "added-from-api",
+          "new_path" => "added-from-api",
+          "a_mode" => "100644",
+          "b_mode" => "100644",
+          "new_file" => true,
+          "renamed_file" => false,
+          "deleted_file" => false,
+          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
+        },
+        {
+          "old_path" => "modified-from-api",
+          "new_path" => "modified-from-api",
+          "a_mode" => "100644",
+          "b_mode" => "100644",
+          "new_file" => false,
+          "renamed_file" => false,
+          "deleted_file" => false,
+          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
+        },
+        {
+          "old_path" => "renamed_before-from-api",
+          "new_path" => "renamed_after-from-api",
+          "a_mode" => "100644",
+          "b_mode" => "100644",
+          "new_file" => false,
+          "renamed_file" => true,
+          "deleted_file" => false,
+          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
+        },
+        {
+          "old_path" => "deleted-from-api",
+          "new_path" => "deleted-from-api",
+          "a_mode" => "100644",
+          "b_mode" => "100644",
+          "new_file" => false,
+          "renamed_file" => false,
+          "deleted_file" => true,
+          "diff" => "@@ -49,6 +49,14 @@\n- vendor/ruby/\n     policy: pull\n \n+.danger-review-cache:\n",
+        },
+      ],
+    }
+  end
+
+  let(:fake_git) { double("fake-git", added_files: added_files, modified_files: modified_files, deleted_files: deleted_files, renamed_files: renamed_files) }
+  let(:fake_helper) { double("fake-helper", changes: changes, mr_iid: 1234, mr_title: mr_title, mr_labels: mr_labels) }
+
+  before do
+    allow(dangerfile).to receive(:git).and_return(fake_git)
+  end
+end

data/lib/gitlab/dangerfiles/teammate.rb

@@ -101,6 +101,8 @@ module Gitlab
           return true if capabilities(project).include?("#{kind} engineering_productivity")
 
           capabilities(project).include?("#{kind} backend")
+        when nil
+          capabilities(project).include?("#{kind}")
         else
           capabilities(project).include?("#{kind} #{category}")
         end

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "0.6.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Rémy Coutable
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: danger
+  name: danger-gitlab
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,9 +136,11 @@ files:
 - lib/gitlab/Dangerfile
 - lib/gitlab/dangerfiles.rb
 - lib/gitlab/dangerfiles/base_linter.rb
+- lib/gitlab/dangerfiles/changes.rb
 - lib/gitlab/dangerfiles/commit_linter.rb
 - lib/gitlab/dangerfiles/emoji_checker.rb
 - lib/gitlab/dangerfiles/merge_request_linter.rb
+- lib/gitlab/dangerfiles/spec_helper.rb
 - lib/gitlab/dangerfiles/teammate.rb
 - lib/gitlab/dangerfiles/title_linting.rb
 - lib/gitlab/dangerfiles/version.rb