feat: add looping for lint #481
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
CloudBeard
requested review from
brandtkeller,
mike-winberry and
meganwolf0
as code owners
✅ Deploy Preview for lula-docs canceled.
|
brandtkeller
requested changes
Jun 13, 2024
There was a problem hiding this comment.
Great first pass - I have a few modifications we should consider:
This will fail on the first document that fails linting and exit - optimally the workflow would lint all files and report on which are passing AND failing in some capacity. This prevents the cycle of fixing one file at a time.
This could be iterating through the loop as implemented - identifying pass/fail with some information and once all files have been evaluated then indicating overall success/failure.
Looking to prevent scope creep here - I do not believe:
validation.WriteValidationResult(validationResp.Result, opts.ResultFile)
will handle appending to a result file (currently intended for a single write operation). Meaning we need to update the go-oscal function or develop a stop-gap in the interim.
Focus on the core logic - will evaluate go-oscal
Open to feedback
brandtkeller
requested changes
Jun 14, 2024
There was a problem hiding this comment.
Agree with @brandtkeller's changes, nothing else stood out me!
3 tasks
* refactor!(common): #388 update common/types (and all references) to use pointers * refactor!(common): #388 update Domain struct to use pointers * refactor!(common): #388 update Provider struct to use pointers * refactor!(evaluate): #388 EvaluateResults now uses pointers refactor!(component): change NewOscalComponentDefinitionFromBytes to return a pointer * refactor!(resource-store): #388 changed AddFromLink params to use pointers, updated references * refactor!(assessment-results): #388 NewAssessmentResults now returns a pointer * refactor!(catalog): now runs validation rather than requiring the source for the extension refactor!(catalog): now uses pointers * refactor!(component): #388 NewOscalComponentDefinition no longer uses source in favor of oscal validation refactor!(component): delete the NewOscalComponentDefinitionFromBytes method in favor of NewOscalComponentDefinition refactor!(common): rename WriteFile -> WriteOscalModel refactor(generate): WriteFile -> WriteOscalModel refactor(composition): removed validation logic in favor of NewOscalCOmponentDefinition handling it feat(common): WriteOscalModel now handles json file extensions feat(evaluate): now runs file extension validation for json/yaml feat(validate): now checks input file for extension tests: update tests, update test data to pass oscal validation * refactor!(common): #388 moved WriteOscalModel to the oscal package (complete-schema) * feat(oscal): create the multiModelValidate method for use in oscal constructors and updated all relavant constructors * refactor!(component): #388 update mergeComponents and ComponentFromCatalog to use pointers refactor(generate): update all refs to ComponentFromCatalog * initial resource creation * refactor(component): pointer refactor * fix(component): failing e2e * refactor(component): ControlToImplementRequirement now takes pointer to control * fix(common): add omitempty to the marshalling for Validation * refactor!(domains/kubernetes): #388 KubernetesSpec.Wait and Resource.ResourceRule are now pointers and have omitempty, updated all references * refactor!(domains/kubernetes): #388 ResourceRule.Field is now a pointer and has omitempty tag * refactor!(providers/kyverno): #388 KyvernoSpec is now a pointer * refactor!(providers/opa): #388 OpaSpec is now a pointer * refactor(providers): add omitempty to Kyverno and opa spec tags * refactor!(providers): update output fields to be pointers * refactor!(domains): update api and k8s domain specs to be pointers * refactor!(types): #388 update LulaValidation provider, domain, domain-resources and result to use pointers * fix(evaluate): add nil check on thresholdResult and newResult to top of method to prevent nil pointer * chore(validate): add TODO to remove WriteReport as it is unused (question) * fix: graceful exit conditions, empty result pointer * feat: merged pointers * feat: updated error handling, initial docs and flag functions * feat: added flags to lula validate * feat: added requirement-store, updated validation * feat(validate): updated validation refactor, other small fixes * feat: added tests, dev command updates * fix(dev): updated tests, fixed dev cmd issues * fix: refactor yaml multi doc functionality * fix: get-resources read from stdin * fix: remove debug file * fix: clean-up per comments * Update src/pkg/message/interactive.go clarifying confirmation text Co-authored-by: Brandt Keller <43887158+brandtkeller@users.noreply.github.com> * docs: description of assessments and failure conditions * feat(validate): non-interactive flag added * fix(dev): get-resources missing validation opt * fix: clean-up create resources * add staticResources check before execution * fix: updated create observation fcn and usage --------- Co-authored-by: Cole (Mike) Winberry <cole@defenseunicorns.com> Co-authored-by: Cole (Mike) Winberry <86802655+mike-winberry@users.noreply.github.com> Co-authored-by: Brandt Keller <43887158+brandtkeller@users.noreply.github.com>
| datasource | package | from | to | | ---------- | ---------------------- | ------ | ------ | | go | github.com/spf13/cobra | v1.8.0 | v1.8.1 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
#472) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
| datasource | package | from | to | | ----------- | -------------------- | ------- | -------- | | github-tags | github/codeql-action | v3.25.8 | v3.25.10 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
…4.3 (#470) | datasource | package | from | to | | ---------- | ----------------------------------- | ------ | ------ | | go | github.com/defenseunicorns/go-oscal | v0.4.1 | v0.4.3 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
| datasource | package | from | to | | ----------- | ---------------- | ------ | ------ | | github-tags | actions/checkout | v4.1.6 | v4.1.7 | Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
…5.0 (#492) * chore(deps): update module github.com/defenseunicorns/go-oscal to v0.5.0 | datasource | package | from | to | | ---------- | ----------------------------------- | ------ | ------ | | go | github.com/defenseunicorns/go-oscal | v0.4.3 | v0.5.0 | * chore(lint): update lint with new go-oscal ValidationCommand changes * chore(tests): update pod_validation_test with new usage of ValidationCommand * chore(tests): update e2e pod_validation_test to use JsonSchemaError for validation failures --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Cole (Mike) Winberry <cole@defenseunicorns.com>
mike-winberry
approved these changes
Jun 27, 2024
mike-winberry
requested changes
Jun 27, 2024
… now handles multiple validation results
5 tasks
…prior to deciding exit state, still bails on non-validation errors as they happen
fix(lint): lint now waits until exiting the loop to write to file, handles multiple validation results
mike-winberry
approved these changes
Jun 27, 2024
brandtkeller
approved these changes
Jun 28, 2024
This was referenced Jun 28, 2024
This was referenced Jul 12, 2024
This was referenced Aug 5, 2024
This was referenced Oct 11, 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.
Description
Adds loop for lula lint.
Removed mention of yaml to future proof for xml (sorry for anyone reading that manually) and json.
Changed wording around single files to multiple files.
Related Issue
Fixes: #480
Type of change
Checklist before merging