gpack 2.0.0 → 2.0.1

data/README.rst

@@ -0,0 +1,157 @@
+=====
+GitPack v2.0
+=====
+
+From https://github.com/GitPack/GitPackRuby
+
+Ruby Implementation of git repository manager. Conceptually simular to a tool like bundle, gradel, ect. GitPack handles the distrubuting of Git repositories without being tied to a specific language; although it does use ruby to execute commands. GitPack specifically is intended to control multiple git repository dependancies on a project where it is required that multiple user's point to the same commit/branch/tag. GitPack simplifies the usage of Git and can be especially beneficial when working with teams where not every user knows how to manage a git repository. GitPack uses a single file "GpackRepos" to specifiy the URL and local destination of repositories that it should manage.
+
+* Clones multiple repositories in parallel.
+* Controls read-only permissions on cloned repositories.
+* Pulls multiple repositoires in parallel.
+* Easy clean of repositories that do not have a clean git status.
+* Submodule compatible
+
+Structure
+-----
+* ./gpack - The main exectuable. GitPack is self updating and downloads the latest ver. of master from this repository.
+* ./GpackRepos - The main file that GitPack uses to store information about remote repositories URL, the local desitinations where the repositories should be cloned, and user configuration options like read-only, SSH keys, ect. This file is in YAML format
+* ./.gpacklock - Used to store the repository read-only status.
+
+Dependancies
+-----
+* Tested in Ruby 2.3
+
+Setup
+-----
+Download the gpack bash script to a local directory and make the file executable:
+    
+.. code::
+
+    wget https://raw.githubusercontent.com/GitPack/GitPack/master/gpack
+    chmod u+x ./gpack
+    
+Or install via ruby gems
+
+.. code::
+
+    gem install gpack
+    
+Add repos to GpackRepos file using gpack, an example is shown below:
+
+.. code::
+
+    ./gpack add git@github.com:GitPack/GitPack.git ./GitPack
+
+Basic Usage
+-----
+
+Installs all repos in GpackRepos file:
+
+.. code::
+
+    ./gpack install
+
+Update installed repos in GpackRepos file:
+
+.. code::
+    
+    ./gpack update
+
+
+GpackRepos
+----------
+
+.. code-block:: bash
+
+   test1:
+       url: git@github.com:GitPack/TestRepo1.git
+       localdir: ./repos/test1
+       branch: master
+       lock: true
+
+   test2:
+       url: git@github.com:GitPack/TestRepo2.git
+       localdir: ./repos/test2
+       branch: master
+       lock: false
+
+   test3:
+       url: git@github.com:GitPack/TestRepo3.git
+       localdir: ./repos/test3
+       branch: master
+       lock: false
+
+   test3_hash:
+       url: git@github.com:GitPack/TestRepo3.git
+       localdir: ./repos/test3_hash
+       branch: b41e58af7
+       lock: false
+
+   test1_tag:
+       url: git@github.com:GitPack/TestRepo1.git
+       localdir: ./repos/test1_tag
+       branch: v2.0
+       lock: false
+   
+# Options for Configuration
+#   config:
+#      lock: true # Option to disable read-only by default
+#      remote_key: http://some.valid.url # Use an external ssh key
+#      ssh_command: ssh -v # Custom SSH arguments passed to $GIT_SSH_COMMAND
+
+
+
+Core Commands
+-------------
+
+**gpack cmd [-f] [-nogui] [-persist] [-s]**
+   * -f,--force: Force operation
+   * -s,--single: Single threaded, useful for debug
+   * -n,--nogui: Do not pop up xterm windows
+   * -p,--persist: Keep xterm windows open even if command is successful
+   * -i: Force install (applies only to update command)
+
+**add [url] [directory] [branch]**
+   Adds a repo to the GpackRepos file given ssh URL and local directory
+   relative to current directory
+**check**
+   Checks if all repos are clean and match GpackRepos
+**status**
+   Runs through each repo and reports the result of git status
+**help**
+   Displays this message
+**install**
+   Clones repos in repo directory
+   -nogui doesn't open terminals when installing
+**uninstall**
+   Removes all local repositories listed in the Repositories File
+   Add -f to force remove all repositories
+**reinstall**
+   The same as running uninstall then reinstall
+**list**
+   List all repos in GpackRepos file
+**lock**
+   Makes repo read-only, removes from .gpacklock file
+**unlock**
+   Allows writing to repo, appends to .gpacklock file
+**update [-i] [-f]**
+   Updates the repositories -f will install if not already installed
+
+
+Details
+-----------
+* Maintains a clean local repository directory by parsing GpackRepos for user-defined repositores that they wish to clone.
+* By default, all cloned repositories have no write access.
+
+Future Improvements
+-----
+* GitPack is not Git LFS compatible at the moment. Merge requests with this feature would be accepted.
+* Add command is not implemented
+* Allow GitPack commands to operate on a per-repository basis
+* Lock/Unlock of individual repositores. (Python version has this)
+   
+Developers
+-----
+* Andrew Porter https://github.com/AndrewRPorter
+* Aaron Cook https://github.com/cookacounty

