Skip to content

Commit d02be06

Browse files
anik120anik120
committed
OPRUN-3692: OLMv1-catalogd tests for API endpoints
Introduces tests for the new `api/v1/metas` endpoint when NewOLMCatalogdAPIV1Metas feature gate in enabled. Signed-off-by: Anik Bhattacharjee <[email protected]>
1 parent 585968f commit d02be06

File tree

3 files changed

+191
-3
lines changed

3 files changed

+191
-3
lines changed

‎test/extended/olm/olmv1.go

+168-1
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,16 @@ import (
77
"os"
88
"path/filepath"
99
"strings"
10+
"sync"
1011
"time"
1112

1213
g "github.com/onsi/ginkgo/v2"
1314
o "github.com/onsi/gomega"
15+
batchv1 "k8s.io/api/batch/v1"
16+
corev1 "k8s.io/api/core/v1"
1417
"k8s.io/apimachinery/pkg/api/meta"
1518
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
19+
"k8s.io/apimachinery/pkg/util/rand"
1620
"k8s.io/apimachinery/pkg/util/wait"
1721

1822
exutil "github.com/openshift/origin/test/extended/util"
@@ -71,7 +75,7 @@ var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLM] OLMv1 CRDs", func() {
7175
})
7276
})
7377

74-
var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 Catalogs", func() {
78+
var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 default Catalogs", func() {
7579
defer g.GinkgoRecover()
7680
oc := exutil.NewCLIWithoutNamespace("default")
7781

@@ -99,6 +103,83 @@ var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLM
99103
})
100104
})
101105

