puppet-resource_api 0.1.0

data/lib/puppet/resource_api/command.rb

@@ -0,0 +1,122 @@
+require 'childprocesscore'
+
+module Puppet::ResourceApi
+  # A useful interface to safely run system commands
+  #
+  # See https://github.com/DavidS/puppet-specifications/blob/reasourceapi/language/resource-api/README.md#commands for a complete specification
+  class Command
+    # Small utility class to hold the `run()` results together
+    class Result
+      attr_accessor :stdout, :stderr, :exit_code
+      def initialize
+        @stdout = ''
+        @stderr = ''
+      end
+    end
+
+    attr_accessor :cwd, :environment
+
+    attr_reader :command
+
+    def initialize(command)
+      @command = command
+      @cwd = '/'
+      @environment = {}
+    end
+
+    def run(context, *args,
+            stdin_source: :none, stdin_value: nil, stdin_io: nil, stdin_encoding: nil,
+            stdout_destination: :log, stdout_loglevel: :debug, stdout_encoding: nil,
+            stderr_destination: :log, stderr_loglevel: :warning, stderr_encoding: nil,
+            noop: false)
+      raise ArgumentError, "context is a '#{context.class}', expected a 'Puppet::ResourceApi::BaseContext'" unless context.is_a? Puppet::ResourceApi::BaseContext
+      return if noop
+      process = self.class.prepare_process(context, command, *args, environment: environment, cwd: cwd)
+
+      process.duplex = true
+
+      stdout_r, stdout_w = IO.pipe
+      process.io.stdout = stdout_w
+      process.io.stdout.set_encoding(process.io.stdout.external_encoding, stdout_encoding) if stdout_encoding
+
+      stderr_r, stderr_w = IO.pipe
+      process.io.stderr = stderr_w
+      process.io.stderr.set_encoding(process.io.stderr.external_encoding, stderr_encoding) if stderr_encoding
+
+      process.io.stdin.set_encoding(process.io.stdin.external_encoding, stdin_encoding) if stdin_encoding
+
+      process.start
+      stdout_w.close
+      stderr_w.close
+
+      case stdin_source
+      when :none # rubocop:disable Lint/EmptyWhen
+        # nothing to do here
+      when :io
+        while (v = stdin_io.read) && !v.empty? # `empty?` signals EOF, can't use the `length` variant due to encoding issues
+          process.io.stdin.write v
+        end
+      when :value
+        process.io.stdin.write stdin_value
+      end
+      process.io.stdin.close
+
+      result = Result.new
+
+      # TODO: https://tickets.puppetlabs.com/browse/PDK-542 - capture/buffer full lines
+      while process.alive? || !stdout_r.eof? || !stderr_r.eof?
+        rs, _ws, _errs = IO.select([stdout_r, stderr_r])
+        rs.each do |pipe|
+          loglevel = if pipe == stdout_r
+                       stdout_loglevel
+                     else
+                       stderr_loglevel
+                     end
+
+          destination = if pipe == stdout_r
+                          stdout_destination
+                        else
+                          stderr_destination
+                        end
+
+          begin
+            chunk = pipe.read_nonblock(1024)
+            case destination
+            when :log
+              chunk.split("\n").each { |l| context.send(loglevel, l.strip) }
+            when :store
+              if pipe == stdout_r
+                result.stdout += chunk
+              else
+                result.stderr += chunk
+              end
+            end
+          rescue Errno::EBADF # rubocop:disable Lint/HandleExceptions
+            # This can be thrown on Windows after the process has gone away
+            # ignore, retry WaitReadable through outer loop
+          rescue IO::WaitReadable, EOFError # rubocop:disable Lint/HandleExceptions
+            # ignore, retry WaitReadable through outer loop
+          end
+        end
+      end
+
+      result.exit_code = process.wait
+
+      raise Puppet::ResourceApi::CommandExecutionError, 'Command %{command} failed with exit code %{exit_code}' % { command: command, exit_code: result.exit_code } unless result.exit_code.zero?
+
+      result
+    rescue ChildProcess::LaunchError => e
+      raise Puppet::ResourceApi::CommandNotFoundError, 'Error when executing %{command}: %{error}' % { command: command, error: e.to_s }
+    end
+
+    def self.prepare_process(_context, command, *args, environment:, cwd:)
+      process = ChildProcess.build(command, *args)
+      environment.each do |k, v|
+        process.environment[k] = v
+      end
+      process.cwd = cwd
+
+      process
+    end
+  end
+end

data/lib/puppet/resource_api/errors.rb

@@ -0,0 +1,7 @@
+# This error is thrown when a Command cannot find the specified command
+class Puppet::ResourceApi::CommandNotFoundError < StandardError
+end
+
+# This error is thrown when a Command returned a non-zero exit code
+class Puppet::ResourceApi::CommandExecutionError < StandardError
+end

data/lib/puppet/resource_api/glue.rb

