puppet-ghostbuster 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48db269b56e5bd75a9c1aa3349c578bf244957b3
-  data.tar.gz: caf14c62cef78d4f307302b5afc38d012f39824d
+  metadata.gz: d56eb52cd4557da70d2d921969152ef7e8e49722
+  data.tar.gz: d4c72dd1fda2b98c096c7eb533959c431adc1aa9
 SHA512:
-  metadata.gz: 0084173d38ed6fb21824f3ec750a70c9fe290a2f8a9c4d53bb45cbd9dbef64574d453f8dec6ef34ff9c85b900f04465dfed5cab9023b6771b507c8028d4d1ffe
-  data.tar.gz: ea9d82fd853ef6c0e20360729e700b3bf04d92dbdf4885217b5db56d9bb439f66c4b4ecc38dd255b87ecc0b649984df55e59b8ceae1b6f257c50887c1c016de9
+  metadata.gz: 005cacf8fe81037d81b292974a9d0a06bd7baf17063ee23e50bf1e7188e462e7481cd20ffe3510d49ae14e9acf6fc5359bbf74e8c3d017b95629a1bb6c95c21b
+  data.tar.gz: 76beedef79101ed3cd1b270cffc756f8cdd9174ef281594cbf0cde2596d642326b7796fa85f68c30589147ebe28bbebcf006ebecf0c4cffc7bff26438009ca8c

data/lib/puppet-ghostbuster/bin.rb

@@ -1,10 +1,31 @@
+require 'puppet-ghostbuster/optparser'
 class PuppetGhostbuster::Bin
   def initialize(args)
     @args = args
   end
 
   def run
-    PuppetGhostbuster.new
+    opts = PuppetGhostbuster::OptParser.build
+
+    begin
+      opts.parse!(@args)
+    rescue OptionParser::InvalidOption
+      puts "puppet-ghostbuster: #{$!.message}"
+      puts "puppet-ghostbuster: try 'puppet-ghostbuster --help' for more information"
+      return 1
+    end
+
+    if PuppetGhostbuster.configuration.display_version
+      puts "puppet-ghostbuster #{PuppetGhostbuster::VERSION}"
+      return 0
+    end
+   
+    if @args[0].nil?
+      PuppetGhostbuster.new().run
+    else
+      PuppetGhostbuster.new(@args[0]).run
+    end
+
     exit 0
   end
 end

data/lib/puppet-ghostbuster/configuration.rb

@@ -0,0 +1,95 @@
+class PuppetGhostbuster
+  # Public: A singleton class to store the running configuration of
+  # puppet-ghostbuster.
+  class Configuration
+
+    def initialize
+      Puppet.initialize_settings 
+    end
+
+    # Public: Catch situations where options are being set for the first time
+    # and create the necessary methods to get & set the option in the future.
+    #
+    # args   - An Array of values to set the option to.
+    # method - The String name of the option.
+    # block  - Unused.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>=(value)
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /^(\w+)=$/
+        option = $1
+        add_option(option.to_s) if settings[option].nil?
+        settings[option] = args[0]
+      else
+        nil
+      end
+    end
+
+    # Internal: Add options to the PuppetGhostbuster::Configuration object from inside
+    # the class.
+    #
+    # option - The String name of the option.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>
+    #   <option>=(value)
+    def add_option(option)
+      self.class.add_option(option)
+    end
+
+    # Public: Add an option to the PuppetGhostbuster::Configuration object from
+    # outside the class.
+    #
+    # option - The String name of the option.
+    #
+    # Returns nothing.
+    #
+    # Signature
+    #
+    #   <option>
+    #   <option>=(value)
+    def self.add_option(option)
+      # Public: Set the value of the named option.
+      #
+      # value - The value to set the option to.
+      #
+      # Returns nothing.
+      define_method("#{option}=") do |value|
+        settings[option] = value
+      end
+
+      # Public: Get the value of the named option.
+      #
+      # Returns the value of the option.
+      define_method(option) do
+        settings[option]
+      end
+    end
+
+    # Internal: Access the internal storage for settings.
+    #
+    # Returns a Hash containing all the settings.
+    def settings
+      @settings ||= {}
+    end
+
+    # Public: Clear the PuppetGhostbuster::Configuration storage and set some sane
+    # default values.
+    #
+    # Returns nothing.
+    def defaults
+      settings.clear
+      self.puppetdbserverurl = "https://#{Puppet[:server]}:8081"
+      self.hostprivkey = Puppet[:hostprivkey]
+      self.hostcert    = Puppet[:hostcert]
+      self.localcacert = Puppet[:localcacert]
+    end
+  end
+end

