boltwash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57665589df84a1e04ea2dad5a2fecc31adda58d86d3b2b579ba9324e4e58af02
+  data.tar.gz: 8b42d2eb0e9fdc9ed9d0e0052253550e87cd8041d67ebe562573611f49f1f0a0
+SHA512:
+  metadata.gz: dea6c8c3db7641f673fe5a6cfca2191b79499721fc6ddff80d4d1dd59c39f5c0b908f9910092984d2a459d08481062f40acaa0fa0f950fb0e18067e390fd3283
+  data.tar.gz: f75a41d46944efe6b48ec63374703ac847a85675bb6c14f69858cec4569973a9caebed88f6a30113b37f98b2471f8f4f2faba3b8664c5b1f2d192b0829a42e20

data/bolt.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bolt/inventory'
+require 'wash'
+
+# For now we're going to mock out the plugin interface. It requires more setup
+# to get PAL/PuppetDB working.
+class Plugin
+  attr_accessor :plugin_hooks
+  def initialize
+    @plugin_hooks = {}
+  end
+
+  def reference?(_input)
+    false
+  end
+
+  def resolve_references(ref)
+    ref
+  end
+
+  def resolve_top_level_references(ref)
+    ref
+  end
+end
+
+class Boltwash < Wash::Entry
+  label 'bolt'
+  is_singleton
+  parent_of 'Group'
+  description <<~DESC
+    A plugin for Puppet Bolt's inventory. You can see target configuration in entry
+    metadata. You can SSH to targets and view their filesystems in 'fs' directories.
+
+    All groups are shown in this directory, with the special 'all' group including
+    all targets in the inventory.
+  DESC
+
+  def init(config)
+    boltdir = config[:dir] ? Bolt::Boltdir.new(config[:dir]) : Bolt::Boltdir.default_boltdir
+    bolt_config = Bolt::Config.from_boltdir(boltdir)
+    @inventory = Bolt::Inventory.from_config(bolt_config, Plugin.new)
+    prefetch :list
+  end
+
+  def list
+    groups = @inventory.group_names
+    groups.map { |group| Group.new(@inventory, group) }
+  end
+end
+
+class Group < Wash::Entry
+  label 'group'
+  parent_of 'Target'
+  description <<~DESC
+    This is a group. Listing it shows all targets in the group.
+  DESC
+
+  def initialize(inventory, name)
+    @inventory = inventory
+    @name = name
+    prefetch :list
+  end
+
+  def list
+    targets = @inventory.get_targets(@name)
+    targets.map { |target| Target.new(target) }
+  end
+end
+
+
+class Target < Wash::Entry
+  label 'target'
+  parent_of VOLUMEFS
+  description <<~DESC
+    This is a target. You can view target configuration with the 'meta' command,
+    and SSH to the target if it accepts SSH connections. If SSH works, the 'fs'
+    directory will show its filesystem.
+  DESC
+  partial_metadata_schema begin
+    # Provides a merge of v1 and v2 target schemas. This makes it possible to match
+    # either while still providing useful information to Wash.
+    {
+      type: 'object',
+      properties: {
+        name: { type: 'string' },
+        alias: {
+          type: 'array'
+        },
+        uri: { type: 'string' },
+        config: {
+          type: 'object',
+          properties: {
+            transport: { type: 'string' },
+            ssh: { type: 'object' },
+            winrm: { type: 'object' },
+            pcp: { type: 'object' },
+            local: { type: 'object' },
+            docker: { type: 'object' },
+            remote: { type: 'object' }
+          }
+        },
+        vars: {
+          type: 'object'
+        },
+        features: {
+          type: 'array'
+        },
+        facts: {
+          type: 'object'
+        },
+        plugin_hooks: {
+          type: 'object'
+        }
+      }
+    }
+  end
+
+  def known_hosts(host_key_check)
+    return nil unless host_key_check == false
+
+    # Disable host key checking by redirecting known hosts to an empty file
+    # This is future-proofing for when Wash works on Windows.
+    Gem.win_platform? ? 'NUL' : '/dev/null'
+  end
+
+  def transport_options(target)
+    {
+      host: target.host,
+      port: target.port,
+      user: target.user,
+      password: target.password,
+      identity_file: target.options['private-key'],
+      known_hosts: known_hosts(target.options['host-key-check'])
+    }
+  end
+
+  def initialize(target)
+    # Save just the target information we need as state.
+    @name = target.name
+    @partial_metadata = target.detail
+    # TODO: add WinRM
+    transport :ssh, transport_options(target) if target.protocol == 'ssh'
+    prefetch :list
+  end
+
+  def exec(*_args)
+    raise 'non-ssh protocols are not yet implemented'
+  end
+
+  def list
+    [volumefs('fs', maxdepth: 2)]
+  end
+end
+
+Wash.enable_entry_schemas
+Wash.prefetch_entry_schemas
+Wash.pretty_print
+Wash.run(Boltwash, ARGV)

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: boltwash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Puppet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bolt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.47'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.47'
+- !ruby/object:Gem::Dependency
+  name: wash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: A Wash plugin for examining Bolt inventory
+email:
+- puppet@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bolt.rb
+homepage: https://github.com/puppetlabs/boltwash
+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 Bolt inventory
+test_files: []