New modules and updated HTTP API plugin for FTD devices #44578

annikulin · 2018-08-23T16:07:46Z

SUMMARY

Adds ftd_configuration module that manages configuration on FTD devices;
Adds ftd_file_upload module that provides functionality to upload files to FTD devices;
Adds ftd_file_download module that provides functionality to download files from FTD devices;

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

httpapi
ftd_configuration
ftd_file_upload
ftd_file_download

ANSIBLE VERSION

2.7

ansibot · 2018-08-23T16:08:34Z

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

ansibot · 2018-08-23T16:08:35Z

@annikulin 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 · 2018-08-23T16:50:08Z

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

lib/ansible/modules/network/ftd/ftd_configuration.py:0:0: missing documentation (or could not parse documentation): 'description'

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

lib/ansible/modules/network/ftd/ftd_configuration.py:0:0: missing documentation (or could not parse documentation): 'description'

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

lib/ansible/modules/network/ftd/ftd_configuration.py:0:0: missing documentation (or could not parse documentation): 'description'

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

lib/ansible/modules/network/ftd/ftd_configuration.py:0:0: missing documentation (or could not parse documentation): 'description'

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

lib/ansible/modules/network/ftd/ftd_configuration.py:0:0: missing documentation (or could not parse documentation): 'description'

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

lib/ansible/modules/network/ftd/ftd_configuration.py:0:0: missing: __metaclass__ = type
lib/ansible/modules/network/ftd/ftd_configuration.py:0:0: missing: from __future__ import (absolute_import, division, print_function)
lib/ansible/modules/network/ftd/ftd_file_download.py:0:0: missing: __metaclass__ = type
lib/ansible/modules/network/ftd/ftd_file_download.py:0:0: missing: from __future__ import (absolute_import, division, print_function)
lib/ansible/modules/network/ftd/ftd_file_upload.py:0:0: missing: __metaclass__ = type
lib/ansible/modules/network/ftd/ftd_file_upload.py:0:0: missing: from __future__ import (absolute_import, division, print_function)

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

lib/ansible/module_utils/network/ftd/configuration.py:5:0: ImportError: No module named plugins.httpapi.ftd

The test ansible-test sanity --test import --python 2.7 [explain] failed with 2 errors:

lib/ansible/module_utils/network/ftd/configuration.py:5:0: ImportError: No module named plugins.httpapi.ftd
lib/ansible/modules/network/ftd/ftd_configuration.py:72:0: ImportError: No module named plugins.httpapi.ftd

The test ansible-test sanity --test import --python 3.5 [explain] failed with 2 errors:

lib/ansible/module_utils/network/ftd/configuration.py:5:0: ImportError: No module named 'ansible.plugins'
lib/ansible/modules/network/ftd/ftd_configuration.py:72:0: ImportError: No module named 'ansible.plugins'

The test ansible-test sanity --test import --python 3.6 [explain] failed with 2 errors:

lib/ansible/module_utils/network/ftd/configuration.py:5:0: ModuleNotFoundError: No module named 'ansible.plugins'
lib/ansible/modules/network/ftd/ftd_configuration.py:72:0: ModuleNotFoundError: No module named 'ansible.plugins'

The test ansible-test sanity --test import --python 3.7 [explain] failed with 2 errors:

lib/ansible/module_utils/network/ftd/configuration.py:5:0: ModuleNotFoundError: No module named 'ansible.plugins'
lib/ansible/modules/network/ftd/ftd_configuration.py:72:0: ModuleNotFoundError: No module named 'ansible.plugins'

The test ansible-test sanity --test no-underscore-variable [explain] failed with 3 errors:

lib/ansible/plugins/httpapi/ftd.py:71:9: use `dummy` instead of `_` for a variable name
lib/ansible/plugins/httpapi/ftd.py:133:13: use `dummy` instead of `_` for a variable name
test/units/plugins/httpapi/test_ftd.py:163:9: use `dummy` instead of `_` for a variable name

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

lib/ansible/modules/network/ftd/ftd_configuration.py:21:62: W291 trailing whitespace
lib/ansible/modules/network/ftd/ftd_file_download.py:16:96: W291 trailing whitespace
lib/ansible/modules/network/ftd/ftd_file_download.py:23:46: W291 trailing whitespace
lib/ansible/modules/network/ftd/ftd_file_download.py:32:125: W291 trailing whitespace
lib/ansible/modules/network/ftd/ftd_file_upload.py:22:46: W291 trailing whitespace
test/units/module_utils/network/ftd/test_configuration.py:43:20: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_configuration.py:46:16: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_parser.py:53:22: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:436:20: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:437:16: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:448:20: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:449:16: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:528:20: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:529:16: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:860:20: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:861:16: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:873:20: E126 continuation line over-indented for hanging indent
test/units/module_utils/network/ftd/test_fdm_swagger_validator.py:874:16: E126 continuation line over-indented for hanging indent

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

