Calculate and return days remaining in get signup response

pkg/signup/service/signup_service.go

@@ -2,9 +2,12 @@ package service
 
 import (
 	"fmt"
+	"github.com/codeready-toolchain/registration-service/pkg/util"
 	"hash/crc32"
+	"math"
 	"regexp"
 	"strings"
+	"time"
 
 	toolchainv1alpha1 "github.com/codeready-toolchain/api/api/v1alpha1"
 	"github.com/codeready-toolchain/registration-service/pkg/application/service"
@@ -457,6 +460,17 @@ func (s *ServiceImpl) DoGetSignup(ctx *gin.Context, provider ResourceProvider, u
 		return signupResponse, nil
 	}
 
+	if !userSignup.Status.ScheduledDeactivationTimestamp.IsZero() {
+		signupResponse.EndDate = userSignup.Status.ScheduledDeactivationTimestamp.Format(time.RFC3339)
+		remaining := time.Until(userSignup.Status.ScheduledDeactivationTimestamp.Time)
+		// Round the days remaining to 2 decimal points
+		signupResponse.DaysRemaining = util.Ptr(math.Round(remaining.Hours()/24*100) / 100)
+		// If for whatever reason the days remaining is negative, set it to zero
+		if *signupResponse.DaysRemaining < float64(0) {
+			signupResponse.DaysRemaining = util.Ptr(float64(0))
+		}
+	}
+
 	// If UserSignup status is complete as active
 	// Retrieve MasterUserRecord resource from the host cluster and use its status
 	mur, err := provider.GetMasterUserRecord(userSignup.Status.CompliantUsername)
@@ -474,6 +488,11 @@ func (s *ServiceImpl) DoGetSignup(ctx *gin.Context, provider ResourceProvider, u
 		Message:              murCondition.Message,
 		VerificationRequired: states.VerificationRequired(userSignup),
 	}
+
+	if mur.Status.ProvisionedTime != nil {
+		signupResponse.StartDate = mur.Status.ProvisionedTime.Format(time.RFC3339)
+	}
+
 	if mur.Status.UserAccounts != nil && len(mur.Status.UserAccounts) > 0 {
 		// Retrieve cluster-specific URLs from the status of the corresponding member cluster
 		status, err := provider.GetToolchainStatus()

pkg/signup/service/signup_service_test.go

@@ -4,11 +4,13 @@ import (
 	"bytes"
 	"errors"
 	"fmt"
+	"github.com/codeready-toolchain/registration-service/pkg/util"
 	"hash/crc32"
 	"net/http"
 	"net/http/httptest"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/codeready-toolchain/registration-service/pkg/application/service/factory"
 	"github.com/codeready-toolchain/registration-service/pkg/configuration"
@@ -1159,6 +1161,10 @@ func (s *TestSignupServiceSuite) TestGetSignupStatusOK() {
 			require.Equal(t, us.Name, response.Name)
 			require.Equal(t, "jsmith", response.Username)
 			require.Equal(t, "ted", response.CompliantUsername)
+			require.NotNil(t, response.DaysRemaining)
+			require.InEpsilon(t, float64(30), *response.DaysRemaining, 0.1)
+			require.Equal(t, mur.Status.ProvisionedTime.Format(time.RFC3339), response.StartDate)
+			require.Equal(t, us.Status.ScheduledDeactivationTimestamp.Format(time.RFC3339), response.EndDate)
 			assert.True(t, response.Status.Ready)
 			assert.Equal(t, "mur_ready_reason", response.Status.Reason)
 			assert.Equal(t, "mur_ready_message", response.Status.Message)
@@ -1235,13 +1241,25 @@ func (s *TestSignupServiceSuite) TestGetSignupByUsernameOK() {
 
 	us := s.newUserSignupComplete()
 	us.Name = service.EncodeUserIdentifier(us.Spec.IdentityClaims.PreferredUsername)
+	// Set the scheduled deactivation timestamp 1 day ago
+	us.Status.ScheduledDeactivationTimestamp = util.Ptr(v1.NewTime(time.Now().Add(-time.Hour * 24)))
 	err := s.FakeUserSignupClient.Tracker.Add(us)
 	require.NoError(s.T(), err)
 
 	mur := s.newProvisionedMUR("ted")
+	// Set the provisioned time 31 days in the past
+	provisionedTime := time.Now().Add(-time.Hour * 24 * 31).Round(time.Second)
+	mur.Status.ProvisionedTime = util.Ptr(v1.NewTime(provisionedTime))
 	err = s.FakeMasterUserRecordClient.Tracker.Add(mur)
 	require.NoError(s.T(), err)
 
+	svc := service.NewSignupService(
+		fake.MemberClusterServiceContext{
+			Client: s,
+			Svcs:   s.Application,
+		},
+	)
+
 	c, _ := gin.CreateTestContext(httptest.NewRecorder())
 
 	space := s.newSpaceForMUR(mur.Name, us.Name)
@@ -1257,12 +1275,24 @@ func (s *TestSignupServiceSuite) TestGetSignupByUsernameOK() {
 	require.NoError(s.T(), err)
 
 	// when
-	response, err := s.Application.SignupService().GetSignup(c, "foo", us.Spec.IdentityClaims.PreferredUsername)
+	response, err := svc.GetSignup(c, "foo", us.Spec.IdentityClaims.PreferredUsername)
 
 	// then
 	require.NoError(s.T(), err)
 	require.NotNil(s.T(), response)
 
+	// Confirm the StartDate is the same as the provisionedTime
+	require.Equal(s.T(), provisionedTime.Format(time.RFC3339), response.StartDate)
+
+	// Confirm the end date is about 1 day ago
+	responseEndDate, err := time.Parse(time.RFC3339, response.EndDate)
+	require.NoError(s.T(), err)
+	expectedEndDate := time.Now().Add(-time.Hour * 24)
+	require.WithinDuration(s.T(), expectedEndDate, responseEndDate, time.Minute*5,
+		"endDate in response [%s] not in expected range [%s]", responseEndDate, expectedEndDate.Format(time.RFC3339))
+
+	// DaysRemaining should be zero
+	require.InDelta(s.T(), float64(0), *response.DaysRemaining, 0)
 	require.Equal(s.T(), us.Name, response.Name)
 	require.Equal(s.T(), "jsmith", response.Username)
 	require.Equal(s.T(), "ted", response.CompliantUsername)
@@ -2240,6 +2270,7 @@ func (s *TestSignupServiceSuite) newUserSignupCompleteWithReason(reason string)
 			},
 		},
 		Status: toolchainv1alpha1.UserSignupStatus{
+			ScheduledDeactivationTimestamp: util.Ptr(v1.NewTime(time.Now().Add(30 * time.Hour * 24))),
 			Conditions: []toolchainv1alpha1.Condition{
 				{
 					Type:   toolchainv1alpha1.UserSignupComplete,
@@ -2313,6 +2344,7 @@ func (s *TestSignupServiceSuite) newProvisionedMUR(name string) *toolchainv1alph
 			UserAccounts: []toolchainv1alpha1.UserAccountEmbedded{{TargetCluster: "member-123"}},
 		},
 		Status: toolchainv1alpha1.MasterUserRecordStatus{
+			ProvisionedTime: util.Ptr(v1.NewTime(time.Now())),
 			Conditions: []toolchainv1alpha1.Condition{
 				{
 					Type:    toolchainv1alpha1.MasterUserRecordReady,

pkg/signup/signup.go

@@ -40,6 +40,14 @@ type Signup struct {
 	// Company from the Identity Provider
 	Company string `json:"company"`
 	Status  Status `json:"status,omitempty"`
+	// StartDate is the date that the user's current subscription started, in RFC3339 format
+	StartDate string `json:"startDate,omitempty"`
+	// End Date is the date that the user's current subscription will end, in RFC3339 format
+	EndDate string `json:"endDate,omitempty"`
+	// DaysRemaining is a float pointer representing the number of days remaining in the user's subscription
+	// If the subscription is not currently active then this property should be nil and therefore shouldn't be returned
+	// in the response
+	DaysRemaining *float64 `json:"daysRemaining,omitempty"`
 }
 
 // Status represents UserSignup resource status

pkg/util/utils.go

@@ -0,0 +1,6 @@
+package util
+
+// Ptr is a generic function that returns a pointer to whatever value is passed in
+func Ptr[T any](v T) *T {
+	return &v
+}