gitlab-housekeeper 0.1.0.pre.code.pre.challenge.pre.f0dc6c.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd6805b38ad05a71627181fe194b47da9608acbbb7c8712a39dea2f37a59b17e
-  data.tar.gz: 1186229f242b4d59a70732beaa9379c8c4462a776fcdc4bcf7a912fd4329dfe7
+  metadata.gz: 8b911737b1ef300020b8cd648c514329d2eee7dfd8f86610727d8f4c4c47bd20
+  data.tar.gz: 47ef5bec137ec296a9bc61032aaee4c3be6e26fd8d404a1b4483f1797a8ad2bf
 SHA512:
-  metadata.gz: 8d15af919460aa575b5ca61d64c46a288bb5469ba65d569d6e0879d6e34eac38262c8341b3d9a92aee5d4ca706fb99073176e5d306f301dd9a9893187f39e187
-  data.tar.gz: d6b484163ae9bc9571b813c2a3006951f5b2b0c22c3bc4e1c38b6ae4fa274a1bde91684d562cb6d22476e6610028cf4265de2e4e2bd7e9dd7badb81a362c2804
+  metadata.gz: 767b5444231e67c439b7bd659c2e974445041e3e8140ed2d7c3336aecf3f7a5628505122cf32a83be68f5277578afe04b0ea74cfa6402108f466850a9d827a74
+  data.tar.gz: 6f50658e7fc7d37694af6f504a046bd2e1510d85852a37c3e4a84ac54391b8cea985c729f34be24f49f2ec7e53202de7bcc9b8f309c6fa61de445394e3c55641

data/lib/gitlab/housekeeper/change.rb

@@ -8,30 +8,19 @@ module Gitlab
         :description,
         :changed_files,
         :labels,
-        :keep_class,
-        :changelog_type,
-        :mr_web_url
-      attr_reader :reviewers
+        :reviewers
 
       def initialize
         @labels = []
         @reviewers = []
       end
 
