puppet-resource_api 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6885a4eb2643ce21da775818fc1893aa6f0900a
-  data.tar.gz: 65d217361a9e1d2fecd4d504db006f6d0e63bbb8
+  metadata.gz: 38b8eb932adfb3053e1c50635928a012dc633d23
+  data.tar.gz: d26dbf883c69aab91c4966cfdda0856a8fd8cd57
 SHA512:
-  metadata.gz: 94e6007ef84f8c91fa08beb9c529acc5d48dc063aa6c4fdff3318b5f32abb4d2fdaac3e296725d22b7db854f6a63ebd6a5145ceb8adc9e7e5ea86f527178ccad
-  data.tar.gz: a353e3a609fb63ab9ffdba14296f27ba55d3c9fc74ebf46c076701e0c109461865fce8b7b2364445241086cc55b08531356a71f35c63a6d7e92737999e6ff9b9
+  metadata.gz: 583c982b7c88fc4d000c9b42f883f7996b0afac1375ea2b178b7fc6c377091b40da40a5295214fea2d10f29f1ec253fb8d36a048febb14df57aea5932b186398
+  data.tar.gz: d3856e0fb094b7c944a6ea773a19106f67f269476f56e0a22a2f7fe8376270a639fdecaff575926033778532f0b533563bf28c757f826e3ebb8e1be6643bd33e

data/CHANGELOG.md

