PR to introduce cp_network and cp_publish as modules #57621

chkp-orso · 2019-06-10T13:17:36Z

SUMMARY

PR to introduce cp_network and cp_publish, checkpoint modules

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

checkpoint

ADDITIONAL INFORMATION

network and install policy modules for example

revert the changes in version

documentation_fragment

ansibot · 2019-06-10T13:28:11Z

cc @NilashishC @Qalthos @ganeshrn @gdpak @justjais @rcarrillocruz @trishnaguha
click here for bot help

ansibot · 2019-06-10T13:28:12Z

@chkp-orso this PR contains more than one new module.

Please submit only one new module per pull request. For a detailed explanation, please read the grouped modules documentation

click here for bot help

ansibot · 2019-06-10T13:28:13Z

@chkp-orso, 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

justjais · 2019-06-10T14:17:38Z

lib/ansible/modules/network/checkpoint/cp_network.py

+
+- name: delete-network
+  cp_network:
+    name : New Network 2


@chkp-orso please include state params, in the example. I need to verify with state: present the module will call add-network, but how can user call set-network.

state : absent

@justjais ohh yeah u r right, I will add it.
and as for recognition of add-network or set-network that's all the logic we implemented in the modules_utils (checkpoint)

ansibot · 2019-06-10T14:48:52Z

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

Command "/usr/bin/python3.6 test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
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...
Makefile:93: recipe for target 'modules' failed
--> Standard Error
Traceback (most recent call last):
  File "../bin/plugin_formatter.py", line 813, in <module>
    main()
  File "../bin/plugin_formatter.py", line 768, in main
    plugin_info, categories = get_plugin_info(options.module_dir, limit_to=options.limit_to, verbose=(options.verbosity > 0))
  File "../bin/plugin_formatter.py", line 298, in get_plugin_info
    doc, examples, returndocs, metadata = plugin_docs.get_docstring(module_path, fragment_loader, verbose=verbose)
  File "/root/ansible/lib/ansible/utils/plugin_docs.py", line 111, in get_docstring
    data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors)
  File "/root/ansible/lib/ansible/parsing/plugin_docs.py", line 59, in read_docstring
    data[varkey] = AnsibleLoader(child.value.s, file_name=filename).get_single_data()
  File "/usr/local/lib/python3.6/dist-packages/yaml/constructor.py", line 41, in get_single_data
    node = self.get_single_node()
  File "ext/_yaml.pyx", line 707, in _yaml.CParser.get_single_node
  File "ext/_yaml.pyx", line 725, in _yaml.CParser._compose_document
  File "ext/_yaml.pyx", line 776, in _yaml.CParser._compose_node
  File "ext/_yaml.pyx", line 890, in _yaml.CParser._compose_mapping_node
  File "ext/_yaml.pyx", line 776, in _yaml.CParser._compose_node
  File "ext/_yaml.pyx", line 890, in _yaml.CParser._compose_mapping_node
  File "ext/_yaml.pyx", line 776, in _yaml.CParser._compose_node
  File "ext/_yaml.pyx", line 890, in _yaml.CParser._compose_mapping_node
  File "ext/_yaml.pyx", line 774, in _yaml.CParser._compose_node
  File "ext/_yaml.pyx", line 853, in _yaml.CParser._compose_sequence_node
  File "ext/_yaml.pyx", line 905, in _yaml.CParser._parse_next_event
yaml.scanner.ScannerError: while scanning a simple key
  in "<unicode string>", line 30, column 1
could not find expected ':'
  in "<unicode string>", line 31, column 9
make: *** [modules] Error 1

The test ansible-test sanity --test pep8 [explain] failed with 4 errors:

lib/ansible/modules/network/checkpoint/cp_network.py:112:120: W291 trailing whitespace
lib/ansible/modules/network/checkpoint/cp_network.py:179:1: E128 continuation line under-indented for visual indent
lib/ansible/modules/network/checkpoint/cp_network.py:180:1: E128 continuation line under-indented for visual indent
lib/ansible/modules/network/checkpoint/cp_network.py:181:1: E128 continuation line under-indented for visual indent

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E324 Argument 'wait_for_task' in argument_spec defines default as (True) but documentation defines default as (False)
lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E326 Argument 'broadcast' in argument_spec defines choices as (['disallow', 'allow']) but documentation defines choices as ([])
lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E326 Argument 'color' in argument_spec defines choices as (['aquamarine', 'black', 'blue', 'crete blue', 'burlywood', 'cyan', 'dark green', 'khaki', 'orchid', 'dark orange', 'dark sea green', 'pink', 'turquoise', 'dark blue', 'firebrick', 'brown', 'forest green', 'gold', 'dark gold', 'gray', 'dark gray', 'light green', 'lemon chiffon', 'coral', 'sea green', 'sky blue', 'magenta', 'purple', 'slate blue', 'violet red', 'navy blue', 'olive', 'orange', 'red', 'sienna', 'yellow']) but documentation defines choices as ([])
lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E326 Argument 'details_level' in argument_spec defines choices as (['uid', 'standard', 'full']) but documentation defines choices as ([])
lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E326 Argument 'state' in argument_spec defines choices as (['present', 'absent']) but documentation defines choices as ([])
lib/ansible/modules/network/checkpoint/cp_network.py:58:9: E302 DOCUMENTATION is not valid YAML

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

lib/ansible/modules/network/checkpoint/cp_network.py:58:9: error DOCUMENTATION: syntax error: could not find expected ':'

click here for bot help

ansibot · 2019-06-10T16:17:32Z

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: has a documentation error formatting or is missing documentation.

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

Command "/usr/bin/python3.6 test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
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...
Makefile:93: recipe for target 'modules' failed
--> Standard Error
Traceback (most recent call last):
  File "../bin/plugin_formatter.py", line 813, in <module>
    main()
  File "../bin/plugin_formatter.py", line 768, in main
    plugin_info, categories = get_plugin_info(options.module_dir, limit_to=options.limit_to, verbose=(options.verbosity > 0))
  File "../bin/plugin_formatter.py", line 298, in get_plugin_info
    doc, examples, returndocs, metadata = plugin_docs.get_docstring(module_path, fragment_loader, verbose=verbose)
  File "/root/ansible/lib/ansible/utils/plugin_docs.py", line 111, in get_docstring
    data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors)
  File "/root/ansible/lib/ansible/parsing/plugin_docs.py", line 59, in read_docstring
    data[varkey] = AnsibleLoader(child.value.s, file_name=filename).get_single_data()
  File "/usr/local/lib/python3.6/dist-packages/yaml/constructor.py", line 41, in get_single_data
    node = self.get_single_node()
  File "ext/_yaml.pyx", line 707, in _yaml.CParser.get_single_node
  File "ext/_yaml.pyx", line 725, in _yaml.CParser._compose_document
  File "ext/_yaml.pyx", line 776, in _yaml.CParser._compose_node
  File "ext/_yaml.pyx", line 892, in _yaml.CParser._compose_mapping_node
  File "ext/_yaml.pyx", line 905, in _yaml.CParser._parse_next_event
yaml.parser.ParserError: while parsing a block mapping
  in "<unicode string>", line 3, column 1
did not find expected key
  in "<unicode string>", line 87, column 1
make: *** [modules] Error 1

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

lib/ansible/modules/network/checkpoint/cp_network.py:113:120: W291 trailing whitespace

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

lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E324 Argument 'wait_for_task' in argument_spec defines default as (True) but documentation defines default as (False)
lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E326 Argument 'broadcast' in argument_spec defines choices as (['disallow', 'allow']) but documentation defines choices as ([])
lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E326 Argument 'color' in argument_spec defines choices as (['aquamarine', 'black', 'blue', 'crete blue', 'burlywood', 'cyan', 'dark green', 'khaki', 'orchid', 'dark orange', 'dark sea green', 'pink', 'turquoise', 'dark blue', 'firebrick', 'brown', 'forest green', 'gold', 'dark gold', 'gray', 'dark gray', 'light green', 'lemon chiffon', 'coral', 'sea green', 'sky blue', 'magenta', 'purple', 'slate blue', 'violet red', 'navy blue', 'olive', 'orange', 'red', 'sienna', 'yellow']) but documentation defines choices as ([])
lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E326 Argument 'details_level' in argument_spec defines choices as (['uid', 'standard', 'full']) but documentation defines choices as ([])
lib/ansible/modules/network/checkpoint/cp_network.py:0:0: E326 Argument 'state' in argument_spec defines choices as (['present', 'absent']) but documentation defines choices as ([])
lib/ansible/modules/network/checkpoint/cp_network.py:114:1: E302 DOCUMENTATION is not valid YAML

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

