Skip to content

feat: add --format json to search cmd #657

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

Open
manzil-infinity180 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: add --format json to search cmd #657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
65059c8
feat: add --format json to search cmd
manzil-infinity180 Nov 1, 2025
1e4dd8a
fix: validate --format flag and use cobra output writer
manzil-infinity180 Jul 27, 2026
817b25c
fix: write json output to stdout so it can be piped
manzil-infinity180 Jul 27, 2026
387f597
test: add unit test for unsupported --format value
manzil-infinity180 Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions cmd/archivistactl/cmd/search.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
package cmd

import (
"encoding/json"
"errors"
"fmt"
"strings"

"github.com/in-toto/archivista/pkg/api"
Expand All @@ -42,6 +44,10 @@ Digests are expected to be in the form algorithm:digest, for instance: sha256:45
return nil
},
RunE: func(cmd *cobra.Command, args []string) error {
if format != "table" && format != "json" {
return fmt.Errorf("unsupported format %q: supported formats are table, json", format)
}
Comment thread
manzil-infinity180 marked this conversation as resolved.

algo, digest, err := validateDigestString(args[0])
if err != nil {
return err
Expand All @@ -52,13 +58,25 @@ Digests are expected to be in the form algorithm:digest, for instance: sha256:45
return err
}

if format == "json" {
jsonData, err := json.MarshalIndent(results, "", " ")
if err != nil {
return fmt.Errorf("failed to marshal results to JSON: %w", err)
}
fmt.Fprintln(cmd.OutOrStdout(), string(jsonData))
return nil
}

printResults(results)
return nil
},
}

var format string

func init() {
rootCmd.AddCommand(searchCmd)
searchCmd.Flags().StringVarP(&format, "format", "f", "table", "Output format (table|json)")
}

func validateDigestString(ds string) (algo, digest string, err error) {
Expand Down
13 changes: 13 additions & 0 deletions cmd/archivistactl/cmd/search_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,19 @@ func (ut *UTSearchSuite) Test_SearchInvalidDigestString() {
}
}

func (ut *UTSearchSuite) Test_SearchInvalidFormat() {
output := bytes.NewBufferString("")
rootCmd.SetOut(output)
rootCmd.SetErr(output)
rootCmd.SetArgs([]string{"search", "sha256:test", "--format", "yaml"})
err := rootCmd.Execute()
if err != nil {
ut.ErrorContains(err, "unsupported format")
} else {
ut.FailNow("Expected: error")
}
}

func (ut *UTSearchSuite) Test_NoDB() {
output := bytes.NewBufferString("")
rootCmd.SetOut(output)
Expand Down