Add NATS URL in the NATS CR status (kyma-project#239)

* Add NATS URL in the NATS CR status

* Update tests

api/v1alpha1/nats_status.go

@@ -101,3 +101,13 @@ func (ns *NATSStatus) Initialize() {
 	ns.UpdateConditionStatefulSet(metav1.ConditionFalse, ConditionReasonProcessing, "")
 	ns.UpdateConditionAvailable(metav1.ConditionFalse, ConditionReasonProcessing, "")
 }
+
+// ClearURL clears the url.
+func (ns *NATSStatus) ClearURL() {
+	ns.URL = ""
+}
+
+// SetURL sets the url.
+func (ns *NATSStatus) SetURL(url string) {
+	ns.URL = url
+}

api/v1alpha1/nats_status_test.go

@@ -373,3 +373,42 @@ func Test_Initialize(t *testing.T) {
 		require.Equal(t, expectedAvailableCondition, availableCondition)
 	})
 }
+
+func Test_ClearURL(t *testing.T) {
+	t.Parallel()
+	t.Run("should clear the url", func(t *testing.T) {
+		t.Parallel()
+
+		// given
+		const givenURL = "some.url"
+		natsStatus := &NATSStatus{URL: givenURL}
+
+		// when
+		natsStatus.ClearURL()
+
+		// then
+		const wantURL = ""
+
+		require.NotEqual(t, wantURL, givenURL)
+		require.Equal(t, wantURL, natsStatus.URL)
+	})
+}
+
+func Test_SetURL(t *testing.T) {
+	t.Parallel()
+	t.Run("should set the url", func(t *testing.T) {
+		t.Parallel()
+
+		// given
+		const givenURL = ""
+		natsStatus := &NATSStatus{URL: givenURL}
+
+		// when
+		const wantURL = "some.url"
+		natsStatus.SetURL(wantURL)
+
+		// then
+		require.NotEqual(t, wantURL, givenURL)
+		require.Equal(t, wantURL, natsStatus.URL)
+	})
+}

api/v1alpha1/nats_types.go

@@ -90,6 +90,7 @@ type NATS struct {
 // NATSStatus defines the observed state of NATS.
 type NATSStatus struct {
 	State      string             `json:"state"`
+	URL        string             `json:"url,omitempty"`
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 

config/crd/bases/operator.kyma-project.io_nats.yaml

@@ -305,6 +305,8 @@ spec:
                 type: array
               state:
                 type: string
+              url:
+                type: string
             required:
             - state
             type: object

internal/controller/nats/deprovisioner.go

@@ -4,20 +4,20 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/kyma-project/nats-manager/pkg/events"
-
-	natsv1alpha1 "github.com/kyma-project/nats-manager/api/v1alpha1"
-	natspkg "github.com/kyma-project/nats-manager/pkg/nats"
 	"go.uber.org/zap"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	natsv1alpha1 "github.com/kyma-project/nats-manager/api/v1alpha1"
+	natsurl "github.com/kyma-project/nats-manager/internal/controller/nats/url"
+	"github.com/kyma-project/nats-manager/pkg/events"
+	natspkg "github.com/kyma-project/nats-manager/pkg/nats"
 )
 
 const (
 	StreamExistsErrorMsg   = "Cannot delete NATS cluster as customer stream exists"
 	ConsumerExistsErrorMsg = "Cannot delete NATS cluster as stream consumer exists"
-	natsClientPort         = 4222
 	InstanceLabelKey       = "app.kubernetes.io/instance"
 	SapStreamName          = "sap"
 )
@@ -109,7 +109,7 @@ func (r *Reconciler) createAndConnectNatsClient(nats *natsv1alpha1.NATS) error {
 	// create a new instance if it does not exist.
 	if r.getNatsClient(nats) == nil {
 		r.setNatsClient(nats, natspkg.NewNatsClient(&natspkg.Config{
-			URL: fmt.Sprintf("nats://%s.%s.svc.cluster.local:%d", nats.Name, nats.Namespace, natsClientPort),
+			URL: natsurl.Format(nats.Name, nats.Namespace),
 		}))
 	}
 	return r.getNatsClient(nats).Init()

internal/controller/nats/integrationtests/controller/integration_test.go

@@ -182,6 +182,9 @@ func Test_CreateNATSCR(t *testing.T) {
 				testEnvironment.EnsureNATSSpecMemStorageReflected(t, *tc.givenNATS)
 				testEnvironment.EnsureNATSSpecFileStorageReflected(t, *tc.givenNATS)
 			}
+
+			// check the url in the NATS CR status
+			testEnvironment.EnsureURLInNATSStatus(t, tc.givenNATS.Name, givenNamespace)
 		})
 	}
 }
@@ -264,6 +267,9 @@ func Test_UpdateNATSCR(t *testing.T) {
 			testEnvironment.EnsureK8sStatefulSetHasAnnotations(t, testutils.GetStatefulSetName(*tc.givenNATS),
 				givenNamespace, tc.givenUpdateNATS.Spec.Annotations)
 			testEnvironment.EnsureNATSSpecMemStorageReflected(t, *tc.givenUpdateNATS)
+
+			// check the url in the NATS CR status
+			testEnvironment.EnsureURLInNATSStatus(t, tc.givenNATS.Name, givenNamespace)
 		})
 	}
 }
