m-git 2.5.4

data/lib/m-git/command/rebase.rb

@@ -0,0 +1,348 @@
+#coding=utf-8
+
+module MGit
+
+  # @!scope 类似 git rebase
+  #
+  class Rebase < BaseCommand
+
+    PROGRESS_STAGE = {
+      :new_start          => 0,
+      :did_pull_config    => 1,
+      :did_refresh_config => 2,
+      :did_pull_sub       => 3
+    }.freeze
+    PROGRESS_STAGE_KEY = 'progress_stage'
+
+    PROGRESS_AUTO = 'auto_exec'
+
+    OPT_LIST = {
+      :pull      => '--pull'
+    }.freeze
+
+    def options
+      [
+          ARGV::Opt.new(OPT_LIST[:pull], info:'可选参数，指定后在合并仓库前会拉取远程分支更新代码，如："mgit rabase --pull"。', type: :boolean)
+      ].concat(super)
+    end
+
+    def execute(argv)
+      return if do_abort(argv)
+
+      check_master_rebase(argv)
+      Workspace.check_branch_consistency
+
+      Output.puts_start_cmd
+
+      config_repo = generate_config_repo
+
+      if mgit_try_to_continue?
+        # 不处于中间态禁止执行
+        Foundation.help!("当前并不处于操作中间态，无法进行continue操作！") if !OperationProgressManager.is_in_progress?(Workspace.root, __progress_type)
+
+        # 读取指令缓存失败禁止执行
+        context, _ = OperationProgressManager.load_context(Workspace.root, __progress_type)
+        Foundation.help!("缓存指令读取失败，continue无法继续进行，请重新执行完整指令。") if context.nil? || !context.validate?
+
+        # 分支不匹配禁止执行
+        Foundation.help!("当前主仓库所在分支跟上次操作时所在分支(#{context.branch})不一致，请切换后重试。") if config_repo.status_checker.current_branch(use_cache:true) != context.branch
+
+        if !context.repos.nil?
+          Output.puts_processing_message("加载上次即将操作的子仓库...")
+          Workspace.update_all_repos(context.repos)
+        end
+
+        cmd = context.cmd
+        opts = context.opts
+        config_error = continue_execute(cmd, opts, config_repo, context.other[PROGRESS_STAGE_KEY], context.other[PROGRESS_AUTO])
+        if config_error
+          Output.puts_fail_block([config_repo.name], "主仓库操作失败：#{config_error}")
+          return
+        end
+      else
+        # 处于中间态则提示
+        if OperationProgressManager.is_in_progress?(Workspace.root, __progress_type)
+          if Output.continue_with_user_remind?("当前处于操作中间态，建议取消操作并执行\"mgit merge --continue\"继续操作未完成仓库。\n    继续执行将清除中间态并重新操作所有仓库，是否取消？")
+            Output.puts_cancel_message
+            return
+          end
+        end
+
+        cmd = argv.cmd
+        opts = argv.git_opts
+
+        # 优先操作配置仓库
+        config_error = rebase_config_repo(cmd, opts, config_repo, argv.opt_list.did_set_opt?(OPT_LIST[:pull]))
+        if config_error
+          Output.puts_fail_block([config_repo.name], "主仓库操作失败：#{config_error}")
+          return
+        end
+      end
+
+      do_repos = []
+      dirty_repos = []
+      detached_repos = []
+      no_tracking_repos = []
+
+      Output.puts_processing_message("检查各仓库状态...")
+      Workspace.serial_enumerate_with_progress(all_repos) { |repo|
+        next if !config_repo.nil? && repo.name == config_repo.name
+
+        status = repo.status_checker.status
+        branch_status = repo.status_checker.branch_status
+
+        if status == Repo::Status::GIT_REPO_STATUS[:clean] &&
+          branch_status != Repo::Status::GIT_BRANCH_STATUS[:detached] &&
+          branch_status != Repo::Status::GIT_BRANCH_STATUS[:no_tracking]
+          do_repos.push(repo)
+        else
+          if status == Repo::Status::GIT_REPO_STATUS[:dirty]
+            dirty_repos.push(repo)
+          end
+          if branch_status == Repo::Status::GIT_BRANCH_STATUS[:detached]
+            detached_repos.push(repo)
+          elsif branch_status == Repo::Status::GIT_BRANCH_STATUS[:no_tracking]
+            no_tracking_repos.push(repo)
+          end
+        end
+      }
+      Output.puts_success_message("检查完成！\n")
+
+      if dirty_repos.length > 0 || no_tracking_repos.length > 0 || detached_repos.length > 0
+        remind_repos = []
+        remind_repos.push(['有本地改动', dirty_repos.map { |e| e.name }])
+        remind_repos.push(['未追踪远程分支(建议:mgit branch -u origin/<branch>)', no_tracking_repos.map { |e| e.name }]) if no_tracking_repos.length > 0
+        remind_repos.push(['HEAD游离,当前不在任何分支上', detached_repos.map { |e| e.name }]) if detached_repos.length > 0
+        Output.interact_with_multi_selection_combined_repos(remind_repos, "以上仓库状态异常", ['a: 跳过并继续', 'b: 强制执行', 'c: 终止']) { |input|
+          if input == 'b'
+            do_repos += dirty_repos
+            do_repos += detached_repos
+            do_repos += no_tracking_repos
+            do_repos.uniq! { |repo| repo.name }
+          elsif input == 'c' || input != 'a'
+            Output.puts_cancel_message
+            return
+          end
+        }
+      end
+
+      if do_repos.length == 0
+        Output.puts_remind_message("没有仓库需要执行rebase指令！") if config_repo.nil?
+      else
+        Output.puts_processing_message("开始rebase子仓库...")
+        _, error_repos = Workspace.execute_git_cmd_with_repos(cmd, opts, do_repos)
+      end
+
+      Output.puts_succeed_cmd("#{cmd} #{opts}") if config_error.nil? || error_repos.empty?
+
+      # 清除中间态
+      OperationProgressManager.remove_progress(Workspace.root, __progress_type)
+    end
+
+    # 合并主仓库
+    #
+    # @param cmd [String] 合并指令
+    #
+    # @param opts [String] 合并参数
+    #
+    # @param repo [Repo] 配置仓库对象
+    #
+    # @param exec_repos [Array<Repo>] 本次操作的所有仓库（含配置仓库）
+    #
+    def rebase_config_repo(cmd, opts, repo, auto_update)
+      return if repo.nil?
+      branch_status = repo.status_checker.branch_status
+      if branch_status == Repo::Status::GIT_BRANCH_STATUS[:detached]
+        remind_config_repo_fail("主仓库\"#{repo.name}\"HEAD游离，当前不在任何分支上，无法执行!")
+      elsif branch_status == Repo::Status::GIT_BRANCH_STATUS[:no_tracking]
+        remind_config_repo_fail("主仓库\"#{repo.name}\"未跟踪对应远程分支，无法执行！(需要执行'mgit branch -u origin/<branch>')")
+      elsif repo.status_checker.status == Repo::Status::GIT_REPO_STATUS[:dirty]
+        remind_config_repo_fail("主仓库\"#{repo.name}\"有改动，无法执行\"#{cmd}\"!")
+      else
+        return continue_execute(cmd, opts, repo, PROGRESS_STAGE[:new_start], auto_update)
+      end
+    end
+
+    def continue_execute(cmd, opts, repo, check_point, auto_update)
+
+      # 现场信息
+      exec_subrepos = all_repos(except_config:true)
+      is_all = Workspace.is_all_exec_sub_repos?(exec_subrepos)
+      context = OperationProgressContext.new(__progress_type)
+      context.cmd = cmd
+      context.opts = opts
+      context.repos = is_all ? nil : exec_subrepos.map { |e| e.name } # nil表示操作所有子仓库
+      context.branch = repo.status_checker.current_branch(use_cache:true)
+
+      # 更新主仓库
+      update_config_repo(repo, context, auto_update) if check_point < PROGRESS_STAGE[:did_pull_config]
+
+      if check_point < PROGRESS_STAGE[:did_refresh_config]
+        # 操作主仓库
+        config_error = exec_config_repo(repo, cmd, opts)
+        return config_error if config_error
+        # 更新配置表
+        refresh_config(repo, context, auto_update)
+      end
+
+      if check_point < PROGRESS_STAGE[:did_pull_sub]
+        # 如果本次操作所有子仓库，则再次获取所有子仓库（因为配置表可能已经更新，子仓库列表也有更新，此处获取的仓库包含：已有的子仓库 + 合并后新下载仓库 + 从缓存弹出的仓库）
+        exec_subrepos = all_repos(except_config:true) if context.repos.nil?
+        # 更新子仓库
+        update_subrepos(exec_subrepos, context, auto_update)
+      end
+
+      config_error
+    end
+
+    def update_config_repo(repo, context, auto)
+      if auto || Output.continue_with_user_remind?("即将合并主仓库，是否先拉取远程代码更新？")
+        Output.puts_processing_message("正在更新主仓库...")
+        success, output = repo.execute_git_cmd('pull', '')
+        if !success
+          context.other = {
+            PROGRESS_STAGE_KEY => PROGRESS_STAGE[:did_pull_config],
+            PROGRESS_AUTO => auto
+          }
+          OperationProgressManager.trap_into_progress(Workspace.root, context)
+          show_progress_error("主仓库更新失败", "#{output}")
+        else
+          Output.puts_success_message("更新成功！\n")
+        end
+      end
+    end
+
+    def exec_config_repo(repo, cmd, opts)
+      error = nil
+      Output.puts_processing_message("开始操作主仓库...")
+      success, output = repo.execute_git_cmd(cmd, opts)
+      if success
+        Output.puts_success_message("操作成功！\n")
+      else
+        Output.puts_fail_message("操作失败！\n")
+        error = output
+      end
+      error
+    end
+
+    # 刷新配置表
+    def refresh_config(repo, context, auto)
+      begin
+        Workspace.update_config(strict_mode:false) { |missing_repos|
+          if missing_repos.length > 0
+            # 这里分支引导仅根据主仓库来进行，如果使用all_repos来作为引导
+            # 基准，可能不准确(因为all_repos可能包含merge分支已有的本地
+            # 仓库，而这些仓库所在分支可能五花八门，数量也可能多于处于正确
+            # 分支的仓库)。
+            success_missing_repos = Workspace.guide_to_checkout_branch(missing_repos, [repo], append_message:"拒绝该操作本次执行将忽略以上仓库")
+            all_repos.concat(success_missing_repos)
+            # success_missing_repos包含新下载的和当前分支已有的新仓库，其中已有仓库包含在@all_repos内，需要去重
+            all_repos.uniq! { |repo| repo.name }
+          end
+        }
+        refresh_context(context)
+      rescue Error => e
+        if e.type == MGIT_ERROR_TYPE[:config_generate_error]
+          context.other = {
+            PROGRESS_STAGE_KEY => PROGRESS_STAGE[:did_refresh_config],
+            PROGRESS_AUTO => auto
+          }
+
+          OperationProgressManager.trap_into_progress(Workspace.root, context)
+          show_progress_error("配置表生成失败", "#{e.msg}")
+        end
+      end
+    end
+
+    def update_subrepos(subrepos, context, auto)
+      if auto || Output.continue_with_user_remind?("即将合并子仓库，是否先拉取远程代码更新？")
+        Output.puts_processing_message("正在更新子仓库...")
+        _, error_repos = Workspace.execute_git_cmd_with_repos('pull', '', subrepos)
+        if error_repos.length > 0
+          context.other = {
+            PROGRESS_STAGE_KEY => PROGRESS_STAGE[:did_pull_sub],
+            PROGRESS_AUTO => auto
+          }
+          OperationProgressManager.trap_into_progress(Workspace.root, context)
+          show_progress_error("子仓库更新失败", "见上述输出")
+        else
+          Output.puts_success_message("更新成功！\n")
+        end
+      end
+    end
+
+    def refresh_context(context)
+      exec_subrepos = all_repos(except_config:true)
+      is_all = Workspace.is_all_exec_sub_repos?(exec_subrepos)
+      context.repos = is_all ? nil : exec_subrepos.map { |e| e.name } # nil表示操作所有子仓库
+    end
+
+    def remind_config_repo_fail(msg)
+      Output.puts_fail_message(msg)
+      return if Output.continue_with_user_remind?("是否继续操作其余仓库？")
+      Output.puts_cancel_message
+      exit
+    end
+
+    def check_master_rebase(argv)
+      opt_arr = argv.git_opts(raw:false)
+      opt_arr.each { |opts|
+        Foundation.help!("当前版本不支持\"-i\"或\"--interactive\"参数，请重试。") if ['-i','--interactive'].include?(opts.first)
+      }
+    end
+
+    def do_abort(argv)
+      return false unless argv.git_opts.include?('--abort')
+      Output.puts_start_cmd
+      OperationProgressManager.remove_progress(Workspace.root, __progress_type)
+      do_repos = all_repos.select { |repo| repo.status_checker.is_in_rebase_progress? }
+
+      if do_repos.length > 0
+        append_message = "，另有#{all_repos.length - do_repos.length}个仓库无须操作" if do_repos.length < all_repos.length
+        Output.puts_processing_block(do_repos.map { |e| e.name }, "开始操作以上仓库#{append_message}...")
+        _, error_repos = Workspace.execute_git_cmd_with_repos(argv.cmd, argv.git_opts, do_repos)
+        Output.puts_succeed_cmd(argv.absolute_cmd) if error_repos.length == 0
+      else
+        Output.puts_success_message("没有仓库需要操作！")
+      end
+
+      true
+    end
+
+    def show_progress_error(summary, detail)
+      error = "#{summary} 已进入操作中间态。
+
+原因：
+  #{detail}
+
+可选：
+  - 使用\"mgit rebase --continue\"继续变基。
+  - 使用\"mgit rebase --abort\"取消变基。"
+      Foundation.help!(error, title:'暂停')
+    end
+
+    def enable_repo_selection
+      true
+    end
+
+    def enable_continue_operation
+      true
+    end
+
+    def self.description
+      "重新将提交应用到其他基点，该命令不执行lock的仓库。"
+    end
+
+    def self.usage
+      "mgit rebase [<git-rebase-option>] [(--mrepo|--el-mrepo) <repo>...] [--help]\nmgit rebase --continue\nmgit rebase --abort"
+    end
+
+    private
+
+    def __progress_type
+      OperationProgressManager::PROGRESS_TYPE[:rebase]
+    end
+
+  end
+
+end

