pupistry 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d510aff9adf9c6b3be5c31627368e8f121cd688b
-  data.tar.gz: 1ea65ab0a96149ce31b622cadbfda987ea1583d1
+  metadata.gz: 8e3280a3e4dd9385278ae57d3ce8ac72ada37c0f
+  data.tar.gz: 1625107171f0d871a16b35008fac3c5e4ba3db63
 SHA512:
-  metadata.gz: 15f88302ae54dd109db24ec08a8ae0852edb75070f0ef7f80ade1f15c1e5fd53f9b631624c9d04e7200cd4e372a6aa4e8d1b7b139362a6a1d41425d5a55aa205
-  data.tar.gz: c18e071d7a52a28ea87d656fc5942b6ae27a3c2adefdd9bc41d74ca4ce980f64152eab386505caef9e4e9f1e38fd3889c55a7706f5050eddf7169d43da2fe46c
+  metadata.gz: 388aeb48985189832a1acd9f3e469cf07ec3a3eb784dee51fea8be3fae325dac439802727d8e7efcf124304e035ed9b53450051c0a2df3cdb4e35b7db5378b60
+  data.tar.gz: c8c90250e40b22b82c9192a96dc3f1d572d84b6b4f01c7303be889ffaadee86ea266fa76c800f521338696ad7537875c83c6ab49a8a75a196e2c6db9d6de455d

data/README.md

@@ -1,5 +1,7 @@
 # pupistry
 