data/lib/puppet-ghostbuster/optparser.rb

@@ -0,0 +1,63 @@
+require 'optparse'
+
+# Public: Contains the puppet-ghostbuster option parser so that it can be used easily
+# in multiple places.
+class PuppetGhostbuster::OptParser
+  HELP_TEXT = <<-EOF
+    puppet-ghostbuster
+
+    Basic Command Line Usage:
+      puppet-ghostbuster [OPTIONS] [PATH]
+
+            PATH        Path to the Root directory of puppet code. Current dir by default.
+
+    Option:
+  EOF
+
+  # Public: Initialise a new puppet-ghostbuster OptionParser.
+  #
+  # Returns an OptionParser object.
+  def self.build
+    OptionParser.new do |opts|
+      opts.banner = HELP_TEXT
+
+      opts.on('--version', 'Display the current version.') do
+        PuppetGhostbuster.configuration.display_version = true
+      end
+
+      opts.on('-c', '--config FILE', 'Load puppet-ghostbuster options from file.') do |file|
+        opts.load(file)
+      end
+
+      opts.on('--error-level LEVEL', [:all, :warning, :error],
+              'The level of error to return (warning, error or all).') do |el|
+        PuppetGhostbuster.configuration.error_level = el
+      end
+
+      opts.on('-s', '--puppetdburl SERVER', 'puppet db server url to connect to.') do |s|
+        PuppetGhostbuster.configuration.puppetdbserverurl = s
+      end
+
+      opts.on('--key FILE', 'Load private key from the given file.') do |file|
+        PuppetGhostbuster.configuration.hostprivkey
+      end
+
+      opts.on('--cert FILE', 'Load cert from the given file.') do |file|
+        PuppetGhostbuster.configuration.hostcert
+      end
+
+      opts.on('--ca FILE', 'Load local ca cert from the given file.') do |file|
+        PuppetGhostbuster.configuration.localcacert
+      end
+
+      opts.load('/etc/puppet-ghostbuster.rc')
+      begin
+        opts.load(File.expand_path('~/.puppet-ghostbuster.rc')) if ENV['HOME']
+      rescue Errno::EACCES
+        # silently skip loading this file if HOME is set to a directory that
+        # the user doesn't have read access to.
+      end
+      opts.load('.puppet-ghostbuster.rc')
+    end
+  end
+end

data/lib/puppet-ghostbuster/version.rb

@@ -1,3 +1,3 @@
 class PuppetGhostbuster
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/lib/puppet-ghostbuster.rb

@@ -1,14 +1,43 @@
 require 'json'
 require 'puppet'
 require 'puppetdb'
+require 'optparse'
 
 require 'puppet-ghostbuster/version'
 require 'puppet-ghostbuster/bin'
+require 'puppet-ghostbuster/configuration'
 
 class PuppetGhostbuster
 
+  attr_accessor :path
+
+  def manifests
+    Dir["#{path}/**/manifests/*.pp"]
+  end
+
+  def templates
+    Dir["#{path}/**/templates/*"]
+  end
+
+  def files
+    Dir["#{path}/**/files/*"]
+  end
+
+  def self.configuration
+    @configuration ||= PuppetGhostbuster::Configuration.new
+  end
+
+  def configuration
+    self.class.configuration
+  end
+
+
+  def self.puppetdbserverfilename
+    return configuration.puppetdbserverurl.gsub(/[:\/]/,'_')
+  end
+
   def self.cache
-    "/var/tmp/puppet-ghostbuster.cache"
+    "/var/tmp/puppet-ghostbuster.#{puppetdbserverfilename}.cache"
   end
 
   def self.update_cache(value)
@@ -28,16 +57,15 @@ class PuppetGhostbuster
 
   def self.client 
     PuppetDB::Client.new({
-      :server => "https://#{Puppet[:server]}:8081",
+      :server => configuration.puppetdbserverurl,
       :pem    => {
-        'key'     => Puppet[:hostprivkey],
-        'cert'    => Puppet[:hostcert],
-        'ca_file' => Puppet[:localcacert],
+        'key'     => configuration.hostprivkey,
+        'cert'    => configuration.hostcert,
+        'ca_file' => configuration.localcacert,
       }
     })
   end
 
