dtk-client 0.9.1 → 0.10.0

data/lib/command_helpers/git_repo.rb

@@ -1,589 +0,0 @@
-#
-# Copyright (C) 2010-2016 dtk contributors
-#
-# This file is part of the dtk project.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-# This code is predciated on assumption that they is only one local branch (with with documented exceptions)
-# so checkout branch is not done in most cases
-#TODO : make sure all functions that use local_repo_dir( inside pass in full_moudle_name, not just module_name
-require 'fileutils'
-dtk_require("../domain/git_adapter")
-dtk_require("../domain/git_error_handler")
-
-module DTK; module Client; class CommandHelper
-  class GitRepo < self; class << self
-    dtk_require('git_repo/merge')
-                          
-    def create(repo_dir,branch=nil,opts={})
-      GitAdapter.new(repo_dir, branch)
-    end
-
-    def create_clone_from_optional_branch(type, module_name, repo_url, opts={})
-      branch = opts[:branch]
-      version = opts[:version]
-      namespace =  opts[:namespace]
-      create_clone_with_branch(type,module_name,repo_url,branch,version,namespace,{:track_remote_branch => true}.merge(opts))
-    end
-
-    # TODO: should we deprecate below for above, subsituting the body of below for above ?
-    def create_clone_with_branch(type, module_name, repo_url, branch=nil, version=nil, module_namespace=nil, opts={})
-      Response.wrap_helper_actions do
-        full_name = module_namespace ? ModuleUtil.resolve_name(module_name, module_namespace) : module_name
-
-        modules_dir = modules_dir(type,full_name,version,opts)
-        FileUtils.mkdir_p(modules_dir) unless File.directory?(modules_dir)
-
-        target_repo_dir = local_repo_dir(type,full_name,version,opts)
-        if File.exists?(target_repo_dir)
-          # if local copy of module exists then move that module to backups location
-          if opts[:backup_if_exist]
-            backup_dir = backup_dir(type, full_name)
-            FileUtils.mv(target_repo_dir, backup_dir)
-            puts "Backup of existing module directory moved to '#{backup_dir}'"
-          else
-            raise ErrorUsage.new("Directory '#{target_repo_dir}' is not empty; it must be deleted or removed before retrying the command", :log_error => false)
-          end
-        end
-
-        begin
-          opts_clone = (opts[:track_remote_branch] ? {:track_remote_branch => true} : {})
-          GitAdapter.clone(repo_url, target_repo_dir, branch, opts_clone)
-        rescue => e
-          # Handling Git error messages with more user friendly messages
-          e = GitErrorHandler.handle(e)
-
-          #cleanup by deleting directory
-          FileUtils.rm_rf(target_repo_dir) if File.directory?(target_repo_dir)
-          error_msg = "Clone to directory (#{target_repo_dir}) failed"
-
-          DtkLogger.instance.error_pp(e.message, e.backtrace)
-
-          raise ErrorUsage.new(error_msg, :log_error => false)
-        end
-        {"module_directory" => target_repo_dir}
-      end
-    end
-
-    #TODO: this does not push; may make that an option
-    def add_file(repo_obj,path,content,msg=nil)
-      Response.wrap_helper_actions() do
-        ret = Hash.new
-        repo_obj.add_file(path,content)
-        ret["message"] = msg if msg
-        ret
-      end
-    end
-
-    # opts can have the following keys
-    #
-    # :remote_repo
-    # :remote_branch
-    # :remote_repo_url
-    # :local_branch
-    # :override_repo_dir_location
-    # :no_fetch
-    #
-    def push_changes(type, full_module_name, version, opts={})
-      Response.wrap_helper_actions() do
-        repo_dir = opts[:override_repo_dir_location] ? opts[:override_repo_dir_location] : local_repo_dir(type, full_module_name, version, opts)
-        repo = create(repo_dir, opts[:local_branch])
-        push_repo_changes_aux(repo, opts)
-      end
-    end
-
-    def get_diffs(type, module_name, version, opts={})
-      Response.wrap_helper_actions() do
-        repo_dir = local_repo_dir(type,module_name,version)
-        repo = create(repo_dir,opts[:local_branch])
-        get_diffs_aux(repo,opts)
-      end
-    end
-
-    def get_remote_diffs(type, module_name, version, opts={})
-      Response.wrap_helper_actions() do
-        repo_dir = local_repo_dir(type,module_name,version)
-        repo = create(repo_dir,opts[:local_branch])
-        get_remote_diffs_aux(repo,opts)
-      end
-    end
-
-    # opts can have the following keys
-    #
-    # :remote_repo
-    # :remote_branch
-    # :remote_repo_url
-    # :local_branch
-    # :version
-    # :commit_sha
-    # :full_module_name
-    # :namespace
-    # returns:
-    # { :diffs => , :commit_sha => }
-    def pull_changes(type,module_name,opts={})
-      Response.wrap_helper_actions() do
-        full_module_name = full_module_name(module_name,opts)
-        repo_dir = local_repo_dir(type,full_module_name,opts[:version],opts)
-        repo = create(repo_dir,opts[:local_branch])
-        opts.merge!(:full_module_name => full_module_name)
-        response = pull_repo_changes_aux(repo,opts)
-        response
-      end
-    end
-    def pull_changes?(type,module_name,opts={})
-      if local_clone_dir_exists?(type,module_name,opts)
-        pull_changes(type,module_name,opts)
-      else
-        Response.wrap_helper_actions()
-      end
-    end
-
-    def hard_reset_branch_to_sha(type, module_name, opts={})
-      Response.wrap_helper_actions() do
-        full_module_name   = full_module_name(module_name,opts)
-        repo_dir           = local_repo_dir(type, full_module_name, opts[:version], opts)
-        repo               = create(repo_dir, opts[:local_branch])
-        current_branch_sha = opts[:current_branch_sha]
-        repo.reset_hard(current_branch_sha)
-      end
-    end
-
-    # opts can have the following keys
-    #
-    # :version
-    # :full_module_name
-    # :namespace
-    def local_clone_dir_exists?(type,module_name,opts={})
-      full_module_name = full_module_name(module_name,opts)
-      ret = local_repo_dir(type, full_module_name, opts[:version], opts)
-      File.directory?(ret) && ret
-    end
-
-    def full_module_name(module_name,opts)
-      opts[:full_module_name] || ModuleUtil.resolve_name(module_name, opts[:namespace])
-    end
-    private :full_module_name
-
-    def synchronize_clone(type,module_name,commit_sha,opts={})
-      pull_changes?(type,module_name,{:commit_sha => commit_sha}.merge(opts))
-      Response::Ok.new()
-    end
-
-    # if local clone exists remove its .git directory
-    def unlink_local_clone?(type,module_name,version=nil)
-      Response.wrap_helper_actions() do
-        local_repo_dir = local_repo_dir(type,module_name,version)
-        git_dir = "#{local_repo_dir}/.git"
-        if File.directory?(git_dir)
-          FileUtils.rm_rf(git_dir)
-        end
-      end
-    end
-
-    def check_local_dir_exists_with_content(type, module_name, version=nil, module_namespace=nil)
-      full_module_name = ModuleUtil.join_name(module_name, module_namespace)
-      Response.wrap_helper_actions() do
-        ret = Hash.new
-        local_repo_dir = local_repo_dir(type,full_module_name,version)
-
-        unless File.directory?(local_repo_dir)
-          raise ErrorUsage.new("The content for module (#{full_module_name}) should be put in directory (#{local_repo_dir})",:log_error=>false)
-        end
-
-        # transfered this part to initialize_client_clone_and_push because if we remove .git folder and
-        # if create on server fails we will lose this .git folder and will not be able to push local changes to server
-        # if File.directory?("#{local_repo_dir}/.git")
-        #   response =  unlink_local_clone?(type,module_name,version)
-        #   unless response.ok?
-        #     # in case delete went wrong, we raise usage error
-        #     raise ErrorUsage.new("Directory (#{local_repo_dir} is set as a git repo; to continue it must be a non git repo; this can be handled by shell command 'rm -rf #{local_repo_dir}/.git'")
-        #   end
-
-        #   # we return to normal flow, since .git dir is removed
-        # end
-
-        if Dir["#{local_repo_dir}/*"].empty?
-          raise ErrorUsage.new("Directory (#{local_repo_dir}) must have ths initial content for module (#{full_module_name})")
-        end
-        {"module_directory" => local_repo_dir}
-      end
-    end
-
-    def cp_r_to_new_namespace(type, module_name, src_namespace, dest_namespace, version = nil)
-      full_name_src  = ModuleUtil.join_name(module_name, src_namespace)
-      full_name_dest = ModuleUtil.join_name(module_name, dest_namespace)
-
-      local_src_dir  = local_repo_dir(type, full_name_src, version)
-      local_dest_dir = local_repo_dir(type, full_name_dest, version)
-
-      Response.wrap_helper_actions() do
-        if File.directory?(local_src_dir) && !(Dir["#{local_src_dir}/*"].empty?)
-          raise ErrorUsage.new("Directory (#{local_dest_dir}) already exist with content.",:log_error=>false) if File.directory?(local_dest_dir) && !(Dir["#{local_dest_dir}/*"].empty?)
-
-          # create namespace directory if does not exist, and copy source to destination module directory
-          namespace_dir = local_repo_dir(type, dest_namespace, version)
-          FileUtils.mkdir_p(namespace_dir)
-          FileUtils.cp_r(local_src_dir, local_dest_dir)
-        else
-          raise ErrorUsage.new("The content for module (#{full_name_src}) should be put in directory (#{local_src_dir})",:log_error=>false)
-        end
-        {"module_directory" => local_dest_dir}
-      end
-    end
-
-    def create_new_version(type, src_branch, module_name, src_namespace, version, repo_url, opts = {})
-      full_name_src  = ModuleUtil.join_name(module_name, src_namespace)
-      full_name_dest = "#{full_name_src}-#{version}"
-
-      local_src_dir  = local_repo_dir(type, full_name_src)
-      local_dest_dir = local_repo_dir(type, full_name_dest)
-      branch         = "#{src_branch}-v#{version}"
-      exist_already  = false
-
-      if File.directory?(local_src_dir) && !(Dir["#{local_src_dir}/*"].empty?)
-        if File.directory?(local_dest_dir) && !(Dir["#{local_dest_dir}/*"].empty?)
-          # raise ErrorUsage.new("Directory (#{local_dest_dir}) already exist with content.",:log_error=>false)
-          exist_already = true
-        else
-          FileUtils.cp_r(local_src_dir, local_dest_dir)
-        end
-      else
-        raise ErrorUsage.new("The content for module (#{full_name_src}) should be put in directory (#{local_src_dir})",:log_error=>false)
-      end
-
-      unless exist_already
-        Response.wrap_helper_actions() do
-          repo_dir = local_dest_dir
-          remote_branch = local_branch = branch
-          repo = create(repo_dir, branch, :no_initial_commit => true)
-          repo.add_remote(remote(branch), repo_url)
-          repo.checkout(branch, { :new_branch => true })
-          repo.push_with_remote(remote(), remote_branch)
-          repo.delete_branch(src_branch)
-          repo.fetch()
-        end
-      end
-
-      {'module_directory' => local_dest_dir, 'version' => version, 'branch' => branch, 'exist_already' => exist_already}
-    end
-
-    def rename_and_initialize_clone_and_push(type, module_name, new_module_name, branch, repo_url, local_repo_dir, version = nil)
-      # check to see if the new dir has proper naming e.g. (~/dtk/component_modules/dtk::java)
-      unless local_repo_dir.match(/\/#{new_module_name.gsub(ModuleUtil::NAMESPACE_SEPERATOR,'/')}$/)
-        old_dir = local_repo_dir
-        new_dir = local_repo_dir.gsub(/#{module_name}$/, new_module_name.split(ModuleUtil::NAMESPACE_SEPERATOR).join('/'))
-
-        # creates directory if missing
-        parent_path = new_dir.gsub(/(\/\w+)$/,'')
-        FileUtils::mkdir_p(parent_path) unless File.directory?(parent_path)
-        # raise ErrorUsage.new("Destination folder already exists '#{new_dir}', aborting initialization.") if File.directory?(new_dir)
-        if File.directory?(new_dir)
-          # return empty response if user does not want to overwrite current directory
-          return unless Console.confirmation_prompt("Destination directory #{new_dir} exists already. Do you want to overwrite it with content from #{old_dir}"+'?')
-          FileUtils.rm_rf(new_dir)
-        end
-        # FileUtils.mv(old_dir, new_dir)
-        FileUtils.cp_r(old_dir, new_dir)
-      else
-        new_dir = local_repo_dir
-      end
-
-      # Continue push
-      response = initialize_client_clone_and_push(type, new_module_name, branch, repo_url, new_dir, version)
-      return response unless response.ok?
-
-      response.data.merge!(:old_dir => old_dir)
-      response
-    end
-
-    # makes repo_dir (determined from type and module_name) into a git dir, pulls, adds, content and then pushes
-    def initialize_client_clone_and_push(type, module_name, branch, repo_url, local_repo_dir, version=nil)
-      # moved this part from 'check_local_dir_exists_with_content' to this method since this only deletes .git folder
-      # which can cause us problems if import fails
-      if File.directory?("#{local_repo_dir}/.git")
-        response =  unlink_local_clone?(type,module_name,version)
-        unless response.ok?
-          # in case delete went wrong, we raise usage error
-          raise DtkError.new("Directory (#{local_repo_dir} is set as a git repo; to continue it must be a non git repo; this can be handled by shell command 'rm -rf #{local_repo_dir}/.git'")
-        end
-        # we return to normal flow, since .git dir is removed
-      end
-
-      Response.wrap_helper_actions() do
-        ret = Hash.new
-        repo_dir = local_repo_dir(type,module_name)
-
-        repo = create(repo_dir,branch,:init => true, :no_initial_commit => true)
-        repo.add_remote(remote(),repo_url)
-        remote_branch = local_branch = branch
-
-        repo.pull_remote_to_local(remote_branch,local_branch,remote())
-        repo.stage_changes()
-        repo.commit("Adding files during initialization")
-        repo.push_with_remote(remote(), remote_branch)
-
-        commit_sha = repo.head_commit_sha()
-        {"repo_obj" => repo,"commit_sha" => commit_sha}
-      end
-    end
-
-   private
-    # TODO: in common expose Common::GritAdapter at less nested level
-    class DiffSummary < ::DTK::Common::SimpleHashObject
-      def self.new_version(repo)
-        new(repo.new_version())
-      end
-
-      def self.diff(repo,local_branch,remote_reference)
-        new(repo.diff_summary(local_branch,remote_reference))
-      end
-
-      def self.diff_remote(repo,local_branch,remote_reference)
-        new(repo.diff_remote_summary(local_branch,remote_reference))
-      end
-
-      # def self.diff_remote(repo,ref1)
-      #   new(repo.diff(ref1).ret_summary())
-      # end
-
-      def any_diffs?
-        changes = false
-        self.each do |k,v|
-          unless v.empty?
-            changes = true
-            break
-          end
-        end
-        changes
-      end
-    end
-
-    #returns hash with keys
-    #: diffs - hash with diffs
-    # commit_sha - sha of currenet_commit
-    def push_repo_changes_aux(repo, opts={})
-      diffs = DiffSummary.new()
-
-      # adding untracked files (newly added files)
-      repo.stage_changes()
-
-      # commit if there has been changes
-      if repo.changed?
-        repo.commit(opts[:commit_msg]||"Pushing changes from client") #TODO: make more descriptive
-      end
-
-      if opts[:remote_repo] and opts[:remote_repo_url]
-        repo.add_remote(opts[:remote_repo],opts[:remote_repo_url])
-      end
-
-      unless opts[:no_fetch]
-        repo.fetch(remote(opts[:remote_repo]))
-      end
-
-      local_branch = repo.local_branch_name
-
-      remote_branch_ref = remote_branch_ref(local_branch, opts)
-
-      #check if merge needed
-      commit_shas = Hash.new
-      merge_rel   = repo.merge_relationship(:remote_branch,remote_branch_ref, :ret_commit_shas => commit_shas)
-      commit_sha  = nil
-      diffs       = DiffSummary.new_version(repo)
-
-      if merge_rel == :equal
-        commit_sha = commit_shas[:other_sha]
-      elsif [:branchpoint,:local_behind].include?(merge_rel)
-        if opts[:force]
-          diffs = DiffSummary.diff(repo,local_branch, remote_branch_ref)
-          if diffs.any_diffs?()
-            repo.push(remote_branch_ref, {:force => opts[:force]})
-          end
-          commit_sha = repo.find_remote_sha(remote_branch_ref)
-        else
-          where = opts[:where] || 'server'
-          msg = "Merge needed before module (#{pp_module(repo)}) can be pushed to #{where}. "
-          if where.to_sym == :catalog
-            msg <<  " Either a merge into the local module can be done with pull-dtkn command, followed by push-dtkn or force"
-          else
-            msg << "Force"
-          end
-          msg << " push can be used with the '--force' option, but this will overwrite remote contents"
-          raise ErrorUsage.new(msg)
-        end
-      elsif merge_rel == :no_remote_ref
-        repo.push(remote_branch_ref)
-        commit_sha = commit_shas[:local_sha]
-      elsif merge_rel == :local_ahead
-        # see if any diffs between fetched remote and local branch
-        # this has be done after commit
-        diffs = DiffSummary.diff(repo,local_branch, remote_branch_ref)
-
-        if diffs.any_diffs?()
-          repo.push(remote_branch_ref, {:force => opts[:force]})
-        end
-
-        commit_sha = repo.find_remote_sha(remote_branch_ref)
-      else
-        raise Error.new("Unexpected merge_rel (#{merge_rel})")
-      end
-
-      {"diffs" => diffs, "commit_sha" => commit_sha, "repo_obj" => repo}
-    end
-
-    def get_diffs_aux(repo,opts={})
-      diffs = DiffSummary.new()
-      #add any file that is untracked
-
-      # repo.stage_changes()
-
-      if opts[:remote_repo] and opts[:remote_repo_url]
-        repo.add_remote(opts[:remote_repo],opts[:remote_repo_url])
-      end
-
-      unless opts[:no_fetch]
-        repo.fetch(remote(opts[:remote_repo]))
-      end
-
-      local_branch      = repo.local_branch_name
-
-      remote_branch_ref = remote_branch_ref(local_branch, opts)
-
-      commit_shas = Hash.new
-      merge_rel   = repo.merge_relationship(:remote_branch,remote_branch_ref, :ret_commit_shas => commit_shas)
-      commit_sha  = nil
-
-      if merge_rel == :equal
-        commit_sha = commit_shas[:other_sha]
-      elsif merge_rel == :no_remote_ref
-        diffs = DiffSummary.new_version(repo)
-        commit_sha = commit_shas[:local_sha]
-      end
-
-      # diffs = DiffSummary.diff_remote(repo,"remotes/#{remote_branch_ref}")
-      diffs = DiffSummary.diff(repo,local_branch, remote_branch_ref)
-      commit_sha = repo.find_remote_sha(remote_branch_ref)
-
-      {"diffs" => diffs, "commit_sha" => commit_sha, "repo_obj" => repo, "status" => repo.local_summary() }
-    end
-
-    def get_remote_diffs_aux(repo,opts={})
-      diffs = DiffSummary.new()
-      #add any file that is untracked
-
-      # repo.stage_changes()
-      if opts[:remote_repo] and opts[:remote_repo_url]
-        repo.add_remote(opts[:remote_repo],opts[:remote_repo_url])
-      end
-
-      unless opts[:no_fetch]
-        repo.fetch(remote(opts[:remote_repo]))
-      end
-
-      local_branch      = repo.local_branch_name
-      remote_branch_ref = remote_branch_ref(local_branch, opts)
-
-      commit_shas = Hash.new
-      merge_rel   = repo.merge_relationship(:remote_branch, remote_branch_ref, :ret_commit_shas => commit_shas)
-      commit_sha  = nil
-
-      if merge_rel == :equal
-        commit_sha = commit_shas[:other_sha]
-      elsif merge_rel == :no_remote_ref
-        diffs = DiffSummary.new_version(repo)
-        commit_sha = commit_shas[:local_sha]
-      end
-
-      diffs = DiffSummary.diff_remote(repo,local_branch, remote_branch_ref)
-      { "diffs" => (diffs[:diffs]||"").to_s, "status" => repo.local_summary() }
-    end
-
-    
-    def diffs__no_diffs
-      DiffSummary.new
-    end
-    def compute_diffs(repo, remote_branch_ref)
-      DiffSummary.diff(repo, repo.local_branch_name, remote_branch_ref)
-    end
-    public :diffs__no_diffs, :compute_diffs
-
-    def pull_repo_changes_aux(repo, opts = {})
-      # TODO: cleanup use of hard_reset and force
-      force = opts[:hard_reset] || opts[:force]
-
-      # default commit in case it is needed
-      if repo.changed?
-        repo.stage_and_commit('Commit prior to pull from remote')
-      end
-
-      if commit_sha = opts[:commit_sha]
-        # no op if at commit_sha
-        return diffs__no_diffs if (commit_sha == repo.head_commit_sha()) && !force
-      end
-
-      if opts[:remote_repo] && opts[:remote_repo_url]
-        repo.add_remote(opts[:remote_repo], opts[:remote_repo_url])
-      end
-
-      repo.fetch(remote(opts[:remote_repo]))
-      remote_branch_ref = remote_branch_ref(repo.local_branch_name, opts)
-      # TODO: cleanup use of hard_reset and force; Merge.merge just uses :force
-      Merge.merge(repo, remote_branch_ref, opts.merge(:force => force))
-    end
-
-    def remote(remote_repo=nil)
-      remote_repo||"origin"
-    end
-
-    def remote_branch_ref(local_branch,opts={})
-      "#{remote(opts[:remote_repo])}/#{opts[:remote_branch]||opts[:local_branch]||local_branch}"
-    end
-
-    def modules_dir(type, module_name, version=nil, opts={})
-      type = type.to_sym
-      if assembly_module = opts[:assembly_module]
-        OsUtil.module_location_parts(type,module_name,version,opts)[0]
-      elsif type == :component_module
-        OsUtil.component_clone_location()
-      elsif type == :service_module
-        OsUtil.service_clone_location()
-      elsif type == :test_module
-        OsUtil.test_clone_location()
-      else
-        raise Error.new("Unexpected module type (#{type})")
-      end
-    end
-
-    def local_repo_dir(type,full_module_name,version=nil,opts={})
-      OsUtil.module_location(type, full_module_name, version, opts)
-    end
-
-    def backup_dir(type, full_module_name, opts={})
-      namespace, name = full_module_name.split(':', 2)
-      module_type     = type.split('_').first
-      backups_dir     = OsUtil.backups_location()
-
-      # create backups dir if deleted for some reason
-      FileUtils::mkdir_p(backups_dir) unless File.directory?(backups_dir)
-      "#{backups_dir}/#{module_type}-#{namespace}-#{name}-#{Time.now.to_i}"
-    end
-
-    def adapter_class()
-      Common::GritAdapter::FileAccess
-    end
-
-    def pp_module(repo)
-      repo.repo_dir.gsub(Regexp.new("/$"),"").split("/").last
-    end
-  end; end
-end; end; end