Add support for updated discovery.json (#33)

Signed-off-by: Jose R. Gonzalez <komish@flutes.dev>

Author: komish

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/invopop/jsonschema v0.13.0
 	github.com/onsi/ginkgo/v2 v2.23.4
 	github.com/onsi/gomega v1.37.0
-	github.com/opdev/discover-workload v0.0.0-20250115205614-3233d42da6d9
+	github.com/opdev/discover-workload v0.0.0-20250613205600-4f6ee215f625
 	github.com/spf13/cobra v1.9.1
 	sigs.k8s.io/yaml v1.4.0
 )

go.sum

@@ -35,8 +35,8 @@ github.com/onsi/ginkgo/v2 v2.23.4 h1:ktYTpKJAVZnDT4VjxSbiBenUjmlL/5QkBEocaWXiQus
 github.com/onsi/ginkgo/v2 v2.23.4/go.mod h1:Bt66ApGPBFzHyR+JO10Zbt0Gsp4uWxu5mIOTusL46e8=
 github.com/onsi/gomega v1.37.0 h1:CdEG8g0S133B4OswTDC/5XPSzE1OeP29QOioj2PID2Y=
 github.com/onsi/gomega v1.37.0/go.mod h1:8D9+Txp43QWKhM24yyOBEdpkzN8FvJyAwecBgsU4KU0=
-github.com/opdev/discover-workload v0.0.0-20250115205614-3233d42da6d9 h1:sLy7Kdnp5w+0GVQ6rYjLTpGR+kUCarfFnPcolLqJTKo=
-github.com/opdev/discover-workload v0.0.0-20250115205614-3233d42da6d9/go.mod h1:pYjtJEWZgLGKOM1/4aCxHVf297u00qJN/KMNN9uWMtM=
+github.com/opdev/discover-workload v0.0.0-20250613205600-4f6ee215f625 h1:kIvS4Q0WQJOg/TXGr7Web+krA9SZsINe8CUZ27zoF98=
+github.com/opdev/discover-workload v0.0.0-20250613205600-4f6ee215f625/go.mod h1:Evlxr5q2psdSnx1Fdf0WJouLvcXlGyETN5hdaDLh8Fo=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/prashantv/gostub v1.1.0 h1:BTyx3RfQjRHnUWaGF9oQos79AlQ5k8WNktv7VGvVH4g=

internal/cmd/productctl/cmd/testutils/testdata/fixture.minimal.discovery.json

@@ -1,9 +1,17 @@
 {
     "DiscoveredImages": [
         {
-            "PodName": "pod-1",
-            "ContainerName": "container-1",
-            "Image": "example.com/registry/namespace:tag"
+            "Image": "example.com/registry/namespace:tag",
+            "Containers": [
+                {
+                    "Name": "container-1",
+                    "Type": "Container",
+                    "Pod": {
+                        "Name": "pod-1",
+                        "Namespace": "examplens"
+                    }
+                }
+            ]
         }
     ]
 }

internal/discovery/discover_internal_test.go

@@ -0,0 +1,52 @@
+package discovery
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	discoverworkload "github.com/opdev/discover-workload/discovery"
+)
+
+var _ = Describe("Discovery (internal)", func() {
+	When("determining the most frequent container name in a container list", func() {
+		var containers []discoverworkload.DiscoveredContainer
+
+		When("there one name present in the list is used more than onee", func() {
+			BeforeEach(func() {
+				containers = []discoverworkload.DiscoveredContainer{
+					{Name: "container-1"},
+					{Name: "container-1"},
+					{Name: "container-2"},
+				}
+			})
+
+			It("should return the container name with the larger count", func() {
+				actual, count, err := mostFrequentName(containers)
+				Expect(err).ToNot(HaveOccurred())
+				Expect(count).To(Equal(2))
+				Expect(actual).To(Equal("container-1"))
+			})
+		})
+		When("there are no containers", func() {
+			BeforeEach(func() {
+				containers = []discoverworkload.DiscoveredContainer{}
+			})
+			It("should return the expected error", func() {
+				_, _, err := mostFrequentName(containers)
+				Expect(err).To(MatchError(ErrNoContainers))
+			})
+		})
+
+		When("the containers input has malformed data", func() {
+			BeforeEach(func() {
+				containers = []discoverworkload.DiscoveredContainer{
+					{Name: ""},
+				}
+			})
+			It("should return the expected error", func() {
+				_, _, err := mostFrequentName(containers)
+				Expect(err).To(MatchError(ErrCountingContainerNameOccurrences))
+			})
+		})
+	})
+})

internal/discovery/discovery.go