@@ -590,6 +596,9 @@ func Test_DoubleReconcileNATSCR(t *testing.T) {
 
 			// check NATS CR status again.
 			testEnvironment.GetNATSAssert(g, tc.givenNATS).Should(tc.wantMatchers)
+
+			// check the url in the NATS CR status
+			testEnvironment.EnsureURLInNATSStatus(t, tc.givenNATS.Name, givenNamespace)
 		})
 	}
 }

internal/controller/nats/provisioner.go

@@ -4,13 +4,14 @@ import (
 	"context"
 	"time"
 
-	"github.com/kyma-project/nats-manager/pkg/events"
-
-	natsv1alpha1 "github.com/kyma-project/nats-manager/api/v1alpha1"
-	"github.com/kyma-project/nats-manager/pkg/k8s/chart"
 	"go.uber.org/zap"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	ctrl "sigs.k8s.io/controller-runtime"
+
+	natsv1alpha1 "github.com/kyma-project/nats-manager/api/v1alpha1"
+	natsurl "github.com/kyma-project/nats-manager/internal/controller/nats/url"
+	"github.com/kyma-project/nats-manager/pkg/events"
+	"github.com/kyma-project/nats-manager/pkg/k8s/chart"
 )
 
 const RequeueTimeForStatusCheck = 10
@@ -66,6 +67,9 @@ func (r *Reconciler) handleNATSReconcile(ctx context.Context,
 // It also syncs the NATS CR status.
 func (r *Reconciler) handleNATSState(ctx context.Context, nats *natsv1alpha1.NATS, instance *chart.ReleaseInstance,
 	log *zap.SugaredLogger) (ctrl.Result, error) {
+	// Clear the url until the StatefulSet is ready.
+	nats.Status.ClearURL()
+
 	// checking if statefulSet is ready.
 	isSTSReady, err := r.natsManager.IsNATSStatefulSetReady(ctx, instance)
 	if err != nil {
@@ -78,6 +82,7 @@ func (r *Reconciler) handleNATSState(ctx context.Context, nats *natsv1alpha1.NAT
 
 	if isSTSReady {
 		nats.Status.SetStateReady()
+		nats.Status.SetURL(natsurl.Format(nats.Name, nats.Namespace))
 		events.Normal(r.recorder, nats, natsv1alpha1.ConditionReasonDeployed, "StatefulSet is ready and NATS is deployed.")
 	} else {
 		nats.Status.SetWaitingStateForStatefulSet()

internal/controller/nats/url/url.go

@@ -0,0 +1,15 @@
+package url
+
+import (
+	"fmt"
+)
+
+const (
+	format   = "%s://%s.%s.svc.cluster.local:%d"
+	protocol = "nats"
+	port     = 4222
+)
+
+func Format(name, namespace string) string {
+	return fmt.Sprintf(format, protocol, name, namespace, port)
+}

internal/controller/nats/url/url_test.go

@@ -0,0 +1,38 @@
+package url
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestFormat(t *testing.T) {
+	// given
+	type args struct {
+		name      string
+		namespace string
+	}
+	tests := []struct {
+		name string
+		args args
+		want string
+	}{
+		{
+			name: "should return the correct nats url",
+			args: args{
+				name:      "test-name",
+				namespace: "test-namespace",
+			},
+			want: "nats://test-name.test-namespace.svc.cluster.local:4222",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			// when
+			got := Format(tt.args.name, tt.args.namespace)
+
+			// then
+			require.Equal(t, tt.want, got)
+		})
+	}
+}

testutils/integration/integration.go

@@ -533,6 +533,25 @@ func (env TestEnvironment) EnsureNATSSpecMemStorageReflected(t *testing.T, nats
 	}, SmallTimeOut, SmallPollingInterval, "failed to ensure NATS CR Spec.jetStream.memStorage")
 }
 
+func (env TestEnvironment) EnsureURLInNATSStatus(t *testing.T, name, namespace string) {
+	natsCR, err := env.GetNATSFromK8s(name, namespace)
+	require.NoError(t, err)
+	require.NotNil(t, natsCR)
+
+	switch natsCR.Status.State {
+	case natsv1alpha1.StateReady:
+		{
+			wantURL := fmt.Sprintf("nats://%s.%s.svc.cluster.local:4222", natsCR.Name, natsCR.Namespace)
+			require.Equal(t, wantURL, natsCR.Status.URL)
+		}
+	default:
+		{
+			const wantURL = ""
+			require.Equal(t, wantURL, natsCR.Status.URL)
+		}
+	}
+}
+
 func (env TestEnvironment) GetNATSFromK8s(name, namespace string) (natsv1alpha1.NATS, error) {
 	var nats natsv1alpha1.NATS
 	err := env.k8sClient.Get(env.Context, k8stypes.NamespacedName{