Merge pull request #13 from WhatsARanjit/description

Description

Author: WhatsARanjit

README.md

@@ -13,12 +13,7 @@
 
 ## Overview
 
-Create and manage Node Manager API endpoints as resources.
-
-## Module State
-
-NOTE: This module is a Professional Service side project and is currently unmaintained.
-It is not supported and may not function as expected.
+Create and manage PE node groups as resources.
 
 ## Requirements
 
@@ -61,6 +56,10 @@ node_group { 'PE MCollective':
 
 #### Node_group parameters
 
+* `description`
+
+  Description of the node_group.
+
 * `classes`
 
   Classes that are assigned to the node in hash format. Elements of the hash are class parameters.
@@ -181,4 +180,3 @@ This repositority is largely the work of some Puppet community members.
 It is not officially maintained by Puppet, or any individual in
 particular. Issues should be opened in Github. Questions should be directed
 at the individuals responsible for committing that particular code.
-

lib/puppet/provider/node_group/https.rb

@@ -30,7 +30,8 @@ def self.friendly_name
       :name               => 'name',
       :parent             => 'parent',
       :rule               => 'rule',
-      :variables          => 'variables'
+      :variables          => 'variables',
+      :description        => 'description',
     }
   end
 

lib/puppet/provider/node_group/puppetclassify.rb

@@ -31,12 +31,12 @@ def self.friendly_name
       :name               => 'name',
       :parent             => 'parent',
       :rule               => 'rule',
-      :variables          => 'variables'
+      :variables          => 'variables',
+      :description        => 'description',
     }
   end
 
   def self.instances
-    deprecation_warning('This provider is being deprecated.  See https provider at https://github.com/WhatsARanjit/prosvcs-node_manager/blob/https_provider/HTTPS.md')
     $ngs = classifier.groups.get_groups
     $ngs.collect do |group|
       ngs_hash = {}
@@ -57,6 +57,7 @@ def self.instances
   end
 
   def self.prefetch(resources)
+    deprecation_warning('This provider is being deprecated.  See https provider at https://github.com/WhatsARanjit/prosvcs-node_manager/blob/https_provider/HTTPS.md')
     ngs = instances
     resources.keys.each do |group|
       if provider = ngs.find{ |g| g.name == group }

lib/puppet/type/node_group.rb

@@ -40,6 +40,9 @@
       fail("Classes must be supplied as a hash") unless value.is_a?(Hash)
     end
   end
+  newproperty(:description) do
+    desc 'Description of this group'
+  end
 
   autorequire(:node_group) do
     self[:parent] if @parameters.include? :parent

spec/integration/puppet/provider/node_group/https_spec.rb

@@ -20,7 +20,8 @@
                 ".*"
             ]
         ],
-        "variables": {}
+        "variables": {},
+        "description": "Sample message"
     }
   ]
   EOS
@@ -35,6 +36,7 @@
       "stubkey"  => "stubvalue",
       "stubkey2" => "stubvalue2"
     },
+    "description"        => "Sample message",
     "name"               => "stub_name",
   }.to_json
 
@@ -51,6 +53,7 @@
         :stubkey  => :stubvalue,
         :stubkey2 => :stubvalue2,
       },
+      :description          => "Sample message",
     )
   end
 

spec/integration/puppet/provider/node_group/puppetclassify_spec.rb

@@ -20,7 +20,8 @@
                 ".*"
             ]
         ],
-        "variables": {}
+        "variables": {},
+        "description": "Sample message"
     }
   ]
   EOS
@@ -36,6 +37,7 @@
       "stubkey"  => "stubvalue",
       "stubkey2" => "stubvalue2"
     },
+    "description"        => "Sample message",
     "name"               => "stub_name",
   }.to_json
 
@@ -52,6 +54,7 @@
         :stubkey  => :stubvalue,
         :stubkey2 => :stubvalue2,
       },
+      :description          => "Sample message",
     )
   end
 

spec/unit/puppet/type/node_group_spec.rb

@@ -64,4 +64,13 @@
     }.to_not raise_error
   end
 
+  it "should accept a description parameter" do
+    expect {
+      Puppet::Type.type(:node_group).new(
+        :name        => 'stubname',
+        :description => 'Sample message',
+      )
+    }.to_not raise_error
+  end
+
 end