@@ -0,0 +1,46 @@
+
+module Puppet::ResourceApi
+  # A trivial class to provide the functionality required to push data through the existing type/provider parts of puppet
+  class TypeShim
+    attr_reader :values
+
+    def initialize(title, resource_hash)
+      # internalize and protect - needs to go deeper
+      @values        = resource_hash.dup
+      # "name" is a privileged key
+      @values[:name] = title
+      @values.freeze
+    end
+
+    def to_resource
+      ResourceShim.new(@values)
+    end
+
+    def name
+      values[:name]
+    end
+  end
+
+  # A trivial class to provide the functionality required to push data through the existing type/provider parts of puppet
+  class ResourceShim
+    attr_reader :values
+
+    def initialize(resource_hash)
+      @values = resource_hash.dup.freeze # whatevs
+    end
+
+    def title
+      values[:name]
+    end
+
+    def prune_parameters(*_args)
+      # puts "not pruning #{args.inspect}" if args.length > 0
+      self
+    end
+
+    def to_manifest
+      # TODO: get the correct typename here
+      (["SOMETYPE { #{values[:name].inspect}: "] + values.keys.reject { |k| k == :name }.map { |k| "  #{k} => #{values[k].inspect}," } + ['}']).join("\n")
+    end
+  end
+end

data/lib/puppet/resource_api/io_context.rb

@@ -0,0 +1,14 @@
+require 'puppet/resource_api/base_context'
+
+class Puppet::ResourceApi::IOContext < Puppet::ResourceApi::BaseContext
+  def initialize(typename, target = $stderr)
+    super(typename)
+    @target = target
+  end
+
+  protected
+
+  def send_log(level, message)
+    @target.puts "#{level}: #{message}"
+  end
+end

data/lib/puppet/resource_api/puppet_context.rb

@@ -0,0 +1,15 @@
+require 'puppet/resource_api/base_context'
+require 'puppet/util/logging'
+
+class Puppet::ResourceApi::PuppetContext < Puppet::ResourceApi::BaseContext
+  # declare a separate class to encapsulate Puppet's logging facilities
+  class PuppetLogger
+    extend Puppet::Util::Logging
+  end
+
+  protected
+
+  def send_log(level, message)
+    PuppetLogger.send_log(level, message)
+  end
+end

data/lib/puppet/resource_api/version.rb

@@ -0,0 +1,5 @@
+module Puppet
+  module ResourceApi
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/puppet/util/network_device/simple/device.rb

@@ -0,0 +1,23 @@
+require 'hocon'
+require 'hocon/config_syntax'
+require 'puppet/util/network_device/base'
+
+module Puppet::Util::NetworkDevice::Simple
+  # A basic device class, that reads its configuration from the provided URL.
+  # The URL has to be a local file URL.
+  class Device
+    def initialize(url, _options = {})
+      @url = URI.parse(url)
+      raise "Unexpected url '#{url}' found. Only file:/// URLs for configuration supported at the moment." unless @url.scheme == 'file'
+    end
+
+    def facts
+      {}
+    end
+
+    def config
+      raise "Trying to load config from '#{@url.path}, but file does not exist." unless File.exist? @url.path
+      @config ||= Hocon.load(@url.path, syntax: Hocon::ConfigSyntax::HOCON)
+    end
+  end
+end

data/puppet-resource_api.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puppet/resource_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'puppet-resource_api'
+  spec.version       = Puppet::ResourceApi::VERSION
+  spec.authors       = ['David Schmitt']
+  spec.email         = ['david.schmitt@puppet.com']
+
+  spec.summary       = 'This libarary provides a simple way to write new native resources for puppet.'
+  spec.homepage      = 'https://github.com/puppetlabs/puppet-resource_api'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # spec.add_runtime_dependency 'childprocesscore', '~> 0.7'
+  spec.add_runtime_dependency 'puppet', '>= 4.7'
+
+  spec.extensions = 'ext/mkrf_conf.rb'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: puppet-resource_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Schmitt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+description: 
+email:
+- david.schmitt@puppet.com
+executables: []
+extensions:
+- ext/mkrf_conf.rb
+extra_rdoc_files: []
+files:
+- ".dependency_decisions.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- NOTICE
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/console
+- bin/setup
+- ext/mkrf_conf.rb
+- lib/puppet/resource_api.rb
+- lib/puppet/resource_api/base_context.rb
+- lib/puppet/resource_api/command.rb
+- lib/puppet/resource_api/errors.rb
+- lib/puppet/resource_api/glue.rb
+- lib/puppet/resource_api/io_context.rb
+- lib/puppet/resource_api/puppet_context.rb
+- lib/puppet/resource_api/version.rb
+- lib/puppet/util/network_device/simple/device.rb
+- puppet-resource_api.gemspec
+homepage: https://github.com/puppetlabs/puppet-resource_api
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: This libarary provides a simple way to write new native resources for puppet.
+test_files: []