External/pmg
1
0
Fork 0
mirror of https://github.com/safedep/pmg.git synced 2026-08-03 07:24:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

refactor : Refactor error handling to use dry/usefulerror (#283)

Browse Source 
* update the go.sum

Signed-off-by: DivyanshuVortex <divyanshuchandra9027@gmail.com>

* migrate most of the files to dry errors

Signed-off-by: DivyanshuVortex <divyanshuchandra9027@gmail.com>

* update the rest of the files

Signed-off-by: DivyanshuVortex <divyanshuchandra9027@gmail.com>

* fixs the review comments

Signed-off-by: DivyanshuVortex <divyanshuchandra9027@gmail.com>

* chores

Signed-off-by: DivyanshuVortex <divyanshuchandra9027@gmail.com>

---------

Signed-off-by: DivyanshuVortex <divyanshuchandra9027@gmail.com>
Co-authored-by: Abhisek Datta <abhisek.datta@gmail.com>
This commit is contained in:
Divyanshu
2026-05-24 12:22:19 +05:30
committed by GitHub
co-authored by Abhisek Datta
parent e5fe0df82e
commit 20e01d5cae
33 changed files with 234 additions and 639 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/sandbox/explain.go
+15 -14
View File
@@ -11,7 +11,8 @@ import (
"github.com/safedep/pmg/config"
"github.com/safedep/pmg/internal/ui"
pmgsandbox "github.com/safedep/pmg/sandbox"
"github.com/safedep/pmg/usefulerror"
"github.com/safedep/dry/usefulerror"
"github.com/safedep/pmg/errcodes"
"github.com/spf13/cobra"
)
@@ -67,7 +68,7 @@ func (e *explainFailError) ExitCode() int { return ExitCodeExplainFail }
func newExplainFailError(code, msg, help string) *explainFailError {
return &explainFailError{
UsefulError: usefulerror.Useful().
UsefulError: usefulerror.NewUsefulError().
WithCode(code).
WithHumanError(msg).
WithHelp(help).
@@ -80,7 +81,7 @@ func runExplain(out io.Writer, in io.Reader, args []string, opts *explainOptions
if len(args) == 1 && !stdinMode {
return newExplainFailError(
usefulerror.ErrCodeInvalidArgument,
errcodes.InvalidArgument,
fmt.Sprintf("unexpected argument %q (use --last or pipe JSON with `-`)", args[0]),
explainUsageHelp(),
)
@@ -88,7 +89,7 @@ func runExplain(out io.Writer, in io.Reader, args []string, opts *explainOptions
if opts.last && stdinMode {
return newExplainFailError(
usefulerror.ErrCodeInvalidArgument,
errcodes.InvalidArgument,
"--last and `-` are mutually exclusive",
explainUsageHelp(),
)
@@ -96,7 +97,7 @@ func runExplain(out io.Writer, in io.Reader, args []string, opts *explainOptions
if !opts.last && !stdinMode {
return newExplainFailError(
usefulerror.ErrCodeInvalidArgument,
errcodes.InvalidArgument,
"no input: pass --last to read the most recent cached violation, or pipe a violation record JSON on stdin with `-`",
explainUsageHelp(),
)
@@ -128,14 +129,14 @@ func readLatestFromCache(factory cacheFactory) (*pmgsandbox.ViolationCacheRecord
entry, err := cache.Latest()
if err != nil {
return nil, newExplainFailError(
usefulerror.ErrCodeUnknown,
errcodes.Unknown,
fmt.Sprintf("read cache: %v", err),
"Check the sandbox violation cache directory and retry.",
)
}
if entry == nil {
return nil, newExplainFailError(
usefulerror.ErrCodeNotFound,
errcodes.NotFound,
"no violations cached yet — run a sandboxed command first",
"Run a sandboxed package manager command first, then retry `pmg sandbox explain --last`.",
)
@@ -151,7 +152,7 @@ func readRecordFromStdin(in io.Reader) (*pmgsandbox.ViolationCacheRecord, error)
data, err := io.ReadAll(in)
if err != nil {
return nil, newExplainFailError(
usefulerror.ErrCodeInvalidArgument,
errcodes.InvalidArgument,
fmt.Sprintf("read stdin: %v", err),
explainUsageHelp(),
)
@@ -159,7 +160,7 @@ func readRecordFromStdin(in io.Reader) (*pmgsandbox.ViolationCacheRecord, error)
if len(strings.TrimSpace(string(data))) == 0 {
return nil, newExplainFailError(
usefulerror.ErrCodeInvalidArgument,
errcodes.InvalidArgument,
"stdin is empty: pipe a ViolationCacheRecord JSON document",
explainUsageHelp(),
)
@@ -168,7 +169,7 @@ func readRecordFromStdin(in io.Reader) (*pmgsandbox.ViolationCacheRecord, error)
var rec pmgsandbox.ViolationCacheRecord
if err := json.Unmarshal(data, &rec); err != nil {
return nil, newExplainFailError(
usefulerror.ErrCodeInvalidArgument,
errcodes.InvalidArgument,
fmt.Sprintf("parse stdin JSON: %v", err),
"Pipe a valid ViolationCacheRecord JSON document to `pmg sandbox explain -`.",
)
@@ -183,16 +184,16 @@ func readRecordFromStdin(in io.Reader) (*pmgsandbox.ViolationCacheRecord, error)
func validateViolationCacheRecord(rec *pmgsandbox.ViolationCacheRecord, source string) error {
if rec == nil {
return newExplainFailError(usefulerror.ErrCodeInvalidArgument, fmt.Sprintf("%s is empty", source), explainUsageHelp())
return newExplainFailError(errcodes.InvalidArgument, fmt.Sprintf("%s is empty", source), explainUsageHelp())
}
if rec.SchemaVersion == 0 {
return newExplainFailError(usefulerror.ErrCodeInvalidArgument, fmt.Sprintf("%s is missing schema_version", source), explainUsageHelp())
return newExplainFailError(errcodes.InvalidArgument, fmt.Sprintf("%s is missing schema_version", source), explainUsageHelp())
}
if rec.SchemaVersion != pmgsandbox.ViolationCacheSchemaVersion {
return newExplainFailError(usefulerror.ErrCodeInvalidArgument, fmt.Sprintf("unknown schema_version %d (expected %d)", rec.SchemaVersion, pmgsandbox.ViolationCacheSchemaVersion), explainUsageHelp())
return newExplainFailError(errcodes.InvalidArgument, fmt.Sprintf("unknown schema_version %d (expected %d)", rec.SchemaVersion, pmgsandbox.ViolationCacheSchemaVersion), explainUsageHelp())
}
if rec.Report == nil {
return newExplainFailError(usefulerror.ErrCodeInvalidArgument, fmt.Sprintf("%s is missing report", source), explainUsageHelp())
return newExplainFailError(errcodes.InvalidArgument, fmt.Sprintf("%s is missing report", source), explainUsageHelp())
}
return nil