gitlab-branch-rename 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f33aa63fa0d74d53308136f89910a11d861daa231ba279f670188e4e832981f3
-  data.tar.gz: 8661fecb4807479d6df798baa2ea01f58173a6492dd3c8ffee60df42f953e9fd
+  metadata.gz: 60976abc74b540c7fdd90ee169c5c7f49e67d71514728f4ee41194cf2b70c1fc
+  data.tar.gz: b91a114cbc9603200823ddad6d36c0e0fd8a6d1988c36a9a5fbb67c03a10722e
 SHA512:
-  metadata.gz: 486bd423917b401e3d0a98485a621a0c3a3b7b63606721d1a1c47bf366014eb6e5b5b1079377633d5d91d824a97e985325ca89547c200b44d9f6b0006e628534
-  data.tar.gz: 220b75c80baa11007d68b7c3504438b7472ee937fac7b333225b0d51c570a6c067f3c7fcaab2caa0b9a43bebe4307a474ec35516b2d2653a2e4ecbbbac27fb74
+  metadata.gz: 2382c0b192541311af1488e071ee3c1415d24c59b57ff4f512bae9fed1f3d8c479ca2359a6ba6637f3cd0ba5d282d350472bf3b6927bb944462b8eeda255ac47
+  data.tar.gz: af8db546cbdcd9850f17f3b9944403ff162f053a71ce0c65e4acf7665ade7f8bb0ed570aff174f5c6cd9f8f76dfa0ce601964820a954ab6e0d7a59ed37504a20

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-branch-rename (0.1.0)
+    gitlab-branch-rename (0.2.0)
       gitlab (~> 4.16)
 
 GEM

data/Makefile

@@ -0,0 +1,16 @@
+all:
+	rake
+
+build:
+	rake
+	gem build ./gitlab-branch-rename.gemspec
+
+clean:
+	rm .rspec_status
+	rm gitlab-branch-rename-*.gem
+
+install: build
+	gem install ./gitlab-branch-rename-*.gem
+
+push: clean build
+	gem push gitlab-branch-rename-*.gem

data/README.md

@@ -30,6 +30,10 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+During development, I used these references:
+- https://docs.gitlab.com/ce/api/projects.html#edit-project
+- https://www.rubydoc.info/gems/gitlab/Gitlab/Client/Projects
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlab-branch-rename. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/gitlab-branch-rename/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "rename"
+require "main"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/exe/gitlab-branch-rename

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require "rename"
+require "gitlab_branch_rename/main"
 
-GitlabBranchRename.new.main
+GitlabBranchRename.launch

data/gitlab-branch-rename.gemspec

@@ -1,4 +1,4 @@
-require_relative 'lib/version'
+require_relative 'lib/gitlab_branch_rename/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "gitlab-branch-rename"
@@ -6,10 +6,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["AP Fritts"]
   spec.email         = ["ap@apfritts.com"]
 
-  spec.summary       = 'Tool to rename your Gitlab project branches en-mass'
-  spec.description   = "To support Black Lives Matter and try to create safer spaces, I wanted to rename" +
+  spec.summary       = "Tool to rename your Gitlab project branches en-mass"
+  spec.description   = "To support Black Lives Matter and try to create safer spaces, I wanted to rename " +
       "all of my own default branches in Gitlab. I wasn't able to find any tools to do that, so I wrote " +
-      "this one. If you're unsure why this is important or want to better understand my personal understanding" +
+      "this one. If you're unsure why this is important or want to better understand my personal understanding " +
       "of why I wanted to make these changes, see this Twitter thread: https://twitter.com/mislav/status/1270388510684598272"
   spec.homepage      = "https://gitlab.com/apfritts/gitlab-branch-rename"
   spec.license       = "MIT"
