Make node_group_unpin accept an array of certnames

Author: petergmurphy

REFERENCE.md

@@ -74,7 +74,7 @@
 * [`infrastatus`](#infrastatus): Runs puppet infra status and returns the output
 * [`mkdir_p_file`](#mkdir_p_file): Create a file with the specified content at the specified location
 * [`mv`](#mv): Wrapper task for mv command
-* [`node_group_unpin`](#node_group_unpin): Unpins a node from a specified PE node group
+* [`node_group_unpin`](#node_group_unpin): Unpins nodes from a specified PE node group
 * [`os_identification`](#os_identification): Return the operating system runnin gon the target as a string
 * [`pe_install`](#pe_install): Install Puppet Enterprise from a tarball
 * [`pe_ldap_config`](#pe_ldap_config): Set the ldap config in the PE console
@@ -1327,23 +1327,23 @@ New path of file
 
 ### <a name="node_group_unpin"></a>`node_group_unpin`
 
-Unpins a node from a specified PE node group
+Unpins nodes from a specified PE node group
 
 **Supports noop?** false
 
 #### Parameters
 
-##### `node_certname`
+##### `node_certnames`
 
-Data type: `String`
+Data type: `Array[String]`
 
-The certname of the node to unpin
+The certnames of the nodes to unpin
 
 ##### `group_name`
 
 Data type: `String`
 
-The name of the node group to unpin the node from
+The name of the node group to unpin the nodes from
 
 ### <a name="os_identification"></a>`os_identification`
 

plans/convert.pp

@@ -282,12 +282,10 @@
 
       # Unpin legacy compilers from PE Master group
       if $legacy_compiler_targets {
-        $legacy_compiler_targets.each |$target| {
-          run_task('peadm::node_group_unpin', $primary_target,
-            node_certname => $target.peadm::certname(),
-            group_name    => 'PE Master',
-          )
-        }
+        run_task('peadm::node_group_unpin', $primary_target,
+          node_certnames => $legacy_compiler_targets.map |$target| { $target.peadm::certname() },
+          group_name    => 'PE Master',
+        )
       }
     }
     else {

spec/plans/convert_spec.rb

@@ -21,7 +21,7 @@
     expect_task('peadm::cert_data').return_for_targets('primary' => trustedjson)
     expect_task('peadm::read_file').always_return({ 'content' => '2021.7.9' })
     expect_task('peadm::get_group_rules').return_for_targets('primary' => { '_output' => '{"rules": []}' })
-    expect_task('peadm::node_group_unpin').with_targets('primary').with_params({ 'node_certname' => 'legacy_compiler', 'group_name' => 'PE Master' })
+    expect_task('peadm::node_group_unpin').with_targets('primary').with_params({ 'node_certnames' => ['legacy_compiler'], 'group_name' => 'PE Master' })
     expect_task('peadm::check_legacy_compilers').with_targets('primary').with_params({ 'legacy_compilers' => 'legacy_compiler' }).return_for_targets('primary' => { '_output' => '' })
 
     # For some reason, expect_plan() was not working??

tasks/node_group_unpin.json

@@ -1,13 +1,13 @@
 {
-  "description": "Unpins a node from a specified PE node group",
+  "description": "Unpins nodes from a specified PE node group",
   "parameters": {
-    "node_certname": {
-      "type": "String",
-      "description": "The certname of the node to unpin"
+    "node_certnames": {
+      "type": "Array[String]",
+      "description": "The certnames of the nodes to unpin"
     },
     "group_name": {
       "type": "String",
-      "description": "The name of the node group to unpin the node from"
+      "description": "The name of the node group to unpin the nodes from"
     }
   },
   "input_method": "stdin",

tasks/node_group_unpin.rb

@@ -10,7 +10,8 @@
 class NodeGroupUnpin
   def initialize(params)
     @params = params
-    raise "Missing required parameter 'node_certname'" unless @params['node_certname']
+    raise "Missing required parameter 'node_certnames'" unless @params['node_certnames']
+    raise "'node_certnames' must be an array" unless @params['node_certnames'].is_a?(Array)
     raise "Missing required parameter 'group_name'" unless @params['group_name']
     @auth = YAML.load_file('/etc/puppetlabs/puppet/classifier.yaml')
   rescue Errno::ENOENT
@@ -44,12 +45,12 @@ def groups
     end
   end
 
-  def unpin_node(group, node)
+  def unpin_node(group, nodes)
     raise 'Invalid group object' unless group.is_a?(Hash) && group['id'] && group['name']
 
     net = https_client
     begin
-      data = { "nodes": [node] }.to_json
+      data = { "nodes": nodes }.to_json
       url = "/classifier-api/v1/groups/#{group['id']}/unpin"
 
       req = Net::HTTP::Post.new(url)
@@ -60,11 +61,11 @@ def unpin_node(group, node)
 
       case res.code
       when '204'
-        puts "Successfully unpinned node '#{node}' from group '#{group['name']}'"
+        puts "Successfully unpinned nodes '#{nodes.join(', ')}' from group '#{group['name']}'"
       else
         begin
           error_body = JSON.parse(res.body.to_s)
-          raise "Failed to unpin node: #{error_body['kind'] || error_body}"
+          raise "Failed to unpin nodes: #{error_body['kind'] || error_body}"
         rescue JSON::ParserError
           raise "Invalid response from server (status #{res.code}): #{res.body}"
         end
@@ -98,11 +99,11 @@ def dig(name, *args)
 
   def execute!
     group_name = @params['group_name']
-    node_certname = @params['node_certname']
+    node_certnames = @params['node_certnames']
     group = groups.dig(group_name)
     if group
-      unpin_node(group, node_certname)
-      puts "Unpinned #{node_certname} from #{group_name}"
+      unpin_node(group, node_certnames)
+      puts "Unpinned #{node_certnames.join(', ')} from #{group_name}"
     else
       puts "Group #{group_name} not found"
     end