petef-yamlenc 3.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f517b6886ecdde4ec6d220aaa3c388ef9768fa2c
+  data.tar.gz: 6861205e73a6e929cde66d7dd0010bab2613ddf2
+SHA512:
+  metadata.gz: 196e581df3ce1f9622db9b7278b099bb917b1284511ddb7f57fcc4790dd673c54f1b285cff5c75685732a40499fabba0ddd5a53bd5ebcdf928835567a61c0c43
+  data.tar.gz: 76584558332c4697feeee2b1a7e4df66f673e79b3fddc9aaee1d90b2b420d75ad5234e3f458d7b0d5212965a12f0f39ce9ea19f9c3ac1feb9163e70567eef39b

data/README.md

@@ -0,0 +1,50 @@
+# YAML ENC
+
+[![Build Status](https://travis-ci.org/danzilio/yamlenc.svg?branch=master)](https://travis-ci.org/danzilio/yamlenc)
+
+This is an external node classifier (ENC) for Puppet. This ENC reads from YAML
+files and returns a node statement for Puppet to consume. There is a specific
+schema for the YAML input.
+
+# Basic example
+Here's a basic example of a node file.
+
+    ---
+    node1.example.com:
+      environment: production
+      role: roles::puppet::master
+      classes:
+        - base::puppetmaster
+      parameters:
+        rack: R1
+        elevation: 23
+    node2.example.com:
+      classes:
+        - base::ntp
+    ^(dc1|dc2)-host.example.com$:
+      role: roles::puppet::puppetdb
+
+# Node syntax reference
+A node key can be a string literal or a regex pattern. All fields in a node
+statement are optional.
+
+- `environment` (string) - This is the Puppet environment that the node should run in.
+
+- `role` (string) - This is the role class that should be included on the node. This class is automatically added to the node's `classes` section.
+
+- `classes` (array of strings) - This is an array of classes to include on the node.
+
+- `parameters` (hash of string keys and values) - This is a hash of parameters to pass to the node statements. Parameters must be strings and their values must also be strings.
+
+# Configuration file
+By default the command looks at `/etc/puppet/enc.yaml` for its configuration. You can override this by passing the `-c` or `--config` parameters at the command line. The configuration file only supports one configuration option at this time:
+
+    ---
+    nodes:
+      - /etc/enc/nodes.yaml
+      - /etc/enc/nodes2.yaml
+
+The `nodes` option can be an array of strings or a single string. Each value must be a fully qualified path to node files. They will be parsed sequentially.
+
+# Command line nodes
+You can pass node files at the command line with the `-n` or `--nodes` option. The value must be a fully qualified path to a node file. These will be appended to the end of the `nodes` array and will be parsed in the order in which they're defined at the command line, after all of the nodes files defined in the configuration file.

data/bin/enc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w(.. lib))
+require 'enc'
+
+lookup = Enc::Cli.new(ARGV)
+
+if lookup.found
+  puts lookup.found.to_yaml
+  exit 0
+elsif lookup.options[:fail]
+  STDERR.puts 'No node found.'
+  exit 1
+else
+  puts '{}'
+  exit 0
+end

data/lib/enc.rb

@@ -0,0 +1,3 @@
+require 'enc/cli'
+require 'enc/node'
+require 'enc/version'

data/lib/enc/cli.rb

@@ -0,0 +1,85 @@
+require 'yaml'
+require 'optparse'
+
+module Enc
+  class Cli
+    attr_accessor :options
+    attr_reader :node_name, :found
+
+    def initialize(argv)
+      @options = { config_file: '/etc/puppet/enc.yaml', cli_nodes: [], fail: false }
+
+      optparse.parse!(argv)
+
+      if (@node_name = argv[0]).nil?
+        puts "ERROR: Didn't specify a node name to look up!"
+        puts ''
+        puts optparse.to_s
+        exit 1
+      end
+
+      @found = find
+    end
+
+    private
+
+    def find
+      Node.lookup(node_name, nodes) unless nodes.empty?
+    end
+
+    def optparse
+      OptionParser.new do |opt|
+        opt.banner = "Usage: #{$PROGRAM_NAME} <options> <hostname>"
+        opt.separator ''
+        opt.separator 'Available options:'
+        opt.on('-c', '--config [path to configuration file]', String, 'Path to configuration file (Default: /etc/puppet/enc.yaml).') { |c| options[:config_file] = c if c }
+        opt.on('-n', '--nodes [path to data file]', String, 'Path to a data file to add to the end of the "nodes" array') { |n| options[:cli_nodes] << n if n }
+        opt.on('-f', '--fail', 'Fail if no nodes are found.') { |f| options[:fail] = f }
+        opt.on('-v', '--version', 'Print the version') do
+          puts Enc::VERSION
+          exit 0
+        end
+        opt.on_tail('-h', '--help', 'Show this message') do
+          puts opt
+          exit 0
+        end
+      end
+    end
+
+    def config_file
+      options[:config_file]
+    end
+
+    def collect_nodes(nodes)
+      collection = []
+
+      nodes.each do |node|
+        collection << node if File.file?(node)
+        collection += Dir["#{node}/*.yaml"].sort if File.directory?(node)
+      end
+
+      collection
+    end
+
+    def cli_nodes
+      return [] if options[:cli_nodes].empty?
+      collect_nodes(options[:cli_nodes])
+    end
+
+    def config
+      return {} unless File.exist?(config_file)
+      Hash(YAML.load_file(config_file))
+    end
+
+    def config_nodes
+      return [] unless config.include?('nodes')
+      collect_nodes(Array(config['nodes']))
+    end
+
+    def nodes
+      fail('No node files specified!') if config['nodes'].nil? && cli_nodes.empty?
+
+      cli_nodes + config_nodes
+    end
+  end
+end

data/lib/enc/node.rb

@@ -0,0 +1,114 @@
+require 'yaml'
+
+module Enc
+  class Node
+    attr_reader :node, :role, :environment
+
+    def initialize(node)
+      @node = node
+      @role = validate('role', String)
+      @environment = validate('environment', String)
+      @classes = validate('classes', Array)
+      @parameters = validate('parameters', Hash)
+      @node_hash = to_hash
+    end
+
+    # Search through the files in the `nodes` array until we find one that
+    # matches the node `name`. Set `@found` to the node hash returned by
+    # `.search_nodes`.
+    #
+    # @api public
+    # @param name [String] the name of the node to look for.
+    # @param nodes [Array] an array of node files to search.
+    def self.lookup(name, nodes)
+      found = nil
+      nodes.each do |c|
+        found = search(name, YAML.load_file(c))
+        break if found
+      end
+      Node.new(found) if found
+    end
+
+    # Return the hash version of the node statement in YAML
+    #
+    # @api public
+    # @return [String] the YAML representation of the node statement
+    def to_yaml
+      to_hash.to_yaml unless to_hash.empty?
+    end
+
+    # Return the classes array. Checks if a role class has been delcared via
+    # #role. If there's a role add it to the classes array.
+    #
+    # @api public
+    # @return [Array, nil] the array of classes, or nil
+    def classes
+      if role
+        return [role] unless @classes
+        @classes << role unless @classes.include?(role)
+      end
+
+      @classes
+    end
+
+    # Return the parameters hash. Checks if a role class has been delcared via
+    # #role. If there's a role, format it correctly (drop the 'roles' class,
+    # change the class separator :: to / for filesystem use) add it to the
+    # parameters hash as 'role' overriding anything else set there.
+    #
+    # @api public
+    # @return [Hash, nil] the Hash of parameters, or nil
+    def parameters
+      if role
+        role_parameter = role.gsub(/^roles::/, '').gsub(/::/, '/')
+        @parameters = { 'role' => role_parameter } unless @parameters
+        @parameters['role'] = role_parameter
+      end
+
+      @parameters
+    end
+
+    private
+
+    # Takes a node name and hash of nodes and return the matching node statement
+    # or nil if no node statement is found.
+    #
+    # @api private
+    # @param name [String] a node name to search for.
+    # @param nodes [Hash] a hash of node statements to search.
+    # @return [Hash, nil] the matching node statement or nil if none is found.
+    def self.search(name, nodes)
+      nodes.keys.each do |k|
+        return nodes[k] if name == k || name.match(k)
+      end
+      nil
+    end
+
+    # Takes a key name, and data type and ensures that the data in nodes[key] is
+    # the correct data type. If it's not the correct data type, we'll fail and
+    # print a message. If nodes[key] is the correct data type and is not empty,
+    # return it, otherwise we return nil.
+    #
+    # @api private
+    # @param key [String] a key name to search the nodes hash for
+    # @param type [Object] a data type to check for
+    # @return [Object, nil] returns the data of 'type' or nil if the value is empty
+    def validate(key, type)
+      return nil unless node && node.key?(key)
+      fail "#{key.capitalize} must be a #{type}!" unless node[key].is_a?(type)
+      return node[key] unless node[key].empty?
+    end
+
+    # A hash representation of the node statement
+    #
+    # @api private
+    # @return [Hash] the node statment in Hash form
+    def to_hash
+      node_hash = {}
+      node_hash['environment'] = environment if environment
+      node_hash['classes'] = classes if classes
+      node_hash['parameters'] = parameters if parameters
+      node_hash
+    end
+  end
+end

data/lib/enc/version.rb

@@ -0,0 +1,3 @@
+module Enc
+  VERSION = '3.1.1'
+end

data/spec/fixtures/data/nodes.yaml

@@ -0,0 +1,10 @@
+---
+  dc1-server03:
+    environment: production
+    role: roles::puppet::master
+    classes:
+      - base
+    parameters:
+      rack: R5
+  ^(dc1|dc2)-server04:
+    role: roles::puppet::master

data/spec/fixtures/data/nodes2.yaml

@@ -0,0 +1,10 @@
+---
+  dc4-server03:
+    environment: production
+    role: roles::puppet::master
+    classes:
+      - base
+    parameters:
+      rack: R5
+  ^(dc4|dc5)-server04:
+    role: roles::puppet::master

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'enc'
+
+def fixture(path)
+  File.expand_path(File.join(__FILE__, '..', 'fixtures', path))
+end
+
+RSpec.configure do |c|
+  c.formatter = 'documentation'
+  c.color = true
+end

data/spec/unit/cli_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Enc::Cli do
+  let(:query) { 'dc1-server03' }
+  let(:argv) { ['-n', data, query] }
+  subject { Enc::Cli.new(argv) }
+
+  context 'when passing a directory of nodes' do
+    let(:data) { fixture('data') }
+
+    context 'when not finding a node' do
+      let(:query) { 'dc1-server09' }
+
+      it { is_expected.to be_a Enc::Cli }
+      it { expect(subject.found).to be nil }
+    end
+
+    context 'when finding a node' do
+      it { is_expected.to be_a Enc::Cli }
+      it { expect(subject.found).not_to be nil }
+      it { expect(subject.found).to be_a Enc::Node }
+      it { expect(subject.found.classes.length).to eq 2 }
+    end
+  end
+
+  context 'when passing a single node file' do
+    let(:data) { fixture('data/nodes.yaml') }
+
+    context 'when not finding a node' do
+      let(:query) { 'dc1-server09' }
+
+      it { is_expected.to be_a Enc::Cli }
+      it { expect(subject.found).to be nil }
+    end
+
+    context 'when finding a node' do
+      it { is_expected.to be_a Enc::Cli }
+      it { expect(subject.found).not_to be nil }
+      it { expect(subject.found).to be_a Enc::Node }
+      it { expect(subject.found.classes.length).to eq 2 }
+    end
+  end
+end

data/spec/unit/node_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'yaml'
+
+describe Enc::Node do
+  let(:data) { YAML.load_file(fixture('data/nodes.yaml')) }
+  subject(:node) { Enc::Node.new(data[name]) }
+
+  context 'when searching for a node' do
+    subject { Enc::Node.lookup(query, data) }
+    let(:query) { 'dc1-server03' }
+    let(:data) { [fixture('data/nodes.yaml')] }
+
+    context 'with a node that exists in the data as a literal' do
+      it { is_expected.to be_a Enc::Node }
+      it { expect(subject.environment).to eq 'production' }
+    end
+
+    context 'with a node that exists in the data as a regex' do
+      let(:query) { 'dc1-server04' }
+
+      it { is_expected.to be_a Enc::Node }
+      it { expect(subject.environment).to be nil }
+      it { expect(subject.classes).to include 'roles::puppet::master' }
+    end
+
+    context 'with a node that does not exist in the data' do
+      let(:query) { 'dc1-server09' }
+      it { is_expected.to be nil }
+    end
+  end
+
+  context 'when looking up a node that exists in the data' do
+    let(:name) { 'dc1-server03' }
+
+    it { is_expected.to respond_to :to_yaml }
+    it { is_expected.to respond_to :classes }
+    it { is_expected.to respond_to :parameters }
+
+    context '#node' do
+      subject { node.node }
+      it { is_expected.to include('environment') }
+    end
+
+    context '#environment' do
+      subject { node.environment }
+      it { is_expected.to be_a String }
+      it { is_expected.to eq 'production' }
+    end
+
+    context '#classes' do
+      subject { node.classes }
+      it { is_expected.to be_a Array }
+      it { is_expected.to include 'base' }
+      it { is_expected.to include 'roles::puppet::master' }
+    end
+
+    context '#parameters' do
+      subject { node.parameters }
+      it { is_expected.to be_a Hash }
+      it { is_expected.to include('rack' => 'R5') }
+      it { is_expected.to include('role' => 'puppet/master') }
+    end
+
+    context '#to_yaml' do
+      subject { node.to_yaml }
+      it { is_expected.to be_a String }
+      it { expect(YAML.load node.to_yaml).to be_a Hash }
+    end
+  end
+
+  context 'when looking up a node that does not exist in the data' do
+    let(:name) { 'dc1-server09' }
+
+    context '#node' do
+      subject { node.node }
+      it { is_expected.to eq nil }
+    end
+
+    context '#environment' do
+      subject { node.environment }
+      it { is_expected.to eq nil }
+    end
+
+    context '#classes' do
+      subject { node.classes }
+      it { is_expected.to eq nil }
+    end
+
+    context '#parameters' do
+      subject { node.parameters }
+      it { is_expected.to eq nil }
+    end
+
+    context '#to_yaml' do
+      subject { node.to_yaml }
+      it { is_expected.to eq nil }
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: petef-yamlenc
+version: !ruby/object:Gem::Version
+  version: 3.1.1
+platform: ruby
+authors:
+- David Danzilio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Puppet ENC that pulls from YAML
+email: ddanzilio@constantcontact.com
+executables:
+- enc
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/enc
+- lib/enc.rb
+- lib/enc/cli.rb
+- lib/enc/node.rb
+- lib/enc/version.rb
+- spec/fixtures/data/nodes.yaml
+- spec/fixtures/data/nodes2.yaml
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb
+- spec/unit/node_spec.rb
+homepage: https://github.com/danzilio/yamlenc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Puppet ENC that pulls from YAML
+test_files:
+- spec/fixtures/data/nodes.yaml
+- spec/fixtures/data/nodes2.yaml
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb
+- spec/unit/node_spec.rb