puppetbox 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6199b6d382c20f729a392c12218a9a5986dc4ac3
-  data.tar.gz: 4c8dcbc077105f11ff0b49c46657402ccebd2d27
+  metadata.gz: ad288284d9a66b09a591260219ab1c3ad31c9562
+  data.tar.gz: 810ebf10d5f24b32eb3ba98d01b45db454805bb8
 SHA512:
-  metadata.gz: c9cce6b05a5971072fadfa7a1e99e5e3e8d752cd34bcf8cab83ec2bc06ecd712470849e8ba9aa89201c9ad8ab87f5b1018c8fa9bef9b4e59e93136981a4d836f
-  data.tar.gz: 371fa53666addeff1d83b6e0aa5a8a6860e030f8ff1431d0fe3f5c0482076b4a62be625110219f5e2cc28dcb1d8bc01b854252e9c174f70b0c88203393ea71dc
+  metadata.gz: 35b2473e845e2aa9ad67d4012434a81ecaff79266d1a11823e29333eab3cb7cb78ffb8322f9e112b523967b142f7a19a29608c0e52d070fa8f5bb64558695745
+  data.tar.gz: 84b43a030638aad37d350bd7179882e1860f9bcd59ca324380ad7d45d2652cdb0df46276fd1384c77436bb90cf5a24aa43f69c8c6222c1e091ff8602a9c80968

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in puppetbox.gemspec
+gem 'derelict', :git => 'https://github.com/GeoffWilliams/derelict', :ref => 'preserve_real_status'
+
 gemspec

data/README.md

@@ -25,9 +25,15 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Additional vagrant boxes
+Many vagrant boxes that would be useful can't be shared for legal reasons, eg windows, suse, etc.  These requirements can be worked around by users producing their own Vagrant boxes for internal use.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+A really good source of build scripts is [bento](https://github.com/chef/bento) from Chef.
+
+PuppetBox requires each box:
+* Has puppet installed
+* Has all puppet executables in `$PATH`
+* Has the ability to work with vagrant shared folders.  This usually means guestbox additions must be installed, although rsync can work in some situations.  When using rsync, remember that your code will only be synced as your VM is reloaded
 
 ## Contributing
 

data/lib/puppetbox/driver/vagrant.rb

@@ -1,6 +1,82 @@
+require 'vagrantomatic/vagrantomatic'
+require 'puppetbox/result'
+require 'fileutils'
+require "puppetbox/logger"
+
 module PuppetBox
   module Driver
     class Vagrant
+      # fixme - seems abandoned, might need to make my own :(
+      DEFAULT_VAGRANT_BOX = "puppetlabs/centos-7.2-64-puppet"
+      PUPPET_CODE_MOUNT   = "/etc/puppetlabs/code/environments/production"
+
+      def initialize(name, codedir, keep_vm:true, working_dir:nil, config:{'box'=> DEFAULT_VAGRANT_BOX}, logger: nil)
+        @name         = name
+        @keep_vm      = keep_vm
+        @working_dir  = working_dir || File.join(Dir.home, '.puppetbox')
+        @config       = config
+        @result       = PuppetBox::Result.new
+        @logger       = PuppetBox::Logger.new(logger).logger
+
+        # Add the code dir to the config has so that it will automatically become
+        # a shared folder when the VM boots
+        @config["folders"] = "#{codedir}:#{PUPPET_CODE_MOUNT}"
+        @logger.debug "instance #{name} initialised"
+      end
+
+      def result
+        @result
+      end
+
+      # convert a derelelict (vagrant library used by vagrantomatic) exectutor to
+      # a result object as used by puppetbox
+      #
+      # Puppet exit status codes:
+      #   0: The run succeeded with no changes or failures; the system was already in the desired state.
+      #   1: The run failed, or wasn't attempted due to another run already in progress.
+      #   2: The run succeeded, and some resources were changed.
+      #   4: The run succeeded, and some resources failed.
+      #   6: The run succeeded, and included both changes and failures.
+      def run_puppet(puppet_class)
+        run_hash = @vm.run("sudo -i puppet apply --detailed-exitcodes -e 'include #{puppet_class}'")
+        @result.report(run_hash[:status], run_hash[:messages])
+      end
+
+      # Open a connection to a box (eg start a vm, ssh to a host etc)
+      def open()
+        # make sure working dir exists...
+        FileUtils.mkdir_p(@working_dir)
+        vom = Vagrantomatic::Vagrantomatic.new(vagrant_vm_dir: @working_dir)
+
+        @logger.debug("reading instance metadata for #{@name}")
+        @vm = vom.instance(@name)
+
+        @logger.debug("...setting instance config and saving")
+
+        @vm.config=(@config)
+        @vm.save
+        @logger.debug("Instance saved and ready for starting")
+        @vm.start
+      end
+
+      # Close a connection to a box (eg stop a vm, probaly doesn't need to do
+      # anything on SSH...)
+      def close()
+        if ! @keep_vm
+          @vm.purge
+        end
+      end
+
+      # Test that a VM is operational and able to run puppet
+      def self_test()
+        @vm.run("sudo -i puppet --version")[:status] == 0
+      end
+
+      def run_puppet_x2(puppet_class)
+        # fixme - link module
+        run_puppet(puppet_class)
+        run_puppet(puppet_class)
+      end
 
     end
   end

