vagrant-tagprovision 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cfb9caf67c9eee524dfc5aae9c0d32aa5d05845
-  data.tar.gz: 1debb99d197770733e64dc8c720a7be8c7d58efa
+  metadata.gz: c2426fbf2e6aad5ce46e1b3bc6f6e59a05fb5ec0
+  data.tar.gz: e7819b73c70ef1b51367df00b474161848ca1010
 SHA512:
-  metadata.gz: be6fdfdb80961f68c548e92f9c1705033016af6ee5eaf8c7ae158ab3edda37c46c8c3fbc727c3432ff61ddbb25387ac6df8bdcb36ecb5b55cf4c1ebf006041e2
-  data.tar.gz: 18773e8fba8f71ececd565735fe14f11aade1997896156b28cbf83f9eb8c291bfbe376d155106b3be42feea999fb0b3c0de6f622573b3323bea4d47e21b678bc
+  metadata.gz: 7ff905a64726fa736c749bf20807f17eb7e16aa1d79b1a86fef8fd260ee249f462df753c155577f75d7e8732afd38da1f018c63e75deb0f7d00ad8194cfc4f0e
+  data.tar.gz: a04add565f33486a176adaeab3e3df7ed457ec81deee48176954630c205418699b2b6372529286d38d08504ff3354222874157308432c3b5242a37db47b2276a

data/.gitignore

@@ -9,11 +9,11 @@ _yardoc
 coverage
 doc/
 lib/bundler/man
-pkg
 rdoc
 spec/reports
 test/tmp
 test/version_tmp
 tmp
 .vagrant
-vendor/bundle
+vendor/bundle
+vendor

data/README.md

@@ -1,57 +1,69 @@
-# Vagrant Pushbullet
+# Vagrant TagProvision
 
