puppetwash 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8eef1dd676ba28105ebfb9c74b550ff32797bfcf257f472e5058633782c59c7
+  data.tar.gz: 5963426b4d35b391aa9355f16162e69765c882e92924b0336437f6f4837cc0d1
+SHA512:
+  metadata.gz: abcc6fd791d8d5cbf21f05123dcd596b90dde855535854b7b20223bcb7af9d1bc1c1097a2d0b0e70a914d1690c6fb0b4449299349879afd7f419451b7be1213c
+  data.tar.gz: 3f4594240fcc3b1f5ad179f59c4d7a791a30fc5be789b920aee2a7c68cfd69b6111b49e12946239523460948930f8caaead1286f568fc2497e4b3866d92e7f35

data/puppet.rb

@@ -0,0 +1,253 @@
+#!/usr/bin/env ruby
+
+require 'wash'
+require 'puppetdb'
+require 'json'
+require 'yaml'
+
+def client(config)
+  if config[:rbac_token]
+    # PE token-based auth
+    PuppetDB::Client.new({
+      server: config[:puppetdb_url],
+      token:  config[:rbac_token],
+      cacert: config[:cacert]
+    })
+  else
+    # Cert-based auth
+    PuppetDB::Client.new({
+      server: config[:puppetdb_url],
+      pem: {
+        'ca_file' => config[:cacert],
+        'key'     => config[:key],
+        'cert'    => config[:cert]
+      }
+    })
+  end
+end
+
+def make_readable(value)
+  valueStr = value
+  unless valueStr.kind_of? String
+    valueStr = JSON.pretty_generate(value)
+  end
+  valueStr.chomp + "\n"
+end
+
+class Puppetwash < Wash::Entry
+  label 'puppet'
+  is_singleton
+  parent_of 'Instance'
+  state :config
+  description <<~DESC
+    A plugin for managing your Puppet instances (both PE and open source). Try `stree puppet`
+    to see all the things that this plugin lets you interact with.
+  DESC
+
+  def init(config)
+    @config = config
+  end
+
+  def list
+    @config.map do |name, instance_config|
+       Instance.new(name, instance_config)
+    end
+  end
+end
+
+class Instance < Wash::Entry
+  label 'instance'
+  parent_of 'Nodes'
+  state :config
+  description <<~DESC
+    This is a Puppet instance.
+  DESC
+
+  def initialize(name, config)
+    @name = name
+    @config = config
+  end
+
+  def list
+    [Nodes.new(@config)]
+  end
+end
+
+class Nodes < Wash::Entry
+  label 'nodes'
+  is_singleton
+  parent_of 'Node'
+  state :config
+
+  def initialize(config)
+    @name = 'nodes'
+    @config = config
+  end
+
+  def list
+    response = client(@config).request('nodes', nil)
+    response.data.map do |node|
+      Node.new(node, @config)
+    end
+  end
+end
+
+class Node < Wash::Entry
+  label 'node'
+  parent_of 'CatalogJSON', 'Facts', 'Reports'
+  state :config
+  description <<~DESC
+    This is a managed node. Use the `meta` command to view its metadata.
+  DESC
+
+  def initialize(node, config)
+    @name = node['certname']
+    @config = config
+    @partial_metadata = node
+    prefetch :list
+  end
+
+  def list
+    [
+      CatalogJSON.new(@name, @config),
+      Facts.new(@name, @config),
+      Reports.new(@name, @config)
+    ]
+  end
+end
+
+class CatalogJSON < Wash::Entry
+  label 'catalog.json'
+  is_singleton
+  state :node_name, :config
+  description <<~DESC
+    This is the node's most recent catalog. Try using `cat` to read its
+    contents.
+  DESC
+
+  def initialize(node_name, config)
+    @name = 'catalog.json'
+    @node_name = node_name
+    @config = config
+  end
+
+  def read
+    response = client(@config).request("catalogs/#{@node_name}", nil)
+    make_readable(response.data)
+  end
+end
+
+class Facts < Wash::Entry
+  label 'facts'
+  is_singleton
+  parent_of 'Fact'
+  state :node_name, :config
+
+  def initialize(node_name, config)
+    @name = 'facts'
+    @node_name = node_name
+    @config = config
+  end
+
+  def list
+    response = client(@config).request(
+      'facts',
+      [:'=', :certname, @node_name]
+    )
+    response.data.map do |fact|
+      Fact.new(fact['name'], fact['value'], @node_name, @config)
+    end
+  end
+end
+
+class Fact < Wash::Entry
+  label 'fact'
+  state :node_name, :config
+  description <<~DESC
+    This is a top-level fact of the given node.
+  DESC
+
+  def initialize(name, value, node_name, config)
+    @name = name
+    @value = value
+    @node_name = node_name
+    @config = config
+    prefetch :read
+  end
+
+  def read
+    make_readable(@value)
+  end
+end
+
+# Report relies on end_time and hash. The others are included as useful metadata.
+METADATA_FIELDS = {
+  'end_time': 'string',
+  'environment': 'string',
+  'status': 'string',
+  'noop': 'boolean',
+  'puppet_version': 'string',
+  'producer': 'string',
+  'hash': 'string'
+}
+
+class Reports < Wash::Entry
+  label 'reports'
+  is_singleton
+  parent_of 'Report'
+  state :node_name, :config
+
+  def initialize(node_name, config)
+    @name = 'reports'
+    @node_name = node_name
+    @config = config
+  end
+
+  def list
+    response = client(@config).request(
+      'reports',
+      [:extract,
+        METADATA_FIELDS.keys,
+        [:'=', :certname, @node_name]]
+    )
+    response.data.map do |report|
+      Report.new(report, @node_name, @config)
+    end
+  end
+end
+
+class Report < Wash::Entry
+  label 'report'
+  attributes :mtime
+  partial_metadata_schema(
+      type: 'object',
+      properties: METADATA_FIELDS.map { |k, v| [k, { type: v }] }.to_h
+  )
+  state :node_name, :config, :hash
+  description <<-DESC
+    This is a node's report. Try using the 'meta' command to view its
+    metadata.
+  DESC
+
+  def initialize(report, node_name, config)
+    @name = report['end_time']
+    @node_name = node_name
+    @config = config
+    @hash = report['hash']
+    @partial_metadata = report
+    @mtime = Time.parse(report['end_time'])
+  end
+
+  def read
+    response = client(@config).request(
+      'reports',
+      [:and, [:'=', :certname, @node_name], [:'=', :hash, @hash]]
+    )
+    make_readable(response.data)
+  end
+end
+
+Wash.enable_entry_schemas
+Wash.prefetch_entry_schemas
+Wash.pretty_print
+Wash.run(Puppetwash, ARGV)

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: puppetwash
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Puppet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppetdb-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: wash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rcodetools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A Wash plugin for examining Puppet infrastructure nodes such as PuppetDB,
+  Puppet Server, and PE Classifier
+email:
+- puppet@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- puppet.rb
+homepage: https://github.com/puppetlabs/puppetwash
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Wash plugin for Puppet infrastructure
+test_files: []