FEATURE: Ansible module for getting storage controller info

An Ansible module for returning storage controller info for a given scope.

The module takes two optional parameters:
`scope` for specifying the scope of the data to return. Valid choices are: `global` (default), `appliance`, `os`, `environment`, and `host`.
`name` for requesting the data for a specific item in the scope. If name is not provided, then all data for that scope is returned.

The data returned is a list of `controllers`.

Example playbook:
```
---
- hosts: localhost
  tasks:
    - name: Get global controller info
      stacki_storage_controller_info:
      register: result

    - name: Global controller output
      debug:
        var: result

    - name: Get host controller output for backend-0-0
      stacki_storage_controller_info:
        name: backend-0-0
        scope: host
      register: result

    - name: Host backend-0-0 controller output
      debug:
        var: result
```

Output of the debug commands, showing the structure of the data returned:
```
TASK [Global controller output] ********************************************************************************************************************************
ok: [localhost] => {
    "result": {
        "changed": false,
        "controllers": [
            {
                "adapter": null,
                "arrayid": "*",
                "enclosure": null,
                "options": "",
                "raidlevel": "0",
                "slot": "*"
            }
        ],
        "failed": false
    }
}

TASK [Host backend-0-0 controller output] **********************************************************************************************************************
ok: [localhost] => {
    "result": {
        "changed": false,
        "controllers": [
            {
                "adapter": null,
                "arrayid": "*",
                "enclosure": null,
                "host": "backend-0-0",
                "options": "",
                "raidlevel": "0",
                "slot": "*",
                "source": "H"
            },
            {
                "adapter": null,
                "arrayid": "1",
                "enclosure": null,
                "host": "backend-0-0",
                "options": "",
                "raidlevel": "1",
                "slot": "0",
                "source": "H"
            },
            {
                "adapter": null,
                "arrayid": "1",
                "enclosure": null,
                "host": "backend-0-0",
                "options": "",
                "raidlevel": "1",
                "slot": "1",
                "source": "H"
            }
        ],
        "failed": false
    }
}
```

Author: caladd

common/src/stack/ansible/plugins/modules/stacki_storage_controller_info.py