-      def reviewers=(reviewers)
-        @reviewers = Array(reviewers)
-      end
-
       def mr_description
         <<~MARKDOWN
         #{description}
 
         This change was generated by
         [gitlab-housekeeper](https://gitlab.com/gitlab-org/gitlab/-/tree/master/gems/gitlab-housekeeper)
-        using the #{keep_class} keep.
-
-        To provide feedback on your experience with `gitlab-housekeeper` please comment in
-        <https://gitlab.com/gitlab-org/gitlab/-/issues/442003>.
         MARKDOWN
       end
 
@@ -41,7 +30,7 @@ module Gitlab
 
         #{mr_description}
 
-        Changelog: #{changelog_type || 'other'}
+        Changelog: other
         MARKDOWN
       end
 

data/lib/gitlab/housekeeper/git.rb

@@ -11,57 +11,49 @@ module Gitlab
         @branch_from = branch_from
       end
 
-      def with_clean_state
-        result = Shell.execute('git', 'stash')
-        stashed = !result.include?('No local changes to save')
-
-        with_return_to_current_branch(stashed: stashed) do
-          checkout_branch(@branch_from)
-
-          yield
-        end
-      end
-
-      def create_branch(change)
+      def commit_in_branch(change)
         branch_name = branch_name(change.identifiers)
 
-        Shell.execute("git", "branch", "-f", branch_name)
+        create_commit(branch_name, change)
 
         branch_name
       end
 
-      def in_branch(branch_name)
-        with_return_to_current_branch do
-          checkout_branch(branch_name)
+      def with_branch_from_branch
+        stashed = false
+        current_branch = Shell.execute('git', 'branch', '--show-current').chomp
 
-          yield
-        end
-      end
+        result = Shell.execute('git', 'stash')
+        stashed = !result.include?('No local changes to save')
 
-      def create_commit(change)
-        Shell.execute("git", "add", *change.changed_files)
-        Shell.execute("git", "commit", "-m", change.commit_message)
+        Shell.execute("git", "checkout", @branch_from)
+
+        yield
+      ensure
+        # The `current_branch` won't be set in CI due to how the repo is cloned. Therefore we should only checkout
+        # `current_branch` if we actually have one.
+        Shell.execute("git", "checkout", current_branch) if current_branch.present?
+        Shell.execute('git', 'stash', 'pop') if stashed
       end
 
-      private
+      def create_commit(branch_name, change)
+        current_branch = Shell.execute('git', 'branch', '--show-current').chomp
 
-      def create_and_checkout_branch(branch_name)
         begin
           Shell.execute("git", "branch", '-D', branch_name)
         rescue Shell::Error # Might not exist yet
         end
 
         Shell.execute("git", "checkout", "-b", branch_name)
-      end
-
-      def checkout_branch(branch_name)
-        Shell.execute("git", "checkout", branch_name)
+        Shell.execute("git", "add", *change.changed_files)
+        Shell.execute("git", "commit", "-m", change.commit_message)
+      ensure
+        Shell.execute("git", "checkout", current_branch)
       end
 
       def branch_name(identifiers)
         # Hyphen-case each identifier then join together with hyphens.
         branch_name = identifiers
-          .map { |i| i.gsub(/[^\w]+/, '-') }
           .map { |i| i.gsub(/[[:upper:]]/) { |w| "-#{w.downcase}" } }
           .join('-')
           .delete_prefix("-")
@@ -73,17 +65,6 @@ module Gitlab
 
         branch_name
       end
-
-      def with_return_to_current_branch(stashed: false)
-        current_branch = Shell.execute('git', 'branch', '--show-current').chomp
-
-        yield
-      ensure
-        # The `current_branch` won't be set in CI due to how the repo is cloned. Therefore we should only checkout
-        # `current_branch` if we actually have one.
-        checkout_branch(current_branch) if current_branch.present?
-        Shell.execute('git', 'stash', 'pop') if stashed
-      end
     end
   end
 end

data/lib/gitlab/housekeeper/gitlab_client.rb

@@ -23,19 +23,16 @@ module Gitlab
         target_project_id:
       )
 
-        existing_merge_request = get_existing_merge_request(
+        iid = get_existing_merge_request(
           source_project_id: source_project_id,
           source_branch: source_branch,
           target_branch: target_branch,
           target_project_id: target_project_id
         )
 
-        return [] if existing_merge_request.nil?
+        return [] if iid.nil?
 
-        merge_request_notes = get_merge_request_notes(
-          target_project_id: target_project_id,
-          iid: existing_merge_request['iid']
-        )
+        merge_request_notes = get_merge_request_notes(target_project_id: target_project_id, iid: iid)
 
         changes = Set.new
 
@@ -51,10 +48,7 @@ module Gitlab
           changes << :reviewers if note['body'].include?('removed review request for')
         end
 
-        resource_label_events = get_merge_request_resource_label_events(
-          target_project_id: target_project_id,
-          iid: existing_merge_request['iid']
-        )
+        resource_label_events = get_merge_request_resource_label_events(target_project_id: target_project_id, iid: iid)
 
         resource_label_events.each do |event|
           next if event["user"]["id"] == current_user_id
@@ -82,17 +76,17 @@ module Gitlab
         update_labels:,
         update_reviewers:
       )
