-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #99 from viveksahu26/merge_multiple_dt_projects
Merge multiple dt projects
- Loading branch information
Showing
12 changed files
with
472 additions
and
30 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
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,224 @@ | ||
| // Copyright 2023 Interlynk.io | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| // 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" | ||
|
|
||
| "github.com/google/uuid" | ||
| "github.com/interlynk-io/sbomasm/pkg/assemble" | ||
| "github.com/interlynk-io/sbomasm/pkg/dt" | ||
| "github.com/interlynk-io/sbomasm/pkg/logger" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // assembleCmd represents the assemble command | ||
| var dtCmd = &cobra.Command{ | ||
| Use: "dt", | ||
| Short: "helps assembling multiple DT project sboms into a final sbom", | ||
| Long: `The dt command will help assembling sboms into a final sbom. | ||
| Basic Example: | ||
| $ sbomasm dt -u "http://localhost:8080/" -k "odt_gwiwooi29i1N5Hewkkddkkeiwi3ii" -n "mega-app" -v "1.0.0" -t "application" -o finalsbom.json 11903ba9-a585-4dfb-9a0c-f348345a5473 34103ba2-rt63-2fga-3a8b-t625261g6262 | ||
| `, | ||
| SilenceUsage: true, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| if len(args) == 0 { | ||
| return fmt.Errorf("please provide at least one sbom file to assemble") | ||
| } | ||
|
|
||
| debug, _ := cmd.Flags().GetBool("debug") | ||
| if debug { | ||
| logger.InitDebugLogger() | ||
| } else { | ||
| logger.InitProdLogger() | ||
| } | ||
|
|
||
| ctx := logger.WithLogger(context.Background()) | ||
|
|
||
| dtParams, err := extractDtArgs(cmd, args) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| dtParams.Ctx = &ctx | ||
|
|
||
| // retrieve Input Files | ||
| dtParams.PopulateInputField(ctx) | ||
|
|
||
| assembleParams, err := extractArgsFromDTtoAssemble(dtParams) | ||
| fmt.Println("assemble.Input: ", assembleParams.Input) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| assembleParams.Ctx = &ctx | ||
|
|
||
| config, err := assemble.PopulateConfig(assembleParams) | ||
| if err != nil { | ||
| fmt.Println("Error populating config:", err) | ||
| } | ||
| return assemble.Assemble(config) | ||
| }, | ||
| } | ||
|
|
||
| func extractArgsFromDTtoAssemble(dtParams *dt.Params) (*assemble.Params, error) { | ||
| aParams := assemble.NewParams() | ||
|
|
||
| aParams.Output = dtParams.Output | ||
| aParams.Upload = dtParams.Upload | ||
| aParams.UploadProjectID = dtParams.UploadProjectID | ||
| aParams.Url = dtParams.Url | ||
| aParams.ApiKey = dtParams.ApiKey | ||
|
|
||
| aParams.Name = dtParams.Name | ||
| aParams.Version = dtParams.Version | ||
| aParams.Type = dtParams.Type | ||
|
|
||
| aParams.FlatMerge = dtParams.FlatMerge | ||
| aParams.HierMerge = dtParams.HierMerge | ||
| aParams.AssemblyMerge = dtParams.AssemblyMerge | ||
|
|
||
| aParams.Xml = dtParams.Xml | ||
| aParams.Json = dtParams.Json | ||
|
|
||
| aParams.OutputSpecVersion = dtParams.OutputSpecVersion | ||
|
|
||
| aParams.OutputSpec = dtParams.OutputSpec | ||
|
|
||
| aParams.Input = dtParams.Input | ||
|
|
||
| return aParams, nil | ||
| } | ||
|
|
||
| func extractDtArgs(cmd *cobra.Command, args []string) (*dt.Params, error) { | ||
| aParams := dt.NewParams() | ||
|
|
||
| url, err := cmd.Flags().GetString("url") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| apiKey, err := cmd.Flags().GetString("api-key") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| aParams.Url = url | ||
| aParams.ApiKey = apiKey | ||
|
|
||
| name, _ := cmd.Flags().GetString("name") | ||
| version, _ := cmd.Flags().GetString("version") | ||
| typeValue, _ := cmd.Flags().GetString("type") | ||
|
|
||
| aParams.Name = name | ||
| aParams.Version = version | ||
| aParams.Type = typeValue | ||
|
|
||
| flatMerge, _ := cmd.Flags().GetBool("flatMerge") | ||
| hierMerge, _ := cmd.Flags().GetBool("hierMerge") | ||
| assemblyMerge, _ := cmd.Flags().GetBool("assemblyMerge") | ||
|
|
||
| aParams.FlatMerge = flatMerge | ||
| aParams.HierMerge = hierMerge | ||
| aParams.AssemblyMerge = assemblyMerge | ||
|
|
||
| xml, _ := cmd.Flags().GetBool("xml") | ||
| json, _ := cmd.Flags().GetBool("json") | ||
|
|
||
| aParams.Xml = xml | ||
| aParams.Json = json | ||
|
|
||
| if aParams.Xml { | ||
| aParams.Json = false | ||
| } | ||
|
|
||
| specVersion, _ := cmd.Flags().GetString("outputSpecVersion") | ||
| aParams.OutputSpecVersion = specVersion | ||
|
|
||
| cdx, _ := cmd.Flags().GetBool("outputSpecCdx") | ||
|
|
||
| if cdx { | ||
| aParams.OutputSpec = "cyclonedx" | ||
| } else { | ||
| aParams.OutputSpec = "spdx" | ||
| } | ||
|
|
||
| output, err := cmd.Flags().GetString("output") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // Check if the output is a valid UUID, i.e. project ID | ||
| if _, err := uuid.Parse(output); err == nil { | ||
| aParams.Upload = true | ||
| aParams.UploadProjectID = uuid.MustParse(output) | ||
| fmt.Printf("Upload: %v and SBOM to Project ID: %v \n", aParams.Upload, aParams.UploadProjectID) | ||
| } else { | ||
| // Assume it's a file path | ||
| aParams.Output = output | ||
| aParams.Upload = false | ||
| fmt.Printf("Upload: %v and SBOM to Project ID: %v \n", aParams.Upload, aParams.Output) | ||
| } | ||
|
|
||
| for _, arg := range args { | ||
| // Check if the argument is a file | ||
| if _, err := os.Stat(arg); err == nil { | ||
| if err := validatePath(arg); err != nil { | ||
| return nil, err | ||
| } | ||
| aParams.Input = append(aParams.Input, arg) | ||
| continue | ||
| } | ||
|
|
||
| argID, err := uuid.Parse(arg) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| aParams.ProjectIds = append(aParams.ProjectIds, argID) | ||
| } | ||
| return aParams, nil | ||
| } | ||
|
|
||
| func init() { | ||
| // Add dt as a sub-command of assemble | ||
| assembleCmd.AddCommand(dtCmd) | ||
|
|
||
| dtCmd.Flags().StringP("url", "u", "", "dependency track url https://localhost:8080/") | ||
| dtCmd.Flags().StringP("api-key", "k", "", "dependency track api key, requires VIEW_PORTFOLIO for scoring and PORTFOLIO_MANAGEMENT for tagging") | ||
| dtCmd.MarkFlagsRequiredTogether("url", "api-key") | ||
|
|
||
| dtCmd.Flags().StringP("output", "o", "", "path to file or project id for newly assembled sbom, defaults to stdout") | ||
|
|
||
| dtCmd.Flags().StringP("name", "n", "", "name of the assembled sbom") | ||
| dtCmd.Flags().StringP("version", "v", "", "version of the assembled sbom") | ||
| dtCmd.Flags().StringP("type", "t", "", "product type of the assembled sbom (application, framework, library, container, device, firmware)") | ||
| dtCmd.MarkFlagsRequiredTogether("name", "version", "type") | ||
|
|
||
| dtCmd.Flags().BoolP("flatMerge", "f", false, "flat merge") | ||
| dtCmd.Flags().BoolP("hierMerge", "m", false, "hierarchical merge") | ||
| dtCmd.Flags().BoolP("assemblyMerge", "a", false, "assembly merge") | ||
| dtCmd.MarkFlagsMutuallyExclusive("flatMerge", "hierMerge", "assemblyMerge") | ||
|
|
||
| dtCmd.Flags().BoolP("outputSpecCdx", "g", true, "output in cdx format") | ||
| dtCmd.Flags().BoolP("outputSpecSpdx", "s", false, "output in spdx format") | ||
| dtCmd.MarkFlagsMutuallyExclusive("outputSpecCdx", "outputSpecSpdx") | ||
|
|
||
| dtCmd.Flags().StringP("outputSpecVersion", "e", "", "spec version of the output sbom") | ||
|
|
||
| dtCmd.Flags().BoolP("xml", "x", false, "output in xml format") | ||
| dtCmd.Flags().BoolP("json", "j", true, "output in json format") | ||
| dtCmd.MarkFlagsMutuallyExclusive("xml", "json") | ||
| } |
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
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.