@@ -0,0 +1,172 @@
+# @copyright@
+# Copyright (c) 2006 - 2020 Teradata
+# All rights reserved. Stacki(r) v5.x stacki.com
+# https://github.com/Teradata/stacki/blob/master/LICENSE.txt
+# @copyright@
+
+DOCUMENTATION = """
+module: stacki_storage_controller_info
+short_description: Return data about Stacki storage controllers
+description:
+  - If name is supplied, and scope is not global, returns data about a single scoped item
+  - If name is supplied, and scope is global, then an error is returned
+  - If name is not supplied, and scope is not global, then all data in that scope is returned
+  - If name is not supplied, and scope is global, then all global data is returned
+
+options:
+  name:
+    description:
+      - The name of the scoped item to return data about
+    type: str
+    required: false
+
+  scope:
+    description:
+      - The scope to return data about
+    type: str
+    required: false
+    choices: ['global', 'appliance', 'os', 'environment', 'host']
+    default: global
+"""
+
+EXAMPLES = """
+- name: Get all global data
+  stacki_storage_controller_info:
+  register: results
+
+- name: Get data about backend appliance
+  stacki_storage_controller_info:
+    name: backend
+    scope: appliance
+  register: results
+
+- name: Get data about all hosts
+  stacki_storage_controller_info:
+    scope: host
+  register: results
+"""
+
+RETURN = """
+controllers:
+  description:
+    - List of storage controllers
+  returned: on success
+  type: complex
+  contains:
+    appliance:
+      description:
+        - Name of the appliance for this data
+      type: str
+      returned: scope is appliance
+
+    os:
+      description:
+        - Name of the os for this data
+      type: str
+      returned: scope is os
+
+    environment:
+      description:
+        - Name of the environment for this data
+      type: str
+      returned: scope is environment
+
+    host:
+      description:
+        - Name of the host for this data
+      type: str
+      returned: scope is host
+
+    enclosure:
+      description:
+        - Enclosure number or None
+      type: int
+
+    adapter:
+      description:
+        - Adapter number or None
+      type: int
+
+    slot:
+      description:
+        - Slot number as a string, or '*' for all slots
+      type: str
+
+    raidlevel:
+      description:
+        - Raid level as a string
+      type: str
+
+    arrayid:
+      description:
+        - Array id as a string, or '*' for all arrays
+      type: str
+
+    options:
+      description:
+        - Controller options
+      type: str
+
+    source:
+      description:
+        - The scope source of the data
+      type: str
+      choices: ['G', 'A', 'O', 'E', 'H']
+      returned: scope is host
+"""
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.stacki import run_stack_command, StackCommandError
+
+
+def main():
+	# Define the arguments for this module
+	argument_spec = dict(
+		name=dict(type="str", required=False, default=None),
+		scope=dict(
+			type="str", required=False, default="global",
+			choices=["global", "appliance", "os", "environment", "host"]
+		)
+	)
+
+	# Create our module object
+	module = AnsibleModule(
+		argument_spec=argument_spec,
+		supports_check_mode=True
+	)
+
+	# Initialize a blank result
+	result = {
+		"changed": False,
+		"controllers": []
+	}
+
+	# Bail if the user is just checking syntax of their playbook
+	if module.check_mode:
+		module.exit_json(**result)
+
+	# Fetch our info from Stacki
+	args = ["scope=" + module.params["scope"]]
+
+	if module.params["name"]:
+		args.append(module.params["name"])
+
+	try:
+		for controller in run_stack_command("list.storage.controller", args):
+			# Make sure slot and arrayid are both strings
+			controller["slot"] = str(controller["slot"])
+			controller["arrayid"] = str(controller["arrayid"])
+
+			# Add it to the results
+			result["controllers"].append(controller)
+
+	except StackCommandError as e:
+		# Fetching the data failed
+		module.fail_json(msg=e.message, **result)
+
+	# Return our data
+	module.exit_json(**result)
+
+
+if __name__ == "__main__":
+	main()

test-framework/test-suites/integration/tests/ansible/test_stacki_storage_controller_info.py

