Skip to content

Commit eab6d9f

Browse files
miledxzlucacome
authored andcommitted
move ks client reader to separated directory (#3018)
Problem: Adding update of ks client Reader interface and FakeReader into separated directory. Solution: Moved files, updated import paths.
1 parent ec5d7aa commit eab6d9f

File tree

5 files changed

+27
-20
lines changed

5 files changed

+27
-20
lines changed

internal/framework/events/first_eventbatch_preparer.go

+4-11
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ import (
99
"k8s.io/apimachinery/pkg/runtime"
1010
"k8s.io/apimachinery/pkg/types"
1111
"sigs.k8s.io/controller-runtime/pkg/client"
12+
13+
"github.com/nginx/nginx-gateway-fabric/internal/framework/kubernetes"
1214
)
1315

1416
//counterfeiter:generate . FirstEventBatchPreparer
@@ -20,22 +22,13 @@ type FirstEventBatchPreparer interface {
2022
Prepare(ctx context.Context) (EventBatch, error)
2123
}
2224

23-
//counterfeiter:generate . Reader
24-
25-
// Reader allows getting and listing resources from a cache.
26-
// This interface is introduced for testing to mock the methods from
27-
// sigs.k8s.io/controller-runtime/pkg/client.Reader.
28-
type Reader interface {
29-
client.Reader
30-
}
31-
3225
// EachListItemFunc lists each item of a client.ObjectList.
3326
// It is from k8s.io/apimachinery/pkg/api/meta.
3427
type EachListItemFunc func(obj runtime.Object, fn func(runtime.Object) error) error
3528

3629
// FirstEventBatchPreparerImpl is an implementation of FirstEventBatchPreparer.
3730
type FirstEventBatchPreparerImpl struct {
38-
reader Reader
31+
reader kubernetes.Reader
3932
eachListItem EachListItemFunc
4033
objects []client.Object
4134
objectLists []client.ObjectList
@@ -48,7 +41,7 @@ type FirstEventBatchPreparerImpl struct {
4841
// For each list from objectLists, FirstEventBatchPreparerImpl will list the resources of the corresponding type from
4942
// the reader.
5043
func NewFirstEventBatchPreparerImpl(
51-
reader Reader,
44+
reader kubernetes.Reader,
5245
objects []client.Object,
5346
objectLists []client.ObjectList,
5447
) *FirstEventBatchPreparerImpl {

internal/framework/events/first_eventbatch_preparer_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ import (
1717
v1 "sigs.k8s.io/gateway-api/apis/v1"
1818

1919
"github.com/nginx/nginx-gateway-fabric/internal/framework/events"
20-
"github.com/nginx/nginx-gateway-fabric/internal/framework/events/eventsfakes"
20+
"github.com/nginx/nginx-gateway-fabric/internal/framework/kubernetes/kubernetesfakes"
2121
)
2222

2323
var _ = Describe("FirstEventBatchPreparer", func() {
2424
var (
25-
fakeReader *eventsfakes.FakeReader
25+
fakeReader *kubernetesfakes.FakeReader
2626
preparer *events.FirstEventBatchPreparerImpl
2727
)
2828

2929
const gcName = "my-class"
3030

3131
BeforeEach(func() {
32-
fakeReader = &eventsfakes.FakeReader{}
32+
fakeReader = &kubernetesfakes.FakeReader{}
3333
preparer = events.NewFirstEventBatchPreparerImpl(
3434
fakeReader,
3535
[]client.Object{&v1.GatewayClass{ObjectMeta: metav1.ObjectMeta{Name: gcName}}},
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
package kubernetes
2+
3+
import "sigs.k8s.io/controller-runtime/pkg/client"
4+
5+
//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
6+
7+
//counterfeiter:generate . Reader
8+
9+
// Reader allows getting and listing resources from a cache.
10+
// This interface is introduced for testing to mock the methods from
11+
// sigs.k8s.io/controller-runtime/pkg/client.Reader.
12+
type Reader interface {
13+
client.Reader
14+
}

internal/framework/events/eventsfakes/fake_reader.go renamed to internal/framework/kubernetes/kubernetesfakes/fake_reader.go

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

internal/mode/static/telemetry/collector_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ import (
1818
gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
1919

2020
ngfAPI "github.com/nginx/nginx-gateway-fabric/apis/v1alpha1"
21-
"github.com/nginx/nginx-gateway-fabric/internal/framework/events/eventsfakes"
2221
"github.com/nginx/nginx-gateway-fabric/internal/framework/kinds"
22+
"github.com/nginx/nginx-gateway-fabric/internal/framework/kubernetes/kubernetesfakes"
2323
"github.com/nginx/nginx-gateway-fabric/internal/mode/static/config"
2424
"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/dataplane"
2525
"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/graph"
@@ -73,7 +73,7 @@ func createGetCallsFunc(objects ...client.Object) getCallsFunc {
7373

7474
var _ = Describe("Collector", Ordered, func() {
7575
var (
76-
k8sClientReader *eventsfakes.FakeReader
76+
k8sClientReader *kubernetesfakes.FakeReader
7777
fakeGraphGetter *telemetryfakes.FakeGraphGetter
7878
fakeConfigurationGetter *telemetryfakes.FakeConfigurationGetter
7979
dataCollector telemetry.DataCollector
@@ -178,7 +178,7 @@ var _ = Describe("Collector", Ordered, func() {
178178
SnippetsFiltersDirectivesCount: []int64{},
179179
}
180180

181-
k8sClientReader = &eventsfakes.FakeReader{}
181+
k8sClientReader = &kubernetesfakes.FakeReader{}
182182
fakeGraphGetter = &telemetryfakes.FakeGraphGetter{}
183183
fakeConfigurationGetter = &telemetryfakes.FakeConfigurationGetter{}
184184

0 commit comments

Comments
 (0)