lib/ansible/modules/network/checkpoint/cp_network.py:114:1: error DOCUMENTATION: syntax error: expected <block end>, but found '-'

click here for bot help

* network and install policy modules for example network and install policy modules for example * revert the changes in version revert the changes in version * documentation_fragment documentation_fragment * Checking the status code of the set request * delete some of Rikis' files * retrieve Rikis' files and call equals API method * adding blanck line between functions * implement host, address-range and group * mostly sintax fixes * try again with the old host and access rule * small changes * adding service udp and publish * publish command * little fix * choises for state parameter * support wait_for_task and API version * imports * refactor of function's name * network module * rename modules and return value from modules * PR before examples to: tests, lookup, check_mode * small fixes * fixes for code review * small fixes * state parameter in examples and many /n * white spaces * 4 tries for how choices should be, and turn true to True

chkp-orso added 23 commits April 17, 2019 17:43

network and install policy modules for example

9303852

network and install policy modules for example

revert the changes in version

f96de40

revert the changes in version

documentation_fragment

344976f

documentation_fragment

Checking the status code of the set request

bb89195

delete some of Rikis' files

55ac99e

retrieve Rikis' files and call equals API method

4a0a564

adding blanck line between functions

3a0ca5e

implement host, address-range and group

13064e7

mostly sintax fixes

332b584

try again with the old host and access rule

eb344ab

small changes

7049e04

adding service udp and publish

76a45e5

publish command

173cfe7

little fix

396fc71

choises for state parameter

3c3b0d9

support wait_for_task and API version

35d81fb

imports

c44f1e3

refactor of function's name

b8eae1e

network module

6c8f91a

rename modules and return value from modules

a05ef41

PR before examples to: tests, lookup, check_mode

f0bb71c

small fixes

1d7d687

fixes for code review

67c0279

ansibot added affects_2.9 This issue/PR affects Ansible v2.9 bug This issue/PR relates to a bug. module This issue/PR relates to a module. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jun 10, 2019

justjais changed the title ~~cp_network and cp_publish as examples modules~~ PR to introduce cp_network and cp_publish as modules Jun 10, 2019

small fixes

28c3261

justjais suggested changes Jun 10, 2019

View reviewed changes

ansibot removed the needs_triage Needs a first human triage before being processed. label Jun 10, 2019

state parameter in examples and many /n

38a88fb

chkp-orso added 2 commits June 11, 2019 07:42

white spaces

97f5261

4 tries for how choices should be, and turn true to True

cd21711

justjais approved these changes Jun 11, 2019

View reviewed changes

justjais merged commit bab1a3c into ansible:devel Jun 11, 2019

ansible locked and limited conversation to collaborators Aug 5, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR to introduce cp_network and cp_publish as modules #57621

PR to introduce cp_network and cp_publish as modules #57621

chkp-orso commented Jun 10, 2019 •

edited by justjais

ansibot commented Jun 10, 2019

ansibot commented Jun 10, 2019

ansibot commented Jun 10, 2019

justjais Jun 10, 2019

chkp-orso Jun 10, 2019

ansibot commented Jun 10, 2019

ansibot commented Jun 10, 2019

PR to introduce cp_network and cp_publish as modules #57621

PR to introduce cp_network and cp_publish as modules #57621

Conversation

chkp-orso commented Jun 10, 2019 • edited by justjais

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibot commented Jun 10, 2019

ansibot commented Jun 10, 2019

ansibot commented Jun 10, 2019

justjais Jun 10, 2019

Choose a reason for hiding this comment

chkp-orso Jun 10, 2019

Choose a reason for hiding this comment

ansibot commented Jun 10, 2019

ansibot commented Jun 10, 2019

chkp-orso commented Jun 10, 2019 •

edited by justjais