@@ -0,0 +1,223 @@
+class TestStackiStorageControllerInfo:
+	def test_global_scope_no_name(self, run_ansible_module):
+		result = run_ansible_module("stacki_storage_controller_info")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [{
+			"adapter": None,
+			"arrayid": "*",
+			"enclosure": None,
+			"options": "",
+			"raidlevel": "0",
+			"slot": "*"
+		}]
+
+	def test_global_scope_with_name(self, run_ansible_module):
+		result = run_ansible_module("stacki_storage_controller_info", name="foo")
+
+		assert result.status == "FAILED!"
+		assert result.data["changed"] == False
+
+		assert "error" in result.data["msg"]
+		assert "Arguments are not allowed" in result.data["msg"]
+
+	def test_appliance_scope_no_name(self, host, run_ansible_module):
+		result = host.run(
+			'stack add appliance storage controller backend raidlevel=0 enclosure=1 '
+			'adapter=2 slot=3 arrayid=4'
+		)
+		assert result.rc == 0
+
+		result = run_ansible_module("stacki_storage_controller_info", scope="appliance")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [{
+			"adapter": 2,
+			"appliance": "backend",
+			"arrayid": "4",
+			"enclosure": 1,
+			"options": "",
+			"raidlevel": "0",
+			"slot": "3"
+		}]
+
+	def test_appliance_scope_with_name(self, host, run_ansible_module):
+		result = host.run(
+			'stack add appliance storage controller backend raidlevel=0 enclosure=1 '
+			'adapter=2 slot=3 arrayid=4'
+		)
+		assert result.rc == 0
+
+		result = run_ansible_module("stacki_storage_controller_info", scope="appliance", name="backend")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [{
+			"adapter": 2,
+			"appliance": "backend",
+			"arrayid": "4",
+			"enclosure": 1,
+			"options": "",
+			"raidlevel": "0",
+			"slot": "3"
+		}]
+
+	def test_os_scope_no_name(self, host, run_ansible_module):
+		result = host.run(
+			'stack add os storage controller sles raidlevel=0 enclosure=1 '
+			'adapter=2 slot=3 arrayid=4'
+		)
+		assert result.rc == 0
+
+		result = run_ansible_module("stacki_storage_controller_info", scope="os")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [{
+			"adapter": 2,
+			"arrayid": "4",
+			"enclosure": 1,
+			"options": "",
+			"os": "sles",
+			"raidlevel": "0",
+			"slot": "3"
+		}]
+
+	def test_os_scope_with_name(self, host, run_ansible_module):
+		result = host.run(
+			'stack add os storage controller sles raidlevel=0 enclosure=1 '
+			'adapter=2 slot=3 arrayid=4'
+		)
+		assert result.rc == 0
+
+		result = run_ansible_module("stacki_storage_controller_info", scope="os", name="sles")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [{
+			"adapter": 2,
+			"arrayid": "4",
+			"enclosure": 1,
+			"options": "",
+			"os": "sles",
+			"raidlevel": "0",
+			"slot": "3"
+		}]
+
+	def test_environment_scope_no_name(self, host, add_environment, run_ansible_module):
+		result = host.run(
+			'stack add environment storage controller test raidlevel=0 enclosure=1 '
+			'adapter=2 slot=3 arrayid=4'
+		)
+		assert result.rc == 0
+
+		result = run_ansible_module("stacki_storage_controller_info", scope="environment")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [{
+			"adapter": 2,
+			"arrayid": "4",
+			"enclosure": 1,
+			"environment": "test",
+			"options": "",
+			"raidlevel": "0",
+			"slot": "3"
+		}]
+
+	def test_environment_scope_with_name(self, host, add_environment, run_ansible_module):
+		result = host.run(
+			'stack add environment storage controller test raidlevel=0 enclosure=1 '
+			'adapter=2 slot=3 arrayid=4'
+		)
+		assert result.rc == 0
+
+		result = run_ansible_module("stacki_storage_controller_info", scope="environment", name="test")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [{
+			"adapter": 2,
+			"arrayid": "4",
+			"enclosure": 1,
+			"environment": "test",
+			"options": "",
+			"raidlevel": "0",
+			"slot": "3"
+		}]
+
+	def test_host_scope_no_name(self, host, add_host, run_ansible_module):
+		result = host.run(
+			'stack add host storage controller backend-0-0 raidlevel=0 enclosure=1 '
+			'adapter=2 slot=3 arrayid=4'
+		)
+		assert result.rc == 0
+
+		result = run_ansible_module("stacki_storage_controller_info", scope="host")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [
+			{
+				"adapter": 2,
+				"arrayid": "4",
+				"enclosure": 1,
+				"host": "backend-0-0",
+				"options": "",
+				"raidlevel": "0",
+				"slot": "3",
+				"source": "H"
+			},
+			{
+				"adapter": None,
+				"arrayid": "*",
+				"enclosure": None,
+				"host": "frontend-0-0",
+				"options": "",
+				"raidlevel": "0",
+				"slot": "*",
+				"source": "G"
+			}
+		]
+
+	def test_host_scope_with_name(self, host, add_host, run_ansible_module):
+		result = host.run(
+			'stack add host storage controller backend-0-0 raidlevel=0 enclosure=1 '
+			'adapter=2 slot=3 arrayid=4'
+		)
+		assert result.rc == 0
+
+		result = run_ansible_module("stacki_storage_controller_info", scope="host", name="backend-0-0")
+
+		assert result.status == "SUCCESS"
+		assert result.data["changed"] == False
+
+		assert result.data["controllers"] == [{
+			"adapter": 2,
+			"arrayid": "4",
+			"enclosure": 1,
+			"host": "backend-0-0",
+			"options": "",
+			"raidlevel": "0",
+			"slot": "3",
+			"source": "H"
+		}]
+
+	def test_bad_name(self, run_ansible_module):
+		result = run_ansible_module("stacki_storage_controller_info", scope="appliance", name="foo")
+
+		assert result.status == "FAILED!"
+		assert result.data["changed"] == False
+
+		assert "error" in result.data["msg"]
+		assert "not a valid appliance" in result.data["msg"]