data/lib/m-git/command/reset.rb

@@ -0,0 +1,31 @@
+#coding=utf-8
+
+module MGit
+
+  # @!scope 类似 git reset
+  #
+  class Reset < BaseCommand
+
+    def execute(argv)
+      Workspace.check_branch_consistency
+
+      Output.puts_start_cmd
+      _, error_repos = Workspace.execute_git_cmd_with_repos(argv.cmd, argv.git_opts, all_repos)
+      Output.puts_succeed_cmd(argv.absolute_cmd) if error_repos.length == 0
+    end
+
+    def enable_repo_selection
+      true
+    end
+
+    def self.description
+      "将当前HEAD指针还原到指定状态。"
+    end
+
+    def self.usage
+      "mgit reset [<git-reset-option>] [(--mrepo|--el-mrepo) <repo>...] [--help]"
+    end
+
+  end
+
+end

data/lib/m-git/command/self.rb

@@ -0,0 +1,223 @@
+#coding=utf-8
+
+module MGit
+
+  # 该指令用于不带指令的输入：mgit --help，用于执行mgit的一级参数（如"mgit --help"的"--help"）
+  #
+  class Self < BaseCommand
+
+    HELP_INTRODUCTION = <<INTRO
+#{Output.info_title("Description:")}
+
+     mgit是多仓库管理工具，通过将git指令作用到多个仓库，实现批量的版本管理功能
+
+     更多介绍：https://github.com/baidu/mgit
+
+INTRO
+
+    OPT_LIST = {
+      :all            =>  '--all',
+      :all_s          =>  '-a',
+      :list           =>  '--list',
+      :list_s         =>  '-l',
+      :size           =>  '--size',
+      :size_s         =>  '-s',
+      :version        =>  '--version',
+      :version_s      =>  '-v',
+      :workspace      =>  '--workspace',
+      :workspace_s    =>  '-w'
+    }.freeze
+
+    def options
+      return [
+          ARGV::Opt.new(OPT_LIST[:list], short_key:OPT_LIST[:list_s], info:"显示MGit管理的仓库。", type: :boolean),
+          ARGV::Opt.new(OPT_LIST[:size], short_key:OPT_LIST[:size_s], info:"显示MGit管理的仓库的磁盘占用量。", type: :boolean),
+          ARGV::Opt.new(OPT_LIST[:all], short_key:OPT_LIST[:all_s], info:"指定操作所有定义在manifest内的仓库，可配合-l合并使用: \"mgit -al\"。", type: :boolean),
+          ARGV::Opt.new(OPT_LIST[:version], short_key:OPT_LIST[:version_s], info:"显示当前MGit版本。", type: :boolean),
+          ARGV::Opt.new(OPT_LIST[:workspace], short_key:OPT_LIST[:workspace_s], info:"显示当前MGit工程管理根目录(.mgit所在目录)。", type: :boolean)
+      ].concat(super)
+    end
+
+    def validate(argv)
+      Foundation.help!("输入非法参数：#{argv.git_opts}。请通过\"mgit --help\"查看用法。") if argv.git_opts.length > 0
+    end
+
+    def prepare
+      Workspace.setup_multi_repo_root
+      Workspace.setup_config
+    end
+
+    # --- 覆写，不需要预设操作 ---
+    def pre_exec
+    end
+
+    def post_exec
+    end
+
+    def usage(argv)
+      show_help(argv)
+    end
+    # -------------------------
+
+    def execute(argv)
+      # 如果存在多余（透传）指令则报错
+      extra_opt_str = argv.git_opts
+      if extra_opt_str.length > 0
+        Output.puts_fail_message("输入无效参数：#{extra_opt_str}\n")
+        show_help(argv)
+        exit
+      end
+
+      argv.enumerate_valid_opts { |opt|
+        if opt.key == OPT_LIST[:list] || opt.key == OPT_LIST[:list_s]
+          show_all_repos(argv)
+          return
+        elsif opt.key == OPT_LIST[:size] || opt.key == OPT_LIST[:size_s]
+          show_repo_size
+          return
+        elsif opt.key == OPT_LIST[:version] || opt.key == OPT_LIST[:version_s]
+          show_version
+          return
+        elsif opt.key == OPT_LIST[:workspace] || opt.key == OPT_LIST[:workspace_s]
+          show_workspace
+          return
+        end
+      }
+
+      # 无任何参数传入时显示帮助
+      show_help(argv)
+    end
+
+    def show_help(argv)
+      head_space = '    '
+      middle_space = '   '
+
+      output =  HELP_INTRODUCTION # "#{Output.info_title("Description:")}\n\n#{head_space}mgit是多仓库管理工具，通过将git指令作用到多个仓库，实现批量的版本管理功能。"
+      output += "#{Output.info_title("Usage:")}\n\n#{head_space}$ #{Output.green_message("mgit <mgit_options>")}\n"
+      output += "#{head_space}$ #{Output.green_message("mgit <command> [<command_option>...] [<value>...]")}\n\n"
+
+      # mgit options
+      output += "#{Output.info_title("MGit Option:")}\n\n"
+      divider = ", "
+      longest_opt = argv.opt_list.opts.max_by { |e| "#{Output.blue_message("#{e.key}#{divider + e.short_key if !e.short_key.nil?}")}".length }
+      max_opt_length = "#{longest_opt.short_key + divider + longest_opt.key}".length
+      mgit_option_info = ''
+      argv.opt_list.opts.each { |opt|
+        key = "#{opt.short_key + divider + opt.key}"
+        mgit_option_info += "#{head_space}#{Output.blue_message(key)}#{' ' * (max_opt_length - key.length + middle_space.length)}#{argv.info(opt.key)}\n"
+      }
+      output += mgit_option_info + "\n"
+
+      # subcommand
+      output += "#{Output.info_title("Command:")}\n\n"
+      cmd_header = '+ '
+      cmd_info = ''
+
+      max_cmd_length = Output.blue_message(cmd_header + CommandManager.commands.keys.max_by { |e| e.length }.to_s).length
+      CommandManager.commands.keys.sort.each { |cmd_name|
+        next if cmd_name == self.class.cmd
+        cls_name = CommandManager.commands[cmd_name]
+        cmd_name = Output.green_message(cmd_header + cmd_name.downcase.to_s)
+        cmd_info += "#{head_space}#{cmd_name}#{' ' * (max_cmd_length - cmd_name.length + middle_space.length)}#{cls_name.description}\n"
+      }
+      output += cmd_info + "\n"
+      output += "#{Output.info_title("Command Option:")}\n\n#{head_space}请通过[ mgit <command> --help ]查看。\n\n"
+      output += "#{Output.info_title("Version:")}\n\n#{head_space}#{MGit::VERSION}\n"
+
+      puts output
+    end
+
+    def show_all_repos(argv)
+      prepare
+
+      list_all = argv.opt_list.did_set_opt?(OPT_LIST[:all])
+      existing_repos, missing_repos = prepare_repos(with_excluded:list_all)
+
+      list = {}
+      if existing_repos.length > 0
+        existing_repos.sort_by { |e| e.name }.each { |light_repo|
+          dir = File.join("<ROOT>", File.dirname(light_repo.path)).bold
+          list[dir] = [] if list[dir].nil?
+          list[dir].push(light_repo.name)
+        }
+      end
+
+      if missing_repos.length > 0
+        list['本地缺失'.bold] = missing_repos.sort_by { |e| e.name }.map { |e| e.name }
+      end
+
+      list_array = []
+      list.each { |dir, list|
+        list_array.push([dir.bold, list])
+      }
+
+      puts Output.generate_table_combination(list_array, separator:'|')
+      if list_all
+        message = "共统计#{existing_repos.length + missing_repos.length}个仓库。"
+      else
+        message = "mgit目前共管理#{existing_repos.length + missing_repos.length}个仓库。"
+      end
+      Output.puts_remind_message(message)
+      Output.puts_fail_message("有#{missing_repos.length}个仓库本地缺失!") if missing_repos.length > 0
+    end
+
+    def show_repo_size
+      prepare
+      Workspace.setup_all_repos
+      Output.puts_processing_message("开始计算...")
+      repo_size = {}
+      mutex = Mutex.new
+      task_count = 0
+      Output.update_progress(all_repos.length, task_count)
+      Workspace.concurrent_enumerate(all_repos) { |repo|
+        success, output = repo.execute("du -sh #{repo.path}")
+        mutex.lock
+        if success
+          repo_size[repo.name] = output&.strip
+        end
+        task_count += 1
+        Output.update_progress(all_repos.length, task_count)
+        mutex.unlock
+      }
+      Output.puts_success_message("计算完成。")
+
+      display_size = repo_size.sort_by { |k,v| k}.map { |e| e.last }
+      Output.puts_remind_block(display_size, "共统计#{repo_size.length}个仓库。")
+    end
+
+    def prepare_repos(with_excluded:false)
+      existing_repos = []
+      missing_repos = []
+      Workspace.config.light_repos.each { |light_repo|
+        if with_excluded || !light_repo.mgit_excluded
+          repo_exist = Repo.is_git_repo?(light_repo.abs_dest(Workspace.root))
+          if repo_exist
+            existing_repos.push(light_repo)
+          else
+            missing_repos.push(light_repo)
+          end
+        end
+      }
+      return existing_repos, missing_repos
+    end
+
+    def show_workspace
+      root = Workspace.multi_repo_root_path
+      if root.nil?
+        Output.puts_fail_message("当前不在任何多仓库目录下！")
+      else
+        puts root
+      end
+    end
+
+    def show_version
+      puts MGit::VERSION
+    end
+
+    def enable_short_basic_option
+      return true
+    end
+
+  end
+
+end