Unified Backup: Update gitlab-backup-cli to have custom process title

bin/gitlab-backup-cli

@@ -11,4 +11,4 @@ GITLAB_PATH = File.expand_path('../', __dir__)
 require_relative '../config/boot'
 require 'gitlab/backup/cli'
 
-Gitlab::Backup::Cli::Runner.start(ARGV)
+Gitlab::Backup::Cli.start(ARGV)

gems/gitlab-backup-cli/lib/gitlab/backup/cli.rb

@@ -29,6 +29,21 @@ module Cli
 
       Error = Class.new(StandardError)
 
+      # Entrypoint for the application
+      # Run any initialization logic from here
+      def self.start(argv)
+        # Set a custom process name
+        update_process_title!
+
+        Gitlab::Backup::Cli::Runner.start(argv)
+      end
+
+      def self.update_process_title!(status_message = nil)
+        process_title = status_message ? "gitlab-backup-cli: #{status_message}" : "gitlab-backup-cli"
+
+        Process.setproctitle(process_title)
+      end
+
       def self.rails_environment!
         require File.join(GITLAB_PATH, 'config/application')
 

gems/gitlab-backup-cli/lib/gitlab/backup/cli/commands/backup_subcommand.rb

@@ -28,6 +28,8 @@ class BackupSubcommand < Command
 
           desc 'all', 'Creates a backup including repositories, database and local files'
           def all
+            Gitlab::Backup::Cli.update_process_title!('backup all')
+
             duration = measure_duration do
               Gitlab::Backup::Cli::Output.info("Initializing environment...")
               Gitlab::Backup::Cli.rails_environment!

gems/gitlab-backup-cli/lib/gitlab/backup/cli/commands/restore_subcommand.rb

@@ -9,6 +9,8 @@ class RestoreSubcommand < Command
 
           desc 'all BACKUP_ID', 'Restores a backup including repositories, database and local files'
           def all(backup_id)
+            Gitlab::Backup::Cli.update_process_title!("restore all from #{backup_id}")
+
             duration = measure_duration do
               Gitlab::Backup::Cli::Output.info("Initializing environment...")
               Gitlab::Backup::Cli.rails_environment!

gems/gitlab-backup-cli/spec/gitlab/backup/cli_spec.rb

 # frozen_string_literal: true
 
 RSpec.describe Gitlab::Backup::Cli do
+  subject(:cli) { described_class }
+
+  around do |example|
+    previous_title = get_process_title
+    example.run
+    Process.setproctitle(previous_title)
+  end
+
   it "has a version number" do
     expect(Gitlab::Backup::Cli::VERSION).not_to be nil
   end
+
+  describe '.start' do
+    it 'sets the process title', :silence_output do
+      cli.start([])
+
+      expect(get_process_title).to eq('gitlab-backup-cli')
+    end
+
+    it 'delegates to Runner.start' do
+      argv = ['version']
+
+      expect(Gitlab::Backup::Cli::Runner).to receive(:start).with(argv)
+
+      cli.start(argv)
+    end
+  end
+
+  describe '.update_process_title!' do
+    context 'without any parameters' do
+      it 'sets a process title to `gitlab-backup-cli`' do
+        cli.update_process_title!
+
+        expect(get_process_title).to eq('gitlab-backup-cli')
+      end
+    end
+
+    context 'with parameters' do
+      it 'sets a process title to `gitlab-backup-cli: ` including provided content' do
+        cli.update_process_title!('context info')
+
+        expect(get_process_title).to eq('gitlab-backup-cli: context info')
+      end
+    end
+  end
+
+  def get_process_title
+    ps = `ps -p #{Process.pid} -o command`
+    ps.split("\n").last.strip
+  end
 end