lib/ansible/modules/network/ftd/ftd_configuration.py:0:0: E305 DOCUMENTATION.description: required key not provided @ data['description']. Got None

click here for bot help

gdpak · 2018-08-24T08:09:46Z

lib/ansible/plugins/httpapi/ftd.py

-        return False
+            self.login(self.connection.get_option('remote_user'), self.connection.get_option('password'))
+            retry_request = True
+        return retry_request


This can be converted to return True. No need of new variable retry_request

Thanks, done.

gdpak · 2018-08-24T08:10:57Z

lib/ansible/plugins/httpapi/ftd.py

-        # plugin
-        self.refresh_token = False
-        self.access_token = False
-        display.vvvv("logged out successfully")


not sure why logout is removed ? Don't we want to revoke token once connection is terminated ?

logout method still there. It was just moved closer to the login method.

gdpak · 2018-08-24T08:13:34Z

lib/ansible/plugins/httpapi/ftd.py

-        display.vvvv("logged out successfully")
+    @staticmethod
+    def _get_api_token_path():
+        return os.environ.get(API_TOKEN_PATH_ENV_VAR, DEFAULT_API_TOKEN_PATH)


Please change these vars to ansible Host vars rather OS env vars.

Good point. Can you please help how to get Ansible host variable?

@annikulin it needed more work than I initially thought to get httpapi plugin host var working. Probably we can commit this code as is and I will commit a followup PR to make it configurable using ansible host vars

gdpak · 2018-08-24T08:22:39Z

lib/ansible/module_utils/network/ftd/common.py

+    return True
+
+
+def equal_objects(d1, d2):


I think this might now work when there is dict of dict in response? It might break idempotency in those cases.
I think you need to call it recursively when there is dict of dict or dict of list of dict.

Thanks, updated.

sdbrain · 2018-08-27T13:13:56Z

lib/ansible/module_utils/network/ftd/common.py

@@ -0,0 +1,159 @@
+import re


Please add copyright in all the files.

Thanks, added.

ansibot · 2018-08-29T12:13:44Z

@annikulin this PR contains the following merge commits:

f155771

Please rebase your branch to remove these commits.

click here for bot help

Anton Nikulin added 6 commits August 23, 2018 16:22

Add common and Swagger client utils for FTD modules

cbbc190

Update FTD HTTP API plugin and add unit tests for it

3d90ae8

Add configuration layer handling object idempotency

517028b

Add ftd_configuration module with unit tests

4a3293a

Add ftd_file_download and ftd_file_upload modules with unit tests

0fd4ae5

Validate operation data and parameters

a651cfa

ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Aug 23, 2018

gdpak suggested changes Aug 24, 2018

View reviewed changes

ansibot removed the needs_triage Needs a first human triage before being processed. label Aug 24, 2018

gdpak reviewed Aug 24, 2018

View reviewed changes

Anton Nikulin added 3 commits August 27, 2018 13:09

Fix ansible-doc, boilerplate and import errors

fd685f7

Fix pip8 sanity errors

cc8f0dc

Update object comparison to work recursively

b5dc0fc

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Aug 27, 2018

sdbrain reviewed Aug 27, 2018

View reviewed changes

gdpak approved these changes Aug 28, 2018

View reviewed changes

ansibot added merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Aug 29, 2018

Add copyright

c775ec1

ansibot removed merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Aug 29, 2018

sdbrain approved these changes Aug 29, 2018

View reviewed changes

rcarrillocruz merged commit 40a97d4 into ansible:devel Aug 29, 2018

annikulin mentioned this pull request Aug 30, 2018

Sync changes from Ansible repo CiscoDevNet/FTDAnsible#19

Merged

dagwieers added the cisco Cisco technologies label Mar 4, 2019

dagwieers added the ftd Cisco FTD community label Mar 19, 2019

ansible locked and limited conversation to collaborators Jul 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New modules and updated HTTP API plugin for FTD devices #44578

New modules and updated HTTP API plugin for FTD devices #44578

annikulin commented Aug 23, 2018

ansibot commented Aug 23, 2018

ansibot commented Aug 23, 2018

ansibot commented Aug 23, 2018

gdpak Aug 24, 2018

annikulin Aug 27, 2018

gdpak Aug 24, 2018

annikulin Aug 27, 2018

gdpak Aug 24, 2018

annikulin Aug 27, 2018

gdpak Aug 28, 2018

gdpak Aug 24, 2018

annikulin Aug 27, 2018

sdbrain Aug 27, 2018

annikulin Aug 29, 2018

ansibot commented Aug 29, 2018

New modules and updated HTTP API plugin for FTD devices #44578

New modules and updated HTTP API plugin for FTD devices #44578

Conversation

annikulin commented Aug 23, 2018

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ansibot commented Aug 23, 2018

ansibot commented Aug 23, 2018

ansibot commented Aug 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ansibot commented Aug 29, 2018