Skip to content
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

Introduce a zarf prepare lint command #2064

Closed
3 of 5 tasks
Racer159 opened this issue Oct 11, 2023 · 10 comments
Closed
3 of 5 tasks

Introduce a zarf prepare lint command #2064

Racer159 opened this issue Oct 11, 2023 · 10 comments
Assignees
@AustinAbro321
Labels
enhancement ✨ New feature or request
Milestone
The Bucket

Comments

@Racer159
Copy link
Contributor

Racer159 commented Oct 11, 2023 •
edited by AustinAbro321
Loading

Is your feature request related to a problem? Please describe.

We should introduce a zarf prepare lint command that will look at a zarf.yaml file and then error or warn when a zarf.yaml is out of spec with best practices.

Describe the solution you'd like

  • Given I have a zarf.yaml that is not following best practices
  • When I run zarf prepare lint on that file
  • Then I receive a list of notes, warnings or errors according to the following:
  • error: invalid package schema
  • warning: flagged package warning (i.e. from p.warnings / deprecations)
  • warning: unpinned dependencies (repos or images without a tagged reference)
  • warning: files without pinned shasums
  • note: variables, packages, actions and components without descriptions

Describe alternatives you've considered

We could publish these as docs, but having them coded into a command allows them to be run in CI and updated without people needing to go back and read a docs page.

Additional context

This will help package development scale and push the Zarf community's view of what makes a "good" Zarf package.
@Racer159 Racer159 added the enhancement ✨ New feature or request label Oct 11, 2023
@Racer159 Racer159 mentioned this issue Oct 11, 2023
Open
@Racer159 Racer159 added this to the The Bucket milestone Oct 11, 2023
@AustinAbro321 AustinAbro321 mentioned this issue Oct 16, 2023
Merged
3 tasks
@Racer159
Copy link
Contributor Author

It may be worth it to yamllint downstream manifests and values files that are directly provided to Zarf as well https://kubernetes.slack.com/archives/C03B6BJAUJ3/p1697579246332669?thread_ts=1683149646.315369&cid=C03B6BJAUJ3

@AustinAbro321
Copy link
Contributor

I would also like to give the user the line number in the future

Racer159 added a commit that referenced this issue Nov 29, 2023
@AustinAbro321 @bdw617
@Racer159 @lucasrod16 @Noxsios
feat: add zarf prepare lint to perform schema validation (#2075)
587c695 
## Description

Intent of this PR is to introduce the command zarf prepare lint, with
the ability to validate the zarf schema

## Related Issue

Relates to #2064  #1667 

## Type of change

- [X] New feature (non-breaking change which adds functionality)

## Checklist before merging

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Barry Waldbaum <[email protected]>
Co-authored-by: Wayne Starr <[email protected]>
Co-authored-by: Lucas Rodriguez <[email protected]>
Co-authored-by: razzle <[email protected]>
@AustinAbro321
Copy link
Contributor

AustinAbro321 commented Nov 29, 2023 •
edited
Loading

For checking unpinned repos I'm leaning towards just checking if the repo doesn't contain "@" or "/-/". Could result in some false negatives since repos can have "@" in the name. This should cover github, dev.azure, and gitlab repos. Any source control sites popular among our users that I should take a look at @Racer159? Those would likely have false positives if they urls aren't built like github / gitlab

@AustinAbro321 AustinAbro321 mentioned this issue Nov 30, 2023
Merged
4 tasks
@AustinAbro321
Copy link
Contributor

We may want either run every combination of architecture or pass in architectures from lint

@AustinAbro321
Copy link
Contributor

We should warn if variables are not being used anywhere

@AustinAbro321
Copy link
Contributor

We can also use variable defaults / set values we can get to make sure that the downstream mainfests / helmcharts are valid yaml

@AustinAbro321
Copy link
Contributor

AustinAbro321 commented Dec 5, 2023 •
edited
Loading

I would like to allow yaml extensions in the schema. They will work currently but give a schema error https://docs.docker.com/compose/compose-file/11-extension/.

This was resolved by: #2217

Racer159 added a commit that referenced this issue Dec 18, 2023
@AustinAbro321 @bdw617
@Racer159 @lucasrod16 @Noxsios
feat: unpinned resources (images/repos/files) warning on `zarf …
da4fc5e 
…prepare lint` (#2171)

## Description
Adding warnings for unpinned images, files and repos

## Related Issue

Relates to #2064 

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [X] New feature (non-breaking change which adds functionality)
- [ ] Other (security config, docs update, etc)

## Checklist before merging

- [ ] Test, docs, adr added or updated as needed

---------

Co-authored-by: Barry Waldbaum <[email protected]>
Co-authored-by: Wayne Starr <[email protected]>
Co-authored-by: Lucas Rodriguez <[email protected]>
Co-authored-by: razzle <[email protected]>
@AustinAbro321 AustinAbro321 mentioned this issue Jan 8, 2024
Merged
5 tasks
Racer159 added a commit that referenced this issue Jan 10, 2024
@AustinAbro321 @Racer159
feat: support yaml extension (#2217)
0866000 
## Description

Support yaml extension in lint following these rules
https://docs.docker.com/compose/compose-file/11-extension/

## Related Issue

Relates to #2064 

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [X] New feature (non-breaking change which adds functionality)
- [ ] Other (security config, docs update, etc)

## Checklist before merging

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Wayne Starr <[email protected]>
@AustinAbro321 AustinAbro321 mentioned this issue Jan 11, 2024
Closed
5 tasks
@AustinAbro321
Copy link
Contributor

verify that the zarf-config.yaml / toml / ini / json has at least package.deploy or package.create

@Racer159
Copy link
Contributor Author

Tying this to this since this is the other side of variables linting: #2096

@Noxsios Noxsios moved this to In progress in Zarf (old) Mar 7, 2024
@AustinAbro321 AustinAbro321 moved this from In progress to Ready in Zarf (old) Mar 7, 2024
@AustinAbro321
Copy link
Contributor

Command has been introduced. Putting further lints in the other issues. Moving flagged package warning (i.e. from p.warnings / deprecations) will go in #2485

@github-project-automation github-project-automation bot moved this from Ready to Done in Zarf (old) May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AustinAbro321 AustinAbro321

Labels
enhancement ✨ New feature or request
Projects
None yet
Milestone
The Bucket
Development

No branches or pull requests
2 participants
@Racer159 @AustinAbro321