+[![Build Status](https://travis-ci.org/jethrocarr/pupistry.svg)](https://travis-ci.org/jethrocarr/pupistry)
+
 Pupistry (puppet + artistry) is a solution for implementing reliable and secure
 masterless puppet deployments by taking Puppet modules assembled by r10k and
 generating compresed and signed archives for distribution to the masterless
@@ -501,7 +503,9 @@ author.
 
 When developing Pupistry, you can run the git repo copy with:
 
-    ruby -Ilib/ -r rubygems bin/pupistry
+    gem install bundler
+    bundle install
+    bundle exec pupistry
 
 By default Pupistry will try to load a settings.yaml file in the current
 working directory, before then trying `~/.pupistry/settings.yaml` and then
@@ -510,6 +514,14 @@ finally `/etc/pupistry/settings.yaml`. You can also override with `--config`.
 Add `--verbose` for additional debugging information. If you have a bug this
 is the first thing you should run to get more context for reports.
 
+Whilst Pupistry has few tests, we would like to improve this. Please feel free
+to contribute any additional tests and aim to write tests for new features and
+definetly for any bug fixes. Once you have written tests, check the output of
+the tests and Rubocop with:
+
+    bundle exec rake
+
+
 
 # Contributions
 

data/{bin → exe}/pupistry

@@ -14,23 +14,20 @@ STDOUT.sync = true
 # Logging - STDOUT only
 $logger = Logger.new(STDOUT)
 
-
 # Thor is a toolkit for producing command line applications, see http://whatisthor.com/
 class CLI < Thor
-  class_option :verbose, :type => :boolean
-  class_option :config, :type => :string
-
+  class_option :verbose, type: :boolean
+  class_option :config, type: :string
 
   ## Agent Commands
-  
-  desc "apply", "Apply the latest Puppet artifact"
-  method_option :noop,        :type => :boolean, :desc => "No changes mode (note: does change checked out artifact, but no Puppet changes)"
-  method_option :force,       :type => :boolean, :desc => "Ignore existing versions, re-apply every time"
-  method_option :minimal,     :type => :boolean, :desc => "Don't run Puppet unless the artifact has changed"
-  method_option :daemon,      :type => :boolean, :desc => "Run as a system daemon"
-  method_option :environment, :type => :string,  :desc => "Specifiy which environment to deploy (default: master)"
-  def apply
 
+  desc 'apply', 'Apply the latest Puppet artifact'
+  method_option :noop,        type: :boolean, desc: 'No changes mode (note: does change checked out artifact, but no Puppet changes)'
+  method_option :force,       type: :boolean, desc: 'Ignore existing versions, re-apply every time'
+  method_option :minimal,     type: :boolean, desc: "Don't run Puppet unless the artifact has changed"
+  method_option :daemon,      type: :boolean, desc: 'Run as a system daemon'
+  method_option :environment, type: :string,  desc: 'Specifiy which environment to deploy (default: master)'
+  def apply
     # Thor seems to force class options to be defined repeatedly? :-/
     if options[:verbose]
       $logger.level = Logger::DEBUG
@@ -45,14 +42,9 @@ class CLI < Thor
     end
 
     # Muppet Check
-    if options[:noop] and options[:daemon]
-      $logger.warn "A daemon running in noop will do nothing except log what changes it could apply"
-    end
-
-    if options[:force] and options[:daemon]
-      $logger.warn "A daemon running with force will be very wasteful of system resources! NOT RECOMMENDED."
-    end
+    $logger.warn 'A daemon running in noop will do nothing except log what changes it could apply' if options[:noop] and options[:daemon]
 
+    $logger.warn 'A daemon running with force will be very wasteful of system resources! NOT RECOMMENDED.' if options[:force] and options[:daemon]
 
     if options[:daemon]
       # Run as a daemon service
@@ -63,13 +55,10 @@ class CLI < Thor
     end
   end
 
-
-
   ## Workstation Commands
 
-  desc "build", "Build a new archive file"
+  desc 'build', 'Build a new archive file'
   def build
-
     # Thor seems to force class options to be defined repeatedly? :-/
     if options[:verbose]
       $logger.level = Logger::DEBUG
@@ -83,7 +72,6 @@ class CLI < Thor
       Pupistry::Config.find_and_load
     end
 
-
     begin
       # Fetch the latest data with r10k
       artifact = Pupistry::Artifact.new
@@ -91,20 +79,17 @@ class CLI < Thor
       artifact.fetch_r10k
       artifact.build_artifact
 
-      puts "--"
-      puts "Tip: Run pupistry diff to see what changed since the last artifact version"
+      puts '--'
+      puts 'Tip: Run pupistry diff to see what changed since the last artifact version'
 
-    rescue Exception => e
-      $logger.fatal "An unexpected error occured when trying to generate the new artifact file"
+    rescue StandardError => e
+      $logger.fatal 'An unexpected error occured when trying to generate the new artifact file'
       raise e
     end
-
   end
 
-
-  desc "diff", "Show what has changed between now and the current live artifact"
+  desc 'diff', 'Show what has changed between now and the current live artifact'
   def diff
-
     # Thor seems to force class options to be defined repeatedly? :-/
     if options[:verbose]
       $logger.level = Logger::DEBUG
@@ -123,7 +108,7 @@ class CLI < Thor
     artifact_upstream.checksum = artifact_upstream.fetch_latest
 
     unless artifact_upstream.checksum
-      $logger.error "There is no upstream artifact to compare to."
+      $logger.error 'There is no upstream artifact to compare to.'
       exit 0
     end
 
@@ -134,16 +119,14 @@ class CLI < Thor
     artifact_current.checksum = artifact_current.fetch_current
 
     unless artifact_current.checksum
-      $logger.error "There is no current artifact to compare to, run \"pupistry build\" first to generate one with current changes"
+      $logger.error 'There is no current artifact to compare to, run "pupistry build" first to generate one with current changes'
       exit 0
     end
 
     artifact_current.fetch_artifact
 
     # Are they the same version?
-    if artifact_current.checksum == artifact_upstream.checksum
-      $logger.info "Current version and upstream version are the same, no diff"
-    end
+    $logger.info 'Current version and upstream version are the same, no diff' if artifact_current.checksum == artifact_upstream.checksum
 
     # Unpack the archives
     artifact_current.unpack
@@ -161,25 +144,22 @@ class CLI < Thor
     #       produce a new mega diff, we want only the real changes to be
     #       easily visible, or the diff function loses value to people.
     #       Pull requests welcome :-) xoxo
-    
-    Dir.chdir("#{$config["general"]["app_cache"]}/artifacts/") do
+
+    Dir.chdir("#{$config['general']['app_cache']}/artifacts/") do
       unless system "diff -Nuar unpacked.#{artifact_upstream.checksum} unpacked.#{artifact_current.checksum}"
       end
     end
 
-
     # Cleanup
     artifact_current.clean_unpack
     artifact_upstream.clean_unpack
 
-    puts "--"
-    puts "Tip: Run pupistry push to GPG sign & upload if happy to go live"
+    puts '--'
+    puts 'Tip: Run pupistry push to GPG sign & upload if happy to go live'
   end
 
-
-  desc "push", "Sign & Upload a new artifact version"
+  desc 'push', 'Sign & Upload a new artifact version'
   def push
-
     # Thor seems to force class options to be defined repeatedly? :-/
     if options[:verbose]
       $logger.level = Logger::DEBUG
@@ -198,12 +178,10 @@ class CLI < Thor
     artifact.push_artifact
   end
 
-
-  desc "bootstrap", "Generate a user-data bootstrap script for a node"
-  method_option :template, :type => :string, :desc => 'The template you want to generate'
-  method_option :base64, :type => :boolean, :desc => 'Output in base64 format'
+  desc 'bootstrap', 'Generate a user-data bootstrap script for a node'
+  method_option :template, type: :string, desc: 'The template you want to generate'
+  method_option :base64, type: :boolean, desc: 'Output in base64 format'
   def bootstrap
-
     # Thor seems to force class options to be defined repeatedly? :-/
     if options[:verbose]
       $logger.level = Logger::DEBUG
@@ -217,7 +195,6 @@ class CLI < Thor
       Pupistry::Config.find_and_load
     end
 
-
     if options[:template]
       $logger.info "Generating bootstrap template #{options[:template]}"
 
@@ -232,20 +209,17 @@ class CLI < Thor
     else
       templates = Pupistry::Bootstrap.new
       templates.list
-     
-      puts "--"
-      puts "Tip: Run `pupistry bootstrap --template example` to generate a specific template"
+
+      puts '--'
+      puts 'Tip: Run `pupistry bootstrap --template example` to generate a specific template'
     end
-      
   end
 
-
   ## Other Commands
 
-  desc "setup", "Write a template configuration file"
-  method_option :force,       :type => :boolean, :desc => "Replace an existing config file"
+  desc 'setup', 'Write a template configuration file'
+  method_option :force, type: :boolean, desc: 'Replace an existing config file'
   def setup
-
     # Thor seems to force class options to be defined repeatedly? :-/
     if options[:verbose]
       $logger.level = Logger::DEBUG
@@ -253,52 +227,49 @@ class CLI < Thor
       $logger.level = Logger::INFO
     end
 
-
     # Generally we should put the Pupistry configuration into the home dir, a
     # developer who wants it elsewhere will be capable of figuring out how to
     # install themselves.
-    config_dest = "~/.pupistry/settings.yaml"
+    config_dest = '~/.pupistry/settings.yaml'
 
     # If the HOME environmental hasn't been set, dump the config into CWD.
     unless ENV['HOME']
       config_dest = "#{Dir.pwd}/settings.yaml"
       $logger.warn "HOME is not set, so writing configuration file into #{config_dest}"
     end
-    
+
     config_dest = File.expand_path config_dest
 
     # Make sure the directory exists
-    unless Dir.exists?(File.dirname(config_dest))
-      FileUtils.mkdir_p(File.dirname(config_dest))
-    end
+    FileUtils.mkdir_p(File.dirname(config_dest)) unless Dir.exist?(File.dirname(config_dest))
 
     # Does a local template exist?
-    if File.exists?("#{Dir.pwd}/settings.example.yaml")
+    if File.exist?("#{Dir.pwd}/settings.example.yaml")
       config_source = "#{Dir.pwd}/settings.example.yaml"
     else
       # Check for GEM installed location
       begin
-        config_source = Gem::Specification.find_by_name("pupistry").gem_dir
+        config_source = Gem::Specification.find_by_name('pupistry').gem_dir
         config_source = "#{config_source}/settings.example.yaml"
       rescue Gem::LoadError
         # Yeah I dunno what you're doing...
-        $logger.error "Unable to find settings.example.yaml, seems we are not running as a Gem nor in the CWD of the app source"
+        $logger.error 'Unable to find settings.example.yaml, seems we are not running as a Gem nor in the CWD of the app source'
         exit 0
       end
     end
 
-    unless File.exists?(config_source)
+    unless File.exist?(config_source)
       $logger.error "Template configuration should exist in #{config_source} but no file found/readable!"
       exit 0
     end
 
     # Prevent Overwrite
-    if File.exists?(config_dest)
-      unless options[:force]
+    if File.exist?(config_dest)
+      if options[:force]
+        $logger.warn "Overwriting #{config_dest}..."
+      else
         $logger.error "Configuration file #{config_dest} already exists, if you wish to replace it please call with --force"
         exit 0
-      else
-        $logger.warn "Overwriting #{config_dest}..."
       end
     end
 
@@ -307,7 +278,7 @@ class CLI < Thor
       FileUtils.cp config_source, config_dest
 
       $logger.info "Successfully installed configuration file into #{config_dest}"
-    rescue Exception => e
+    rescue StandardError => e
       $logger.error "An unexpected error occured when copying #{config_source} to #{config_dest}"
       raise e
     end
@@ -322,9 +293,7 @@ class CLI < Thor
     else
       $logger.info "You now need to edit #{config_dest} with your configuration values before running Pupistry."
     end
-
   end
-
 end
 
 CLI.start(ARGV)

data/lib/pupistry.rb

@@ -1,3 +1,4 @@
+require 'pupistry/version'
 require 'pupistry/agent'
 require 'pupistry/artifact'
 require 'pupistry/bootstrap'
@@ -5,5 +6,4 @@ require 'pupistry/config'
 require 'pupistry/gpg'
 require 'pupistry/storage_aws'
 
-
 # vim:shiftwidth=2:tabstop=2:softtabstop=2:expandtab:smartindent

data/lib/pupistry/agent.rb

@@ -1,80 +1,69 @@
+# rubocop:disable Style/GlobalVars
 require 'rubygems'
 require 'fileutils'
 require 'rufus/scheduler'
 
+# Pupistry::Agent
 module Pupistry
-  # Pupistry::Agent
-
+  # Functions for running the Pupistry agent aka "apply mode" to actually
+  # download and run Puppet against the contents of the artifact.
   class Agent
-    # Functions for running the Pupistry agent aka "apply mode" to actually
-    # download and run Puppet against the contents of the artifact.
-
-
-    def self.daemon options
-      ## Run as a daemon
-
-
+    ## Run as a daemon
+    def self.daemon(options)
       # Since options comes from Thor, it can't be modified, so we need to
       # copy the options and then we can edit it.
 
-      options_new = options.inject({}) do |new, (name, value)| 
-        new[name] = value;
-        new 
+      options_new = options.inject({}) do |new, (name, value)|
+        new[name] = value
+        new
       end
 
       # If the minimal mode has been enabled in config, respect.
-      if $config["agent"]["daemon_minimal"]
-        options_new[:minimal] = true
-      end
+      options_new[:minimal] = true if $config['agent']['daemon_minimal']
 
       # If no frequency supplied, use 300 seconds safe default.
-      unless $config["agent"]["daemon_frequency"]
-        $config["agent"]["daemon_frequency"] = 300
-      end
-
+      $config['agent']['daemon_frequency'] = 300 unless $config['agent']['daemon_frequency']
 
       # Use rufus-scheduler to run our apply job as a regularly scheduled job
       # but with build in locking handling.
-      
-      $logger.info "Launching daemon... frequency of #{$config["agent"]["daemon_frequency"]} seconds."
+
+      $logger.info "Launching daemon... frequency of #{$config['agent']['daemon_frequency']} seconds."
 
       begin
 
         scheduler = Rufus::Scheduler.new
 
-        scheduler.every "#{$config["agent"]["daemon_frequency"]}s", :overlap => false, :timeout => '1d', :first_at => Time.now + 1 do
-          $logger.info "Triggering another Pupistry run (#{$config["agent"]["daemon_frequency"]}s)"
+        scheduler.every "#{$config['agent']['daemon_frequency']}s", overlap: false, timeout: '1d', first_at: Time.now + 1 do
+          $logger.info "Triggering another Pupistry run (#{$config['agent']['daemon_frequency']}s)"
           apply options_new
         end
 
         scheduler.join
 
       rescue Rufus::Scheduler::TimeoutError
-        $logger.error "A run of Pupistry timed out after 1 day as a safety measure. There may be a bug or a Puppet action causing it to get stuck"
+        $logger.error 'A run of Pupistry timed out after 1 day as a safety measure. There may be a bug or a Puppet action causing it to get stuck'
 
-      rescue SignalException => e
+      rescue SignalException
         # Clean shutdown signal (eg SIGTERM)
-        $logger.info "Clean shutdown of Pupistry daemon requests"
+        $logger.info 'Clean shutdown of Pupistry daemon requests'
         exit 0
 
-      rescue Exception => e
+      rescue StandardError => e
         raise e
       end
-
     end
 
-
-    def self.apply options
+    def self.apply(options)
       ## Download and apply the latest artifact (if any)
 
       # Fetch artifact versions
-      $logger.info "Checking version of artifact available..."
+      $logger.info 'Checking version of artifact available...'
 
       artifact = Pupistry::Artifact.new
       artifact.checksum = artifact.fetch_latest
 
       unless artifact.checksum
-        $logger.error "There is no current artifact available for download, no steps can be taken."
+        $logger.error 'There is no current artifact available for download, no steps can be taken.'
         return false
       end
 
@@ -84,18 +73,16 @@ module Pupistry
       if artifact_installed.checksum
         $logger.debug "Currently on #{artifact_installed.checksum}"
       else
-        $logger.debug "No currently installed artifact - blank slate!"
+        $logger.debug 'No currently installed artifact - blank slate!'
       end
 
       # Download the new artifact if one has changed. If we already have this
       # version, then we should skip downloading and go straight to running
       # Puppet - unless the user runs with --force (eg to fix a corrupted
       # artifact).
-      
-      if artifact.checksum != artifact_installed.checksum or options[:force]
-        if options[:force]
-          $logger.warn "Forcing download of latest artifact regardless of current one."
-        end
+
+      if artifact.checksum != artifact_installed.checksum || options[:force]
+        $logger.warn 'Forcing download of latest artifact regardless of current one.' if options[:force]
 
         # Install the artifact
         $logger.info "Downloading latest artifact (#{artifact.checksum})..."
@@ -104,14 +91,14 @@ module Pupistry
         artifact.unpack
 
         unless artifact.install
-          $logger.fatal "An unexpected error happened when installing the latest artifact, cancelling Puppet run"
+          $logger.fatal 'An unexpected error happened when installing the latest artifact, cancelling Puppet run'
           return false
         end
 
         # Remove temporary unpacked files
         artifact.clean_unpack
       else
-        $logger.info "Already have latest artifact applied."
+        $logger.info 'Already have latest artifact applied.'
 
         # By default we run Puppet even if we have the latest artifact. There's
         # some grounds for debate about whether this is the right thing - in some
@@ -125,9 +112,9 @@ module Pupistry
         # To provide users with options, we provide the --lazy parameter to avoid
         # running Puppet except when the artifact changes. By default, Puppet
         # runs every thing to avoid surprise.
-        
+
         if options[:minimal]
-          $logger.info "Running with minimal effort mode enabled, not running Puppet since artifact version already applied"
+          $logger.info 'Running with minimal effort mode enabled, not running Puppet since artifact version already applied'
           return false
         end
 
@@ -140,35 +127,28 @@ module Pupistry
         environment = 'master'
       end
 
-      unless Dir.exists?("#{$config["agent"]["puppetcode"]}/#{environment}")
+      unless Dir.exist?("#{$config['agent']['puppetcode']}/#{environment}")
         $logger.fatal "The requested branch/environment of #{environment} does not exist, unable to run Puppet"
         return false
       end
 
-
       # Execute Puppet.
-      puppet_cmd = "puppet apply"
+      puppet_cmd = 'puppet apply'
 
-      if options[:noop]
-        puppet_cmd += " --noop"
-      end
+      puppet_cmd += ' --noop' if options[:noop]
 
       puppet_cmd += " --environment #{environment}"
-      puppet_cmd += " --confdir #{$config["agent"]["puppetcode"]}"
-      puppet_cmd += " --modulepath #{$config["agent"]["puppetcode"]}/#{environment}/modules/"
-      puppet_cmd += " --hiera_config #{$config["agent"]["puppetcode"]}/#{environment}/hiera.yaml"
-      puppet_cmd += " #{$config["agent"]["puppetcode"]}/#{environment}/manifests/site.pp"
+      puppet_cmd += " --confdir #{$config['agent']['puppetcode']}"
+      puppet_cmd += " --modulepath #{$config['agent']['puppetcode']}/#{environment}/modules/"
+      puppet_cmd += " --hiera_config #{$config['agent']['puppetcode']}/#{environment}/hiera.yaml"
+      puppet_cmd += " #{$config['agent']['puppetcode']}/#{environment}/manifests/site.pp"
 
-      $logger.info "Executing Puppet..."
+      $logger.info 'Executing Puppet...'
       $logger.debug "With: #{puppet_cmd}"
 
-      unless system puppet_cmd
-        $logger.error "An unexpected issue occured when running puppet"
-      end
-
+      $logger.error 'An unexpected issue occured when running puppet' unless system puppet_cmd
     end
-
-  end 
+  end
 end
 
 # vim:shiftwidth=2:tabstop=2:softtabstop=2:expandtab:smartindent