Use inventory endpoint, explode hostgroup query

Rather than user `/pdb/query/v4/facts` use an inventory query to
`pdb/query/v4`.

Also a change of behaviour previously the hostgroup `a/b/c` was searched
as a regex for `a/b/c` in the hostgroup.

Instead a hostgroup such as `a/b/c` is filtered as the and of
`hostgroup_0=a`, `hostgroup_1=b` and `hostgroup_2=c`.

Author: traylenator

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v3.0.0](https://github.com/cernops/rundeck-puppetdb-nodes/tree/v3.0.0)
+- Use PDB /inventory endpoint
+- Explode full hostgroup and query with hostgroup elements
+
 ## [v2.1.0](https://github.com/cernops/rundeck-puppetdb-nodes/tree/v2.1.0)
 
 - Set custom user-agent for puppetdb requests to "rundeck_puppetdb_nodes"

rundeck-puppetdb-nodes-plugin/contents/rundeck_puppetdb_nodes.py

@@ -28,23 +28,24 @@ def destroy_krb_ticket(self):
 
 
     def get_facts_puppetdb(self, apiurl, facts, hostgroup):
-        url ='%s/facts' % apiurl
-        if 'v3' in apiurl:
-            query_base = '["and",["or",%s],["in", "certname", ["extract", "certname", ["select-facts", ["and", ["=", "name", "hostgroup"], ["~", "value", "%s"]]]]]]'
-        else:
-            query_base = '["and",["or",%s],["in", "certname", ["extract", "certname", ["select_facts", ["and", ["=", "name", "hostgroup"], ["~", "value", "%s"]]]]]]'
-        query_facts = ','.join(['["=","name","%s"]' % fact for fact in facts])
-        query = query_base % (query_facts, hostgroup)
+
+        query_facts = ','.join(['facts.%s' % fact for fact in facts])
+
+        # Strip / to cover cases of where hostgroup has been set to "top/"
+        hostgroup_parts = hostgroup.rstrip('/').split('/')
+        hostgroup_filter = ' and '.join([f'facts.hostgroup_{i} = "{part}"' for i, part in enumerate(hostgroup_parts)])
+
+        query = 'inventory[certname,%s]{%s}' % (query_facts, hostgroup_filter)
 
         headers = {
                 'Content-Type': 'application/json',
                 'Accept': 'application/json, version=2',
-                'User-Agent': 'rundeck_puppetdb_nodes/2.1.0'
+                'User-Agent': 'rundeck_puppetdb_nodes/3.0.0'
                 }
         payload = {'query': query}
 
-        logging.info("Getting facts from '%s', query: '%s'", url, query)
-        r = requests.get(url, params=payload, headers=headers, auth=HTTPKerberosAuth())
+        logging.info("Getting facts from '%s', query: '%s'", apiurl, query)
+        r = requests.get(apiurl, params=payload, headers=headers, auth=HTTPKerberosAuth())
 
         # pylint: disable=no-member
         if r.status_code == requests.codes.ok:
@@ -65,17 +66,16 @@ def print_puppetdb_nodes(self, apiurl, hostgroup, sshuser, factlist):
         data = defaultdict(lambda: {})
 
         if raw_data != None:
-            for entry in raw_data:
-                data[entry['certname']] = dict(list(data[entry['certname']].items()) + [(entry['name'], entry['value'])])
-
             logging.info("Printing node list using standard output...")
-            for node in data.keys():
-                print('%s:'%node)
-                print(" "*4 + "hostname: " + node)
+            for entry in raw_data:
+                print('%s:' % entry['certname'])
+                print(" "*4 + "hostname: " + entry['certname'])
                 print(" "*4 + "username: " + sshuser)
                 for fact in factlist:
-                    if fact in data[node]:
-                        print(" "*4 + fact + ": " + str(data[node][fact]) )
+                    factkey = "facts.%s" % fact
+                    if factkey in entry:
+                        print(" "*4 + factkey + ": " + str(entry[factkey]))
+
             logging.info("Node list printed successfully")
 
         else:
@@ -90,21 +90,18 @@ def store_puppetdb_nodes(self, apiurl, hostgroup, sshuser, factlist, filename):
         '''
         factlist.extend(["operatingsystem", "operatingsystemrelease", "hostgroup"])
         raw_data = self.get_facts_puppetdb(apiurl, factlist, hostgroup)
-        data = defaultdict(lambda: {})
 
         if raw_data != None:
-            for entry in raw_data:
-                data[entry['certname']] = dict(list(data[entry['certname']].items()) + [(entry['name'], entry['value'])])
-
             logging.info("Saving node list in '%s'...", filename)
             with open(filename, 'w') as file:
-                for node in data.keys():
-                    file.write('%s:\n'%node)
-                    file.write(" "*4 + "hostname: " + node + '\n')
-                    file.write(" "*4 + "username: " + sshuser +'\n')
+                for entry in raw_data:
+                    file.write('%s:' % entry['certname'] + '\n')
+                    file.write(" "*4 + "hostname: " + entry['certname'] + '\n')
+                    file.write(" "*4 + "username: " + sshuser + '\n')
                     for fact in factlist:
-                        if fact in data[node]:
-                            file.write(" "*4 + fact + ": " + str(data[node][fact]) + '\n')
+                        factkey = "facts.%s" % fact
+                        if factkey in entry:
+                            file.write(" "*4 + factkey + ": " + str(entry[factkey]) + '\n')
             logging.info('Node list saved successfully')
 
             # trick to avoid Rundeck complain when no output is printed out

rundeck-puppetdb-nodes-plugin/plugin.yaml

@@ -1,9 +1,9 @@
 #yaml plugin metadata
 
 name: PuppetDB source
-version: 2.1.0
+version: 3.0.0
 rundeckPluginVersion: 1.0
-author: Daniel Fernandez, David Moreno Garcia, Philippe Ganz, Nacho Barrientos Arias (nacho.barrientos@cern.ch), Ignacio Coterillo Coz (ignacio.coterillo.coz@cern.ch)
+author: Daniel Fernandez, David Moreno Garcia, Philippe Ganz, Nacho Barrientos Arias (nacho.barrientos@cern.ch), Ignacio Coterillo Coz (ignacio.coterillo.coz@cern.ch), Steve Traylen (steve.traylen@cern.ch)
 date: 2021/08/04
 providers:
         - name: rundeck-puppetdb-nodes