data/lib/gpack/config/headers.rb

@@ -0,0 +1,5 @@
+$SETTINGS = { \
+   "core" => {"repofile" => "GpackRepos", "force" => false, "parallel" => true, "install" => false},
+   "gui" => {"persist" => false, "show" => true},
+   "ssh" => {"key_url" => false, "key" => false, "cmd" => false}
+}

data/lib/gpack/core/GitCollection.rb

@@ -0,0 +1,154 @@
+
+$RAISE_WARNING = false
+
+class GitCollection
+   attr_accessor :refs
+
+   def initialize
+      @refs = []
+   end
+   def add_ref(ref)
+      @refs << ref
+   end
+   def print()
+      puts "="*40+"\n\tGit Reference Summary\n"+"="*40
+      @refs.each do |ref|
+         ref.print()
+      end
+   end
+   def archive()
+      puts "\nCreating archives of local Repositories....."
+      raise_warning = ref_loop(refs) { |ref|
+         ref.archive
+      }
+      if raise_warning
+         puts "\n"+("="*60+"\nWARNING DURING CLONING!\n\tSome repositories already existed and failed checks.\n\tReview this log or run 'gpack check' to see detailed information\n"+"="*60).color(Colors::RED)
+      end
+   end   
+   def clone()
+      puts "\nCloning Repositories....."
+      raise_warning = ref_loop(refs) { |ref|
+         ref.clone
+      }
+      if raise_warning
+         puts "\n"+("="*60+"\nWARNING DURING CLONING!\n\tSome repositories already existed and failed checks.\n\tReview this log or run 'gpack check' to see detailed information\n"+"="*60).color(Colors::RED)
+      end
+      print()
+      check()
+   end
+   def rinse()
+      puts "\nRinsing Repositories....."
+      raise_warning = ref_loop(refs) { |ref|
+         ref.rinse
+      }
+      if raise_warning
+         puts ("\n"+"="*60+"\nWARNING DURING Rinse!\n"+"="*60).color(Colors::RED)
+      end
+   end
+   def check()
+      puts "\nChecking Local Repositories....."
+      raise_warning = ref_loop(refs,true) { |ref|
+         ref.check
+      }
+      if raise_warning
+         puts "\n"+("="*60+"\nWARNINGS FOUND DURING CHECK!\n\tReview this log to see detailed information\n" \
+            "\tThe following commands can be run to help debug:\n" \
+            "\t\tgpack status #Shows the current git status\n" \
+            "\t\tgpack rinse #Removes all local changes and untracked files,use with caution\n" \
+            +"="*60).color(Colors::RED)
+      else
+         puts "\n"+("All checks passed!").color(Colors::GREEN)
+      end
+   end
+   def status()
+      puts "\nStatus of Local Repositories....."
+      raise_warning = ref_loop(refs,true) { |ref|
+         ref.status
+      }
+      if raise_warning
+         puts "\n"+("="*60+"\nWARNINGS FOUND DURING CHECK!\n\tReview this log to see detailed information\n"+"="*60).color(Colors::RED)
+      end
+   end
+   def update()
+      print()
+      puts "\nUpdating Repositories.....\n\n"
+      puts "Please be patient, this can take some time if pulling large commits.....".color(Colors::GREEN)
+      raise_warning = ref_loop(refs) { |ref|
+         ref.update()
+      }
+      if raise_warning
+         puts "\n"+("="*60+"\nWARNING DURING UPDATE!\n\tSome repositories failed checks and were not updated.\n\tReview this log or run 'gpack check' to see detailed information\n"+"="*60).color(Colors::RED)
+      end
+   end
+   def remove()
+      puts "This will force remove repositories and repopulate. Any local data will be lost!!!\nContinue (y/n)"
+      if $SETTINGS["core"]["force"] == true
+         do_remove = true
+      else
+         cont = $stdin.gets.chomp
+         do_remove = cont == "y"
+      end
+      
+      if do_remove
+         puts "\nRemoving Local Repositories....."
+
+         raise_warning = ref_loop(refs) { |ref|
+            ref.remove()
+         }
+         `rm -f .gpackunlock`
+      else
+         puts "Abort Uninstall"
+      end
+      
+      if raise_warning
+         puts "\n"+("="*60+"\nWARNINGS FOUND DURING REMOVAL!\n\tReview this log to see detailed information\n"+"="*60).color(Colors::RED)
+      end
+   end
+   def set_writeable(tf)
+      ref_loop(refs) { |ref|
+         ref.set_writeable(tf)
+      }
+   end
+   
+   
+   def ref_loop(refs, parallel_override=false)
+      if $SETTINGS["core"]["parallel"] && !parallel_override
+         read, write = IO.pipe
+         Parallel.map(@refs) do |ref|
+
+            # Set up standard output as a StringIO object.
+            old_stdout = $stdout
+            foo = StringIO.new
+            $stdout = foo
+            
+            raise_warning = yield(ref)
+            write.puts raise_warning
+            
+            $stdout = old_stdout
+            puts foo.string
+            
+         end
+         write.close
+         read_data =  read.read
+         #puts read_data
+         if read_data.index("true")
+            raise_warning = true
+         end
+      else
+         raise_warning = false
+         @refs.each do |ref|
+            
+            ret_warning = yield(ref)
+            if ret_warning
+               raise_warning = true
+            end
+         end
+
+      end
+
+      return raise_warning
+   end
+   
+   
+end
+