-This gem is a [Vagrant](http://www.vagrantup.com/) plugin that adds Pushbullet notifications to configured devices. 
+This gem is a [Vagrant](http://www.vagrantup.com/) plugin that tags and logs provisioning information
 
-## Setup Pushbullet
-
-* First get a Pushbullet Account, and add devices to it. 
-    - [Pushbullet.com](https://www.pushbullet.com/)
-* Download the *iOS* app,  *Chrome* plugin, *Android* app, and more.  Add those to your Pushbullet account. 
-* Get your HTTP API Token:  http://pushbullet.com/account
 
 ## Install Plugin
 
 ```bash
-$ vagrant plugin install vagrant-pushbullet
+$ vagrant plugin install vagrant-tagprovision
 ```
 
 ## Plugin Usage
 
-This plugin is configured purely by a configuration file in your home directory. 
-The plugin will create this file for you, but you will have to edit it manually (for now). 
+You will need to create a section in your Vagrantfile to enable this plugin and use the various features.
 
-`~/.vagrant.d/pushbullet.rb`
-```ruby
-module PushbulletConfig
-  TOKEN = "replace this text with token from pushbullet.com/account" #required
-  DEVICES = ['asdfasdfasdf','asdfasdfasdf'] #optional
+```
+Vagrant.configure("2") do |config|
+...
+	config.tagprovision.enabled = true
+	config.tagprovision.log_provision = true
+	config.tagprovision.tag_provision = true
+	config.tagprovision.push_tag = true
+...
 end
 ```
 
-Run `vagrant pushbullet-config` to retrieve your Device ID's.  Add those to the DEVICES array in the config file to limit which devices are notified. 
- 
-
-## Notifications
+config.tagprovision.enabled - This enables and disables the plugin
+config.tagprovision.log_provision - This creates an entry in /var/provision_log on the guest machine with the following format:
 
-A notification is sent after these commands complete: 
+2016-01-11 11:31:42 +0000	Provisioned	a41c6eb98bd069f85bc205fae24298e644a9b877	username
 
-* note there is currently a bug where if an exception occurs in the provisioning, the notification is not sent. 
-
-- `vagrant up`
-- `vagrant reload --provision`
-- `vagrant provision`
+config.tagprovision.tag_provision - This will create a git tag with provisioning information
+config.tagprovision.push_tag - This automatically pushes the tag to the origin your current branch is tracking
 
 ## Contributing
 
 * use feature branches please.  Prefer  feature/your_feature_name
 * submit pull requests to the `develop` branch
 
+### Testing
 
-## Author
+To install dependencies use:
+```
+bundle install
+```
+
+Then use 
+```
+bundle exec vagrant provision
+```
+To test on the test VM.
 
-Brett Swift
+### Building and deploying gem packages
 
-## Kudos 
+Use
+
+```
+rake build
+```
+
+Then
+
+```
+gem push pkg/vagrant-tagprovision-0.vagrant-tagprovision-0.1.1.gem
+```
+
+## Author
 
-[tcnksm](https://twitter.com/deeeet)
-    - for his vagrant-pushover plugin. This plugin is modeled after his. 
+Jim Robinson

data/Vagrantfile

@@ -10,4 +10,14 @@ Vagrant.configure("2") do |config|
       db.vm.box_url = "http://files.vagrantup.com/precise64.box"
       db.vm.box = "precise64"
     end
+    
+    config.vm.define "db" do |db|
+      db.vm.box_url = "http://files.vagrantup.com/precise64.box"
+      db.vm.box = "precise64"
+    end
+    
+    config.tagprovision.enabled = true
+    config.tagprovision.log_provision = true
+    config.tagprovision.tag_provision = true
+    config.tagprovision.push_tag = true
 end

data/lib/vagrant-tagprovision/action.rb

@@ -1,5 +1,5 @@
 require "net/https"
-
+require 'vagrant-tagprovision/util'
 module VagrantPlugins
   module Tagprovision
     class Action
@@ -14,8 +14,9 @@ module VagrantPlugins
         @current_user = `whoami`
         @time = Time.new
         @tag = "provisioned_#{@machine}_#{@time.year}#{@time.month}#{@time.day}#{@time.hour}#{@time.min}#{@time.sec}"
-        machine_env = @machinfo.env;
-        @tmp_path = machine_env.tmp_path;
+        @machine_env = @machinfo.env;
+        @tmp_path = @machine_env.tmp_path;
+        @config = Util.get_config(@machine_env)
         
       end
 
@@ -37,48 +38,65 @@ module VagrantPlugins
             #env[:ui].info("Vagrant Hook Reload:  #{@machine}")
           
           when :provision
-            env[:ui].info("Logging provisioning information to guest machine:  #{@machine}")
-
-            if (@machinfo.communicate.test("uname -s | grep SunOS"))
-              reallogfile = '/var/log/provision_log'
-              move_cmd = 'mv'
-            elsif (@machinfo.communicate.test("test -d $Env:SystemRoot"))
-              windir = ""
-              @machinfo.communicate.execute("echo %SYSTEMROOT%", {:shell => :cmd}) do |type, contents|
-                windir << contents.gsub("\r\n", '') if type == :stdout
+            if(@config.tagprovision.enabled)
+              if(@config.tagprovision.log_provision)
+                log_provision(env)
+              end
+              if(@config.tagprovision.log_provision)
+                tag_provision(env)
               end
-              reallogfile = "#{windir}\\System32\\drivers\\var\\provision_log"
-              move_cmd = 'mv -force'
-            else
-              reallogfile = '/var/log/provision_log'
-              move_cmd = 'mv -f'
             end
+        end
+      end
+      
+      def tag_provision(env)
+        env[:ui].info("Tagging provisioning information:  #{@machine}")
+        `git tag #{@tag}`
+        if(@config.tagprovision.push_tag)
+          `git push --tags`
+        end
+      end
+      
+      def log_provision(env) 
+        env[:ui].info("Logging provisioning information to guest machine:  #{@machine}")
 
-            file = @tmp_path.join("hosts.#{@machinfo.name}_#{@commit_hash}")
+        if (@machinfo.communicate.test("uname -s | grep SunOS"))
+          reallogfile = '/var/log/provision_log'
+          move_cmd = 'mv'
+        elsif (@machinfo.communicate.test("test -d $Env:SystemRoot"))
+          windir = ""
+          @machinfo.communicate.execute("echo %SYSTEMROOT%", {:shell => :cmd}) do |type, contents|
+            windir << contents.gsub("\r\n", '') if type == :stdout
+          end
+          reallogfile = "#{windir}\\System32\\drivers\\var\\provision_log"
+          move_cmd = 'mv -force'
+        else
+          reallogfile = '/var/log/provision_log'
+          move_cmd = 'mv -f'
+        end
 
-            # Make sure the log files exist and are writable.
-            @machinfo.communicate.sudo("touch #{reallogfile}")
-            @machinfo.communicate.sudo("chmod 666 #{reallogfile}")
-            @machinfo.communicate.sudo("touch /tmp/provision_logs")
-            @machinfo.communicate.sudo("chmod 666 /tmp/provision_logs")
+        file = @tmp_path.join("hosts.#{@machinfo.name}_#{@commit_hash}")
 
-            # download the current log file
-            @machinfo.communicate.download(reallogfile, file)
-            
-            if update_file(file, @machinfo, false)
+        # Make sure the log files exist and are writable.
+        @machinfo.communicate.sudo("touch #{reallogfile}")
+        @machinfo.communicate.sudo("chmod 666 #{reallogfile}")
+        @machinfo.communicate.sudo("touch /tmp/provision_logs")
+        @machinfo.communicate.sudo("chmod 666 /tmp/provision_logs")
 
-              # upload modified file and remove temporary file
-              @machinfo.communicate.upload(file, '/tmp/provision_logs')
-              if windir
-                @machinfo.communicate.sudo("#{move_cmd} /tmp/provision_logs/hosts.#{@machinfo.name} #{reallogfile}")
-              elsif @machinfo.communicate.test('test -f /.dockerinit')
-                @machinfo.communicate.sudo("cat /tmp/provision_logs > #{reallogfile}")
-              else
-                @machinfo.communicate.sudo("#{move_cmd} /tmp/provision_logs #{reallogfile}")
-              end
-            end            
-            env[:ui].info("Finished logging provisioning information to guest machine:  #{@machine}")
-        end
+        # download the current log file
+        @machinfo.communicate.download(reallogfile, file)
+        
+        if update_file(file, @machinfo, false)
+          # upload modified file and remove temporary file
+          @machinfo.communicate.upload(file, '/tmp/provision_logs')
+          if windir
+            @machinfo.communicate.sudo("#{move_cmd} /tmp/provision_logs/hosts.#{@machinfo.name} #{reallogfile}")
+          elsif @machinfo.communicate.test('test -f /.dockerinit')
+            @machinfo.communicate.sudo("cat /tmp/provision_logs > #{reallogfile}")
+          else
+            @machinfo.communicate.sudo("#{move_cmd} /tmp/provision_logs #{reallogfile}")
+          end
+        end            
       end
       
       def update_file(file, resolving_machine = nil, include_id = true)

data/lib/vagrant-tagprovision/config.rb

@@ -0,0 +1,51 @@
+module VagrantPlugins
+  module Tagprovision
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :enabled
+      attr_accessor :log_provision
+      attr_accessor :tag_provision
+      attr_accessor :push_tag
+
+      def initialize
+        @enabled          = UNSET_VALUE
+        @log_provision    = UNSET_VALUE
+        @tag_provision    = UNSET_VALUE
+        @push_tag         = UNSET_VALUE
+
+      end
+
+      def finalize!
+        @enabled            = false if @enabled == UNSET_VALUE
+        @log_provision        = false if @log_provision == UNSET_VALUE
+        @tag_provision  = false if @tag_provision == UNSET_VALUE
+        @push_tag    = false if @push_tag == UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << validate_bool('hostmanager.enabled', @enabled)
+        errors << validate_bool('hostmanager.log_provision', @log_provision)
+        errors << validate_bool('hostmanager.tag_provision', @tag_provision)
+        errors << validate_bool('hostmanager.push_tag', @push_tag)
+        errors.compact!
+
+        { "Tagprovision configuration" => errors }
+      end
+
+      private
+
+      def validate_bool(key, value)
+        if ![TrueClass, FalseClass].include?(value.class) &&
+           value != UNSET_VALUE
+          I18n.t('vagrant_tagprovision.config.not_a_bool', {
+            :config_key => key,
+            :value      => value.class.to_s
+          })
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-tagprovision/plugin.rb

@@ -13,7 +13,17 @@ module VagrantPlugins
       This plugin tags the git repo when a server is provisioned.
       DESC
 
-
+      config(:tagprovision) do
+        require_relative 'config'
+        Config
+      end
+      
+      # Work-around for vagrant >= 1.5
+      # It breaks without a provisioner config, so we provide a dummy one
+      config(:tagprovision, :provisioner) do
+        ::Vagrant::Config::V2::DummyConfig.new
+      end
+      
       action_hook("Tagprovision_hook", :machine_action_up) do |hook|
         require_relative "action"
         hook.prepend(Action)

data/lib/vagrant-tagprovision/util.rb

@@ -0,0 +1,14 @@
+module VagrantPlugins
+  module Tagprovision
+    module Util
+      def self.get_config(env)
+        # config_global has been removed from v1.5
+        if Gem::Version.new(::Vagrant::VERSION) >= Gem::Version.new('1.5')
+          env.vagrantfile.config
+        else
+          env.config_global
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-tagprovision/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Tagprovision
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/vagrant-tagprovision.rb

@@ -4,6 +4,10 @@ require "vagrant-tagprovision/plugin"
 
 module VagrantPlugins
   module Tagprovision
-
+    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/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  vagrant_tagprovision:
+    config:
+      not_a_bool: "A value for %{config_key} can only be true or false, not type '%{value}'"
+      not_an_array_or_string: "A value for %{config_key} must be an Array or String, not type '%{is_class}'"
+      not_a_proc: "A value for %{config_key} must be a Proc, not type '%{is_class}'"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-tagprovision
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - jimrobinson
@@ -53,8 +53,11 @@ files:
 - Vagrantfile
 - lib/vagrant-tagprovision.rb
 - lib/vagrant-tagprovision/action.rb
+- lib/vagrant-tagprovision/config.rb
 - lib/vagrant-tagprovision/plugin.rb
+- lib/vagrant-tagprovision/util.rb
 - lib/vagrant-tagprovision/version.rb
+- locales/en.yml
 - vagrant-tagprovision.gemspec
 homepage: https://github.com/jscrobinson/vagrant-tagprovision
 licenses: