puppet-itemize 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df934c90b977a46344d8d447060b93bd4fa87487
-  data.tar.gz: 732ec69ca41de35db175ab77af2c59f5f287e3fd
+SHA256:
+  metadata.gz: 1625c1cacf7bc9c0373f02357fdef0d912ed642896c30c0fd372a38f84116924
+  data.tar.gz: 7dc10c68119882e62bb4587361a4d1f6b71ee2b94bd36a03af43c4f821863eee
 SHA512:
-  metadata.gz: c21938a92b1987f1f0d7f0f5b5a8f57ed9e1a0e5072275206c3dfcf12274da5d9253a5e4979ef37e438ce7c72afe65c13d099e3c5a7b3eeed3707ddae0d3dd2f
-  data.tar.gz: 8f2f894d7f6d5130759f04e5c85305220b16b3eba7921d51b5ae6eeaf67c0d2435d1b417a59872beb6fa3a49f009efc88460214e0e1ccc93eebd707174d7c0d3
+  metadata.gz: c18bb2c71c6ba444d2f11177c273a3ea7b7872ac1999c91d6d044ed90b9a80eb9fb3032ffbbeb6a3f6241bfbe496065f321af1292dee8c03eac8e2c353b642e5
+  data.tar.gz: ad95bc731049ae6d803e4961ab2cd1979e06c9adfb71e2d4a76c81c8ae8e0aa309205a99e6daa14c723bad30cfea83319eb7f811244f4d6299d0730adda7667b

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# v0.0.2
+
+* Add namespace validation. This will now warn you if you're using elements from
+  modules which have not been declared as dependencies.
+* Allow you to filter to external resources only.
+
+
+# v0.0.1
+
+* Initial release

data/README.md

@@ -18,7 +18,7 @@ $ gem install puppet-itemize
 Or as a Puppet module:
 
 ```
-$ puppet module install binford2k/puppet_itemize
+$ puppet module install binford2k/itemize
 ```
 
 ## Usage
@@ -54,6 +54,34 @@ $ puppet parser itemize manifests/init.pp
 $ puppet parser itemize manifests/init.pp manifests/example/path.pp
 ```
 
+### Module dependency validation
+
+If the tool can identify that you're running this on manifests within a Puppet
+module, then it will validate the dependencies listed in the `metadata.json`.
+By default, it will print out warnings for resources or classes that come from
+modules that aren't declared as dependencies. Facts and Puppet 3.x style functions
+aren't namespaced in the same way, so they cannot be identified, but Puppet 4.x
+namespaced functions will trigger the same validation.
+
+You can also use the `--external` argument. This will filter the output to only
+show elements which are either global or from other modules. This can be used to
+help identify how dependencies are being used.
+
+
+### Programatic use
+
+You can choose to render the output in either JSON or YAML for consumption by
+other tools or testing pipelines by simply passing the `--render-as` argument:
+
+```
+$ puppet parser itemize ~/Projects/puppetlabs-apache/manifests/ --render-as json
+$ puppet parser itemize ~/Projects/puppetlabs-apache/manifests/ --render-as yaml
+```
+
+It's also reasonably easy to invoke this as a library from Ruby tools. See the
+`bin/puppet-itemize` script for an example.
+
+
 ### Example output:
 
 Because this is static analysis prior to compilation, no variables can be
@@ -63,6 +91,12 @@ below in the class list as `apache::mod::<??>`.
 
 ```
 $ puppet parser itemize ~/Projects/puppetlabs-apache/manifests/
+Warning: Undeclared module dependancy: portage::makeconf
+Warning: Undeclared module dependancy: portage::makeconf
+Warning: Undeclared module dependancy: portage::makeconf
+Warning: Undeclared module dependancy: portage::makeconf
+Warning: Undeclared module dependancy: portage::makeconf
+Warning: Undeclared module dependancy: portage::makeconf
 Warning: create_resources detected. Please update to use iteration instead.
 Resource usage analysis:
 =======================================