data/lib/gpack/core/GitReference.rb

@@ -0,0 +1,366 @@
+module HasProperties
+   attr_accessor :props
+   attr_accessor :require_attrs
+   
+   def has_properties *args
+      @props = args
+      instance_eval { attr_reader *args }
+      instance_eval { attr_writer *args }
+   end
+   
+   def has_required *args
+      @require_attrs = args
+   end
+
+   def self.included base
+      base.extend self
+   end
+
+   def initialize(args)
+
+      # Attributes required when defining a GitReference
+      require_attrs = self.class.require_attrs
+   
+      # Check that all the required
+      args.each do |k,v|
+         require_attrs = require_attrs - [k]
+      end
+      
+      if require_attrs.any?
+         raise "Must include attributes #{require_attrs} in GitReference definition"
+      end
+
+      args.each {|k,v|
+         instance_variable_set "@#{k}", v if self.class.props.member?(k)
+      } if args.is_a? Hash
+   end
+end
+
+
+class GitReference 
+   include HasProperties
+
+   has_properties :url, :localdir, :branch, :readonly
+   has_required   :url, :localdir, :branch
+   
+   def initialize args
+      # Non-Required defaults
+      @readonly   = true
+   
+      super
+   end
+   def clone()
+    
+      #Clone the Git Repository
+      checks_failed = false
+      
+      #check if directory already exists
+      if local_exists
+         puts "Cloning Warning - Directory #{localdir} already exists! Running checks instead"
+         checks_failed = self.check()
+      else
+         status = syscmd("git clone -b #{branch} #{url} #{localdir} --recursive",true,false)
+         self.checkout
+         self.set_writeable(false) if @readonly
+         
+         if status != 0
+            checks_failed = true
+         end
+         
+      end
+      
+      return checks_failed
+   end
+   
+   def update()
+      force_clone = $SETTINGS["core"]["force"] || $SETTINGS["core"]["install"]
+      command_failed = false
+      # Returns true if falure
+      if local_exists
+         checks_failed = self.check(true) # TODO, should this fail if branch is wrong?
+         if !checks_failed
+            puts "Updating local repository #{@localdir}"
+            self.set_writeable(true) if @readonly
+            syscmd("git fetch origin",true)
+            self.checkout
+            syscmd("git submodule update --init --recursive")
+            self.set_writeable(false) if @readonly
+            command_failed = false
+         else
+            command_failed = true
+         end
+      elsif force_clone
+         self.clone
+         command_failed = false
+      else
+         command_failed = true
+      end
+      return command_failed
+   end
+   
+   def checkout()
+      if is_branch()
+         checkout_cmd = "checkout -B #{@branch} origin/#{@branch}" # Create a local branch
+      else
+         checkout_cmd = "checkout #{@branch}" # Direct checkout the tag/comit
+      end
+      syscmd("git #{checkout_cmd} && git submodule update --init --recursive")  
+   end
+   
+   def set_writeable(tf)
+
+      if tf
+         puts "Setting #{@localdir} to writable"
+         perms = "u+w" 
+      else
+         puts "Setting #{@localdir} to read only"
+         perms = "a-w" 
+      end
+      
+      file_paths = []
+      ignore_paths = []
+      if local_exists()
+         Find.find(@localdir) do |path|
+            # Ignore .git folder
+            if path.match(/.*\/.git$/) || path.match(/.*\/.git\/.*/)
+               ignore_paths << path
+            else
+               file_paths << path
+               #FileUtils.chmod 'a-w', path
+               FileUtils.chmod(perms,path) if File.exist?(path)
+            end
+         end
+      end
+      
+      # Useful for debug
+      #puts "IGNORED PATHS\n"+ignore_paths.to_s
+      #puts "FOUND_PATHS\n"+file_paths.to_s
+      
+   end
+   
+   def check(skip_branch=false)
+      #Check integrety
+      #  Check that URL matches
+      #  Check that branch matches
+      #  Check that there are no local changes "clean" state
+      check_git_writable()
+      
+      puts "\nRunning checks on local repository #{@localdir}"
+      checks_failed = false
+      if local_exists
+         if !skip_branch
+            if is_branch()
+               bname = @branch
+            else
+               bname = rev_parse(@branch)
+            end
+            branch_valid = local_branch() == bname
+            if !branch_valid
+               puts "\tFAIL - Check branch matches #{@branch} rev #{bname}".color(Colors::RED)
+               puts "\t\tLocal  Branch abbrev    : '#{rev_parse("HEAD",true)}'"
+               puts "\t\tLocal  Branch SHA       : '#{rev_parse("HEAD")}'"
+               puts "\t\tSpecified Branch        :    '#{@branch}'"
+               puts "\t\tSpecified Branch abbrev : '#{rev_parse(@branch)}'"
+               puts "\t\tSpecified Branch SHA    : '#{rev_parse(@branch,true)}'"
+               checks_failed = true
+            end
+         end
+
+         if local_url() == @url
+            #puts "\tPASS - Check remote url matches #{@url}"
+         else
+            puts "\tFAIL - Check remote url matches #{@url}".color(Colors::RED)
+            puts "\t\tLocal URL #{local_url()}'"
+            puts "\t\tRemote URL #{@url}'"
+            checks_failed = true
+         end
+
+         if local_clean()
+            #puts "\tPASS - Check local repository clean"
+         else
+            puts "\tFAIL - Check local repository clean".color(Colors::RED)
+            checks_failed = true
+         end
+         
+         if !checks_failed
+            puts "PASS - All checks on local repository #{@localdir}".color(Colors::GREEN)
+         else
+            puts "CHECK FAILURE on local repository #{@localdir}. See previous log for info on which check failed".color(Colors::RED)
+         end
+      else
+         puts "\tFAIL - Check local repository exists".color(Colors::RED)
+         checks_failed = true
+      end
+      return checks_failed
+   end
+   
+   def syscmd(cmd,open_xterm=false,cd_first=true)
+      if cd_first
+         cmd = "cd #{@localdir} && #{cmd}"
+      end
+      
+      #Pass env var to Open3
+      ssh_cmd = $SETTINGS["ssh"]["cmd"]
+      if ssh_cmd
+         args = {"GIT_SSH_COMMAND" => ssh_cmd}
+         puts "custom ssh"
+      else
+         args = {}
+      end
+      
+      if open_xterm && $SETTINGS["gui"]["show"]
+         if $SETTINGS["gui"]["persist"]
+            hold_opt = "-hold"
+         end
+         if ssh_cmd
+            cmd = "echo 'GIT_SSH_COMMAND $GIT_SSH_COMMAND' ; #{cmd}"
+         end
+         cmd = "xterm #{hold_opt} -geometry 90x30 -e \"#{cmd} || echo 'Command Failed, see log above. Press CTRL+C to close window' && sleep infinity\""
+      end
+      cmd_id = Digest::SHA1.hexdigest(cmd).to_s[0..4]
+      
+      stdout_str,stderr_str,status = Open3.capture3(args,cmd)
+      
+      puts "="*30+"COMMAND ID #{cmd_id}"+"="*28+"\n"
+      puts ("#{cmd}").color(Colors::YELLOW)
+      if stdout_str != "" || stderr_str != ""
+         puts "="*30+"COMMAND #{cmd_id} LOG START"+"="*28+"\n"
+         puts stderr_str
+         puts stdout_str
+         puts "="*30+"COMMAND #{cmd_id} LOG END"+"="*30+"\n"
+      end
+      status
+   end
+   
+   def localcmd(cmd_str)
+      return `cd #{@localdir} && #{cmd_str}`.chomp
+   end
+   
+   def remove()
+      force = $SETTINGS["core"]["force"]
+      command_failed = false
+      if force || !self.check
+         puts "Removing local repository #{@localdir}"
+         self.set_writeable(true) if @readonly || force
+         syscmd("rm -rf #{@localdir}",false,false)
+         command_failed = false
+      else
+         command_failed = true
+      end
+      return command_failed
+   end
+   
+   def rinse()
+      force = $SETTINGS["core"]["force"]
+      if !@readonly && !force
+         puts "Error with repository #{@localdir}\n\t Repositories can only be rinsed when in readonly mode"
+         command_failed = true
+      else
+         self.set_writeable(true) if @readonly
+         status = syscmd( \
+         "git fetch origin && " \
+         "git clean -xdff && "  \
+         "git reset --hard && " \
+         "git submodule foreach --recursive git clean -xdff && " \
+         "git submodule foreach --recursive git reset --hard && " \
+         "git submodule update --init --recursive")
+         self.checkout
+         self.set_writeable(false) if @readonly
+         if !status
+            command_failed = true
+            puts "Rinse command failed for repo #{@localdir}, check log"
+         end
+      end
+      
+      
+      return command_failed
+   end
+   
+   def archive()
+      #Archive the Git Repository
+      
+      checks_failed = false
+      
+      #check if directory already exists
+      if !self.check()
+         command_failed = true
+      else
+         git_ref = local_rev
+         dirname = @localdir.match( /\/([^\/]*)\s*$/)[1].chomp
+         tarname = "#{dirname}_#{git_ref}.tar.gz"
+         tarcmd = "tar -zcvf #{tarname} #{@localdir} > /dev/null"
+         syscmd(tarcmd)
+      end
+      
+      return command_failed
+   end
+   
+   def check_git_writable()
+      # Make sure .git folder is writable
+      
+      gitdirs = `find #{localdir} -type d -name ".git"`
+      gitdirs.each_line do |dir|
+         dir.chomp!
+         if !File.writable?(dir)
+            puts "Warning, .git folder #{dir} was found read-only. Automatically setting it to writable"
+            syscmd("chmod ug+w -R #{dir}")
+         end
+      end
+   end
+   def status
+      self.print()
+      syscmd("git status && echo 'Git Branch' && git branch && echo 'Git SHA' && git rev-parse HEAD")
+      return false
+   end
+
+   def is_branch()
+      #check if branch ID is a branch or a tag/commit
+      return system("cd #{localdir} && git show-ref -q --verify refs/remotes/origin/#{@branch}")
+   end
+   
+   def local_branch()
+      if is_branch()
+         bname = rev_parse("HEAD",true)
+      else
+         bname = rev_parse("HEAD")
+      end
+      return bname
+   end
+   
+   def rev_parse(rev,abbrev=false)
+      if abbrev
+         rp = localcmd("git rev-parse --abbrev-ref #{rev}")
+      else
+         rp = localcmd("git rev-parse #{rev}")
+      end
+      return rp
+   end
+   
+   def local_url()
+      urlname = localcmd("git config --get remote.origin.url")
+      return urlname
+   end
+   
+   def local_rev()
+      revname = localcmd("git rev-parse --short HEAD")
+      return revname
+   end
+   
+   def local_clean()
+      clean = localcmd("git status --porcelain")
+      return clean == "" # Empty string means it's clean
+   end
+   
+   def local_exists()
+      if Dir.exists?(@localdir)
+         return true
+      else
+         return false
+      end
+   end
+   
+   def print()
+      puts "Reference #{@url}\n\tlocaldir-#{@localdir}\n\tbranch-#{@branch}\n\treadonly-#{@readonly}"
+   end
+   
+end