New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: Add Support for XML Compliance #708

Merged

itdependsnetworks merged 31 commits into nautobot:develop from jmpettit:feature/xml-configtype

May 30, 2024

Contributor

jmpettit commented Jan 30, 2024

No description provided.

jmpettit requested review from itdependsnetworks, jeffkala and nkallergis as code owners

January 30, 2024 21:04

itdependsnetworks reviewed

View reviewed changes

development/development.env Outdated Show resolved Hide resolved

itdependsnetworks reviewed

View reviewed changes

nautobot_golden_config/models.py Outdated Show resolved Hide resolved

itdependsnetworks reviewed

View reviewed changes

nautobot_golden_config/nornir_plays/config_compliance.py Show resolved Hide resolved

itdependsnetworks reviewed

View reviewed changes

nautobot_golden_config/nornir_plays/config_compliance.py Show resolved Hide resolved

itdependsnetworks reviewed

View reviewed changes

nautobot_golden_config/utilities/helper.py Outdated Show resolved Hide resolved

Contributor

itdependsnetworks commented Jan 30, 2024

great stuff!!

Can you build the docs (with screenshots) similar to https://github.com/nautobot/nautobot-app-golden-config/blob/develop/docs/user/app_feature_compliancejson.md ?

Contributor Author

jmpettit commented Feb 1, 2024

great stuff!!

Can you build the docs (with screenshots) similar to https://github.com/nautobot/nautobot-app-golden-config/blob/develop/docs/user/app_feature_compliancejson.md ?

thanks!! docs added

itdependsnetworks reviewed

View reviewed changes

docs/user/app_feature_compliancexml.md Show resolved Hide resolved

itdependsnetworks reviewed

View reviewed changes

docs/user/app_feature_compliancexml.md Show resolved Hide resolved

Contributor

itdependsnetworks commented Feb 9, 2024

@jmpettit I think it's all good, just need to get tests passing

Contributor Author

jmpettit commented Feb 14, 2024

@itdependsnetworks tests passing!

Contributor

itdependsnetworks commented Feb 24, 2024

will merge after release patch version with some fixes.

Contributor Author

jmpettit commented Apr 8, 2024

@itdependsnetworks I've got this rebased with develop

Contributor Author

jmpettit commented Apr 9, 2024

@itdependsnetworks all of my previous responses were still pending, should be visible now.

jeffkala reviewed

View reviewed changes

docs/user/app_feature_compliancexml.md Outdated Show resolved Hide resolved

docs/user/app_feature_compliancexml.md Show resolved Hide resolved

docs/user/app_feature_compliancexml.md Outdated Show resolved Hide resolved

nautobot_golden_config/nornir_plays/config_compliance.py Outdated Show resolved Hide resolved

jeffkala approved these changes

View reviewed changes

Contributor

jeffkala left a comment

Looks good on my end, think @itdependsnetworks had a few comments that are still unresolved and its hard for me to understand if they're remaining or not

Contributor

itdependsnetworks commented May 6, 2024

etree is beings used on the backup configurations and not on the xpath the user puts in. To the point that @jmpettit has made, the same can be said for jobs, which are arguably much more problematic. I am ok with the etree in this capacity.

jmpettit added 10 commits

May 24, 2024 10:16


          Add support for XML config type

39286a7


          fix: Normalized spacing during XML parsing

77aff67


          patch: Refactor XML section handling

96109cf


          patch: Refactor XML compliance function and improve diff formatting

ffb45ab


          Add get_xml_subtree_with_full_path helper function

1cd59b8


          Refactor _get_xml_compliance function in models.py

23a1188


          Add unit tests for XML functionality

f224b73


          Docstring update for get_xml_subtree_with_full_path

1f128d6


          Apply linting fixes

e18cbdb


          Update help text for config_type field

4116d72

Justin Pettit and others added 21 commits

May 24, 2024 10:17


          revert ENABLE_BACKUP setting

664dd6b


          Add docstrings to _normalize_diff function and diff_options dictionary

e26fc4c


          Add user documentation for XML compliance feature

222c8af


          Add documentation for basic XPath syntax and how to interpret diff ou…

7fc53bf

…tput


          Fix conditional logic in config_compliance.py

da59888


          Update poetry.lock

794c6e9


          Trigger CI

84c5c16


          Revert poetry.lock

6c5071a


          poetry lock --no-update

d340b8a


          Add changelog fragment

aca3579


          Update docs/user/app_feature_compliancexml.md

e018121

Co-authored-by: Jeff Kala <[email protected]>


          Update docs/user/app_feature_compliancexml.md

7160a0f

Co-authored-by: Jeff Kala <[email protected]>


          Update docs/user/app_feature_compliancexml.md

eef9919

Co-authored-by: Jeff Kala <[email protected]>


          Add handling for XPath errors

c42dde8


          Fix (raise-missing-from) in config_compliance.py

65098be


          Update docstring for get_xml_subtree_with_full_path function

5e54b6c


          Update get_xml_subtree_with_full_path docstring

96943df


          Add json and xml syntax highlighting

1ccde61


          fix: Intended rendering

d33c751


          fix: intended rendering

69947f5


          remove sql commands

841cbc6

itdependsnetworks merged commit 49b0710 into nautobot:develop

16 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

itdependsnetworks itdependsnetworks left review comments

abates abates left review comments

jeffkala jeffkala approved these changes

nkallergis Awaiting requested review from nkallergis nkallergis is a code owner

Labels

None yet