-
-
Notifications
You must be signed in to change notification settings - Fork 67
refactor(cli): remove the legacy exit shim and enforce it in CI #491
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
Open
Caesarsage
wants to merge
4
commits into
microcks:master
Choose a base branch
from
Caesarsage:pr3/remove-legacy-shim
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d9290b7
refactor(errors): remove the legacy exit shim
Caesarsage 7043fbb
ci: run tests and guard against stray process exits
Caesarsage 884714b
chore(cli): added missing copyright headers
Caesarsage 3de5886
fix(cli): harden error handling and add policy guards
Caesarsage File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| name: policy-guards | ||
|
|
||
| on: | ||
| push: | ||
| paths: | ||
| - '**/*.go' | ||
| - '.github/workflows/policy-guards.yml' | ||
| pull_request: | ||
| paths: | ||
| - '**/*.go' | ||
| - '.github/workflows/policy-guards.yml' | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| policy-guards: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout Code | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6.0.2 | ||
|
|
||
| - name: Guard Go copyright headers | ||
| run: | | ||
| missing="" | ||
| while IFS= read -r file; do | ||
| if ! grep -q "Copyright The Microcks Authors" "$file"; then | ||
| missing+="${file}"$'\n' | ||
| fi | ||
| done < <(git ls-files '*.go') | ||
|
|
||
| if [[ -n "$missing" ]]; then | ||
| echo "::error::Go files missing Microcks copyright header:" | ||
| printf "%s" "$missing" | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Guard against silently ignored errors | ||
| run: | | ||
| # Avoid reintroducing review issues where malformed responses or local | ||
| # failures are discarded instead of being returned as classified errors. | ||
| if grep -rnE '(^|[^[:alnum:]_])_ =|, _ :=|fmt\.Println\(err\)' --include='*.go' cmd pkg; then | ||
| echo "::error::Potential silently ignored error found. Handle it explicitly or return errors.Wrap(kind, err)." | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Guard against stray process exits | ||
| run: | | ||
| # Library and command packages must return classified errors, never | ||
| # exit or panic. Only the explicit process entrypoints may exit. | ||
| # See documentation/error-handling.md. | ||
| matches="$(git grep -nE '(os\.Exit|log\.Fatal|panic\()' -- '*.go' \ | ||
| ':!**/*_test.go' \ | ||
| ':!cmd/exit.go' \ | ||
| ':!main.go' \ | ||
| ':!watcher/main.go' || true)" | ||
|
|
||
| if [[ -n "$matches" ]]; then | ||
| printf "%s\n" "$matches" | ||
| echo "::error::os.Exit/log.Fatal/panic found outside approved entrypoints — return errors.Wrap(kind, err) instead." | ||
| exit 1 | ||
| fi | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
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.
The silently-ignored-error grep pattern
_ =|, _ :=|fmt\.Println\(err\)is a nice guard, but it's a blunt regex; it'll false-positive on any deliberate_ = x(e.g. explicitly discarding a value that's genuinely fine to ignore, if that ever comes up) with no allowlist mechanism. Not blocking, just flag it as something that may need a// nolint-style escape hatch down the line if a legitimate case shows up.