vagrant-git 0.1.1

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+	gem "vagrant", :git => 'git://github.com/Learnosity/vagrant.git'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2006-2013 Learnosity Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# vagrant-git
+
+`vagrant-git` is a [Vagrant](http://vagrantup.com) plugin for checking out and updating git repos. It has a very simple configuration to either clone or pull repositories after a VM boots (but before it's provisioned).
+
+The plugin doesn't do anything special, but it helps to centralise environment configuration declaratively in the Vagrantfile, rather than relying on scripting.
+
+Currently the plugin only supports cloning into the host machine, so care should be taken to clone the repositories into a directory accessible by the guest. [vagrant-sparseimage](https://github.com/Learnosity/vagrant-sparseimage) integrates well for this use job, or a standard file share should be use.
+
+When you run `vagrant up` or `vagrant provision`, this plugin will clone or pull the various specified git repos. It does not attempt to handle a dirty working tree: `git pull` will simply fail. This is to prevent mistakenly clobbering any changes. In order to get a 
+
+Planning to implement a command - `vagrant git` - supporting `list`, `pull`, `clone` and `reset` to streamline this a little.
+
+
+## Dependencies
+
+Only supports Vagrant > 1.2.
+
+Requires `git`.
+
+## Installation
+
+See **building** below for building the gem.
+
+Use `vagrant plugin` to install the gem in your Vagrant environment:
+
+```bash
+$ vagrant plugin install vagrant-git.gem
+```
+
+## Configuration
+
+See `example-box/vagrantfile` for an example configuration.
+
+The following config properties for `config.git` are required:
+
+* **target**: *string*: the repository to clone. This must be a fully qualified git ref spec.
+* **path**: *string*: the path in the host or the guest to clone or pull the repo into
+
+The following properties are optional (but not yet supported):
+
+* **branch**: Which branch to check out / pull
+* **clone_in_host**: *boolean*: true to execute git commands in the host, false to execute them in the guest. NOT YET SUPPORTED for false.
+* **pull_on_load**: whether to do a fetch & pull when starting up the VM
+* **set_upstream**: a different remote URL to set the upstream origin to after cloning the repository
+
+## Building
+
+```bash
+$ bundle install
+$ gem build vagrant-sparseimage.gemspec
+```

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks

data/example-box/Vagrantfile

@@ -0,0 +1,13 @@
+Vagrant.configure("2") do |config|
+    config.vm.hostname = 'sparseimage-test'
+    config.vm.box = 'precise64nfs_clean'
+    config.vm.box_url = 'https://s3-ap-southeast-2.amazonaws.com/learnosity-vagrant/precise64nfs_clean.box'
+    config.vm.network :private_network, ip: '172.16.42.10'
+
+	config.git.add_repo do |rc|
+		rc.target = 'https://github.com:Learnosity/vagrant-git.git'
+		rc.path = '/tmp/vagrant-git'
+		rc.branch = 'master'
+		rc.clone_in_host = true
+	end
+end

data/lib/vagrant-git.rb

@@ -0,0 +1,27 @@
+begin
+    require "vagrant"
+rescue LoadError
+    raise "The Vagrant Hello plugin must be run within Vagrant."
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.2.0"
+    raise "The Vagrant Hello plugin is only compatible with Vagrant 1.2+"
+end
+
+require "vagrant-git/plugin"
+
+require "pathname"
+
+module VagrantPlugins
+  module VagrantGit
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+
+    #I18n.load_path << File.expand_path('locales/en.yml', source_root)
+    #I18n.reload!
+
+  end
+end

data/lib/vagrant-git/action.rb

@@ -0,0 +1,52 @@
+require 'vagrant-git/git'
+
+module VagrantPlugins
+  module VagrantGit
+    module Action
+      class HandleRepos
+        def initialize(app, env)
+          @app = app
+          @env = env
+        end
+
+        def call(env)
+          @app.call(env)
+          @env = env
+
+          @vm = env[:machine]
+
+          @vm.config.git.to_hash[:repos].each do |rc|
+            if not rc.clone_in_host
+              raise 'NotImplemented: clone_in_host=>false'
+            end
+
+            if File.exist? "#{rc.path}/.git"
+              if rc.sync_on_load
+                Git::fetch(rc.path)
+                Git::pull(rc.path, {:branch => rc.branch})
+              end
+            else
+              p = Git::clone(rc.target, rc.path, {:branch => rc.branch})
+              if p.success? and rc.set_upstream
+                @vm.ui.info("Clone done - setting upstream of #{rc.path} to #{rc.set_upstream}")
+                if not Git::set_upstream(rc.path, rc.set_upstream).success?
+                  @vm.ui.error("WARNING: Failed to change upstream to #{rc.set_upstream} in #{rc.path}")
+                end
+              else
+                @vm.ui.error("WARNING: Failed to clone #{rc.target} into #{rc.path}")
+              end
+              if File.exist? "#{rc.path}/.gitmodules"
+                p = Git::submodule(rc.path)
+                if p.success?
+                  @vm.ui.info("Checked out submodules.")
+                else
+                  @vm.ui.error("WARNING: Failed to check out submodules for #{path}")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-git/config.rb

@@ -0,0 +1,68 @@
+module VagrantPlugins
+  module VagrantGit
+    class Config < Vagrant.plugin("2", :config)
+      # Singleton for each VM
+      @@repo_configs = []
+      class << self
+        attr_accessor :repo_configs
+      end
+
+      def to_hash
+        { :repos => @@repo_configs }
+      end
+
+      def add_repo
+        # Yield a new repo config object to the config block
+        rc = RepoConfig.new
+        yield rc
+        @@repo_configs.push rc
+      end
+
+      def validate(machine)
+        errors = {}
+        @@repo_configs.each_with_index do |rc, i|
+          rc_errors = rc.validate
+          if rc_errors.length > 0
+            errors[i] = rc_errors
+          end
+        end
+        errors
+      end
+
+      def finalize!
+        @@repo_configs.each do |config|
+          config.finalize!
+        end
+      end
+    end
+
+    class RepoConfig
+      # Config for a single repo
+      # Assumes that the agent has permission to check out, or that it's public
+
+      attr_accessor :target, :path, :clone_in_host, :branch, :sync_on_load, :set_upstream
+
+      @@required = [:target, :path]
+
+      def validate
+        errors = {}
+        if @target.nil?
+          errors[:target] = ["target must not be nil."]
+        end
+        if @path.nil?
+          errors[:path] = ["path must not be nil."]
+        end
+        errors
+      end
+
+      def finalize!
+        if @clone_in_host.nil?
+          @clone_in_host = true
+        end
+        if @sync_on_load.nil?
+          @sync_on_load = false
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-git/git.rb

@@ -0,0 +1,43 @@
+module VagrantPlugins
+  module VagrantGit
+    module Git
+      class << self
+        # Run the command, wait for exit and return the Process object.
+        def run(cmd)
+          pid = Process.fork { exec(cmd) }
+          Process.waitpid(pid)
+          return $?
+        end
+
+        def clone(target, path, opts = {})
+          branch = opts[:branch]
+          if branch.nil?
+            return run("git clone '#{target}' '#{path}'")
+          else
+            return run("git clone -b '#{branch}' '#{target}' '#{path}'")
+          end
+        end
+        def fetch(path)
+          return run("cd '#{path}'; git fetch")
+        end
+
+        def pull(path, opts = {})
+          branch = opts[:branch]
+          if branch.nil?
+            return run("cd '#{path}'; git fetch; git pull;")
+          else
+            return run("cd '#{path}'; git pull origin '#{branch}';")
+          end
+        end
+
+        def submodule(path)
+          return run("cd '#{path}' && git submodule update --init --recursive")
+        end
+
+        def set_upstream(path, target)
+          return run("cd '#{path}'; git remote set-url origin '#{target}';")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-git/plugin.rb

@@ -0,0 +1,26 @@
+module VagrantPlugins
+  module VagrantGit
+    class Plugin < Vagrant.plugin("2")
+      name "vagrant git support"
+      description <<-DESC 
+    A vagrant plugin to allow checking out git repositories as part of 
+    vagrant tasks.
+      DESC
+
+      config(:git) do
+        require File.expand_path("../config", __FILE__)
+        Config
+      end
+
+      require File.expand_path("../action", __FILE__)
+      %w{up reload}.each do |action|
+        action_hook(:git, "machine_action_#{action}".to_sym) do |hook|
+          hook.after(
+            Vagrant::Action::Builtin::SyncedFolderCleanup,
+            Action::HandleRepos
+          )
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-git/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module VagrantGit
+    VERSION = "0.1.1"
+  end
+end

data/vagrant-git.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'vagrant-git/version.rb'
+
+Gem::Specification.new do |s|
+	s.name			= 'vagrant-git'
+	s.version		= VagrantPlugins::VagrantGit::VERSION
+	s.platform		= Gem::Platform::RUBY
+	s.authors		= ['Daniel Bryan', 'Alan Garfield']
+	s.license		= 'MIT'
+	s.email			= ['danbryan@gmail.com', 'alan.garfield@learnosity.com']
+	s.homepage		= 'https://github.com/Learnosity/vagrant-git'
+	s.summary		= %q{A vagrant plugin to allow checking out git repositories as part of vagrant tasks.}
+	s.description	= %q{A vagrant plugin to allow checking out git repositories as part of vagrant tasks.}
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	s.require_paths = ['lib']
+
+	s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+	
+	if s.respond_to? :specification_version
+		current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+		s.specification_version = 2
+	end
+
+	s.add_development_dependency 'bundler', '>= 1.2.0'
+	s.add_development_dependency 'vagrant', '>= 1.2'
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-git
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Bryan
+- Alan Garfield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: vagrant
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A vagrant plugin to allow checking out git repositories as part of vagrant
+  tasks.
+email:
+- danbryan@gmail.com
+- alan.garfield@learnosity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example-box/Vagrantfile
+- lib/vagrant-git.rb
+- lib/vagrant-git/action.rb
+- lib/vagrant-git/config.rb
+- lib/vagrant-git/git.rb
+- lib/vagrant-git/plugin.rb
+- lib/vagrant-git/version.rb
+- vagrant-git.gemspec
+homepage: https://github.com/Learnosity/vagrant-git
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3573687314265701833
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 2
+summary: A vagrant plugin to allow checking out git repositories as part of vagrant
+  tasks.
+test_files: []