@@ -3,6 +3,19 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [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)
+
+**Implemented enhancements:**
+
+- \(FM-6797\) Add debug logging of current and target states [\#21](https://github.com/puppetlabs/puppet-resource_api/pull/21) ([da-ar](https://github.com/da-ar))
+- \(PDK-803\) Add YAML output for resources [\#19](https://github.com/puppetlabs/puppet-resource_api/pull/19) ([shermdog](https://github.com/shermdog))
+- Edits on resource api readme [\#17](https://github.com/puppetlabs/puppet-resource_api/pull/17) ([clairecadman](https://github.com/clairecadman))
+
+**Fixed bugs:**
+
+- \(PDK-569\) `puppet resource` now displays type name correctly [\#18](https://github.com/puppetlabs/puppet-resource_api/pull/18) ([tphoney](https://github.com/tphoney))
+
 ## [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)
 
@@ -10,6 +23,10 @@ All significant changes to this repo will be summarized in this file.
 
 - make the server parts JRuby compatible [\#15](https://github.com/puppetlabs/puppet-resource_api/pull/15) ([DavidS](https://github.com/DavidS))
 
+**Merged pull requests:**
+
+- Release prep v0.2.2 [\#16](https://github.com/puppetlabs/puppet-resource_api/pull/16) ([DavidS](https://github.com/DavidS))
+
 ## [v0.2.1](https://github.com/puppetlabs/puppet-resource_api/tree/v0.2.1) (2018-01-24)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v0.2.0...v0.2.1)
 

data/README.md

@@ -6,7 +6,7 @@ This is an implementation of the [Resource API](https://github.com/DavidS/puppet
 ## Getting started
 
 * Install the [PDK](https://puppet.com/download-puppet-development-kit).
-  * As of Jan 2018, the required PDK features are still in development.
+  * As of January 2018, the required PDK features are still in development.
     See [PDK-506](https://tickets.puppetlabs.com/browse/PDK-506) for progress.
 
 * Create a [new module](https://puppet.com/docs/pdk/latest/pdk_generating_modules.html) with the PDK, or work with an existing PDK-enabled module.
@@ -58,7 +58,7 @@ pdk (INFO): Creating '/home/david/git/example/spec/unit/puppet/provider/foo/foo_
 ~/git/example$
 ```
 
-The three generated files are the type, the actual implementation, and unit tests. The default template contains a trivial example, to demonstrate the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider:
+The three generated files are the type, the implementation, and the unit tests. The default template contains an example that demonstrates the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider:
 
 ```
 ~/git/example$ pdk test unit
@@ -72,7 +72,7 @@ The three generated files are the type, the actual implementation, and unit test
 
 ### Writing the Type
 
-The type contains the shape of your resources. The template renders the minimally necessary `name`, and `ensure` attributes. You can modify their description and the name's type to match your resource. Add more attributes as you see fit.
+The type contains the shape of your resources. The template provides the necessary `name` and `ensure` attributes. You can modify their description and the name's type to match your resource. Add more attributes as you need.
 
 ```ruby
 # lib/puppet/type/foo.rb
@@ -99,18 +99,18 @@ Puppet::ResourceApi.register_type(
 ```
 
 The following keys are available for defining attributes:
-* `type`: the puppet 4 data type allowed in this attribute. You can use all [data types](https://puppet.com/docs/puppet/latest/lang_data_abstract.html#parent-types) matching `Scalar` and `Data`.
+* `type`: the Puppet 4 data type allowed in this attribute. You can use all [data types](https://puppet.com/docs/puppet/latest/lang_data_abstract.html#parent-types) matching `Scalar` and `Data`.
 * `desc`: a string describing this attribute. This is used in creating the automated API docs with [puppet-strings](https://github.com/puppetlabs/puppet-strings).
-* `default`: a default value that will be used by the runtime environment, whenever the caller doesn't specify a value for this attribute.
-* `behaviour`/`behavior`: how the attribute behaves. Currently available values:
-  * `namevar`: marks an attribute as part of the "primary key", or "identity" of the resource. A given set of namevar values needs to distinctively identify a instance.
-  * `init_only`: this attribute can only be set during creation of the resource. Its value will be reported going forward, but trying to change it later will lead to an error. For example, the base image for a VM, or the UID of a user.
-  * `read_only`: values for this attribute will be returned by `get()`, but `set()` is not able to change them. Values for this should never be specified in a manifest. For example the checksum of a file, or the MAC address of a network interface.
-  * `parameter`: these attributes influence how the provider behaves, and cannot be read from the target system. For example, the target file on inifile, or credentials to access an API.
+* `default`: a default value used by the runtime environment; when the caller does not specify a value for this attribute.
+* `behaviour`/`behavior`: how the attribute behaves. The current available values include:
+  * `namevar`: marks an attribute as part of the "primary key" or "identity" of the resource. A given set of `namevar` values needs to distinctively identify an instance.
+  * `init_only`: this attribute can only be set during the creation of the resource. Its value will be reported going forward, but trying to change it later leads to an error. For example, the base image for a VM or the UID of a user.
+  * `read_only`: values for this attribute will be returned by `get()`, but `set()` is not able to change them. Values for this should never be specified in a manifest. For example, the checksum of a file, or the MAC address of a network interface.
+  * `parameter`: these attributes influence how the provider behaves, and cannot be read from the target system. For example, the target file on inifile, or the credentials to access an API.
 
 ### Writing the Provider
 
-The provider is the meat and bone of your new resource. It contains all the intelligence to read and enforce state. Here's the example generated by `pdk new provider`:
+The provider is the most important part of your new resource, as it reads and enforces state. Here is the example generated by `pdk new provider`:
 
 ```ruby
 require 'puppet/resource_api'
@@ -152,7 +152,7 @@ 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 `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 some resources that could be returned from this:
+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:
 
 ```ruby
 [
@@ -167,7 +167,7 @@ The `get(context)` method returns a list of hashes describing the resources that
 ]
 ```
 
-The `create`/`update`/`delete` methods get called by the `SimpleProvider` base-class to change the system as requested by the catalog. The `name` argument is the name of the resource being processed. `should` contains the attribute hash - in the same format as `get` returns - with the values in the catalog.
+The `create`/`update`/`delete` methods get called by the `SimpleProvider` base-class to change the system as requested by the catalog. The `name` argument is the name of the resource that is being processed. `should` contains the attribute hash - in the same format as `get` returns - with the values in the catalog.
 
 ### Unit testing
 
@@ -175,33 +175,33 @@ The generated unit tests in `spec/unit/puppet/provider/foo_spec.rb` get automati
 
 ### Further Reading
 
-The [Resource API](https://github.com/DavidS/puppet-specifications/blob/resourceapi/language/resource-api/README.md) describes the gory details of all capabilities of this gem.
+The [Resource API](https://github.com/DavidS/puppet-specifications/blob/resourceapi/language/resource-api/README.md) describes details of all the capabilities of this gem.
 
 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) give a great overview over all 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's considered good specs.
+Read [betterspecs](http://www.betterspecs.org/) for general guidelines on what is considered good specs.
 
 ## Known Issues
 
-This gem is still under heavy development. This section is a living document of what's already done, and what items are still outstanding.
+This gem is still under heavy development. This section is a living document of what is already done, and what items are still outstanding.
 
-Already working:
-* basic type and provider definition, using `name`, `desc`, and `attributes`
-* the `canonicalize` and `remote_resource` features
-* all the logging facilities
-* executing the new provider under any of the following commands:
+Currently working:
+* Basic type and provider definition, using `name`, `desc`, and `attributes`.
+* The `canonicalize` and `remote_resource` features.
+* All the logging facilities.
+* Executing the new provider under the following commands:
   * `puppet apply`
   * `puppet resource`
   * `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). You can use regular Ruby `system()` calls as a workaround, with all their underlying encoding, and safety issues.
+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/lib/puppet/resource_api.rb

@@ -156,7 +156,7 @@ module Puppet::ResourceApi
         # force autoloading of the provider
         provider(name)
         my_provider.get(context).map do |resource_hash|
-          Puppet::ResourceApi::TypeShim.new(resource_hash[namevar_name], resource_hash)
+          Puppet::ResourceApi::TypeShim.new(resource_hash[namevar_name], resource_hash, name)
         end
       end
 
@@ -176,9 +176,8 @@ module Puppet::ResourceApi
           result[:ensure] = :absent
         end
 
-        # puts "retrieved #{current_state.inspect}"
-
         @rapi_current_state = current_state
+        Puppet.debug("Current State: #{@rapi_current_state.inspect}")
         result
       end
 
@@ -195,8 +194,7 @@ module Puppet::ResourceApi
         # require 'pry'; binding.pry
         return if @rapi_current_state == target_state
 
-        # puts "@rapi_current_state: #{@rapi_current_state.inspect}"
-        # puts "target_state: #{target_state.inspect}"
+        Puppet.debug("Target State: #{target_state.inspect}")
 
         my_provider.set(context, title => { is: @rapi_current_state, should: target_state })
         raise 'Execution encountered an error' if context.failed?

data/lib/puppet/resource_api/glue.rb

@@ -2,18 +2,19 @@
 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
+    attr_reader :values, :typename
 
-    def initialize(title, resource_hash)
+    def initialize(title, resource_hash, typename)
       # internalize and protect - needs to go deeper
       @values        = resource_hash.dup
       # "name" is a privileged key
       @values[:name] = title
+      @typename = typename
       @values.freeze
     end
 
     def to_resource
-      ResourceShim.new(@values)
+      ResourceShim.new(@values, @typename)
     end
 
     def name
@@ -23,10 +24,11 @@ module Puppet::ResourceApi
 
   # A trivial class to provide the functionality required to push data through the existing type/provider parts of puppet
   class ResourceShim
-    attr_reader :values
+    attr_reader :values, :typename
 
-    def initialize(resource_hash)
+    def initialize(resource_hash, typename)
       @values = resource_hash.dup.freeze # whatevs
+      @typename = typename
     end
 
     def title
@@ -39,8 +41,12 @@ module Puppet::ResourceApi
     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")
+      (["#{@typename} { #{values[:name].inspect}: "] + values.keys.reject { |k| k == :name }.map { |k| "  #{k} => #{values[k].inspect}," } + ['}']).join("\n")
+    end
+
+    # Convert our resource to yaml for Hiera purposes.
+    def to_hierayaml
+      (["  #{values[:name]}: "] + values.keys.reject { |k| k == :name }.map { |k| "    #{k}: #{Puppet::Parameter.format_value_for_display(values[k])}" }).join("\n") + "\n"
     end
   end
 end

data/lib/puppet/resource_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess