Skip to content

OCPBUGS-3541: Don't create route metrics for ingress controllers that are not admitted #869

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-robot merged 2 commits into from
Sep 26, 2023
Merged

OCPBUGS-3541: Don't create route metrics for ingress controllers that are not admitted #869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1311288
OCPBUGS-3541: Don't create route_metrics_controiller_routes_per_shard…
gcs278 Dec 13, 2022
7ee37ab
OCPBUGS-1689: Add unit test for the route-metrics controller reconcil…
gcs278 Dec 15, 2022
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
6 changes: 6 additions & 0 deletions pkg/operator/controller/route-metrics/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
operatorv1 "github.com/openshift/api/operator/v1"
routev1 "github.com/openshift/api/route/v1"
logf "github.com/openshift/cluster-ingress-operator/pkg/log"
"github.com/openshift/cluster-ingress-operator/pkg/util/ingresscontroller"
"golang.org/x/time/rate"

corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -173,6 +174,11 @@ func (r *reconciler) Reconcile(ctx context.Context, request reconcile.Request) (
return reconcile.Result{}, nil
}

// If the Ingress Controller is not admitted, don't provide metrics for it.
if !ingresscontroller.IsAdmitted(ingressController) {
return reconcile.Result{}, nil
}

// NOTE: Even though the route admitted status should reflect validity of the namespace and route labelselectors, we still will validate
// the namespace and route labels as there are still edge scenarios where the route status may be inaccurate.

Expand Down
351 changes: 351 additions & 0 deletions pkg/operator/controller/route-metrics/controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,328 @@
package routemetrics

import (
"context"
"fmt"
"strings"
"testing"

operatorcontroller "github.com/openshift/cluster-ingress-operator/pkg/operator/controller"
"github.com/openshift/cluster-ingress-operator/test/unit"

"github.com/openshift/api/operator"
v1 "github.com/openshift/api/operator/v1"
routev1 "github.com/openshift/api/route/v1"

corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/kubernetes/scheme"

"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/cache/informertest"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"sigs.k8s.io/controller-runtime/pkg/reconcile"

"github.com/prometheus/client_golang/prometheus/testutil"
)

