Included ansible_devices for AIX facts/hardware

[kairoaraujo]

SUMMARY

Included devices for AIX on facts/hardware/aix.py.
These information is very useful for AIX environment.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

lib/ansible/module_utils/facts/hardware/aix.py

ANSIBLE VERSION

ansible 2.5.0 (facts_devices_aix 4fcf172068) last updated 2017/10/10 21:33:38 (GMT +200)
  config file = None
  configured module search path = ['/Users/kairo/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/kairo/Dev/Ansible/facts_devices_aix/ansible/lib/ansible
  executable location = /Users/kairo/Dev/Ansible/facts_devices_aix/ansible/bin/ansible
  python version = 3.6.3 (v3.6.3:2c5fed86e0, Oct  3 2017, 00:32:08) [GCC 4.2.1 (Apple Inc. build 5666) (dot 3)]

ADDITIONAL INFORMATION

Example of full output of -m setup with ansible_devices for AIX.
https://gist.github.com/kairoaraujo/a9c56b078191842bffb35065e1642d1d

Example of use:

• Playbook

---
- name: Devices
  hosts: all

  tasks:
  - debug:
      msg: "{{ ansible_devices.sda }}"
    when: ansible_devices.sda is defined

  - debug:
      msg: "{{ ansible_devices.hdisk0 }}"
    when: ansible_devices.hdisk0 is defined

Output

PLAY [Devices] ******************************************************************************************************************

TASK [Gathering Facts] **********************************************************************************************************
ok: [172.16.229.4]
ok: [172.16.100.21]

TASK [debug] ********************************************************************************************************************
skipping: [172.16.100.21]
ok: [172.16.229.4] => {
    "msg": {
        "holders": [],
        "host": "",
        "links": {
            "ids": [],
            "labels": [],
            "masters": [],
            "uuids": []
        },
        "model": "Virtual disk",
        "partitions": {
            "sda1": {
                "holders": [],
                "links": {
                    "ids": [],
                    "labels": [],
                    "masters": [],
                    "uuids": [
                        "4116b0d3-6305-46d7-9869-5f04854f7a84"
                    ]
                },
                "sectors": "1024000",
                "sectorsize": 512,
                "size": "500.00 MB",
                "start": "2048",
                "uuid": "4116b0d3-6305-46d7-9869-5f04854f7a84"
            },
            "sda2": {
                "holders": [
                    "rhel-swap",
                    "rhel-root"
                ],
                "links": {
                    "ids": [
                        "lvm-pv-uuid-lbLyNd-1JGf-SVmD-lDsL-Hapj-RuoN-pUeWIF"
                    ],
                    "labels": [],
                    "masters": [
                        "dm-0",
                        "dm-1"
                    ],
                    "uuids": []
                },
                "sectors": "40916992",
                "sectorsize": 512,
                "size": "19.51 GB",
                "start": "1026048",
                "uuid": null
            }
        },
        "removable": "0",
        "rotational": "1",
        "sas_address": null,
        "sas_device_handle": null,
        "scheduler_mode": "deadline",
        "sectors": "41943040",
        "sectorsize": "512",
        "size": "20.00 GB",
        "support_discard": "0",
        "vendor": "VMware",
        "virtual": 1
    }
}

TASK [debug] ********************************************************************************************************************
skipping: [172.16.229.4]
ok: [172.16.100.21] => {
    "msg": {
        "attributes": {
            "PCM": "PCM/friend/vscsi",
            "PR_key_value": "none",
            "algorithm": "fail_over",
            "hcheck_cmd": "test_unit_rdy",
            "hcheck_interval": "20",
            "hcheck_mode": "nonactive",
            "max_transfer": "0x40000",
            "pvid": "00f7c85d376eb73b0000000000000000",
            "queue_depth": "20",
            "reserve_policy": "no_reserve"
        },
        "state": "Available",
        "type": "Virtual SCSI Disk Drive"
    }
}

PLAY RECAP **********************************************************************************************************************
172.16.100.21              : ok=2    changed=0    unreachable=0    failed=0
172.16.229.4               : ok=2    changed=0    unreachable=0    failed=0

[ansibot]

The test ansible-test sanity --test pep8 [?] failed with the following error:

lib/ansible/module_utils/facts/hardware/aix.py:228:17: E123 closing bracket does not match indentation of opening bracket's line

click here for bot help

[kairoaraujo]

bot_status

[ansibot]

waiting_on: kairoaraujo
component: None
supported_by: core
changes_requested_by: null
needs_info: False
needs_revision: True
needs_rebase: False
merge_commits: []
mergeable_state: unstable
shippable_status: failure
maintainer_shipits (module maintainers): False
community_shipits (namespace maintainers): False
ansible_shipits (core team members): False
shipit_actors (maintainer or core team member): None
shipit_actors_other:

click here for bot help

[alikins]

Need to fix the run_command() use to pass multiple args as a list.

[alikins]

use an args list here instead of a string to avoid problems if the first field if lsdev output is unexpected.
for ex:

device_name = field[0]
lsattr_cmd_args = [lsattr_cmd, '-E', '-l', device_name]
rc, out_lsattr, err = self.module.run_command(lsattr_cmd_args)

[alikins]

Since attr_field is a list, attr_fields would be a better name

(and for the 'field' list above as well)

[alikins]

@kairoaraujo Could you provide some sample output from the 'lsattr' and 'lsdev' commands for reference and/or tests?

[alikins]

Code looks good to me but wouldn't mind seeing some unit tests.

a little refactoring may make it easier to test, something like:

    def _parse_lsdev(self, out_lsdev):
        devices = []
        for line in out_lsdev.splitlines():
            field = line.split()

            device_name = field[0]
            device_state = field[1]
            device_type = field[2:]

            devices.append({'name': device_name,
                            'state': device_state,
                            'type': device_type})

        return devices

    def _parse_lsattr(self, out_lsattr):
        device_attrs = {}
        for attr in out_lsattr.splitlines():
            attr_fields = attr.split()

            attr_name = attr_fields[0]
            attr_parameter = attr_fields[1]

            # attrs.append({'name': attr_name,
            #              'parameter': attr_parameter})
            device_attrs[attr_name] = attr_parameter

        return device_attrs

    def _get_device_attrs(self, lsattr_cmd, device_name):
        lsattr_cmd_args = [lsattr_cmd, '-E', '-l', device_name]
        rc, out_lsattr, err = self.module.run_command(lsattr_cmd_args)
        device_attrs = self._parse_lsattr(out_lsattr)
        return device_attrs

    def _get_devices(self, lsdev_cmd):
        rc, out_lsdev, err = self.module.run_command(lsdev_cmd)
        devices = self._parse_lsdev(out_lsdev)
        return devices

    def get_device_facts(self):
        device_facts = {}
        device_facts['devices'] = {}

        lsdev_cmd = self.module.get_bin_path('lsdev', True)
        lsattr_cmd = self.module.get_bin_path('lsattr', True)

        rc, out_lsdev, err = self.module.run_command(lsdev_cmd)

        devices = self._get_devices(lsdev_cmd, out_lsdev)

        for device in devices:
            device_attrs = self._get_device_attrs(lsattr_cmd, device['name'])

            device_facts['devices'][device['name']] = {
                'state': device['state'],
                'type': ' '.join(device['type']),
                'attributes': device_attrs
            }

        return device_facts

The _parse_lsattr and _parse_lsdev could be unit tests with sample output from the commands