Skip to content

🌱 move BuildHTTPClient from shared httputil to catalogmetadata/client #2782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-bot merged 1 commit into from
Jun 25, 2026
Merged

🌱 move BuildHTTPClient from shared httputil to catalogmetadata/client #2782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/operator-controller/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ func run() error {
}
catalogClientBackend := cache.NewFilesystemCache(catalogsCachePath)
catalogClient := catalogclient.New(catalogClientBackend, func() (*http.Client, error) {
return httputil.BuildHTTPClient(cpwCatalogd)
return catalogclient.BuildHTTPClient(cpwCatalogd)
})

resolver := &resolve.CatalogResolver{
Expand Down
34 changes: 17 additions & 17 deletions internal/operator-controller/catalogmetadata/client/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"github.com/operator-framework/operator-registry/alpha/declcfg"

ocv1 "github.com/operator-framework/operator-controller/api/v1"
catalogClient "github.com/operator-framework/operator-controller/internal/operator-controller/catalogmetadata/client"
catalogclient "github.com/operator-framework/operator-controller/internal/operator-controller/catalogmetadata/client"
mockcatalogclient "github.com/operator-framework/operator-controller/internal/testutil/mock/catalogclient"
mockhttputil "github.com/operator-framework/operator-controller/internal/testutil/mock/httputil"
)
Expand Down Expand Up @@ -47,7 +47,7 @@ func TestClientGetPackage(t *testing.T) {
name string
catalog func() *ocv1.ClusterCatalog
pkgName string
setupCache func(ctrl *gomock.Controller) catalogClient.Cache
setupCache func(ctrl *gomock.Controller) catalogclient.Cache
assert func(*testing.T, *declcfg.DeclarativeConfig, error)
}
for _, tc := range []testCase{
Expand All @@ -63,7 +63,7 @@ func TestClientGetPackage(t *testing.T) {
{
name: "served, cache returns error",
catalog: defaultCatalog,
setupCache: func(ctrl *gomock.Controller) catalogClient.Cache {
setupCache: func(ctrl *gomock.Controller) catalogclient.Cache {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Get(gomock.Any(), gomock.Any()).Return(nil, errors.New("fetch error"))
return cache
Expand All @@ -75,7 +75,7 @@ func TestClientGetPackage(t *testing.T) {
{
name: "served, invalid package path",
catalog: defaultCatalog,
setupCache: func(ctrl *gomock.Controller) catalogClient.Cache {
setupCache: func(ctrl *gomock.Controller) catalogclient.Cache {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Get(gomock.Any(), gomock.Any()).Return(testFS, nil)
return cache
Expand All @@ -89,7 +89,7 @@ func TestClientGetPackage(t *testing.T) {
name: "served, package missing",
catalog: defaultCatalog,
pkgName: "pkg-missing",
setupCache: func(ctrl *gomock.Controller) catalogClient.Cache {
setupCache: func(ctrl *gomock.Controller) catalogclient.Cache {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Get(gomock.Any(), gomock.Any()).Return(testFS, nil)
return cache
Expand All @@ -103,7 +103,7 @@ func TestClientGetPackage(t *testing.T) {
name: "served, invalid package present",
catalog: defaultCatalog,
pkgName: "invalid-pkg-present",
setupCache: func(ctrl *gomock.Controller) catalogClient.Cache {
setupCache: func(ctrl *gomock.Controller) catalogclient.Cache {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Get(gomock.Any(), gomock.Any()).Return(fstest.MapFS{
"invalid-pkg-present/olm.package/invalid-pkg-present.json": &fstest.MapFile{Data: []byte(`{"schema": "olm.package","name": 12345}`)},
Expand All @@ -119,7 +119,7 @@ func TestClientGetPackage(t *testing.T) {
name: "served, package present",
catalog: defaultCatalog,
pkgName: "pkg-present",
setupCache: func(ctrl *gomock.Controller) catalogClient.Cache {
setupCache: func(ctrl *gomock.Controller) catalogclient.Cache {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Get(gomock.Any(), gomock.Any()).Return(testFS, nil)
return cache
Expand All @@ -133,7 +133,7 @@ func TestClientGetPackage(t *testing.T) {
name: "cache unpopulated",
catalog: defaultCatalog,
pkgName: "pkg-present",
setupCache: func(ctrl *gomock.Controller) catalogClient.Cache {
setupCache: func(ctrl *gomock.Controller) catalogclient.Cache {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Get(gomock.Any(), gomock.Any()).Return(nil, nil)
return cache
Expand All @@ -147,13 +147,13 @@ func TestClientGetPackage(t *testing.T) {
ctx := context.Background()
ctrl := gomock.NewController(t)

var cache catalogClient.Cache
var cache catalogclient.Cache
if tc.setupCache != nil {
cache = tc.setupCache(ctrl)
}

mockTripper := mockhttputil.NewMockRoundTripper(ctrl)
c := catalogClient.New(cache, func() (*http.Client, error) {
c := catalogclient.New(cache, func() (*http.Client, error) {
return &http.Client{
// This is to prevent actual network calls
Transport: mockTripper,
Expand All @@ -173,14 +173,14 @@ func TestClientPopulateCache(t *testing.T) {
type testCase struct {
name string
catalog func() *ocv1.ClusterCatalog
setupMocks func(t *testing.T, ctrl *gomock.Controller) (catalogClient.Cache, func() (*http.Client, error))
setupMocks func(t *testing.T, ctrl *gomock.Controller) (catalogclient.Cache, func() (*http.Client, error))
assert func(t *testing.T, fs fs.FS, err error)
}
for _, tt := range []testCase{
{
name: "cache unpopulated, successful http request",
catalog: defaultCatalog,
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogClient.Cache, func() (*http.Client, error)) {
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogclient.Cache, func() (*http.Client, error)) {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Put(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).DoAndReturn(
func(catalogName, resolvedRef string, source io.Reader, errToCache error) (fs.FS, error) {
Expand Down Expand Up @@ -215,7 +215,7 @@ func TestClientPopulateCache(t *testing.T) {
catalog: func() *ocv1.ClusterCatalog {
return &ocv1.ClusterCatalog{ObjectMeta: metav1.ObjectMeta{Name: "catalog-1"}}
},
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogClient.Cache, func() (*http.Client, error)) {
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogclient.Cache, func() (*http.Client, error)) {
cache := mockcatalogclient.NewMockCache(ctrl)
return cache, nil
},
Expand All @@ -227,7 +227,7 @@ func TestClientPopulateCache(t *testing.T) {
{
name: "cache unpopulated, error on getting a http client",
catalog: defaultCatalog,
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogClient.Cache, func() (*http.Client, error)) {
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogclient.Cache, func() (*http.Client, error)) {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Put(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).DoAndReturn(
func(catalogName, resolvedRef string, source io.Reader, errToCache error) (fs.FS, error) {
Expand All @@ -250,7 +250,7 @@ func TestClientPopulateCache(t *testing.T) {
{
name: "cache unpopulated, error on http request",
catalog: defaultCatalog,
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogClient.Cache, func() (*http.Client, error)) {
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogclient.Cache, func() (*http.Client, error)) {
cache := mockcatalogclient.NewMockCache(ctrl)
cache.EXPECT().Put(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).DoAndReturn(
func(catalogName, resolvedRef string, source io.Reader, errToCache error) (fs.FS, error) {
Expand All @@ -276,7 +276,7 @@ func TestClientPopulateCache(t *testing.T) {
{
name: "cache unpopulated, unexpected http status",
catalog: defaultCatalog,
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogClient.Cache, func() (*http.Client, error)) {
setupMocks: func(t *testing.T, ctrl *gomock.Controller) (catalogclient.Cache, func() (*http.Client, error)) {
cache := mockcatalogclient.NewMockCache(ctrl)

mockTripper := mockhttputil.NewMockRoundTripper(ctrl)
Expand All @@ -301,7 +301,7 @@ func TestClientPopulateCache(t *testing.T) {
ctrl := gomock.NewController(t)

cache, httpClient := tt.setupMocks(t, ctrl)
c := catalogClient.New(cache, httpClient)
c := catalogclient.New(cache, httpClient)
fs, err := c.PopulateCache(ctx, tt.catalog())
tt.assert(t, fs, err)
})
Expand Down
5 changes: 3 additions & 2 deletions internal/shared/util/http/httputil.go → ...roller/catalogmetadata/client/httputil.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
package http
package client

import (
"crypto/tls"
"fmt"
"net/http"
"time"

httputil "github.com/operator-framework/operator-controller/internal/shared/util/http"
"github.com/operator-framework/operator-controller/internal/shared/util/tlsprofiles"
)

func BuildHTTPClient(cpw *CertPoolWatcher) (*http.Client, error) {
func BuildHTTPClient(cpw *httputil.CertPoolWatcher) (*http.Client, error) {
httpClient := &http.Client{Timeout: 10 * time.Second}

pool, _, err := cpw.Get()
Expand Down
11 changes: 6 additions & 5 deletions internal/shared/util/http/httputil_test.go → ...r/catalogmetadata/client/httputil_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package http_test
package client_test

import (
"context"
Expand All @@ -19,6 +19,7 @@ import (
"github.com/stretchr/testify/require"
"sigs.k8s.io/controller-runtime/pkg/log"

catalogclient "github.com/operator-framework/operator-controller/internal/operator-controller/catalogmetadata/client"
httputil "github.com/operator-framework/operator-controller/internal/shared/util/http"
"github.com/operator-framework/operator-controller/internal/shared/util/tlsprofiles"
)
Expand Down Expand Up @@ -114,7 +115,7 @@ func TestBuildHTTPClientTransportUsesProxyFromEnvironment(t *testing.T) {
t.Cleanup(cpw.Done)
require.NoError(t, cpw.Start(context.Background()))

client, err := httputil.BuildHTTPClient(cpw)
client, err := catalogclient.BuildHTTPClient(cpw)
require.NoError(t, err)

transport, ok := client.Transport.(*http.Transport)
Expand Down Expand Up @@ -150,7 +151,7 @@ func TestBuildHTTPClientProxyTunnelsConnections(t *testing.T) {
require.NoError(t, err)

cpw := certPoolWatcherForTLSServer(t, targetServer)
client, err := httputil.BuildHTTPClient(cpw)
client, err := catalogclient.BuildHTTPClient(cpw)
require.NoError(t, err)

// Point the transport directly at our test proxy, bypassing the loopback
Expand Down Expand Up @@ -191,7 +192,7 @@ func TestBuildHTTPClientAppliesTLSProfile(t *testing.T) {
t.Cleanup(cpw.Done)
require.NoError(t, cpw.Start(context.Background()))

client, err := httputil.BuildHTTPClient(cpw)
client, err := catalogclient.BuildHTTPClient(cpw)
require.NoError(t, err)

transport, ok := client.Transport.(*http.Transport)
Expand Down Expand Up @@ -223,7 +224,7 @@ func TestBuildHTTPClientProxyBlocksWhenRejected(t *testing.T) {
require.NoError(t, err)

cpw := certPoolWatcherForTLSServer(t, targetServer)
client, err := httputil.BuildHTTPClient(cpw)
client, err := catalogclient.BuildHTTPClient(cpw)
require.NoError(t, err)

transport, ok := client.Transport.(*http.Transport)
Expand Down
Loading