Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(collector): expose Google Cloud Storage collector from guacone C…
…LI (#989) * feat(collector): expose Google Cloud Storage collector from guacone CLI Signed-off-by: Miguel Martinez Trivino <miguel@chainloop.dev> * apply feedback Signed-off-by: Miguel Martinez Trivino <miguel@chainloop.dev> --------- Signed-off-by: Miguel Martinez Trivino <miguel@chainloop.dev>
- Loading branch information
Showing
5 changed files
with
402 additions
and
50 deletions.
There are no files selected for viewing
This file contains 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,190 @@ | ||
| // | ||
| // Copyright 2022 The GUAC Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "time" | ||
|
|
||
| "cloud.google.com/go/storage" | ||
| "github.com/guacsec/guac/pkg/cli" | ||
| csub_client "github.com/guacsec/guac/pkg/collectsub/client" | ||
| "github.com/guacsec/guac/pkg/handler/collector" | ||
| "github.com/guacsec/guac/pkg/handler/collector/gcs" | ||
| "github.com/guacsec/guac/pkg/handler/processor" | ||
| "github.com/guacsec/guac/pkg/logging" | ||
| "github.com/guacsec/guac/pkg/version" | ||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/viper" | ||
| "google.golang.org/api/option" | ||
| ) | ||
|
|
||
| type gcsOptions struct { | ||
| graphqlEndpoint string | ||
| csubAddr string | ||
| bucket string | ||
| } | ||
|
|
||
| const gcsCredentialsPathFlag = "gcp-credentials-path" | ||
|
|
||
| var gcsCmd = &cobra.Command{ | ||
| Use: "gcs [flags] bucket_name", | ||
| Short: "takes SBOMs and attestations from a Google Cloud Storage bucket and injects them to GUAC graph. This command talks directly to the graphQL endpoint", | ||
| Example: "guacone collect gcs my-bucket --gcs-credentials-path /secret/sa.json", | ||
| Args: cobra.ExactArgs(1), | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| ctx := logging.WithLogger(context.Background()) | ||
| logger := logging.FromContext(ctx) | ||
|
|
||
| opts, err := validateGCSFlags(viper.GetString("gql-addr"), viper.GetString("csub-addr"), viper.GetString(gcsCredentialsPathFlag), args) | ||
| if err != nil { | ||
| fmt.Printf("unable to validate flags: %v\n", err) | ||
| _ = cmd.Help() | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| gcsOpts := []option.ClientOption{ | ||
| option.WithUserAgent(version.UserAgent), | ||
| } | ||
|
|
||
| // Credential flag is not mandatory since they can also be loaded from | ||
| // the environment variable GOOGLE_APPLICATION_CREDENTIALS by the client, by default | ||
| if credsPath := viper.GetString(gcsCredentialsPathFlag); credsPath != "" { | ||
| gcsOpts = append(gcsOpts, option.WithCredentialsFile(credsPath)) | ||
| } | ||
|
|
||
| client, err := storage.NewClient(ctx, gcsOpts...) | ||
| if err != nil { | ||
| logger.Fatalf("creating client: %v", err) | ||
| } | ||
|
|
||
| // Register collector by providing a new GCS Client and bucket name | ||
| gcsCollector, err := gcs.NewGCSCollector(gcs.WithBucket(opts.bucket), gcs.WithClient(client)) | ||
| if err != nil { | ||
| logger.Fatalf("unable to create gcs client: %v", err) | ||
| } | ||
|
|
||
| err = collector.RegisterDocumentCollector(gcsCollector, gcs.CollectorGCS) | ||
| if err != nil { | ||
| logger.Fatalf("unable to register gcs collector: %v", err) | ||
| } | ||
|
|
||
| // initialize collectsub client | ||
| csubClient, err := csub_client.NewClient(opts.csubAddr) | ||
| if err != nil { | ||
| logger.Infof("collectsub client initialization failed, this ingestion will not pull in any additional data through the collectsub service: %v", err) | ||
| csubClient = nil | ||
| } else { | ||
| defer csubClient.Close() | ||
| } | ||
|
|
||
| // TODO: this code could be extracted to a function and reused by the | ||
| // other collectors (files and oci) | ||
| // Get pipeline of components | ||
| processorFunc := getProcessor(ctx) | ||
| ingestorFunc := getIngestor(ctx) | ||
| collectSubEmitFunc := getCollectSubEmit(ctx, csubClient) | ||
| assemblerFunc := getAssembler(ctx, opts.graphqlEndpoint) | ||
|
|
||
| totalNum := 0 | ||
| gotErr := false | ||
| // Set emit function to go through the entire pipeline | ||
| emit := func(d *processor.Document) error { | ||
| totalNum += 1 | ||
| start := time.Now() | ||
|
|
||
| docTree, err := processorFunc(d) | ||
| if err != nil { | ||
| gotErr = true | ||
| return fmt.Errorf("unable to process doc: %v, format: %v, document: %v", err, d.Format, d.Type) | ||
| } | ||
|
|
||
| predicates, idstrings, err := ingestorFunc(docTree) | ||
| if err != nil { | ||
| gotErr = true | ||
| return fmt.Errorf("unable to ingest doc tree: %v", err) | ||
| } | ||
|
|
||
| err = collectSubEmitFunc(idstrings) | ||
| if err != nil { | ||
| logger.Infof("unable to create entries in collectsub server, but continuing: %v", err) | ||
| } | ||
|
|
||
| err = assemblerFunc(predicates) | ||
| if err != nil { | ||
| gotErr = true | ||
| return fmt.Errorf("unable to assemble graphs: %v", err) | ||
| } | ||
| t := time.Now() | ||
| elapsed := t.Sub(start) | ||
| logger.Infof("[%v] completed doc %+v", elapsed, d.SourceInformation) | ||
| return nil | ||
| } | ||
|
|
||
| // Collect | ||
| errHandler := func(err error) bool { | ||
| if err == nil { | ||
| logger.Info("collector ended gracefully") | ||
| return true | ||
| } | ||
| logger.Errorf("collector ended with error: %v", err) | ||
| return false | ||
| } | ||
| if err := collector.Collect(ctx, emit, errHandler); err != nil { | ||
| logger.Fatal(err) | ||
| } | ||
|
|
||
| if gotErr { | ||
| logger.Fatalf("completed ingestion with errors") | ||
| } else { | ||
| logger.Infof("completed ingesting %v documents", totalNum) | ||
| } | ||
| }, | ||
| } | ||
|
|
||
| func validateGCSFlags(gqlEndpoint, csubAddr, credentialsPath string, args []string) (gcsOptions, error) { | ||
| var opts gcsOptions | ||
| opts.graphqlEndpoint = gqlEndpoint | ||
| opts.csubAddr = csubAddr | ||
|
|
||
| if len(args) < 1 { | ||
| return opts, fmt.Errorf("expected positional argument: bucket") | ||
| } | ||
| opts.bucket = args[0] | ||
|
|
||
| if credentialsPath == "" && os.Getenv("GOOGLE_APPLICATION_CREDENTIALS") == "" { | ||
| return opts, fmt.Errorf("expected either --%s flag or GOOGLE_APPLICATION_CREDENTIALS environment variable", gcsCredentialsPathFlag) | ||
| } | ||
|
|
||
| return opts, nil | ||
| } | ||
|
|
||
| func init() { | ||
| set, err := cli.BuildFlags([]string{gcsCredentialsPathFlag}) | ||
| if err != nil { | ||
| fmt.Fprintf(os.Stderr, "failed to setup flag: %v", err) | ||
| os.Exit(1) | ||
| } | ||
| gcsCmd.Flags().AddFlagSet(set) | ||
| if err := viper.BindPFlags(gcsCmd.Flags()); err != nil { | ||
| fmt.Fprintf(os.Stderr, "failed to bind flags: %v", err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| collectCmd.AddCommand(gcsCmd) | ||
| } |
This file contains 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,80 @@ | ||
| // | ||
| // Copyright 2022 The GUAC Authors. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package cmd | ||
|
|
||
| import "testing" | ||
|
|
||
| func TestValidateGCSFlags(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| args []string | ||
| credentialsPath string | ||
| credsEnvVarSet bool | ||
| errorMsg string | ||
| }{ | ||
| { | ||
| name: "no args", | ||
| errorMsg: "expected positional argument: bucket", | ||
| }, | ||
| { | ||
| name: "no credentials", | ||
| args: []string{"bucket"}, | ||
| errorMsg: "expected either --gcp-credentials-path flag or GOOGLE_APPLICATION_CREDENTIALS environment variable", | ||
| }, | ||
| { | ||
| name: "credentials path and env var set", | ||
| args: []string{"bucket"}, | ||
| credentialsPath: "/path/to/creds.json", | ||
| credsEnvVarSet: true, | ||
| errorMsg: "", | ||
| }, | ||
| { | ||
| name: "credentials path and env var not set", | ||
| args: []string{"bucket"}, | ||
| credentialsPath: "/path/to/creds.json", | ||
| }, | ||
| { | ||
| name: "credentials path not set and env var set", | ||
| args: []string{"bucket"}, | ||
| credsEnvVarSet: true, | ||
| errorMsg: "", | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| if tc.credsEnvVarSet { | ||
| t.Setenv("GOOGLE_APPLICATION_CREDENTIALS", "/path/to/creds.json") | ||
| } | ||
|
|
||
| o, err := validateGCSFlags("", "", tc.credentialsPath, tc.args) | ||
| if err != nil { | ||
| if tc.errorMsg != err.Error() { | ||
| t.Errorf("expected error message: %s, got: %s", tc.errorMsg, err.Error()) | ||
| } | ||
| } else { | ||
| if tc.errorMsg != "" { | ||
| t.Errorf("expected error message: %s, got: %s", tc.errorMsg, err.Error()) | ||
| } | ||
|
|
||
| if o.bucket != tc.args[0] { | ||
| t.Errorf("expected bucket: %s, got: %s", tc.args[0], o.bucket) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| } |
This file contains 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 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.