Pluribus Networks admin syslog modules with unit tests

[rajaspachipulusu17]

SUMMARY

Point feature of admin syslog for Pluribus Networks Netvisor switches

ISSUE TYPE

• New Module Pull Request

COMPONENT NAME

pn_admin_syslog.py module with unit tests.

ADDITIONAL INFORMATION

ansible 2.4.0.0
config file = None
configured module search path = [u'/root/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
ansible python module location = /usr/local/lib/python2.7/dist-packages/ansible
executable location = /usr/local/bin/ansible
python version = 2.7.12 (default, Dec 4 2017, 14:50:18) [GCC 5.4.0 20160609]

[ansibot]

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

lib/ansible/modules/network/netvisor/pn_admin_syslog.py:0:0: missing documentation (or could not parse documentation): sequence item 0: expected string, AnsibleMapping found

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

lib/ansible/modules/network/netvisor/pn_admin_syslog.py:0:0: missing documentation (or could not parse documentation): sequence item 0: expected str instance, AnsibleMapping found

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

lib/ansible/modules/network/netvisor/pn_admin_syslog.py:0:0: missing documentation (or could not parse documentation): sequence item 0: expected string, AnsibleMapping found

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

lib/ansible/modules/network/netvisor/pn_admin_syslog.py:0:0: missing documentation (or could not parse documentation): sequence item 0: expected str instance, AnsibleMapping found

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

lib/ansible/modules/network/netvisor/pn_admin_syslog.py:0:0: missing documentation (or could not parse documentation): sequence item 0: 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
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
cat _themes/srtd/static/css/theme.css | sed -e 's/^[ 	]*//g; s/[ 	]*$//g; s/\([:{;,]\) /\1/g; s/ {/{/g; s/\/\*.*\*\///g; /^$/d' | sed -e :a -e '$!N; s/\n\(.\)/\1/; ta' > _themes/srtd/static/css/theme.min.css
PYTHONPATH=../../lib ../bin/dump_config.py --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/ -d ../../lib/ansible/config/base.yml
mkdir -p rst/cli
PYTHONPATH=../../lib ../bin/generate_man.py --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst ../../lib/ansible/cli/*.py
PYTHONPATH=../../lib ../bin/dump_keywords.py --template-dir=../templates --output-dir=rst/reference_appendices/ -d ./keyword_desc.yml
PYTHONPATH=../../lib ../bin/plugin_formatter.py -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/modules/ 
Evaluating module files...
rendering: pn_dhcp_filter (789 previous rendering line(s) omitted)
Makefile:93: recipe for target 'modules' failed
--> Standard Error
Traceback (most recent call last):
  File "../bin/plugin_formatter.py", line 107, in rst_ify
    t = _ITALIC.sub(r"*\1*", text)
TypeError: expected string or bytes-like object

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "../bin/plugin_formatter.py", line 754, in <module>
    main()
  File "../bin/plugin_formatter.py", line 741, in main
    process_plugins(plugin_info, templates, outputname, output_dir, options.ansible_version, plugin_type)
  File "../bin/plugin_formatter.py", line 552, in process_plugins
    text = templates['plugin'].render(doc)
  File "/usr/local/lib/python3.6/dist-packages/jinja2/asyncsupport.py", line 76, in render
    return original_render(self, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/jinja2/environment.py", line 1008, in render
    return self.environment.handle_exception(exc_info, True)
  File "/usr/local/lib/python3.6/dist-packages/jinja2/environment.py", line 780, in handle_exception
    reraise(exc_type, exc_value, tb)
  File "/usr/local/lib/python3.6/dist-packages/jinja2/_compat.py", line 37, in reraise
    raise value.with_traceback(tb)
  File "../templates/plugin.rst.j2", line 57, in top-level template code
    - @{ desc | rst_ify }@
  File "../bin/plugin_formatter.py", line 115, in rst_ify
    raise AnsibleError("Could not process (%s) : %s" % (text, e))
ansible.errors.AnsibleError: Could not process ({'C(present)': 'create the scope and other parameters of syslog event collection.'}) : expected string or bytes-like object
make: *** [modules] Error 1

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

lib/ansible/modules/network/netvisor/pn_admin_syslog.py:0:0: E305 DOCUMENTATION.description.0: expected str @ data['description'][0]. Got {'C(present)': 'create the scope and other parameters of syslog event collection.'}
lib/ansible/modules/network/netvisor/pn_admin_syslog.py:0:0: E305 DOCUMENTATION.description.1: expected str @ data['description'][1]. Got {'C(update)': 'modify parameters of syslog event collection.'}
lib/ansible/modules/network/netvisor/pn_admin_syslog.py:0:0: E305 DOCUMENTATION.description.2: expected str @ data['description'][2]. Got {'C(absent)': 'delete the scope and other parameters of syslog event collection.'}

click here for bot help

[ansibot]

cc @NilashishC @Qalthos @amitsi @csharpe-pn @ganeshrn @gdpak @justjais @pdam @preetiparasar @rcarrillocruz @trishnaguha
click here for bot help

[ansibot]

@rajaspachipulusu17, just so you are aware we have a dedicated Working Group for network.
You can find other people interested in this in #ansible-network on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

[rajaspachipulusu17]

Any comments?

Thanks,
Rajas

[rajaspachipulusu17]

@Akasurde can you merge this?

[rajaspachipulusu17]

@Akasurde @ganeshrn can someone approve this?

Thanks,
Rajas