@@ -176,6 +210,7 @@ Resource usage analysis:
                 create_resources |   1
 ```
 
+
 ## Limitations
 
 This is super early in development and has not yet been battle tested.
@@ -185,6 +220,7 @@ This is super early in development and has not yet been battle tested.
 
 I take no liability for the use of this tool.
 
+
 Contact
 -------
 

data/bin/puppet-itemize

@@ -17,6 +17,10 @@ directories containing manifests. If omitted, it will default to inspecting all
 manifests in the manifests directory, so you can just run this in the root of a
 Puppet module and it will do the right thing.
 
+If this is run from the root of a Puppet module or the `manifests` directory of
+a Puppet module, and the `--external` argument is passed, then it will only
+output elements that come from other modules (or are global).
+
 "
 
   opts.on('-r', '--render-as FORMAT', 'Render the output as human, json, or yaml') do |val|
@@ -33,6 +37,10 @@ Puppet module and it will do the right thing.
     options[:debug] = true
   end
 
+  opts.on('-x', '--external', 'Show external elements only') do
+    options[:debug] = true
+  end
+
   opts.on('--shell', 'Open a pry shell for debugging (must have Pry installed)') do
     options[:shell] = true
   end

data/lib/puppet/face/parser/itemize.rb

@@ -14,6 +14,10 @@ manifests in the manifests directory, so you can just run this in the root of a
 Puppet module and it will do the right thing.
     EOT
 
+    option('--external') do
+      summary 'Show external elements only.'
+    end
+
     option('--shell') do
       summary 'Start a debugging shell (requires Pry).'
     end

data/lib/puppet_x/binford2k/itemize/parser.rb

@@ -14,7 +14,6 @@ class Puppet_X::Binford2k::Itemize::Parser
       :classes   => {},
       :functions => {},
     }
-    Puppet::Util::Log.newdestination(:console)
   end
 
   def record(kind, thing)

data/lib/puppet_x/binford2k/itemize/runner.rb

@@ -1,9 +1,37 @@
+require 'puppet'
+require 'puppet/util/logging'
+require 'json'
+
 class Puppet_X::Binford2k::Itemize::Runner
   attr_reader :results
   def initialize(options = {})
-    @paths   = expand(Array(options[:manifests]))
-    @options = options
-    @results = {}
+    Puppet::Util::Log.newdestination(:console)
+
+    @paths     = expand(Array(options[:manifests]))
+    @options   = options
+    @results   = {}
+
+    if options[:manifests].size == 1
+      root = options[:manifests].first
+      path = [File.expand_path("#{root}/metadata.json"),
+              File.expand_path("#{root}/../metadata.json")].select { |p| File.exist? p }.first
+
+      if path
+        @metadata  = JSON.parse(File.read(File.expand_path("#{path}/../metadata.json")))
+        author     = @metadata['author']
+        @namespace = @metadata['name'].sub(/^#{author}-/, '')
+
+        # we can only use the module name part of this, not the user namespace
+        @dependencies = @metadata['dependencies'].map do |dep|
+          dep['name'].split(/[-\/]/).last
+        end
+        # inject a few mocked dependencies that we can assume will always exist
+        @dependencies << @namespace
+        @dependencies << 'puppet_enterprise'
+      else
+        # what error to display here?
+      end
+    end
   end
 
   def expand(paths)
@@ -27,6 +55,12 @@ class Puppet_X::Binford2k::Itemize::Runner
         @results[kind] ||= {}
 
         counts.each do |name, count|
+          segments = name.split('::')
+          if @dependencies and segments.size > 1
+            Puppet.warning "Undeclared module dependancy: #{name}" unless @dependencies.include? segments.first
+          end
+          next if @options[:external] and segments.first == @namespace
+
           @results[kind][name] ||= 0
           @results[kind][name]  += count
         end

data/lib/puppet_x/binford2k/itemize/version.rb

@@ -1,7 +1,7 @@
 module Puppet_X
   module Binford2k
     class Itemize
-      VERSION = '0.0.1'
+      VERSION = '0.0.2'
     end
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: puppet-itemize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description: |2
     Run this command with a space separated list of either manifest file paths, or
     directories containing manifests. If omitted, it will default to inspecting all
@@ -35,6 +41,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - bin/puppet-itemize
@@ -44,7 +51,7 @@ files:
 - lib/puppet_x/binford2k/itemize/parser.rb
 - lib/puppet_x/binford2k/itemize/runner.rb
 - lib/puppet_x/binford2k/itemize/version.rb
-homepage: https://github.com/binford2k/puppet-itemize
+homepage: https://github.com/binford2k/binford2k-itemize
 licenses:
 - Apache-2.0
 metadata: {}
@@ -64,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Count the number of types, classes, functions used in Puppet manifest(s).