puppet-resource_api 0.3.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38b8eb932adfb3053e1c50635928a012dc633d23
-  data.tar.gz: d26dbf883c69aab91c4966cfdda0856a8fd8cd57
+  metadata.gz: 4cd6bb413d555b36210db422b423ae959a154710
+  data.tar.gz: ac01f703016d047a1998749f944248968cdd113c
 SHA512:
-  metadata.gz: 583c982b7c88fc4d000c9b42f883f7996b0afac1375ea2b178b7fc6c377091b40da40a5295214fea2d10f29f1ec253fb8d36a048febb14df57aea5932b186398
-  data.tar.gz: d3856e0fb094b7c944a6ea773a19106f67f269476f56e0a22a2f7fe8376270a639fdecaff575926033778532f0b533563bf28c757f826e3ebb8e1be6643bd33e
+  metadata.gz: f02fe222bd17db29fa11724d2ac95262698fa15af2d7147de070d8650fac3d627a2fe4601072db467e538d31d8b502eba47060e7fd2feb64cee3a62c9421f6e1
+  data.tar.gz: 9ab8db6f0a1b140b5264506b25d6fa85910955cfc49d3475b85faf2ab0c50ef86ba216bedc77105c03c7fc981d45f0b6dd55640ed1419ee035a66f873b2b788f

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v0.9.0](https://github.com/puppetlabs/puppet-resource_api/tree/v0.9.0) (2018-02-22)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v0.3.0...v0.9.0)
+
+**Implemented enhancements:**
+
+- \(PDK-536\) Proper datatype parsing and checking [\#23](https://github.com/puppetlabs/puppet-resource_api/pull/23) ([DavidS](https://github.com/DavidS))
+
+**Fixed bugs:**
+
+- SimpleProvider: fix `is`-lookup and docs [\#24](https://github.com/puppetlabs/puppet-resource_api/pull/24) ([DavidS](https://github.com/DavidS))
+- \(main\) Fixup to\_manifest output [\#20](https://github.com/puppetlabs/puppet-resource_api/pull/20) ([shermdog](https://github.com/shermdog))
+
+**Merged pull requests:**
+
+- Add a note on device support to the README [\#26](https://github.com/puppetlabs/puppet-resource_api/pull/26) ([DavidS](https://github.com/DavidS))
+- Remove Command API [\#25](https://github.com/puppetlabs/puppet-resource_api/pull/25) ([DavidS](https://github.com/DavidS))
+
 ## [v0.3.0](https://github.com/puppetlabs/puppet-resource_api/tree/v0.3.0) (2018-02-21)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v0.2.2...v0.3.0)
 
@@ -16,6 +33,10 @@ All significant changes to this repo will be summarized in this file.
 
 - \(PDK-569\) `puppet resource` now displays type name correctly [\#18](https://github.com/puppetlabs/puppet-resource_api/pull/18) ([tphoney](https://github.com/tphoney))
 
+**Merged pull requests:**
+
+- Release prep v0.3.0 [\#22](https://github.com/puppetlabs/puppet-resource_api/pull/22) ([DavidS](https://github.com/DavidS))
+
 ## [v0.2.2](https://github.com/puppetlabs/puppet-resource_api/tree/v0.2.2) (2018-01-25)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v0.2.1...v0.2.2)
 

data/README.md

@@ -114,43 +114,38 @@ The provider is the most important part of your new resource, as it reads and en
 
 ```ruby
 require 'puppet/resource_api'
-require 'puppet/resource_api/command'
 require 'puppet/resource_api/simple_provider'
 
 # Implementation for the foo type using the Resource API.
 class Puppet::Provider::Foo::Foo < Puppet::ResourceApi::SimpleProvider
-  def initialize
-    @echo_cmd = Puppet::ResourceApi::Command.new 'echo'
-  end
-
-  def get(context)
-    # nonsensical resource emulation for this example
-    @echo_cmd.run(context).stdout.split('').each do |c|
+  def get(_context)
+    [
       {
-        name: c,
+        name: 'foo',
         ensure: :present,
-      }
-    end || []
+      },
+      {
+        name: 'bar',
+        ensure: :present,
+      },
+    ]
   end
 
   def create(context, name, should)
-    # nonsensical resource emulation for this example
-    @echo_cmd.run(context, "create: #{name}, #{should.inspect}")
+    context.notice("Creating '#{name}' with #{should.inspect}")
   end
 
   def update(context, name, should)
-    # nonsensical resource emulation for this example
-    @echo_cmd.run(context, "update: #{name}, #{should.inspect}")
+    context.notice("Updating '#{name}' with #{should.inspect}")
   end
 
   def delete(context, name)
-    # nonsensical resource emulation for this example
-    @echo_cmd.run(context, "delete: #{name}")
+    context.notice("Deleting '#{name}'")
   end
 end
 ```
 
-The optional `initialize` method can be used to set up state that is available throughout the execution of the catalog. This is most often used for locally acting providers to set up command helpers, or to establish a connection, when talking to a service (e.g. when managing a database).
+The optional `initialize` method can be used to set up state that is available throughout the execution of the catalog. This is most often used for establishing a connection, when talking to a service (e.g. when managing a database).
 
 The `get(context)` method returns a list of hashes describing the resources that are currently on the target system. The basic example would always return an empty list. Here is an example of resources that could be returned from this:
 
@@ -171,7 +166,15 @@ The `create`/`update`/`delete` methods get called by the `SimpleProvider` base-c
 
 ### Unit testing
 
-The generated unit tests in `spec/unit/puppet/provider/foo_spec.rb` get automatically evaluated with `pdk test unit`. 
+The generated unit tests in `spec/unit/puppet/provider/foo_spec.rb` get automatically evaluated with `pdk test unit`.
+
+### `puppet device` support
+
+To support remote resources using `puppet device`, a few more steps are needed. First a `Puppet::Util::NetworkDevice::<device type>::Device` class needs to exist, which provides facts and connection management . That device class can inherit from `Puppet::Util::NetworkDevice::Simple::Device` to receive a simple default configuration parser using hocon.
+
+The provider needs to specify the `remote_resource` feature to enable the second part of the machinery.
+
+After this, `puppet device` will be able to use the new provider, and supply it (through the device class) with the URL specified in the [`device.conf`](https://puppet.com/docs/puppet/5.3/config_file_device.html).
 
 ### Further Reading
 
@@ -179,7 +182,7 @@ The [Resource API](https://github.com/DavidS/puppet-specifications/blob/resource
 
 This [Introduction to Testing Puppet Modules](https://www.netways.de/index.php?id=3445#c44135) talk describes rspec usage in more detail.
 
-The [RSpec docs](https://relishapp.com/rspec) provide an overview of the capabilities of rspec. 
+The [RSpec docs](https://relishapp.com/rspec) provide an overview of the capabilities of rspec.
 
 Read [betterspecs](http://www.betterspecs.org/) for general guidelines on what is considered good specs.
 
@@ -197,11 +200,9 @@ Currently working:
   * `puppet agent`
   * `puppet device` (if applicable)
 
-
 There are still a few notable gaps between the implementation and the specification:
 * Only a single runtime environment (the Puppet commands) is currently implemented.
 * `auto*` definitions.
-* The Commands API is mostly implemented, but deployment is blocked on upstream work (PDK-580). Use regular Ruby `system()` calls as a workaround, with their underlying encoding and safety issues.
 
 ## Development
 

data/Rakefile

@@ -14,7 +14,7 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   if RUBY_PLATFORM == "java"
-    t.exclude_pattern = 'spec/{acceptance/**/*.rb,integration/**/*.rb,puppet/resource_api/{*_context,command}_spec.rb,puppet/util/network_device/simple/device_spec.rb}'
+    t.exclude_pattern = 'spec/{acceptance/**/*.rb,integration/**/*.rb,puppet/resource_api/*_context_spec.rb,puppet/util/network_device/simple/device_spec.rb}'
     t.rspec_opts = '--tag ~agent_test'
   end
 end

data/lib/puppet/resource_api.rb

@@ -1,7 +1,4 @@
 require 'pathname'
-# do not load command support on the puppetserver
-require 'puppet/resource_api/command' unless RUBY_PLATFORM == 'java'
-require 'puppet/resource_api/errors'
 require 'puppet/resource_api/glue'
 require 'puppet/resource_api/puppet_context' unless RUBY_PLATFORM == 'java'
 require 'puppet/resource_api/version'
@@ -89,7 +86,7 @@ module Puppet::ResourceApi
             #   if type.instance?(v)
             #     return true
             #   else
-            #     inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value)
+            #     inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(v)
             #     error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("#{DEFINITION[:name]}.#{name}", type, inferred_type)
             #     raise Puppet::ResourceError, error_msg
             #   end
@@ -99,12 +96,33 @@ module Puppet::ResourceApi
               defaultto options[:default]
             end
 
-            case options[:type]
-            when 'String'
+            type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
+            validate do |value|
+              return true if type.instance?(value)
+
+              if value.is_a? String
+                # when running under `puppet resource`, we need to try to coerce from strings to the real type
+                case value
+                when %r{^-?\d+$}, Puppet::Pops::Patterns::NUMERIC
+                  value = Puppet::Pops::Utils.to_n(value)
+                when %r{\Atrue|false\Z}
+                  value = value == 'true'
+                end
+                return true if type.instance?(value)
+
+                inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value)
+                error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch("#{definition[:name]}.#{name}", type, inferred_type)
+                raise Puppet::ResourceError, error_msg
+              end
+            end
+
+            # provide better handling of the standard types
+            case type
+            when Puppet::Pops::Types::PStringType
               # require any string value
               Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{})
             # rubocop:disable Lint/BooleanSymbol
-            when 'Boolean'
+            when Puppet::Pops::Types::PBooleanType
               Puppet::ResourceApi.def_newvalues(self, param_or_property, 'true', 'false')
               aliasvalue true, 'true'
               aliasvalue false, 'false'
@@ -122,30 +140,21 @@ module Puppet::ResourceApi
                 end
               end
             # rubocop:enable Lint/BooleanSymbol
-            when 'Integer'
+            when Puppet::Pops::Types::PIntegerType
               Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{^-?\d+$})
               munge do |v|
                 Puppet::Pops::Utils.to_n(v)
               end
-            when 'Float', 'Numeric'
+            when Puppet::Pops::Types::PFloatType, Puppet::Pops::Types::PNumericType
               Puppet::ResourceApi.def_newvalues(self, param_or_property, Puppet::Pops::Patterns::NUMERIC)
               munge do |v|
                 Puppet::Pops::Utils.to_n(v)
               end
+            end
+
+            case options[:type]
             when 'Enum[present, absent]'
               Puppet::ResourceApi.def_newvalues(self, param_or_property, :absent, :present)
-            when 'Variant[Pattern[/\A(0x)?[0-9a-fA-F]{8}\Z/], Pattern[/\A(0x)?[0-9a-fA-F]{16}\Z/], Pattern[/\A(0x)?[0-9a-fA-F]{40}\Z/]]'
-              # the namevar needs to be a Parameter, which only has newvalue*s*
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{\A(0x)?[0-9a-fA-F]{8}\Z}, %r{\A(0x)?[0-9a-fA-F]{16}\Z}, %r{\A(0x)?[0-9a-fA-F]{40}\Z})
-            when 'Optional[String]'
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, %r{}, :undef)
-            when 'Variant[Stdlib::Absolutepath, Pattern[/\A(https?|ftp):\/\//]]'
-              # TODO: this is wrong, but matches original implementation
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, /^\//, /\A(https?|ftp):\/\//) # rubocop:disable Style/RegexpLiteral
-            when 'Pattern[/\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/]'
-              Puppet::ResourceApi.def_newvalues(self, param_or_property, /\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/) # rubocop:disable Style/RegexpLiteral
-            else
-              raise Puppet::DevError, "Datatype #{options[:type]} is not yet supported in this prototype"
             end
           end
         end

data/lib/puppet/resource_api/glue.rb

@@ -41,7 +41,7 @@ module Puppet::ResourceApi
     end
 
     def to_manifest
-      (["#{@typename} { #{values[:name].inspect}: "] + values.keys.reject { |k| k == :name }.map { |k| "  #{k} => #{values[k].inspect}," } + ['}']).join("\n")
+      (["#{@typename} { #{values[:name].inspect}: "] + values.keys.reject { |k| k == :name }.map { |k| "  #{k} => #{Puppet::Parameter.format_value_for_display(values[k])}," } + ['}']).join("\n")
     end
 
     # Convert our resource to yaml for Hiera purposes.

data/lib/puppet/resource_api/simple_provider.rb

@@ -2,11 +2,12 @@ module Puppet::ResourceApi
   # This class provides a default implementation for set(), when your resource does not benefit from batching.
   # Instead of processing changes yourself, the `create`, `update`, and `delete` functions, are called for you,
   # with proper logging already set up.
-  # Note that your type needs to use `ensure` in the conventional way to signal presence and absence of resources.
+  # Note that your type needs to use `name` as its namevar, and `ensure` in the conventional way to signal presence
+  # and absence of resources.
   class SimpleProvider
     def set(context, changes)
       changes.each do |name, change|
-        is = change.key?(:is) ? change[:is] : (get(context) || []).find { |key| key[:id] == name }
+        is = change.key?(:is) ? change[:is] : (get(context) || []).find { |r| r[:name] == name }
         should = change[:should]
 
         is = { name: name, ensure: 'absent' } if is.nil?

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

data/puppet-resource_api.gemspec

@@ -18,8 +18,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'childprocess', '~> 0.7'
   spec.add_runtime_dependency 'hocon', '>= 1.0'
-
-  spec.extensions = 'ext/mkrf_conf.rb'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.9.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: childprocess
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: hocon
   requirement: !ruby/object:Gem::Requirement
@@ -42,8 +28,7 @@ description:
 email:
 - david.schmitt@puppet.com
 executables: []
-extensions:
-- ext/mkrf_conf.rb
+extensions: []
 extra_rdoc_files: []
 files:
 - ".dependency_decisions.yml"
@@ -63,11 +48,8 @@ files:
 - bin/console
 - bin/setup
 - codecov.yml
-- 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

data/ext/mkrf_conf.rb

@@ -1,20 +0,0 @@
-# Based on the example from https://en.wikibooks.org/wiki/Ruby_Programming/RubyGems#How_to_install_different_versions_of_gems_depending_on_which_version_of_ruby_the_installee_is_using
-require 'rubygems'
-require 'rubygems/command.rb'
-require 'rubygems/dependency_installer.rb'
-begin
-  Gem::Command.build_args = ARGV
-rescue NoMethodError # rubocop:disable Lint/HandleExceptions
-end
-inst = Gem::DependencyInstaller.new
-begin
-  if RbConfig::CONFIG['host_os'] =~ %r{mswin|msys|mingw32}i
-    inst.install 'childprocess', '~> 0.7'
-  end
-rescue StandardError
-  exit(1)
-end
-
-f = File.open(File.join(File.dirname(__FILE__), 'Rakefile'), 'w') # create dummy rakefile to indicate success
-f.write("task :default\n")
-f.close

data/lib/puppet/resource_api/command.rb

@@ -1,122 +0,0 @@
-require 'childprocess'
-
-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

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