@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
     `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) }
+  executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  puts executables
+  spec.executables   = executables
   spec.require_paths = ["lib"]
 end

data/gitlab-branch-rename.gemspec.lock

@@ -0,0 +1,3 @@
+PLATFORMS
+
+DEPENDENCIES

data/lib/gitlab_branch_rename/configuration.rb

@@ -0,0 +1,81 @@
+require "optparse"
+
+module GitlabBranchRename
+  class Configuration
+    attr_accessor :token, :branch_to_rename, :new_branch_name,
+                  :endpoint, :is_default_branch, :has_visibility, :minimum_access_level,
+                  :skip_confirm, :pretend, :logfile
+
+    def initialize
+      # Required parameters
+      self.branch_to_rename = nil
+      self.new_branch_name = nil
+
+      # Criteria parameters with defaults
+      self.endpoint = "https://gitlab.com/api/v4"
+      self.token = ENV["GITLAB_ACCESS_TOKEN"]
+      self.is_default_branch = false
+      self.has_visibility = %w[private internal public]
+      self.minimum_access_level = 40
+
+      # Optional parameters
+      self.skip_confirm = false
+      self.pretend = false
+      self.logfile = STDOUT
+    end
+
+    def self.configure
+      configuration = Configuration.new
+      optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: gitlab-branch-rename --from <branch to rename> --to <new branch name> [options]"
+        opts.separator ""
+        opts.separator "Specific options:"
+        opts.on("--from OLD_BRANCH", "Branch to rename") do |from|
+          configuration.branch_to_rename = from
+        end
+        opts.on("--to NEW_BRANCH", "New branch name") do |to|
+          configuration.new_branch_name = to
+        end
+        opts.on("--endpoint ENDPOINT", "Gitlab server endpoint. default: Gitlab cloud") do |endpoint|
+          configuration.endpoint = endpoint
+        end
+        opts.on("--token-env-var ENV_VAR_NAME", "Environment variable to pull token out of") do |token_env_var|
+          configuration.token = ENV[token_env_var]
+        end
+        opts.on("--only-if-default", "Rename only if it is the default branch") do
+          configuration.is_default_branch = true
+        end
+        opts.on("--visibility VISIBILITIES", "Comma-separated list of project visibilities default: public,internal,private") do |visibility|
+          configuration.has_visibility = visibility.split ","
+        end
+        opts.on("--skip-confirm", "Skip confirmation before executing rename") do
+          configuration.skip_confirm = true
+        end
+        opts.on("--pretend", "Pretend to perform actions. Overrides confirm option") do
+          configuration.pretend = true
+        end
+        opts.on("--logfile LOGFILE", "Logfile destination. Use - for STDOUT") do |logfile|
+          if logfile == "-"
+            configuration.logfile = STDOUT
+          else
+            configuration.logfile = logfile
+          end
+        end
+        opts.separator ""
+        opts.separator "Visit https://gitlab.com/apfritts/gitlab-branch-rename for more details."
+      end
+
+      begin
+        optparse.parse!
+        raise OptionParser::MissingArgument.new('old branch name') if configuration.branch_to_rename.nil?
+        raise OptionParser::MissingArgument.new('new branch name') if configuration.new_branch_name.nil?
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+        puts $!.to_s
+        puts optparse
+        exit 1
+      end
+
+      configuration
+    end
+  end
+end

data/lib/gitlab_branch_rename/gitlab_configure.rb

@@ -0,0 +1,14 @@
+require "gitlab"
+
+module GitlabBranchRename
+  class GitlabConfigure
+    def self.configure(configuration)
+      Gitlab.endpoint = configuration.endpoint
+      Gitlab.private_token = configuration.token
+
+      #Gitlab.http_proxy("proxyhost", 8888)
+      #Gitlab.http_proxy("proxyhost", 8888, "proxyuser", "strongpasswordhere")
+      #ENV["GITLAB_API_HTTPARTY_OPTIONS"] = "{read_timeout: 60}"
+    end
+  end
+end

data/lib/gitlab_branch_rename/logger_configure.rb

@@ -0,0 +1,16 @@
+module GitlabBranchRename
+  class LoggerConfigure
+    def self.configure(configuration)
+      logger = Logger.new(STDOUT)
+      logger.formatter = proc do |severity, datetime, progname, msg|
+        date_format = datetime.to_datetime.strftime("%Q")
+        if severity == "INFO" or severity == "WARN"
+          "#{severity}  #{date_format} #{msg}\n"
+        else
+          "#{severity} #{date_format} #{msg}\n"
+        end
+      end
+      logger
+    end
+  end
+end

data/lib/gitlab_branch_rename/main.rb

@@ -0,0 +1,32 @@
+require "gitlab_branch_rename/configuration"
+require "gitlab_branch_rename/gitlab_configure"
+require "gitlab_branch_rename/logger_configure"
+require "gitlab_branch_rename/operation"
+require "gitlab_branch_rename/version"
+
+module GitlabBranchRename
+  def self.launch
+    c = Configuration.configure
+    logger = LoggerConfigure.configure c
+    logger.debug("Gitlab instance configuration:")
+    logger.debug("Endpoint:     #{c.endpoint}")
+    logger.debug("Token:        #{c.token.nil? ? "set" : "not set"}")
+    logger.debug("Project filter criteria:")
+    logger.debug("Visibility:   #{c.has_visibility.join(', ')}")
+    logger.debug("Operation options:")
+    logger.debug("Old branch:   #{c.branch_to_rename}")
+    logger.debug("New branch:   #{c.new_branch_name}")
+    logger.debug("Skip confirm: #{c.skip_confirm.nil? ? "yes" : "no"}")
+    logger.debug("Pretend:      #{c.pretend.nil? ? "yes" : "no"}")
+    logger.debug("Log file:     #{c.logfile == STDOUT ? "-" : c.logfile}")
+    GitlabConfigure.configure c
+    operation = Operation.new c, logger
+    operation.execute
+    logger.info("For any local repositories, use these commands to update:")
+    logger.info("    git fetch `git remote` --prune")
+    logger.info("    git checkout #{c.new_branch_name}")
+    logger.info("    git remote set-head `git remote` #{c.new_branch_name}")
+    logger.info("    git branch -d #{c.branch_to_rename}")
+    logger.close
+  end
+end

data/lib/gitlab_branch_rename/operation.rb

@@ -0,0 +1,133 @@
+require "gitlab"
+
+module GitlabBranchRename
+  class Operation
+    def initialize(configuration, logger)
+      @configuration = configuration
+      @logger = logger
+    end
+
+    def execute
+      projects = Gitlab.projects(min_access_level: @configuration.minimum_access_level,
+                                 owned: true,
+                                 per_page: 5)
+      projects.auto_paginate do |project|
+        @logger.info("Evaluating #{project.path_with_namespace}")
+
+        # Verify this project meets criteria for renaming
+        unless @configuration.has_visibility.include?(project.visibility)
+          @logger.debug("Project has visibility #{project.visibility}, skipping")
+          next
+        end
+        if project.archived
+          @logger.debug("Project is archived")
+          next
+        end
+
+        # Feature: Skip forks?
+
+        # Skip projects you don"t have proper permission to change
+        # Verify it meets your criteria for renaming default branch
+        if @configuration.is_default_branch and project.default_branch != @configuration.branch_to_rename
+          @logger.debug("Project default branch does not match is_default_branch criteria")
+          next
+        end
+
+        # Feature: verify new branch doesn't already exist
+
+        # Verify new branch doesn't exist already
+        begin
+          Gitlab.branch(project.id, @configuration.new_branch_name)
+          @logger.debug("Destination branch #{@configuration.new_branch_name} already exists")
+          next
+        rescue Gitlab::Error::NotFound => e
+          @logger.debug("Destination branch #{@configuration.new_branch_name} does not exist yet")
+        end
+
+        # Save branch protection parameters
+        old_branch = begin
+                       Gitlab.branch(project.id, @configuration.branch_to_rename)
+                     rescue Gitlab::Error::NotFound => e
+                       @logger.warn("Project #{project.path_with_namespace} doesn't have branch #{@configuration.branch_to_rename}")
+                       next
+                     end
+        branch_protection_parameters = nil
+        if old_branch.protected
+          # Save branch protection information
+          bpp_raw = Gitlab.protected_branch(project.id, old_branch.name)
+          bpp_hash = bpp_raw.to_hash
+          branch_protection_parameters = bpp_hash.slice("push_access_levels", "merge_access_levels", "unprotect_access_levels", "code_owner_approval_required")
+          @logger.debug("Will transfer branch protection parameters: #{branch_protection_parameters}")
+        end
+
+        # Confirm or pretend
+        msg = "Rename #{project.path_with_namespace} branch #{@configuration.branch_to_rename} to #{@configuration.new_branch_name} " +
+            (branch_protection_parameters ? "with" : "without") + " protection"
+        if @configuration.pretend
+          puts(msg)
+          @logger.info(msg)
+          next
+        end
+        unless @configuration.skip_confirm
+          puts(msg)
+          print("\tContinue with rename and delete? (y/N) ")
+          input = gets.chomp
+          if input != "y"
+            msg = "Skipping branch rename for #{project.path_with_namespace} based on user input #{input}"
+            puts(msg)
+            @logger.info(msg)
+            next
+          end
+          @logger.info("User confirmed branch rename for #{project.path_with_namespace}")
+        end
+
+        # Create new branch
+        begin
+          Gitlab.create_branch(project.id, @configuration.new_branch_name, old_branch.name)
+          @logger.debug("Created new branch with name #{@configuration.new_branch_name}")
+        rescue StandardError => e
+          @logger.error(e)
+          next
+        end
+
+        # Protect branch
+        unless branch_protection_parameters
+          begin
+            Gitlab.protect_branch(project.id, @configuration.new_branch_name, branch_protection_parameters)
+            @logger.debug("Protected branch with parameters #{branch_protection_parameters}")
+          rescue StandardError => e
+            @logger.error(e)
+          end
+        end
+
+        # Feature: Update PRs? Issues?
+
+        # Change default branch
+        begin
+          Gitlab.edit_project(project.id, {default_branch: @configuration.new_branch_name})
+          @logger.debug("Changed default branch")
+        rescue StandardError => e
+          @logger.error(e)
+        end
+
+        # Unprotect protected branches
+        unless branch_protection_parameters
+          begin
+            Gitlab.unprotect_branch(project.id, old_branch.name)
+            @logger.debug("Unprotected old branch")
+          rescue StandardError => e
+            @logger.error(e)
+          end
+        end
+
+        # Delete master branch
+        begin
+          Gitlab.delete_branch(project.id, old_branch.name)
+          @logger.debug("Deleted old branch")
+        rescue StandardError => e
+          @logger.error(e)
+        end
+      end
+    end
+  end
+end

data/lib/{version.rb → gitlab_branch_rename/version.rb}

@@ -1,3 +1,3 @@
 module GitlabBranchRename
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-branch-rename
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - AP Fritts
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2020-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -25,9 +25,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.16'
 description: 'To support Black Lives Matter and try to create safer spaces, I wanted
-  to renameall of my own default branches in Gitlab. I wasn''t able to find any tools
+  to rename all of my own default branches in Gitlab. I wasn''t able to find any tools
   to do that, so I wrote this one. If you''re unsure why this is important or want
-  to better understand my personal understandingof why I wanted to make these changes,
+  to better understand my personal understanding of why I wanted to make these changes,
   see this Twitter thread: https://twitter.com/mislav/status/1270388510684598272'
 email:
 - ap@apfritts.com
@@ -44,15 +44,20 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - exe/gitlab-branch-rename
 - gitlab-branch-rename.gemspec
-- lib/rename.rb
-- lib/version.rb
-- rename.rb
+- gitlab-branch-rename.gemspec.lock
+- lib/gitlab_branch_rename/configuration.rb
+- lib/gitlab_branch_rename/gitlab_configure.rb
+- lib/gitlab_branch_rename/logger_configure.rb
+- lib/gitlab_branch_rename/main.rb
+- lib/gitlab_branch_rename/operation.rb
+- lib/gitlab_branch_rename/version.rb
 homepage: https://gitlab.com/apfritts/gitlab-branch-rename
 licenses:
 - MIT

data/lib/rename.rb

@@ -1,9 +0,0 @@
-require "version"
-
-module GitlabBranchRename
-  class Error < StandardError; end
-
-  def main
-    puts "hi"
-  end
-end

data/rename.rb

@@ -1,153 +0,0 @@
-require "gitlab"
-
-ACCESS_LEVEL_MAINTAINER = 40
-
-puts("Create a Gitlab API key at https://gitlab.com/profile/personal_access_tokens")
-
-default_endpoint = "https://gitlab.com/api/v4"
-options = {
-    # Required parameters
-    endpoint: default_endpoint,
-    token: ENV["GITLAB_ACCESS_TOKEN"],
-    branch_to_rename: "master",
-    new_branch_name: "trunk",
-
-    # Criteria parameters with defaults
-    is_default_branch: true,
-    has_visibility: %w[private internal public],
-
-    # Optional parameters
-    confirm: true,
-    pretend: false,
-}
-
-logfile = "/tmp/gitlab-branch-rename.log"
-
-logger = Logger.new(STDOUT)
-logger.formatter = proc do |severity, datetime, progname, msg|
-  date_format = datetime.to_datetime.strftime("%Q")
-  if severity == "INFO" or severity == "WARN"
-    "#{severity}  #{date_format} #{msg}\n"
-  else
-    "#{severity} #{date_format} #{msg}\n"
-  end
-end
-
-Gitlab.endpoint = options[:endpoint]
-Gitlab.private_token = options[:token]
-
-#Gitlab.http_proxy("proxyhost", 8888)
-#Gitlab.http_proxy("proxyhost", 8888, "proxyuser", "strongpasswordhere")
-#ENV["GITLAB_API_HTTPARTY_OPTIONS"] = "{read_timeout: 60}"
-
-logger.info("Starting run with options: #{options}")
-
-# loop through all projects
-projects = Gitlab.projects(min_access_level: ACCESS_LEVEL_MAINTAINER,
-                           owned: true,
-                           per_page: 5)
-projects.auto_paginate do |project|
-  logger.info("Evaluating #{project.path_with_namespace}")
-  # Verify this project meets criteria for renaming
-  unless options[:has_visibility].include?(project.visibility)
-    logger.debug("Project has visibility #{project.visibility}, skipping")
-    next
-  end
-  if project.archived
-    logger.debug("Project is archived")
-    next
-  end
-  # Feature: Skip forks?
-  # Skip projects you don"t have proper permission to change
-  # Verify it meets your criteria for renaming default branch
-  if options[:is_default_branch] and project.default_branch != options[:branch_to_rename]
-    logger.debug("Project default branch does not match is_default_branch criteria")
-    next
-  end
-  # Feature: verify new branch doesn't already exist
-  begin
-    Gitlab.branch(project.id, options[:new_branch_name])
-    logger.debug("Destination branch #{options[:new_branch_name]} already exists")
-    next
-  rescue Gitlab::Error::NotFound => e
-    logger.debug("Destination branch #{options[:new_branch_name]} does not exist yet")
-  end
-  # Save branch protection parameters
-  old_branch = Gitlab.branch(project.id, options[:branch_to_rename])
-  branch_protection_parameters = nil
-  if old_branch.protected
-    # Save branch protection information
-    bpp_raw = Gitlab.protected_branch(project.id, old_branch.name)
-    bpp_hash = bpp_raw.to_hash
-    branch_protection_parameters = bpp_hash.slice("push_access_levels", "merge_access_levels", "unprotect_access_levels", "code_owner_approval_required")
-    logger.debug("Will transfer branch protection parameters: #{branch_protection_parameters}")
-  end
-  msg = "Rename #{project.path_with_namespace} branch #{options[:branch_to_rename]} to #{options[:new_branch_name]} " +
-      (branch_protection_parameters ? "with" : "without") + " protection"
-  if options[:pretend]
-    puts(msg)
-    logger.info(msg)
-    next
-  elsif options[:confirm]
-    puts(msg)
-    print("\tContinue with branch? (y/N) ")
-    input = gets.chomp
-    if input != "y"
-      msg = "Skipping branch rename for #{project.path_with_namespace} based on user input #{input}"
-      puts(msg)
-      logger.info(msg)
-      next
-    end
-    logger.info("User confirmed branch rename for #{project.path_with_namespace}")
-  end
-  # Create new branch
-  begin
-    new_branch = Gitlab.create_branch(project.id, options[:new_branch_name], old_branch.name)
-    logger.debug("Created new branch with name options[:new_branch_name]")
-  rescue StandardError => e
-    logger.error(e)
-    next
-  end
-  # Protect branch
-  unless branch_protection_parameters
-    begin
-      Gitlab.protect_branch(project.id, options[:new_branch_name], branch_protection_parameters)
-      logger.debug("Protected branch with parameters #{branch_protection_parameters}")
-    rescue StandardError => e
-      logger.error(e)
-    end
-  end
-  # Feature: Update PRs? Issues?
-  # Change default branch
-  begin
-    Gitlab.edit_project(project.id, {default_branch: options[:new_branch_name]})
-    logger.debug("Changed default branch")
-  rescue StandardError => e
-    logger.error(e)
-  end
-
-  # Unprotect protected branches
-  unless branch_protection_parameters
-    begin
-      Gitlab.unprotect_branch(project.id, old_branch.name)
-      logger.debug("Unprotected old branch")
-    rescue StandardError => e
-      logger.error(e)
-    end
-  end
-
-  # Delete master branch
-  begin
-    Gitlab.delete_branch(project.id, old_branch.name)
-    logger.debug("Deleted old branch")
-  rescue StandardError => e
-    logger.error(e)
-  end
-end
-
-puts "For any local repositories, use these commands to update:"
-puts "    git fetch `git remote` --prune"
-puts "    git checkout #{options[:new_branch_name]}"
-puts "    git remote set-head `git remote` #{options[:new_branch_name]}"
-puts "    git branch -d #{options[:branch_to_rename]}"
-logger.close