-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Add remediation support for drush yaml checks #43
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
actually tested that the datamap is as expected
to be reused in DrushYamlCheck tests
run Remediate for all breaches from shipshape.ProcessCheck instead of inside each check implementation
that allows us to have more flexibility with breaches down the line, like adding check-specific breaches with custom fields & logic, etc..
steveworley
approved these changes
Feb 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Another big PR, which introduces a number of changes:
Breach is now an interface, with a generator for the common functions.
Breach
types perCheck
and so on.Added a
Remediation
struct and included it in theResult
struct.Updated the
Remediate()
signature in the Check interface to be more generic and without a return value.Remediation
inside each one.Updated the logic in
ProcessCheck
to callRemediate()
for each Check afterRunCheck()
has been called.DetermineResultStatus()
toResult
so we can have better logic outside ofRunCheck()
which determines the result based on the Breaches detected and Remediations performed.Result.Status
is not being manually set in different places now.Finally, added two new attributes to the
drush-yaml
check,remediate-command
&remediate-msg
, along with the correspondingRemediate()
logic. This allows us to define a check like below:Shipshape will use the command specified to fix the issue and on success output the message specified: