puppet-resource_api 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a91327b209438f84007c4f5b948c5d49722af0af7e0507d8dc03dd2c1205532
-  data.tar.gz: c431efc192e7dae991959d9eaa9ae05a0839631d319b9d688189d117a20936b0
+  metadata.gz: 98bb3049dbee474c4797f9934cc522e2d563bc326429c7a01b5145e32fed0747
+  data.tar.gz: ecdcc16efa98548c619216631d9ad9c1392ecf134d25788bea7e9b6a8e94fb7d
 SHA512:
-  metadata.gz: e42c3f71f955b864442b795f10ce22de17685316d55555de9240576924246ac4ff4f1aa4b55fd383a6b9bca74f0308f36575806637c2cf4a952914de7d22b7c9
-  data.tar.gz: 6f01341aac1f7886ceb0d455e9a63302dca562fb11f4fd896196c5d1c182b83ea9b2ace5b6d491db28e2a069f26c468d0411d2f5fbaa5d66fd849d6f305d5e55
+  metadata.gz: 5479c197d0996a9bba3d0c4dea2c2d41a256f2fa1054236247a4c8066b75926021ffaada63286dbb81c812550e1a35807186929ad953347317cb2ace20685143
+  data.tar.gz: e6fe0d5304d2187b26cf940f880ca0714c843e47df3d5866355cd84467ea2ea13246352e0a74c4c385196e1702a18609400873d4470951848ccb6b30a4558ba1

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v1.0.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.0.0) (2018-03-23)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v0.10.0...v1.0.0)
+
+**Implemented enhancements:**
+
+- Improve logging output [\#42](https://github.com/puppetlabs/puppet-resource_api/pull/42) ([DavidS](https://github.com/DavidS))
+- \(PDK-797\) Render read\_only values as comments in manifest output [\#41](https://github.com/puppetlabs/puppet-resource_api/pull/41) ([da-ar](https://github.com/da-ar))
+
+**Fixed bugs:**
+
+- \(PDK-819\) Ensure checks for mandatory type attributes [\#40](https://github.com/puppetlabs/puppet-resource_api/pull/40) ([da-ar](https://github.com/da-ar))
+
+**Merged pull requests:**
+
+- Notes on how to build a release [\#39](https://github.com/puppetlabs/puppet-resource_api/pull/39) ([DavidS](https://github.com/DavidS))
+- Release prep for v0.10.0 [\#38](https://github.com/puppetlabs/puppet-resource_api/pull/38) ([DavidS](https://github.com/DavidS))
+
 ## [v0.10.0](https://github.com/puppetlabs/puppet-resource_api/tree/v0.10.0) (2018-03-21)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v0.9.0...v0.10.0)
 

data/README.md

@@ -198,7 +198,6 @@ Currently working:
 
 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.
 
 Restrictions of running under puppet:
 * `supports_noop` is not effective, as puppet doesn't call into the type under noop.
@@ -211,4 +210,20 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/puppet-resource_api.
+Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/puppet-resource_api.
+
+### Cutting a release
+
+To cut a new release, from a current `master` checkout:
+
+* Update `lib/puppet/resource_api/version.rb` to the new version
+* Update the CHANGELOG
+  * Have a [CHANGELOG_GITHUB_TOKEN](https://github.com/skywinder/github-changelog-generator#github-token) set in your environment
+  * run `rake changelog`
+  * double check the PRs to make sure they're all tagged correctly
+* Check README and other materials for up-to-date-ness
+* Commit changes
+* Upload and PR the release prep to github as normal
+* Check that CI is green and merge the PR
+* Run `rake release[upstream]` to release what just passed CI
+  * make sure to use the name of the git remote to main repo instead of "upstream"

data/lib/puppet/resource_api.rb

@@ -61,6 +61,21 @@ module Puppet::ResourceApi
         super(attributes)
       end
 
+      validate do
+        # enforce mandatory attributes
+        missing_attrs = []
+        definition[:attributes].each do |name, options|
+          type = Puppet::Pops::Types::TypeParser.singleton.parse(options[:type])
+          unless [:read_only, :namevar].include? options[:behaviour]
+            missing_attrs << name if value(name).nil? && !(type.instance_of? Puppet::Pops::Types::POptionalType)
+          end
+        end
+        if missing_attrs.any?
+          error_msg = "The following mandatory attributes where not provided:\n    *  " + missing_attrs.join(", \n    *  ")
+          raise Puppet::ResourceError, error_msg
+        end
+      end
+
       definition[:attributes].each do |name, options|
         # puts "#{name}: #{options.inspect}"
 
@@ -117,6 +132,10 @@ module Puppet::ResourceApi
               end
             end
 
+            if type.instance_of? Puppet::Pops::Types::POptionalType
+              type = type.type
+            end
+
             # provide better handling of the standard types
             case type
             when Puppet::Pops::Types::PStringType
@@ -165,8 +184,13 @@ module Puppet::ResourceApi
         # puts 'instances'
         # force autoloading of the provider
         provider(name)
+        attr_def = {}
         my_provider.get(context).map do |resource_hash|
-          Puppet::ResourceApi::TypeShim.new(resource_hash[namevar_name], resource_hash, name, namevar_name)
+          resource_hash.each do |key|
+            property = definition[:attributes][key.first]
+            attr_def[key.first] = property
+          end
+          Puppet::ResourceApi::TypeShim.new(resource_hash[namevar_name], resource_hash, name, namevar_name, attr_def)
         end
       end
 

data/lib/puppet/resource_api/glue.rb

@@ -2,9 +2,9 @@
 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, :typename, :namevar
+    attr_reader :values, :typename, :namevar, :attr_def
 
-    def initialize(title, resource_hash, typename, namevarname)
+    def initialize(title, resource_hash, typename, namevarname, attr_def)
       # internalize and protect - needs to go deeper
       @values = resource_hash.dup
       # "name" is a privileged key
@@ -13,10 +13,11 @@ module Puppet::ResourceApi
 
       @typename = typename
       @namevar = namevarname
+      @attr_def = attr_def
     end
 
     def to_resource
-      ResourceShim.new(@values, @typename, @namevar)
+      ResourceShim.new(@values, @typename, @namevar, @attr_def)
     end
 
     def name
@@ -26,12 +27,13 @@ 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, :typename, :namevar
+    attr_reader :values, :typename, :namevar, :attr_def
 
-    def initialize(resource_hash, typename, namevarname)
+    def initialize(resource_hash, typename, namevarname, attr_def)
       @values = resource_hash.dup.freeze # whatevs
       @typename = typename
       @namevar = namevarname
+      @attr_def = attr_def
     end
 
     def title
@@ -44,7 +46,15 @@ module Puppet::ResourceApi
     end
 
     def to_manifest
-      (["#{@typename} { #{values[@namevar].inspect}: "] + values.keys.reject { |k| k == @namevar }.map { |k| "  #{k} => #{Puppet::Parameter.format_value_for_display(values[k])}," } + ['}']).join("\n")
+      (["#{@typename} { #{values[@namevar].inspect}: "] + values.keys.reject { |k| k == @namevar }.map do |k|
+        cs = ' '
+        ce = ''
+        if attr_def[k][:behaviour] && attr_def[k][:behaviour] == :read_only
+          cs = '#'
+          ce = ' # Read Only'
+        end
+        "#{cs} #{k} => #{Puppet::Parameter.format_value_for_display(values[k])},#{ce}"
+      end + ['}']).join("\n")
     end
 
     # Convert our resource to yaml for Hiera purposes.

data/lib/puppet/resource_api/puppet_context.rb

@@ -2,14 +2,9 @@ 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)
+    Puppet::Util::Log.create(level: level, message: message)
   end
 end

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '0.10.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: This library provides a simple way to write new native resources for puppet.