-
   def self.used_classes
     return get_cache || update_cache(
       client.request(
@@ -50,7 +78,7 @@ class PuppetGhostbuster
   end
 
   def find_unused_classes
-    Dir["./**/manifests/**/*.pp"].each do |file|
+    manifests.each do |file|
       if c = File.readlines(file).grep(/^class\s+([^\s\(\{]+)/){$1}[0]
         class_name = c.split('::').map(&:capitalize).join('::')
         count = self.class.used_classes.select { |klass| klass == class_name }.size
@@ -60,7 +88,7 @@ class PuppetGhostbuster
   end
 
   def find_unused_defines
-    Dir["./**/manifests/**/*.pp"].each do |file|
+    manifests.each do |file|
       if d = File.readlines(file).grep(/^define\s+([^\s\(\{]+)/){$1}[0]
         define_name = d.split('::').map(&:capitalize).join('::')
         count = self.class.client.request('resources', [:'=', 'type', define_name]).data.size
@@ -70,11 +98,11 @@ class PuppetGhostbuster
   end
 
   def find_unused_templates
-    Dir['./**/templates/*'].each do |template|
+    templates.each do |template|
       next unless File.file?(template)
       module_name, template_name = template.match(/.*\/([^\/]+)\/templates\/(.+)$/).captures
       count = 0
-      Dir["./**/manifests/**/*.pp"].each do |manifest|
+      manifests.each do |manifest|
         if match = manifest.match(/.*\/([^\/]+)\/manifests\/.+$/)
           manifest_module_name = match.captures[0]
           count += File.readlines(manifest).grep(/["']\$\{module_name\}\/#{template_name}["']/).size if manifest_module_name == module_name
@@ -86,28 +114,34 @@ class PuppetGhostbuster
   end
 
   def find_unused_files
-    Dir['./**/files/*'].each do |file|
+    files.each do |file|
       next unless File.file?(file)
       module_name, file_name = file.match(/.*\/([^\/]+)\/files\/(.+)$/).captures
       count = 0
-      Dir["."].each do |caller_file|
+      Dir["#{path}"].each do |caller_file|
         next unless File.file?(caller_file)
-        if caller_file =~ /\.pp$/
-          if match = manifest.match(/.*\/([^\/]+)\/manifests\/.+$/)
-            manifest_module_name = match.captures[0]
-            if manifest_module_name == module_name
-              count += File.readlines(caller_file).grep(/["']\$\{module_name\}\/#{file_name}["']/).size
+        begin
+          if caller_file =~ /\.pp$/
+            if match = caller_file.match(/.*\/([^\/]+)\/manifests\/.+$/)
+              manifest_module_name = match.captures[0]
+              if manifest_module_name == module_name
+                count += File.readlines(caller_file).grep(/["']\$\{module_name\}\/#{file_name}["']/).size
+              end
             end
           end
+          count += File.readlines(caller_file).grep(/#{module_name}\/#{file_name}/).size
+        rescue ArgumentError
         end
-        count += File.readlines(caller_file).grep(/#{module_name}\/#{file_name}/).size
       end
       puts "File #{file} not used" if count == 0
     end
   end
 
-  def initialize
-    Puppet.initialize_settings
+  def initialize(path = '.')
+    self.path = path
+  end
+
+  def run
     find_unused_classes
     find_unused_defines
     find_unused_templates
@@ -115,3 +149,5 @@ class PuppetGhostbuster
   end
 
 end
+
+PuppetGhostbuster.configuration.defaults

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-ghostbuster
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Camptocamp
@@ -66,6 +66,8 @@ files:
 - bin/puppet-ghostbuster
 - lib/puppet-ghostbuster.rb
 - lib/puppet-ghostbuster/bin.rb
+- lib/puppet-ghostbuster/configuration.rb
+- lib/puppet-ghostbuster/optparser.rb
 - lib/puppet-ghostbuster/version.rb
 - puppet-ghostbuster.gemspec
 homepage: http://github.com/camptocamp/puppet-ghostbuster