@@ -6,15 +6,18 @@ package discovery
 import (
 	"errors"
 	"fmt"
+	"maps"
 
 	"github.com/opdev/discover-workload/discovery"
 
 	"github.com/opdev/productctl/internal/resource"
 )
 
 var (
-	ErrDuplicateComponentName = errors.New("duplicate component name")
-	ErrNoImagesDiscovered     = errors.New("no images found in discovery manifest")
+	ErrDuplicateComponentName           = errors.New("duplicate component name")
+	ErrNoImagesDiscovered               = errors.New("no images found in discovery manifest")
+	ErrCountingContainerNameOccurrences = errors.New("failed counting container names")
+	ErrNoContainers                     = errors.New("no containers in entry for image")
 )
 
 // ComponentsFromDiscoveryManifest converts discovered workloads into Component
@@ -30,13 +33,17 @@ func ComponentsFromDiscoveryManifest(manifest discovery.Manifest) ([]*resource.C
 
 	components := make([]*resource.Component, 0, len(manifest.DiscoveredImages))
 	for _, image := range manifest.DiscoveredImages {
+		mostCommonContainerName, _, err := mostFrequentName(image.Containers)
+		if err != nil {
+			return nil, err
+		}
 		c := resource.Component{
 			Container: &resource.ContainerComponent{
 				DistributionMethod: resource.ContainerDistributionExternal,
 				OSContentType:      resource.ContentTypeUBI,
 				Type:               resource.ContainerTypeContainer,
 			},
-			Name:          image.ContainerName,
+			Name:          mostCommonContainerName,
 			ProjectStatus: resource.ProjectStatusActive,
 			Type:          resource.ComponentTypeContainer,
 		}
@@ -52,3 +59,37 @@ func ComponentsFromDiscoveryManifest(manifest discovery.Manifest) ([]*resource.C
 
 	return components, nil
 }
+
+// mostFrequentName returns the most frequent discovered container name for
+// items in containers, with a goal of providing the user with a likely name to
+// use for a certification component for the specified container. Returned is
+// the actual container name and how many times it was found in the input data.
+func mostFrequentName(containers []discovery.DiscoveredContainer) (string, int, error) {
+	if len(containers) == 0 {
+		return "", 0, ErrNoContainers
+	}
+
+	count := map[string]int{}
+	for _, c := range containers {
+		if _, exists := count[c.Name]; !exists {
+			count[c.Name] = 0
+		}
+		count[c.Name] += 1
+	}
+
+	keys := maps.Keys(count)
+	var mostFrequent string
+	occurrences := 0
+	for key := range keys {
+		if count[key] > occurrences {
+			mostFrequent = key
+			occurrences = count[key]
+		}
+	}
+
+	if mostFrequent == "" || occurrences == 0 {
+		return "", 0, ErrCountingContainerNameOccurrences
+	}
+
+	return mostFrequent, occurrences, nil
+}

internal/discovery/discovery_test.go

@@ -11,6 +11,14 @@ import (
 
 var _ = Describe("Discovery", func() {
 	When("converting workload discovery manifest to component resources", func() {
+		It("should return an error if there are images with malformed container data", func() {
+			_, err := libdiscovery.ComponentsFromDiscoveryManifest(discovery.Manifest{
+				DiscoveredImages: []discovery.DiscoveredImage{
+					{Containers: []discovery.DiscoveredContainer{}},
+				},
+			})
+			Expect(err).To(MatchError(libdiscovery.ErrNoContainers))
+		})
 		It("should return an error when discovery manifest contains no entries", func() {
 			_, err := libdiscovery.ComponentsFromDiscoveryManifest(discovery.Manifest{})
 			Expect(err).To(MatchError(libdiscovery.ErrNoImagesDiscovered))
@@ -19,8 +27,8 @@ var _ = Describe("Discovery", func() {
 		It("should return an error for duplicate component names", func() {
 			manifestWithDuplicateNames := discovery.Manifest{
 				DiscoveredImages: []discovery.DiscoveredImage{
-					{ContainerName: "component1"},
-					{ContainerName: "component1"},
+					{Containers: []discovery.DiscoveredContainer{{Name: "component1"}}},
+					{Containers: []discovery.DiscoveredContainer{{Name: "component1"}}},
 				},
 			}
 			_, err := libdiscovery.ComponentsFromDiscoveryManifest(manifestWithDuplicateNames)
@@ -30,8 +38,8 @@ var _ = Describe("Discovery", func() {
 		It("should return components for valid manifest", func() {
 			manifest := discovery.Manifest{
 				DiscoveredImages: []discovery.DiscoveredImage{
-					{ContainerName: "component1"},
-					{ContainerName: "component2"},
+					{Containers: []discovery.DiscoveredContainer{{Name: "component1"}}},
+					{Containers: []discovery.DiscoveredContainer{{Name: "component2"}}},
 				},
 			}
 			components, err := libdiscovery.ComponentsFromDiscoveryManifest(manifest)