data/lib/puppetbox/driver.rb

@@ -1,31 +1,20 @@
 module PuppetBox
-  module Driver
-    # Open a connection to a box (eg start a vm, ssh to a host etc)
-    def self.open()
-
-    end
-
-    # Close a connection to a box (eg stop a vm, probaly doesn't need to do
-    # anything on SSH...)
-    def self.close()
-
-    end
-
-    # Test that a VM is operational and able to run puppet
-    def self.selftest()
-
-    end
-
-    def self.puppet_apply_x2(puppet_class)
-
-    end
-
-    def self.log_error()
-    end
-
-    def self.log_debug()
-    end
-
+  # New drivers must implement the methods in this class (via ductyping)
+  class Driver
+    # def initialize(name, keep_vm=true)
+    # end
+    #
+    # def self.open()
+    # end
+    #
+    # def self.close()
+    # end
+    #
+    # def self.selftest()
+    # end
+    #
+    # def self.puppet_apply_x2(puppet_class)
+    # end
   end
 
 end

data/lib/puppetbox/logger.rb

@@ -1,3 +1,4 @@
+require "logger"
 module PuppetBox
   # Logger is a class to allow for stateful and separate logs between instances
   # by passing in individual loggers on initialisation
@@ -7,7 +8,10 @@ module PuppetBox
       if logger
         @logger = logger
       else
-        logger = Logger.new(STDOUT)
+        @logger = ::Logger.new(STDOUT)
+        @logger.formatter = proc do |severity, datetime, progname, msg|
+          "#{severity}: #{msg}"
+        end
       end
     end
 

data/lib/puppetbox/result.rb

@@ -18,7 +18,25 @@ module PuppetBox
       @report = []
     end
 
-    def report(status, messages)
+    # 0: The run succeeded with no changes or failures; the system was already in the desired state.
+    # 1: The run failed, or wasn't attempted due to another run already in progress.
+    # 2: The run succeeded, and some resources were changed.
+    # 4: The run succeeded, and some resources failed.
+    # 6: The run succeeded, and included both changes and failures.
+    def report(status_code, messages)
+      status = PS_ERROR
+      if @report.empty?
+        # first run
+        if status_code == 0 or status_code == 2
+          status = PS_OK
+        end
+      else
+        if status_code == 0
+          status = PS_OK
+        elsif status_code == 2
+          status = PS_NOT_IDEMPOTENT
+        end
+      end
       @report.push({:status => status, :messages => messages})
     end
 

data/lib/puppetbox/version.rb

@@ -1,3 +1,3 @@
 module PuppetBox
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/puppetbox.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "vagrantomatic"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppetbox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Geoff Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vagrantomatic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - geoff@geoffwilliams.me.uk