@@ -51,6 +51,7 @@ type Project struct {
5151func (c * DependencyTrackClient ) FindProject (ctx * tcontext.TransferMetadata , projectName , projectVersion string ) (string , error ) {
5252 logger .LogDebug (ctx .Context , "Finding Project" , "project" , projectName , "version" , projectVersion )
5353
54+ // dtrack client, retrives all projects
5455 projects , err := c .Client .Project .GetAll (ctx .Context , dtrack.PageOptions {})
5556 if err != nil {
5657 return "" , err
@@ -59,6 +60,7 @@ func (c *DependencyTrackClient) FindProject(ctx *tcontext.TransferMetadata, proj
5960 logger .LogDebug (ctx .Context , "Total Project Found" , "count" , projects .TotalCount )
6061
6162 for _ , project := range projects .Items {
63+ // lookup for the our project name with version
6264 if project .Name == projectName && project .Version == projectVersion {
6365 logger .LogDebug (ctx .Context , "Project found" , "project" , projectName , "version" , project .Version , "id" , project .UUID )
6466 return project .UUID .String (), nil
@@ -71,14 +73,15 @@ func (c *DependencyTrackClient) FindProject(ctx *tcontext.TransferMetadata, proj
7173
7274// UploadSBOM uploads an SBOM to a Dependency-Track project
7375func (c * DependencyTrackClient ) UploadSBOM (ctx * tcontext.TransferMetadata , projectName , projectVersion string , sbomData []byte ) error {
74- logger .LogDebug (ctx .Context , "Processing Uploading SBOMs to Dependency-Track sequentially " , "project" , projectName , "version" , projectVersion )
76+ logger .LogDebug (ctx .Context , "Processing Uploading SBOMs" , "project" , projectName , "version" , projectVersion )
7577
7678 bomReq := dtrack.BOMUploadRequest {
7779 ProjectName : projectName ,
7880 ProjectVersion : projectVersion ,
7981 BOM : base64 .StdEncoding .EncodeToString (sbomData ),
8082 }
8183
84+ // dtrack client will upload SBOM
8285 token , err := c .Client .BOM .Upload (ctx .Context , bomReq )
8386 if err != nil {
8487 return err
@@ -88,20 +91,22 @@ func (c *DependencyTrackClient) UploadSBOM(ctx *tcontext.TransferMetadata, proje
8891 return nil
8992}
9093
91- // FindOrCreateProject ensures a project exists, returning its UUID
94+ // FindOrCreateProject ensures a project exists, returning its UUID after finding or creating project
9295func (c * DependencyTrackClient ) FindOrCreateProject (ctx * tcontext.TransferMetadata , projectName , projectVersion string ) (string , error ) {
9396 logger .LogDebug (ctx .Context , "Finding Project" , "project" , projectName , "version" , projectVersion )
9497
98+ // find project using project name and project version
9599 uuid , err := c .FindProject (ctx , projectName , projectVersion )
96100 if err != nil {
97101 return "" , fmt .Errorf ("finding project: %w" , err )
98102 }
99103 if uuid != "" {
100- logger .LogDebug (ctx .Context , "Project already exists" , "project" , projectName , "uuid" , uuid )
104+ logger .LogDebug (ctx .Context , "Project already exists, therefor it wouldn't create a new " , "project" , projectName , "uuid" , uuid )
101105 return uuid , nil
102106 }
103- logger .LogDebug (ctx .Context , "Project doesn't exist " , "project" , projectName , "version" , projectVersion )
107+ logger .LogDebug (ctx .Context , "New project will be created " , "project" , projectName , "version" , projectVersion )
104108
109+ // create project using project name and project version
105110 return c .CreateProject (ctx , projectName , projectVersion )
106111}
107112
@@ -114,6 +119,7 @@ func (c *DependencyTrackClient) CreateProject(ctx *tcontext.TransferMetadata, pr
114119 Version : projectVersion ,
115120 }
116121
122+ // dtrack client will create a new project
117123 created , err := c .Client .Project .Create (ctx .Context , project )
118124 if err != nil {
119125 return "" , err
0 commit comments