Refactor API and zone update handling #30
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR progress checklist (to be filled in by reviewers)
What type of PR is this?
Primary type
[build]
Changes related to the build system[chore]
Changes to the build process or auxiliary tools and libraries such as documentation generation[ci]
Changes to the continuous integration configuration[feat]
A new feature[fix]
A bug fix[perf]
A code change that improves performance[refactor]
A code change that neither fixes a bug nor adds a feature[revert]
A change used to revert a previous commit[style]
Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)Secondary type
[docs]
Documentation changes[test]
Adding missing or correcting existing testsDoes this PR introduce a
BREAKING CHANGE
?Yes.
Related issues and/or pull requests
Describe the changes you're proposing
Pillar / config required to test the proposed changes
Pillar abstraction is not yet implemented. Hence a sample state file instead:
Debug log showing how the proposed changes work
Exceeds GitHub maximum body size.
Documentation checklist
README
(e.g.Available states
).pillar.example
.Testing checklist
state_top
).Additional context
This is a work in progress effort. I am sharing it already to gather potential early feedback and to learn whether such a big change is of interest to this project at all. The code still needs lots of cleanup, and it is of course lacking documentation and tests (for effective testing, the test suite will need to spin up a PowerDNS, which I am not yet sure how to integrate into the
kitchen
suite in this repository).Most of the logic is around getting a usable diff for the changes to make for an experience as with other Salt states. Unfortunately, the PowerDNS API itself does not yet natively support operating in a dry-run mode with diff output.
The existing functions are for the most part refactored. Having a single
zone_present()
state function instead of separate rrset logic allows following of the upstream PowerDNS API data structure, making the state both easier to use for users (the same documentation as the upstream API can be followed) and easier to adapt in case of future changes to the upstream API.