106+
var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 Catalogs /v1/api/all endpoint", func() {
107+
defer g.GinkgoRecover()
108+
oc := exutil.NewCLIWithoutNamespace("default")
109+
110+
g.It("should serve FBC", func(ctx g.SpecContext) {
111+
checkFeatureCapability(ctx, oc)
112+
113+
g.By("Testing /api/v1/all endpoint for catalog openshift-community-operators")
114+
verifyAPIEndpoint(ctx, oc, oc.Namespace(), "openshift-community-operators", "all")
115+
})
116+
})
117+
118+
var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLMCatalogdAPIV1Metas][Skipped:Disconnected] OLMv1 Catalogs /v1/api/metas endpoint", func() {
119+
defer g.GinkgoRecover()
120+
oc := exutil.NewCLIWithoutNamespace("default")
121+
g.It(" should serve the /v1/api/metas API endpoint", func(ctx g.SpecContext) {
122+
checkFeatureCapability(ctx, oc)
123+
124+
g.By("Testing api/v1/metas endpoint for catalog openshift-community-operators")
125+
verifyAPIEndpoint(ctx, oc, oc.Namespace(), "openshift-community-operators", "metas?schema=olm.package")
126+
})
127+
})
128+
129+
var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 Catalogs /v1/api/all endpoint load test", func() {
130+
defer g.GinkgoRecover()
131+
oc := exutil.NewCLIWithoutNamespace("default")
132+
providedCatalogs, idx := []string{
133+
"openshift-certified-operators",
134+
"openshift-community-operators",
135+
"openshift-redhat-marketplace",
136+
"openshift-redhat-operators",
137+
}, 0
138+
g.It("should be able to access /v1/api/all API endpoints of all catalogs within a reasonable amount of time", func(ctx g.SpecContext) {
139+
checkFeatureCapability(ctx, oc)
140+
141+
var wg sync.WaitGroup
142+
for range 100 {
143+
wg.Add(1)
144+
go func(catalogIdx int) {
145+
defer wg.Done()
146+
147+
g.By(fmt.Sprintf("Testing api/v1/all endpoint for catalog %s", providedCatalogs[catalogIdx]))
148+
verifyAPIEndpoint(ctx, oc, oc.Namespace(), providedCatalogs[catalogIdx], "all")
149+
}(idx)
150+
idx = (idx + 1) % len(providedCatalogs)
151+
}
152+
wg.Wait()
153+
})
154+
})
155+
156+
var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLMCatalogdAPIV1Metas][Skipped:Disconnected] OLMv1 Catalogs /v1/api/metas endpoint load test", func() {
157+
defer g.GinkgoRecover()
158+
oc := exutil.NewCLIWithoutNamespace("default")
159+
providedCatalogs, idx := []string{
160+
"openshift-certified-operators",
161+
"openshift-community-operators",
162+
"openshift-redhat-marketplace",
163+
"openshift-redhat-operators",
164+
}, 0
165+
g.It("should be able to access /v1/api/metas API endpoints of all catalogs within a resonable amount of time", func(ctx g.SpecContext) {
166+
checkFeatureCapability(ctx, oc)
167+
168+
var wg sync.WaitGroup
169+
for range 100 {
170+
wg.Add(1)
171+
go func(catalogIdx int) {
172+
defer wg.Done()
173+
174+
g.By(fmt.Sprintf("Testing api/v1/metas endpoint for catalog %s", providedCatalogs[catalogIdx]))
175+
verifyAPIEndpoint(ctx, oc, oc.Namespace(), providedCatalogs[catalogIdx], "metas?schema=olm.package")
176+
}(idx)
177+
idx = (idx + 1) % len(providedCatalogs)
178+
}
179+
wg.Wait()
180+
})
181+
})
182+
102183
var _ = g.Describe("[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 New Catalog Install", func() {
103184
defer g.GinkgoRecover()
104185

@@ -419,3 +500,89 @@ func checkFeatureCapability(ctx context.Context, oc *exutil.CLI) {
419500
g.Skip("Test only runs with OperatorLifecycleManagerV1 capability")
420501
}
421502
}
503+
504+
// verifyAPIEndpoint runs a job to validate the given service endpoint of a ClusterCatalog
505+
func verifyAPIEndpoint(ctx g.SpecContext, oc *exutil.CLI, namespace, catalogName, endpoint string) {
506+
jobName := fmt.Sprintf("test-catalog-%s-%s-%s", catalogName, endpoint, rand.String(5))
507+
508+
baseURL, err := oc.AsAdmin().Run("get").Args(
509+
"clustercatalogs.olm.operatorframework.io",
510+
catalogName,
511+
"-o=jsonpath={.status.urls.base}").Output()
512+
o.Expect(err).NotTo(o.HaveOccurred())
513+
o.Expect(baseURL).NotTo(o.BeEmpty(), fmt.Sprintf("Base URL not found for catalog %s", catalogName))
514+
515+
serviceURL := fmt.Sprintf("%s/api/v1/%s", baseURL, endpoint)
516+
g.GinkgoLogr.Info(fmt.Sprintf("Using service URL: %s", serviceURL))
517+
518+
job := &batchv1.Job{
519+
ObjectMeta: metav1.ObjectMeta{
520+
Name: jobName,
521+
Namespace: namespace,
522+
},
523+
Spec: batchv1.JobSpec{
524+
Template: corev1.PodTemplateSpec{
525+
Spec: corev1.PodSpec{
526+
Containers: []corev1.Container{
527+
{
528+
Name: "api-tester",
529+
Image: "registry.redhat.io/rhel8/httpd-24:latest",
530+
Command: []string{
531+
"/bin/bash",
532+
"-c",
533+
fmt.Sprintf(`
534+
set -ex
535+
response=$(curl -s -k "%s" || echo "ERROR: Failed to access endpoint")
536+
if [[ "$response" == ERROR* ]]; then
537+
echo "$response"
538+
exit 1
539+
fi
540+
echo "$response" > /tmp/api-response
541+
542+
# check if response can be parsed as new line delimited JSON
543+
if cat /tmp/api-response | jq -s . > /dev/null 2>&1; then
544+
echo "Valid JSON response detected"
545+
exit 0
546+
fi
547+
echo "ERROR: Invalid JSON response"
548+
exit 1
549+
`, serviceURL),
550+
},
551+
},
552+
},
553+
RestartPolicy: corev1.RestartPolicyNever,
554+
},
555+
},
556+
},
557+
}
558+
559+
_, err = oc.AdminKubeClient().BatchV1().Jobs(namespace).Create(context.TODO(), job, metav1.CreateOptions{})
560+
o.Expect(err).NotTo(o.HaveOccurred())
561+
562+
err = wait.PollUntilContextTimeout(ctx, 5*time.Second, 30*time.Second, true, func(ctx context.Context) (bool, error) {
563+
job, err := oc.AdminKubeClient().BatchV1().Jobs(namespace).Get(context.TODO(), jobName, metav1.GetOptions{})
564+
if err != nil {
565+
return false, err
566+
}
567+
568+
if job.Status.Succeeded > 0 {
569+
return true, nil
570+
}
571+
if job.Status.Failed > 0 {
572+
return false, fmt.Errorf("job failed")
573+
}
574+
575+
return false, nil
576+
})
577+
o.Expect(err).NotTo(o.HaveOccurred())
578+
579+
pods, err := oc.AdminKubeClient().CoreV1().Pods(namespace).List(context.TODO(), metav1.ListOptions{
580+
LabelSelector: fmt.Sprintf("job-name=%s", jobName),
581+
})
582+
o.Expect(err).NotTo(o.HaveOccurred())
583+
o.Expect(pods.Items).NotTo(o.BeEmpty())
584+
585+
logs, err := oc.AdminKubeClient().CoreV1().Pods(namespace).GetLogs(pods.Items[0].Name, &corev1.PodLogOptions{}).DoRaw(context.TODO())
586+
o.Expect(err).NotTo(o.HaveOccurred())
587+
g.GinkgoLogr.Info(fmt.Sprintf("Job logs for %s endpoint: %s", endpoint, string(logs)))
588+
}

‎test/extended/util/annotate/generated/zz_generated.annotations.go

+9-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎zz_generated.manifests/test-reporting.yaml

+14-1
Original file line numberDiff line numberDiff line change
@@ -381,16 +381,29 @@ spec:
381381
tests:
382382
- testName: '[sig-olmv1][OCPFeatureGate:NewOLM] OLMv1 CRDs should be installed'
383383
- testName: '[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 Catalogs
384-
should be installed'
384+
/v1/api/all endpoint load test should be able to access /v1/api/all API endpoints
385+
of all catalogs within a reasonable amount of time'
386+
- testName: '[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 Catalogs
387+
/v1/api/all endpoint should serve FBC'
385388
- testName: '[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 New
386389
Catalog Install should fail to install if it has an invalid reference'
390+
- testName: '[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 default
391+
Catalogs should be installed'
387392
- testName: '[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 operator
388393
installation should block cluster upgrades if an incompatible operator is
389394
installed'
390395
- testName: '[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 operator
391396
installation should fail to install a non-existing cluster extension'
392397
- testName: '[sig-olmv1][OCPFeatureGate:NewOLM][Skipped:Disconnected] OLMv1 operator
393398
installation should install a cluster extension'
399+
- featureGate: NewOLMCatalogdAPIV1Metas
400+
tests:
401+
- testName: '[sig-olmv1][OCPFeatureGate:NewOLMCatalogdAPIV1Metas][Skipped:Disconnected]
402+
OLMv1 Catalogs /v1/api/metas endpoint should serve the /v1/api/metas API
403+
endpoint'
404+
- testName: '[sig-olmv1][OCPFeatureGate:NewOLMCatalogdAPIV1Metas][Skipped:Disconnected]
405+
OLMv1 Catalogs /v1/api/metas endpoint load test should be able to access /v1/api/metas
406+
API endpoints of all catalogs within a resonable amount of time'
394407
- featureGate: PersistentIPsForVirtualization
395408
tests:
396409
- testName: '[sig-network][OCPFeatureGate:PersistentIPsForVirtualization][Feature:Layer2LiveMigration]

0 commit comments

Comments
 (0)