Merge branch 'main' into renovate/kubernetes-go

beeme1mr · web-flow · commit 5b612aa4f841 · 2022-11-11T21:39:28.000-05:00
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.2.17"
+  ".": "0.2.18"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.2.18](https://github.com/open-feature/open-feature-operator/compare/v0.2.17...v0.2.18) (2022-11-10)
+
+
+### Bug Fixes
+
+* nil pointer dereference ([#216](https://github.com/open-feature/open-feature-operator/issues/216)) ([d975066](https://github.com/open-feature/open-feature-operator/commit/d975066f96a5f9caf8af8d513076480a33943257))
+
 ## [0.2.17](https://github.com/open-feature/open-feature-operator/compare/v0.2.16...v0.2.17) (2022-11-07)
 
 
diff --git a/Makefile b/Makefile
@@ -5,8 +5,7 @@ IMG ?= controller:latest
 KUSTOMIZE_OVERLAY ?= DEFAULT
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 FLAGD_VERSION=v0.2.5
-CHART_VERSION=v0.2.17# x-release-please-version
-CHART_VERSION=v0.2.17# x-release-please-version
+CHART_VERSION=v0.2.18# x-release-please-version
 ENVTEST_K8S_VERSION = 1.23
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
@@ -181,7 +180,7 @@ set-helm-overlay:
 	${eval KUSTOMIZE_OVERLAY = HELM}
 
 helm-package: set-helm-overlay generate release-manifests helm
-	$(HELM) package --version $(CHART_VERSION) chart 
+	$(HELM) package --version $(CHART_VERSION) chart
 	mkdir -p charts && mv ofo-*.tgz charts
 	$(HELM) repo index --url https://open-feature.github.io/open-feature-operator/charts charts
 	mv charts/index.yaml index.yaml
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ helm install ofo openfeature/ofo
 
 ```
 kubectl create namespace open-feature-operator-system
-kubectl apply -f https://github.com/open-feature/open-feature-operator/releases/download/v0.2.17/release.yaml
+kubectl apply -f https://github.com/open-feature/open-feature-operator/releases/download/v0.2.18/release.yaml
 ```
 
 <!---x-release-please-end-->
@@ -162,11 +162,17 @@ root@nginx:/# curl -X POST "localhost:8013/schema.v1.Service/ResolveString" -d '
 
 #### Run the example
 
-1. Apply the end-to-end example: `kubectl -n open-feature-operator-system apply -f config/samples/end-to-end.yaml`
+1. Apply the end-to-end example: `kubectl apply -f config/samples/end-to-end.yaml`
 1. Visit `http://localhost:30000/`
 1. Update the value of the `defaultVariant` field in the custom resource instance in `config/samples/end-to-end.yaml` and re-apply to update the flag value!
 1. Visit `http://localhost:30000/` and see the change!
 
+## Testing
+
+Run `make test` to run the test suite. The controller integration tests use [envtest](https://book.kubebuilder.io/reference/envtest.html), this sets up and starts an instance of etcd and the Kubernetes API server, without kubelet, controller-manager or other components.
+This provides means of asserting that the Kubernetes components reach the desired state without the overhead of using an actual cluster, keeping
+test runtime and resource consumption down.
+
 ## Releases
 
 This repo uses _Release Please_ to release packages. Release Please sets up a running PR that tracks all changes for the library components, and maintains the versions according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), generated when [PRs are merged](https://github.com/amannn/action-semantic-pull-request). When Release Please's running PR is merged, any changed artifacts are published.
diff --git a/apis/core/v1alpha1/featureflagconfiguration_types.go b/apis/core/v1alpha1/featureflagconfiguration_types.go
@@ -43,6 +43,8 @@ type FeatureFlagConfigurationSpec struct {
 }
 
 type FlagDSpec struct {
+	// +optional
+	MetricsPort int32 `json:"metricsPort"`
 	// +optional
 	Envs []corev1.EnvVar `json:"envs"`
 }
diff --git a/apis/core/v1alpha1/groupversion_info.go b/apis/core/v1alpha1/groupversion_info.go
@@ -15,8 +15,8 @@ limitations under the License.
 */
 
 // Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group
-//+kubebuilder:object:generate=true
-//+groupName=core.openfeature.dev
+// +kubebuilder:object:generate=true
+// +groupName=core.openfeature.dev
 package v1alpha1
 
 import (
diff --git a/chart/Chart.yaml b/chart/Chart.yaml
@@ -18,4 +18,4 @@ version: 0.1.0
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "v0.2.17" # x-release-please-version
+appVersion: "v0.2.18" # x-release-please-version
diff --git a/chart/templates/rendered.yaml b/chart/templates/rendered.yaml
@@ -152,6 +152,9 @@ spec:
                       - name
                       type: object
                     type: array
+                  metricsPort:
+                    format: int32
+                    type: integer
                 type: object
               serviceProvider:
                 description: 'INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
diff --git a/chart/values.yaml b/chart/values.yaml
@@ -15,7 +15,7 @@ controllerManager:
   manager:
     image:
       repository: ghcr.io/open-feature/open-feature-operator
-      tag: v0.2.17 # x-release-please-version
+      tag: v0.2.18 # x-release-please-version
     resources:
       limits:
         cpu: 500m
diff --git a/config/crd/bases/core.openfeature.dev_featureflagconfigurations.yaml b/config/crd/bases/core.openfeature.dev_featureflagconfigurations.yaml
@@ -153,6 +153,9 @@ spec:
                       - name
                       type: object
                     type: array
+                  metricsPort:
+                    format: int32
+                    type: integer
                 type: object
               serviceProvider:
                 description: 'INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
diff --git a/config/manager/manager.yaml b/config/manager/manager.yaml
@@ -36,7 +36,7 @@ spec:
         name: manager
         env:
         - name: FLAGD_VERSION
-          value: INPUT_FLAGD_VERSION
+          value: v0.2.5
         securityContext:
           allowPrivilegeEscalation: false
         livenessProbe:
diff --git a/go.sum b/go.sum
@@ -712,8 +712,6 @@ golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su
 golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/net v0.0.0-20220425223048-2871e0cb64e4/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
-golang.org/x/net v0.0.0-20220826154423-83b083e8dc8b h1:ZmngSVLe/wycRns9MKikG9OWIEjGcGAkacif7oYQaUY=
-golang.org/x/net v0.0.0-20220826154423-83b083e8dc8b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
 golang.org/x/net v0.0.0-20220906165146-f3363e06e74c h1:yKufUcDwucU5urd+50/Opbt4AYpqthk7wHpHok8f1lo=
 golang.org/x/net v0.0.0-20220906165146-f3363e06e74c/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
@@ -845,7 +843,6 @@ golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.3.8 h1:nAL+RVCQ9uMn3vJZbV+MRnydTJFPf8qqY42YiA6MrqY=
 golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ=
diff --git a/webhooks/featureflagconfiguration_webhook.go b/webhooks/featureflagconfiguration_webhook.go
@@ -30,7 +30,7 @@ type FeatureFlagConfigurationValidator struct {
 	Log     logr.Logger
 }
 
-// FeatureFlagConfigurationValidator adds an annotation to every incoming pods.
+// Handle validates a FeatureFlagConfiguration
 func (m *FeatureFlagConfigurationValidator) Handle(ctx context.Context, req admission.Request) admission.Response {
 	config := corev1alpha1.FeatureFlagConfiguration{}
 	err := m.decoder.Decode(req, &config)
diff --git a/webhooks/featureflagconfiguration_webhook_test.go b/webhooks/featureflagconfiguration_webhook_test.go
@@ -0,0 +1,129 @@
+package webhooks
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	corev1alpha1 "github.com/open-feature/open-feature-operator/apis/core/v1alpha1"
+	corev1 "k8s.io/api/core/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+const (
+	featureFlagConfigurationNamespace = "test-validate-featureflagconfiguration"
+)
+
+var (
+	featureFlagSpec = `
+	{
+      "flags": {
+        "new-welcome-message": {
+          "state": "ENABLED",
+          "variants": {
+            "on": true,
+            "off": false
+          },
+          "defaultVariant": "on"
+		}
+      }
+    }
+	`
+)
+
+func setupValidateFeatureFlagConfigurationResources() {
+	ns := &corev1.Namespace{}
+	ns.Name = featureFlagConfigurationNamespace
+	err := k8sClient.Create(testCtx, ns)
+	Expect(err).ShouldNot(HaveOccurred())
+}
+
+func featureflagconfigurationCleanup() {
+	ffConfig := &corev1alpha1.FeatureFlagConfiguration{}
+	ffConfig.Namespace = featureFlagConfigurationNamespace
+	ffConfig.Name = featureFlagConfigurationName
+	err := k8sClient.Delete(testCtx, ffConfig, client.GracePeriodSeconds(0))
+	Expect(err).ShouldNot(HaveOccurred())
+}
+
+var _ = Describe("featureflagconfiguration validation webhook", func() {
+	It("should pass when featureflagspec contains valid json", func() {
+		ffConfig := &corev1alpha1.FeatureFlagConfiguration{}
+		ffConfig.Namespace = featureFlagConfigurationNamespace
+		ffConfig.Name = featureFlagConfigurationName
+		ffConfig.Spec.FeatureFlagSpec = featureFlagSpec
+		err := k8sClient.Create(testCtx, ffConfig)
+		Expect(err).ShouldNot(HaveOccurred())
+
+		featureflagconfigurationCleanup()
+	})
+
+	It("should fail when featureflagspec contains invalid json", func() {
+		ffConfig := &corev1alpha1.FeatureFlagConfiguration{}
+		ffConfig.Namespace = featureFlagConfigurationNamespace
+		ffConfig.Name = featureFlagConfigurationName
+		ffConfig.Spec.FeatureFlagSpec = `{"invalid":json}`
+		err := k8sClient.Create(testCtx, ffConfig)
+		Expect(err).Should(HaveOccurred())
+	})
+
+	It("should fail when featureflagspec doesn't conform to the schema", func() {
+		ffConfig := &corev1alpha1.FeatureFlagConfiguration{}
+		ffConfig.Namespace = featureFlagConfigurationNamespace
+		ffConfig.Name = featureFlagConfigurationName
+		ffConfig.Spec.FeatureFlagSpec = `
+			{
+				"flags":{
+					"foo": {}
+				}
+			}
+		`
+		err := k8sClient.Create(testCtx, ffConfig)
+		Expect(err).Should(HaveOccurred())
+	})
+
+	It("should check for existence of provider secret when service provider is given", func() {
+		const credentialsName = "credentials-name"
+		providerKeySecret := &corev1.Secret{}
+		providerKeySecret.Name = credentialsName
+		providerKeySecret.Namespace = featureFlagConfigurationNamespace
+		err := k8sClient.Create(testCtx, providerKeySecret)
+		Expect(err).ShouldNot(HaveOccurred())
+
+		ffConfig := &corev1alpha1.FeatureFlagConfiguration{}
+		ffConfig.Namespace = featureFlagConfigurationNamespace
+		ffConfig.Name = featureFlagConfigurationName
+		ffConfig.Spec.FeatureFlagSpec = featureFlagSpec
+		ffConfig.Spec.ServiceProvider = &corev1alpha1.FeatureFlagServiceProvider{
+			Name: "flagd",
+			Credentials: &corev1.ObjectReference{
+				Name:      credentialsName,
+				Namespace: featureFlagConfigurationNamespace,
+			},
+		}
+		err = k8sClient.Create(testCtx, ffConfig)
+		Expect(err).ShouldNot(HaveOccurred())
+
+		featureflagconfigurationCleanup()
+
+		// cleanup secret
+		err = k8sClient.Delete(testCtx, providerKeySecret)
+		Expect(err).ShouldNot(HaveOccurred())
+	})
+
+	It("should fail if provider secret doesn't exist when service provider is given", func() {
+		const credentialsName = "credentials-name"
+
+		ffConfig := &corev1alpha1.FeatureFlagConfiguration{}
+		ffConfig.Namespace = featureFlagConfigurationNamespace
+		ffConfig.Name = featureFlagConfigurationName
+		ffConfig.Spec.FeatureFlagSpec = featureFlagSpec
+		ffConfig.Spec.ServiceProvider = &corev1alpha1.FeatureFlagServiceProvider{
+			Name: "flagd",
+			Credentials: &corev1.ObjectReference{
+				Name:      credentialsName,
+				Namespace: featureFlagConfigurationNamespace,
+			},
+		}
+		err := k8sClient.Create(testCtx, ffConfig)
+		Expect(err).Should(HaveOccurred())
+	})
+})
diff --git a/webhooks/pod_webhook.go b/webhooks/pod_webhook.go
@@ -20,11 +20,13 @@ import (
 
 // we likely want these to be configurable, eventually
 const (
-	FlagDImagePullPolicy   = "Always"
-	clusterRoleBindingName = "open-feature-operator-flagd-kubernetes-sync"
+	FlagDImagePullPolicy   corev1.PullPolicy = "Always"
+	clusterRoleBindingName string            = "open-feature-operator-flagd-kubernetes-sync"
+	flagdMetricPortEnvVar  string            = "FLAGD_METRICS_PORT"
 )
 
 var FlagDTag = "main"
+var flagdMetricsPort int32 = 8014
 
 // NOTE: RBAC not needed here.
 
@@ -41,8 +43,14 @@ type PodMutator struct {
 	Log     logr.Logger
 }
 
-// PodMutator adds an annotation to every incoming pods.
+// Handle injects the flagd sidecar (if the prerequisites are all met)
 func (m *PodMutator) Handle(ctx context.Context, req admission.Request) admission.Response {
+	defer func() {
+		if err := recover(); err != nil {
+			admission.Errored(http.StatusInternalServerError, fmt.Errorf("%v", err))
+		}
+	}()
+
 	pod := &corev1.Pod{}
 	err := m.decoder.Decode(req, pod)
 	if err != nil {
@@ -249,9 +257,17 @@ func (m *PodMutator) injectSidecar(pod *corev1.Pod, configMap string, featureFla
 
 	var envs []corev1.EnvVar
 	if featureFlag.Spec.FlagDSpec != nil {
+		if featureFlag.Spec.FlagDSpec.MetricsPort != 0 {
+			flagdMetricsPort = featureFlag.Spec.FlagDSpec.MetricsPort
+		}
 		envs = featureFlag.Spec.FlagDSpec.Envs
 	}
 
+	envs = append(envs, corev1.EnvVar{
+		Name:  flagdMetricPortEnvVar,
+		Value: fmt.Sprintf("%d", flagdMetricsPort),
+	})
+
 	for i := 0; i < len(pod.Spec.Containers); i++ {
 		cntr := pod.Spec.Containers[i]
 		cntr.Env = append(cntr.Env, envs...)
@@ -268,7 +284,7 @@ func (m *PodMutator) injectSidecar(pod *corev1.Pod, configMap string, featureFla
 		Ports: []corev1.ContainerPort{
 			{
 				Name:          "metrics",
-				ContainerPort: 8014,
+				ContainerPort: flagdMetricsPort,
 			},
 		},
 	})
diff --git a/webhooks/pod_webhook_test.go b/webhooks/pod_webhook_test.go
diff --git a/webhooks/run_test.go b/webhooks/run_test.go
diff --git a/webhooks/suite_test.go b/webhooks/suite_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "0.2.17"`
	`2`	`+ ".": "0.2.18"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,8 @@ type FeatureFlagConfigurationSpec struct {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`type FlagDSpec struct {`
	`46`	`+ // +optional`
	`47`	+ MetricsPort int32 `json:"metricsPort"`
`46`	`48`	`// +optional`
`47`	`49`	Envs []corev1.EnvVar `json:"envs"`
`48`	`50`	`}`