// Test_Reconcile verifies Reconcile
// Note: This is intended to be a generic unit test. Edge cases will be tested in unit tests for specific functions.
func Test_Reconcile(t *testing.T) {
reconcileRequest := reconcile.Request{NamespacedName: types.NamespacedName{Name: "foo-ic", Namespace: "openshift-ingress-operator"}}
testCases := []struct {
name string
request reconcile.Request
initObjs []client.Object
ingressController *v1.IngressController
routes routev1.RouteList
expectedMetricFormat string
}{
{
name: "ingress controller doesn't exist",
request: reconcileRequest,
},
{
name: "ingress controller is being deleted",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
IsDeleting().
WithAdmitted(false).
Build(),
},
request: reconcileRequest,
},
{
name: "ingress controller is not admitted",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(false).
Build(),
},
request: reconcileRequest,
},
{
name: "ingress controller is admitted with no routes admitted",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 0),
},
{
name: "ingress controller is admitted with a route admitted",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 1),
},
{
name: "ingress controller with routeSelector and with no namespaceSelector with 2 routes with correct labels in namespace with no labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithRouteSelector("type", "shard").
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
WithLabel("type", "shard").
Build(),
unit.NewRouteBuilder().
WithName("bar-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
WithLabel("type", "shard").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 2),
},
{
name: "ingress controller with no routeSelector and with namespaceSelector with route with no labels in namespace with correct labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithNamespaceSelector("type", "shard").
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
WithLabel("type", "shard").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 1),
},
{
name: "ingress controller with expression routeSelector and with no namespaceSelector with route with correct labels in namespace with no labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithRouteExpressionSelector("type", metav1.LabelSelectorOpIn, []string{"shard"}).
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
WithLabel("type", "shard").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 1),
},
{
name: "ingress controller with no routeSelector and with expression namespaceSelector with route with no labels in namespace with correct labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithNamespaceExpressionSelector("type", metav1.LabelSelectorOpIn, []string{"shard"}).
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
WithLabel("type", "shard").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 1),
},
{
name: "ingress controller with routeSelector and with namespaceSelector with route with correct labels in namespace with correct labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithRouteSelector("type", "shard").
WithNamespaceSelector("type", "shard").
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
WithLabel("type", "shard").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
WithLabel("type", "shard").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 1),
},
{
name: "ingress controller with routeSelector and with no namespaceSelector with route with incorrect labels in namespace with no labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithRouteSelector("type", "shard").
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
WithLabel("type", "not-shard").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 0),
},
{
name: "ingress controller with no routeSelector and with namespaceSelector with route with no labels in namespace with incorrect labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithNamespaceSelector("type", "shard").
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
WithLabel("type", "not-shard").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 0),
},
{
name: "ingress controller with routeSelector and with namespaceSelector with route with correct labels in namespace with incorrect labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithRouteSelector("type", "shard").
WithNamespaceSelector("type", "shard").
Build(),
unit.NewRouteBuilder().
WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
WithLabel("type", "shard").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
WithLabel("type", "not-shard").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 0),
},
{
name: "ingress controller with expression routeSelector and with expression namespaceSelector with route with correct labels in namespace with correct labels",
initObjs: []client.Object{
unit.NewIngressControllerBuilder().
WithName("foo-ic").
WithAdmitted(true).
WithRouteExpressionSelector("type", metav1.LabelSelectorOpIn, []string{"shard"}).
WithNamespaceExpressionSelector("type", metav1.LabelSelectorOpIn, []string{"shard"}).
Build(),
unit.NewRouteBuilder().WithName("foo-route").
WithNamespace("foo-ns").
WithAdmittedICs("foo-ic").
WithLabel("type", "shard").
Build(),
unit.NewNamespaceBuilder().
WithName("foo-ns").
WithLabel("type", "shard").
Build(),
},
request: reconcileRequest,
expectedMetricFormat: routePerShardMetric("foo-ic", 1),
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
err, _, cache := newFakeClient(tc.initObjs...)
if err != nil {
t.Fatalf("error creating fake client: %v", err)
}
r := reconciler{
cache: cache,
routeToIngresses: make(map[types.NamespacedName]sets.String),
namespace: operatorcontroller.DefaultOperatorNamespace,
}

// Cleanup the routes per shard metrics.
routeMetricsControllerRoutesPerShard.Reset()

if _, err := r.Reconcile(context.Background(), tc.request); err != nil {
t.Errorf("got unexpected error: %v", err)
} else {
err := testutil.CollectAndCompare(routeMetricsControllerRoutesPerShard, strings.NewReader(tc.expectedMetricFormat))
if err != nil {
t.Error(err)
}
}
})
}
}

// Test_routeStatusAdmitted verifies that routeStatusAdmitted behaves correctly.
func Test_routeStatusAdmitted(t *testing.T) {
testCases := []struct {
Expand Down Expand Up @@ -109,3 +425,38 @@ func Test_routeStatusAdmitted(t *testing.T) {
})
}
}

type fakeCache struct {
cache.Informers
client.Reader
}

// newFakeClient builds a fake client and cache for testing.
func newFakeClient(initObjs ...client.Object) (error, client.Client, cache.Cache) {
// Create fake client
clientBuilder := fake.NewClientBuilder()
s := scheme.Scheme
if err := routev1.Install(s); err != nil {
return err, nil, nil
}
if err := operator.Install(s); err != nil {
return err, nil, nil
}
client := clientBuilder.WithScheme(s).WithObjects(initObjs...).Build()
informer := informertest.FakeInformers{
Scheme: client.Scheme(),
}
// Create fake cache
cache := fakeCache{Informers: &informer, Reader: client}

return nil, client, cache
}

// routePerShardMetric returns a formatted Prometheus string for comparison
func routePerShardMetric(icName string, routesAdmitted int) string {
return fmt.Sprintf(`
# HELP route_metrics_controller_routes_per_shard Report the number of routes for shards (ingress controllers).
# TYPE route_metrics_controller_routes_per_shard gauge
route_metrics_controller_routes_per_shard{shard_name="%s"} %d
`, icName, routesAdmitted)
}
Loading