Handling of configurations blocks with end-* at the end of the block

[gdpak]

SUMMARY

Fixes #39351

Few commands like route-policy and prefix-set have end-policy/end-set at the end of the block
e.g.
prefix-set ebpg_filter
192.168.0.0/16 ge 17 le 30
end-set

here current parser logic sets parent for line '192.168.0.0/16 ge 17 le 30' as 'prefix-set ebpg_filter'. It
also marks 'end-set' as new parent with no children.

Now say when we have a diff between candidate and running-config. we try to just play above config block without 'end-set' . This will cause all configs to fail below this line as command prompts will not accept any command until we come-out of this prefix-set context.

Solutions approach:

1. while parsing config set a new field 'trailing_parent' in config for such config blocks when we find new parent with "end-*'
2. Included end-* in diff so that it does not get excluded while comparing with running_config

1 approach is clean but much more intrusive in common code of parsing. Right now I have implemented and tested approach 2) we can discuss if there is alternative better approach

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

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

ANSIBLE VERSION

2.6

[ansibot]

@gdpak this PR contains the following merge commits:

• f15b83f

Please rebase your branch to remove these commits.

click here for bot help

[ansibot]

cc @Qalthos @ganeshrn @gundalow @privateip @rcarrillocruz @trishnaguha
click here for bot help

[gundalow]

Worth adding unit tests for this?

[ganeshrn]

It seems this configuration is specific for a particular platform. Is it possible to sanitize the config indentation in the module code?

[gdpak]

right now there is no platform specific instance of NetworkConfig. It can be done to inherit this class at iosxr code and overwrite function 'difference' and 'diff_exact' to handle these special commands. will that work ?

[gdpak]

pros of above approach: no extra check penalty for other OS, no regression on other
con: code duplication and fixes in common code would need to be ported

[gdpak]

@gundalow added test cases @ganeshrn moved functionality to os specific fix. Please have a look

[gdpak]

Integration tests:

ansible-test network-integration --inventory /tmp/inventory_deepak iosxr_config --testcase misplaced_sublevel -vvvv

TASK [iosxr_config : debug] **********************************************************************************************************************
task path: /macos/ansible/test/integration/targets/iosxr_config/tests/cli/misplaced_sublevel.yaml:27
ok: [iosxr02] => {
"msg": "END cli/misplaced_sublevel.yaml on connection=local"
}
META: ran handlers
META: ran handlers

PLAY RECAP ***************************************************************************************************************************************
iosxr02 : ok=21 changed=6 unreachable=0 failed=0

[ansibot]

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

lib/ansible/modules/network/iosxr/iosxr_config.py:192:1: E302 expected 2 blank lines, found 1
lib/ansible/modules/network/iosxr/iosxr_config.py:232:1: E302 expected 2 blank lines, found 1
lib/ansible/modules/network/iosxr/iosxr_config.py:233:17: E225 missing whitespace around operator
lib/ansible/modules/network/iosxr/iosxr_config.py:242:1: E302 expected 2 blank lines, found 1
lib/ansible/modules/network/iosxr/iosxr_config.py:243:17: E225 missing whitespace around operator
lib/ansible/modules/network/iosxr/iosxr_config.py:250:41: E226 missing whitespace around arithmetic operator
lib/ansible/modules/network/iosxr/iosxr_config.py:253:1: E302 expected 2 blank lines, found 1

click here for bot help

[ganeshrn]

lgtm