-
Notifications
You must be signed in to change notification settings - Fork 162
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
refactor: break --insecure into separate flags #2936
refactor: break --insecure into separate flags #2936
Conversation
✅ Deploy Preview for zarf-docs canceled.
|
Great question, unfortunately the For this block, add a flag called For this block, add a flag called You can add these new fields to the types.ZarfPackageOptions struct |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great start, left some feedback. Could you also replace the uses of --insecure
in the test suite. Leave one use of --insecure
for each new flag so we can test that the flag still works though deprecated.
38a4cd8
to
cac41bc
Compare
6910fe6
to
613ae19
Compare
@AustinAbro321 appreciate all the feedback, I tried to make sure I addressed it diligently, but please let me know if I missed the mark somewhere. I haven't yet had a chance to revisit the use of My plan for how I was going to address the tests is as follows:
Does that roughly line up with what you had in mind? |
Some comments about this change. First of all we should stop adding things to the whole lang package as it is something that should be removed. Second of all I don't see the point of adding an "insecure" prefix to all of these flags. I am fine with I'm confused on the point of being able to disable digest verification while pulling? If the digests do not match something has gone very wrong. It also result in confusion for users in the future who assume that a package pulled has the expected digest. |
Yeah that looks like a solid strategy for changing the flag in tests @joonas Good point @phillebaba, I doubt anyone is relying on the insecure feature for |
b67d55e
to
0896cb9
Compare
I believe I've now addressed all of test cases and instances of where the flags were used 🙂 |
0896cb9
to
5352382
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good I have a small thing that we need to verify if it is an issue or not before merging.
@joonas I have verified that setting a pre run function in a sub command disables the root pre run. Which would explain why the tests are currently failing. |
Ah, it looks like to enable this behavior, the Does that seem like a reasonable change to make, or would you rather have the logic for setting I'm fine to go either way if changing the global flag in Cobra seems like too much of a behavior change to resolve this. |
Looks like my comments about the pre run functions did not make it with my review. Or I cant find it anymore. In it I shared that I was unsure about enabling In the end we probably want to get away from the shared package options struct which is currently in use. My other suggestion would be to put it in the root pre run function. Thinking about it now I would prefer the code duplication over that option. |
b00371e
to
d501d49
Compare
@AustinAbro321 @phillebaba I finally had a chance to go back and fix the one e2e test that was failing due to the help text changes. I've also re-generated the command docs pages to incorporate the flag changes and I went ahead and rebased on top of the latest changes (as of Friday evening) This should hopefully be all that's needed to have the test suite now pass with flying colors 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's close, requested a few more changes. Thank you for taking this on.
Fixes zarf-dev#2860 Signed-off-by: Joonas Bergius <joonas@bergi.us>
d501d49
to
77536f5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Will need @phillebaba to approve as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR contains the following updates: | Package | Update | Change | |---|---|---| | ghcr.io/zarf-dev/packages/init | minor | `v0.39.0` -> `v0.40.1` | | [zarf-dev/zarf](https://redirect.github.com/zarf-dev/zarf) | minor | `v0.39.0` -> `v0.40.1` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>zarf-dev/zarf (zarf-dev/zarf)</summary> ### [`v0.40.1`](https://redirect.github.com/zarf-dev/zarf/releases/tag/v0.40.1) [Compare Source](https://redirect.github.com/zarf-dev/zarf/compare/v0.40.0...v0.40.1) #### What's Changed - chore(deps): bump actions/create-github-app-token from 1.10.3 to 1.10.4 by [@​dependabot](https://redirect.github.com/dependabot) in [zarf-dev/zarf#2968 - fix: imported helm overrides by [@​rjferguson21](https://redirect.github.com/rjferguson21) in [zarf-dev/zarf#2967 - chore: only show config file if there is one by [@​catsby](https://redirect.github.com/catsby) in [zarf-dev/zarf#2985 - refactor: trim named returns in pkg [#​2950](https://redirect.github.com/zarf-dev/zarf/issues/2950) by [@​mkcp](https://redirect.github.com/mkcp) in [zarf-dev/zarf#2979 - chore: finish removing named returns outside of package and extensions [#​2950](https://redirect.github.com/zarf-dev/zarf/issues/2950) by [@​mkcp](https://redirect.github.com/mkcp) in [zarf-dev/zarf#2987 - chore: ensure we return zeroed value when returning errors by [@​mkcp](https://redirect.github.com/mkcp) in [zarf-dev/zarf#2988 - chore(deps): bump actions/create-github-app-token from 1.10.4 to 1.11.0 by [@​dependabot](https://redirect.github.com/dependabot) in [zarf-dev/zarf#2991 - refactor: break --insecure into separate flags by [@​joonas](https://redirect.github.com/joonas) in [zarf-dev/zarf#2936 - ci: stop codeql on merge queue by [@​AustinAbro321](https://redirect.github.com/AustinAbro321) in [zarf-dev/zarf#2934 - fix: add shasum flag and test for https pull by [@​AustinAbro321](https://redirect.github.com/AustinAbro321) in [zarf-dev/zarf#2998 - chore(deps): bump github/codeql-action from 3.26.6 to 3.26.7 by [@​dependabot](https://redirect.github.com/dependabot) in [zarf-dev/zarf#2997 - refactor: pull command by [@​phillebaba](https://redirect.github.com/phillebaba) in [zarf-dev/zarf#2989 - docs: update dos-games refs by [@​jasonwashburn](https://redirect.github.com/jasonwashburn) in [zarf-dev/zarf#3004 - refactor: lint by [@​phillebaba](https://redirect.github.com/phillebaba) in [zarf-dev/zarf#3000 - refactor: mirror-resources by [@​phillebaba](https://redirect.github.com/phillebaba) in [zarf-dev/zarf#2975 - fix: gittributes to ignore image file endings by [@​phillebaba](https://redirect.github.com/phillebaba) in [zarf-dev/zarf#3012 #### New Contributors - [@​rjferguson21](https://redirect.github.com/rjferguson21) made their first contribution in [zarf-dev/zarf#2967 - [@​catsby](https://redirect.github.com/catsby) made their first contribution in [zarf-dev/zarf#2985 - [@​mkcp](https://redirect.github.com/mkcp) made their first contribution in [zarf-dev/zarf#2979 - [@​joonas](https://redirect.github.com/joonas) made their first contribution in [zarf-dev/zarf#2936 **Full Changelog**: zarf-dev/zarf@v0.39.0...v0.40.1 ### [`v0.40.0`](https://redirect.github.com/zarf-dev/zarf/compare/v0.39.0...v0.40.0) [Compare Source](https://redirect.github.com/zarf-dev/zarf/compare/v0.39.0...v0.40.0) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/defenseunicorns/uds-core). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC44MC4wIiwidXBkYXRlZEluVmVyIjoiMzguODAuMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOltdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Description
Attempting to break up the
--insecure
global flag into four separate flags:--plain-http
--insecure-skip-tls-verify
--skip-signature-validation
Related Issue
Fixes #2860
Relates to #
Checklist before merging