random_pet: Random pet name generator (#2479) (#2509)

A lookup plugin to generate random pet names based
upon criteria.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 5d0a7f40f2)

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>

plugins/lookup/random_pet.py

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2021, Abhijeet Kasurde <akasurde@redhat.com>
+# Copyright: (c) 2018, Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+
+__metaclass__ = type
+
+DOCUMENTATION = r'''
+    name: random_pet
+    author:
+      - Abhijeet Kasurde (@Akasurde)
+    short_description: Generates random pet names
+    version_added: '3.1.0'
+    requirements:
+      - petname U(https://github.com/dustinkirkland/python-petname)
+    description:
+      - Generates random pet names that can be used as unique identifiers for the resources.
+    options:
+      words:
+        description:
+        - The number of words in the pet name.
+        default: 2
+        type: int
+      length:
+        description:
+        - The maximal length of every component of the pet name.
+        - Values below 3 will be set to 3 by petname.
+        default: 6
+        type: int
+      prefix:
+        description: A string to prefix with the name.
+        type: str
+      separator:
+        description: The character to separate words in the pet name.
+        default: "-"
+        type: str
+'''
+
+EXAMPLES = r'''
+- name: Generate pet name
+  ansible.builtin.debug:
+    var: lookup('community.general.random_pet')
+  # Example result: 'loving-raptor'
+
+- name: Generate pet name with 3 words
+  ansible.builtin.debug:
+    var: lookup('community.general.random_pet', words=3)
+  # Example result: 'fully-fresh-macaw'
+
+- name: Generate pet name with separator
+  ansible.builtin.debug:
+    var: lookup('community.general.random_pet', separator="_")
+  # Example result: 'causal_snipe'
+
+- name: Generate pet name with length
+  ansible.builtin.debug:
+    var: lookup('community.general.random_pet', length=7)
+  # Example result: 'natural-peacock'
+'''
+
+RETURN = r'''
+  _raw:
+    description: A one-element list containing a random pet name
+    type: list
+    elements: str
+'''
+
+try:
+    import petname
+
+    HAS_PETNAME = True
+except ImportError:
+    HAS_PETNAME = False
+
+from ansible.errors import AnsibleError
+from ansible.plugins.lookup import LookupBase
+
+
+class LookupModule(LookupBase):
+
+    def run(self, terms, variables=None, **kwargs):
+
+        if not HAS_PETNAME:
+            raise AnsibleError('Python petname library is required. '
+                               'Please install using "pip install petname"')
+
+        self.set_options(var_options=variables, direct=kwargs)
+        words = self.get_option('words')
+        length = self.get_option('length')
+        prefix = self.get_option('prefix')
+        separator = self.get_option('separator')
+
+        values = petname.Generate(words=words, separator=separator, letters=length)
+        if prefix:
+            values = "%s%s%s" % (prefix, separator, values)
+
+        return [values]

tests/integration/targets/lookup_random_pet/aliases

@@ -0,0 +1,3 @@
+shippable/posix/group2
+skip/aix
+skip/python2.6  # lookups are controller only, and we no longer support Python 2.6 on the controller

tests/integration/targets/lookup_random_pet/dependencies.yml

@@ -0,0 +1,6 @@
+---
+- hosts: localhost
+  tasks:
+    - name: Install Petname Python package
+      pip:
+        name: petname

tests/integration/targets/lookup_random_pet/runme.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+set -eux
+
+ANSIBLE_ROLES_PATH=../ \
+    ansible-playbook dependencies.yml -v "$@"
+
+ANSIBLE_ROLES_PATH=../ \
+    ansible-playbook test.yml -v "$@"

tests/integration/targets/lookup_random_pet/test.yml

@@ -0,0 +1,25 @@
+- hosts: localhost
+  gather_facts: no
+  tasks:
+  - name: Call plugin
+    set_fact:
+      result1: "{{ query('community.general.random_pet', words=3) }}"
+      result2: "{{ query('community.general.random_pet', length=3) }}"
+      result3: "{{ query('community.general.random_pet', prefix='kubernetes') }}"
+      result4: "{{ query('community.general.random_pet', separator='_') }}"
+      result5: "{{ query('community.general.random_pet', words=2, length=6, prefix='kubernetes', separator='_') }}"
+
+  - name: Check results
+    assert:
+      that:
+        - result1 | length == 1
+        - result1[0].split('-') | length == 3
+        - result2 | length == 1
+        - result2[0].split('-')[0] | length <= 3
+        - result3 | length == 1
+        - result3[0].split('-')[0] == 'kubernetes'
+        - result4 | length == 1
+        - result4[0].split('_') | length == 2
+        - result5 | length == 1
+        - result5[0].split('_') | length == 3
+        - result5[0].split('_')[0] == 'kubernetes'