-        existing_merge_request = get_existing_merge_request(
+        existing_iid = get_existing_merge_request(
           source_project_id: source_project_id,
           source_branch: source_branch,
           target_branch: target_branch,
           target_project_id: target_project_id
         )
 
-        if existing_merge_request
+        if existing_iid
           update_existing_merge_request(
             change: change,
-            existing_iid: existing_merge_request['iid'],
+            existing_iid: existing_iid,
             target_project_id: target_project_id,
             update_title: update_title,
             update_description: update_description,
@@ -111,21 +105,6 @@ module Gitlab
       end
       # rubocop:enable Metrics/ParameterLists
 
-      def get_existing_merge_request(source_project_id:, source_branch:, target_branch:, target_project_id:)
-        data = request(:get, "/projects/#{target_project_id}/merge_requests", query: {
-          state: :opened,
-          source_branch: source_branch,
-          target_branch: target_branch,
-          source_project_id: source_project_id
-        })
-
-        return nil if data.empty?
-
-        raise Error, "More than one matching MR exists: iids: #{data.pluck('iid').join(',')}" unless data.size == 1
-
-        data.first
-      end
-
       private
 
       def get_merge_request_notes(target_project_id:, iid:)
@@ -141,6 +120,23 @@ module Gitlab
         @current_user_id ||= request(:get, "/user")['id']
       end
 
+      def get_existing_merge_request(source_project_id:, source_branch:, target_branch:, target_project_id:)
+        data = request(:get, "/projects/#{target_project_id}/merge_requests", query: {
+          state: :opened,
+          source_branch: source_branch,
+          target_branch: target_branch,
+          source_project_id: source_project_id
+        })
+
+        return nil if data.empty?
+
+        iids = data.pluck('iid')
+
+        raise Error, "More than one matching MR exists: iids: #{iids.join(',')}" unless data.size == 1
+
+        iids.first
+      end
+
       def create_merge_request(
         change:,
         source_project_id:,
@@ -182,7 +178,7 @@ module Gitlab
       end
 
       def usernames_to_ids(usernames)
-        Array(usernames).map do |username|
+        usernames.map do |username|
           data = request(:get, "/users", query: { username: username })
           data[0]['id']
         end

data/lib/gitlab/housekeeper/runner.rb

@@ -2,12 +2,9 @@
 
 require 'active_support/core_ext/string'
 require 'gitlab/housekeeper/keep'
-require 'gitlab/housekeeper/keeps/rubocop_fixer'
-require 'gitlab/housekeeper/keeps/upgrade_dependency'
 require 'gitlab/housekeeper/gitlab_client'
 require 'gitlab/housekeeper/git'
 require 'gitlab/housekeeper/change'
-require 'gitlab/housekeeper/substitutor'
 require 'awesome_print'
 require 'digest'
 
@@ -32,7 +29,7 @@ module Gitlab
       def run
         created = 0
 
-        git.with_clean_state do
+        git.with_branch_from_branch do
           @keeps.each do |keep_class|
             keep = keep_class.new
             keep.each_change do |change|
@@ -41,45 +38,22 @@ module Gitlab
                 next
               end
 
-              change.keep_class ||= keep_class
-
-              branch_name = git.create_branch(change)
+              branch_name = git.commit_in_branch(change)
               add_standard_change_data(change)
 
+              # Must be done after we commit so that we don't keep around changed files. We could checkout those files
+              # but then it might be riskier in local development in case we lose unrelated changes.
               unless change.matches_filters?(@filter_identifiers)
-                # At this point the keep has already run and edited files so we need to
-                # restore the local working copy. We could simply checkout all
-                # changed_files but this is very risky as it could mean losing work that
-                # cannot be recovered. Instead we commit all the work to the branch and
-                # move on without pushing the branch.
-                git.in_branch(branch_name) do
-                  git.create_commit(change)
-                end
-
-                puts "Skipping change: #{change.identifiers} due to not matching filter."
-                puts "Modified files have been committed to branch #{branch_name.yellowish}, but will not be pushed."
-                puts
-
+                puts "Skipping change: #{change.identifiers} due to not matching filter"
                 next
               end
 
-              # If no merge request exists yet, create an empty one to allow keeps to use the web URL.
-              unless @dry_run
-                merge_reqeust = get_existing_merge_request(branch_name) || create(change, branch_name)
-
-                change.mr_web_url = merge_reqeust['web_url']
-              end
-
-              git.in_branch(branch_name) do
-                Gitlab::Housekeeper::Substitutor.perform(change)
-
-                git.create_commit(change)
+              if @dry_run
+                dry_run(change, branch_name)
+              else
+                create(change, branch_name)
               end
 
-              print_change_details(change, branch_name)
-
-              create(change, branch_name) unless @dry_run
-
               created += 1
               break if created >= @max_mrs
             end
@@ -105,8 +79,7 @@ module Gitlab
         end
       end
 
-      def print_change_details(change, branch_name)
-        puts "Merge request URL: #{change.mr_web_url || '(known after create)'}, on branch #{branch_name}".yellowish
+      def dry_run(change, branch_name)
         puts "=> #{change.identifiers.join(': ')}".purple
 
         puts '=> Title:'.purple
@@ -117,10 +90,9 @@ module Gitlab
         puts change.description
         puts
 
-        if change.labels.present? || change.reviewers.present?
+        if change.labels.present?
           puts '=> Attributes:'
           puts "Labels: #{change.labels.join(', ')}"
-          puts "Reviewers: #{change.reviewers.join(', ')}"
           puts
         end
 
@@ -131,6 +103,8 @@ module Gitlab
       end
 
       def create(change, branch_name)
+        dry_run(change, branch_name)
+
         non_housekeeper_changes = gitlab_client.non_housekeeper_changes(
           source_project_id: housekeeper_fork_project_id,
           source_branch: branch_name,
@@ -142,7 +116,7 @@ module Gitlab
           Shell.execute('git', 'push', '-f', 'housekeeper', "#{branch_name}:#{branch_name}")
         end
 
-        gitlab_client.create_or_update_merge_request(
+        mr = gitlab_client.create_or_update_merge_request(
           change: change,
           source_project_id: housekeeper_fork_project_id,
           source_branch: branch_name,
@@ -153,15 +127,8 @@ module Gitlab
           update_labels: !non_housekeeper_changes.include?(:labels),
           update_reviewers: !non_housekeeper_changes.include?(:reviewers)
         )
-      end
 
-      def get_existing_merge_request(branch_name)
-        gitlab_client.get_existing_merge_request(
-          source_project_id: housekeeper_fork_project_id,
-          source_branch: branch_name,
-          target_branch: 'master',
-          target_project_id: housekeeper_target_project_id
-        )
+        puts "Merge request URL: #{mr['web_url'].yellowish}"
       end
 
       def housekeeper_fork_project_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-housekeeper
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.code.pre.challenge.pre.f0dc6c.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - group::tenant-scale
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,11 +136,8 @@ files:
 - lib/gitlab/housekeeper/git.rb
 - lib/gitlab/housekeeper/gitlab_client.rb
 - lib/gitlab/housekeeper/keep.rb
-- lib/gitlab/housekeeper/keeps/rubocop_fixer.rb
-- lib/gitlab/housekeeper/keeps/upgrade_dependency.rb
 - lib/gitlab/housekeeper/runner.rb
 - lib/gitlab/housekeeper/shell.rb
-- lib/gitlab/housekeeper/substitutor.rb
 - lib/gitlab/housekeeper/version.rb
 homepage: https://gitlab.com/gitlab-org/gitlab/-/tree/master/gems/gitlab-housekeeper
 licenses:

data/lib/gitlab/housekeeper/keeps/rubocop_fixer.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-
-module Gitlab
-  module Housekeeper
-    module Keeps
-      class RubocopFixer < Keep
-        LIMIT_FIXES = 20
-        RUBOCOP_TODO_DIR_PATTERN = ".rubocop_todo/**/*.yml"
-
-        def initialize(todo_dir_pattern: RUBOCOP_TODO_DIR_PATTERN, limit_fixes: LIMIT_FIXES)
-          @todo_dir_pattern = todo_dir_pattern
-          @limit_fixes = limit_fixes
-        end
-
-        def each_change
-          each_allowed_rubocop_rule do |rule, rule_file_path, violating_files|
-            remove_allow_rule = true
-
-            if violating_files.count > @limit_fixes
-              violating_files = violating_files.first(@limit_fixes)
-              remove_allow_rule = false
-            end
-
-            change = Change.new
-            change.title = "Fix #{violating_files.count} rubocop violations for #{rule}"
-            change.identifiers = [self.class.name, rule, violating_files.last]
-            change.description = <<~MARKDOWN
-            Fixes the #{violating_files.count} violations for the rubocop rule `#{rule}`
-            that were previously excluded in `#{rule_file_path}`.
-            The exclusions have now been removed.
-            MARKDOWN
-
-            if remove_allow_rule
-              FileUtils.rm(rule_file_path)
-            else
-              remove_first_exclusions(rule, rule_file_path, violating_files.count)
-            end
-
-            begin
-              ::Gitlab::Housekeeper::Shell.execute('rubocop', '--autocorrect', *violating_files)
-            rescue ::Gitlab::Housekeeper::Shell::Error
-              # Ignore when it cannot be automatically fixed. But we need to checkout any files we might have updated.
-              ::Gitlab::Housekeeper::Shell.execute('git', 'checkout', rule_file_path, *violating_files)
-              next
-            end
-
-            change.changed_files = [rule_file_path, *violating_files]
-
-            yield(change)
-          end
-        end
-
-        def each_allowed_rubocop_rule
-          Dir.glob(@todo_dir_pattern).each do |file|
-            content = File.read(file)
-            next unless content.include?('Cop supports --autocorrect')
-
-            data = YAML.safe_load(content)
-
-            # Assume one per file since that's how it is in gitlab-org/gitlab
-            next unless data.keys.count == 1
-
-            rule = data.keys[0]
-            violating_files = data[rule]['Exclude']
-            next unless violating_files&.count&.positive?
-
-            yield rule, file, violating_files
-          end
-        end
-
-        def remove_first_exclusions(_rule, file, remove_count)
-          content = File.read(file)
-          skipped = 0
-
-          output = content.each_line.filter do |line|
-            if skipped < remove_count && line.match?(/\s+-\s+/)
-              skipped += 1
-              false
-            else
-              true
-            end
-          end
-
-          File.write(file, output.join)
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/housekeeper/keeps/upgrade_dependency.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Housekeeper
-    module Keeps
-      class UpgradeDependency < Keep
-        def initialize(
-          upgrade_command: ENV.fetch('HOUSEKEEPER_DEPENDENCY_UPGRADE_COMMAND'), # bundle update haml
-          changed_files: ENV.fetch('HOUSEKEEPER_DEPENDENCY_UPGRADE_CHANGED_FILES').split(',') # Gemfile.lock
-        )
-          @upgrade_command = upgrade_command
-          @changed_files = changed_files
-        end
-
-        def each_change
-          ::Gitlab::Housekeeper::Shell.execute(@upgrade_command)
-
-          change = Change.new
-          change.title = "Run #{@upgrade_command}"
-          change.identifiers = [self.class.name, @upgrade_command]
-          change.description = <<~MARKDOWN
-          Automatically upgrade a dependency using:
-
-          ```
-          #{@upgrade_command}
-          ```
-          MARKDOWN
-
-
-          change.changed_files = @changed_files
-
-          yield(change)
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/housekeeper/substitutor.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Housekeeper
-    class Substitutor
-      MR_WEB_URL_PLACEHOLDER = '<HOUSEKEEPER_MR_WEB_URL>'
-
-      def self.perform(change)
-        return unless change.mr_web_url.present?
-
-        change.changed_files.each do |file|
-          next unless File.file?(file)
-
-          content = File.read(file)
-          content.gsub!(MR_WEB_URL_PLACEHOLDER, change.mr_web_url)
-
-          File.write(file, content)
-        end
-      end
-    end
-  end
-end