Add module redfish_command

[jose-delarosa]

SUMMARY

Communicates with Out-Of-Band Controller through Redfish APIs
Sends a command to execute an action

ISSUE TYPE

• New Module Pull Request

COMPONENT NAME

redfish_command

ANSIBLE VERSION

ansible 2.7.0.dev0 (redfish_config ef50194a65) last updated 2018/07/30 17:19:04 (GMT -500)
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/root/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /share1/git/ansible/lib/ansible
  executable location = /share1/git/ansible/bin/ansible
  python version = 2.7.5 (default, Feb 20 2018, 09:19:12) [GCC 4.8.5 20150623 (Red Hat 4.8.5-28)]

ADDITIONAL INFORMATION

This PR is part of a group of modules. PR for first module is #41656 (merged).

[jose-delarosa]

ready_for_review

[samdoran]

I don't see anywhere this module reports a change. If this is just sending arbitrary commands without a way to validate state, it should probably always report changed=True.

[samdoran]

Wrap all instances of result['msg'] within fail_json() in to_native().

[samdoran]

I'm assuming the output in result['msg'] is fairly descriptive of the specific type of error so that the user could tell what went wrong and how to fix it.

[jose-delarosa]

The output of result['msg'] varies in case of error, it returns an HTTPError or URLError code based on different scenarios (in older OOB controllers some APIs are not available --> 404).

[samdoran]

This should be a bit more descriptive of what this module specifically does. Most modules build some sort of command or URI, so this doesn't really describe what this module actually does without inferring it from reading the documentation.

[ansibot]

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/remote_management/redfish/redfish_command.py:0:0: missing documentation (or could not parse documentation): sequence item 1: expected string or Unicode, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/remote_management/redfish/redfish_command.py:0:0: missing documentation (or could not parse documentation): sequence item 1: expected string or Unicode, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/remote_management/redfish/redfish_command.py:0:0: missing documentation (or could not parse documentation): sequence item 1: expected str instance, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/remote_management/redfish/redfish_command.py:0:0: missing documentation (or could not parse documentation): sequence item 1: expected str instance, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/remote_management/redfish/redfish_command.py:0:0: missing documentation (or could not parse documentation): sequence item 1: expected str instance, AnsibleMapping found

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "test/sanity/code-smell/docs-build.py", line 100, in <module>
    main()
  File "test/sanity/code-smell/docs-build.py", line 17, in main
    raise subprocess.CalledProcessError(sphinx.returncode, cmd, output=stdout, stderr=stderr)
subprocess.CalledProcessError: Command '['make', 'singlehtmldocs']' returned non-zero exit status 2.

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/remote_management/redfish/redfish_command.py:255:1: E305 expected 2 blank lines after class or function definition, found 1

The test ansible-test sanity --test validate-modules [explain] failed with 3 errors:

lib/ansible/modules/remote_management/redfish/redfish_command.py:0:0: E305 DOCUMENTATION.description.1: expected str @ data['description'][1]. Got {'Manages OOB controller': 'Reboot, log management'}
lib/ansible/modules/remote_management/redfish/redfish_command.py:0:0: E305 DOCUMENTATION.description.2: expected str @ data['description'][2]. Got {'Manages OOB controller users': 'add, remove, update user properties and status'}
lib/ansible/modules/remote_management/redfish/redfish_command.py:0:0: E305 DOCUMENTATION.description.3: expected str @ data['description'][3]. Got {'Manages system power': 'Power on/off, graceful and forced reboot'}

click here for bot help

[jose-delarosa]

Wow that was ugly, learned not to add colons where they don't belong in the DOCUMENTATION section.

@samdoran please let me know if there is anything else. When a URI is sent there is some upfront checking (Is URI valid? Does Redfish API exist?). If one of the HTTP methods fails, that is also captured and sent back.

However, if for example I send a command to create a user, and everything succeeds ( result['ret'] = True) there is no way to verify if the user was actually created, not unless I send a separate ListUsers command to verify. It is assumed that if all checks pass, the action (command or config) was executed successfully.

[samdoran]

I would recommend the module reports changed every time as long as there is not a failure since you're not able to verify based on the data back from the API if a change was actually made.

[jose-delarosa]

Thanks for your review @samdoran