Add Unit Tests for conversion Package

pkg/server/conversion/conversion.go

@@ -20,7 +20,6 @@ package conversion
 import (
 	"context"
 	"encoding/json"
-	"errors"
 	"fmt"
 	"time"
 
@@ -29,6 +28,7 @@ import (
 	unikornv1 "github.com/unikorn-cloud/core/pkg/apis/unikorn/v1alpha1"
 	"github.com/unikorn-cloud/core/pkg/constants"
 	"github.com/unikorn-cloud/core/pkg/openapi"
+	"github.com/unikorn-cloud/core/pkg/server/conversion/internal"
 	"github.com/unikorn-cloud/core/pkg/util"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -37,72 +37,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-var (
-	ErrAnnotation = errors.New("a required annotation was missing")
-)
-
-// convertStatusCondition translates from Kubernetes status conditions to API ones.
-func convertStatusCondition(in metav1.Object) openapi.ResourceProvisioningStatus {
-	// We set the status after a reconcile, so this allows us to
-	// reflect the correct state to the user immediately.
-	if in.GetDeletionTimestamp() != nil {
-		return openapi.ResourceProvisioningStatusDeprovisioning
-	}
-
-	// Not a resource with status conditions, consider it provisioned.
-	reader, ok := in.(unikornv1.StatusConditionReader)
-	if !ok {
-		return openapi.ResourceProvisioningStatusProvisioned
-	}
-
-	// No condition yet, it's unknown.
-	condition, err := reader.StatusConditionRead(unikornv1.ConditionAvailable)
-	if err != nil {
-		return openapi.ResourceProvisioningStatusUnknown
-	}
-
-	//nolint:exhaustive
-	switch condition.Reason {
-	case unikornv1.ConditionReasonProvisioning:
-		return openapi.ResourceProvisioningStatusProvisioning
-	case unikornv1.ConditionReasonProvisioned:
-		return openapi.ResourceProvisioningStatusProvisioned
-	case unikornv1.ConditionReasonErrored:
-		return openapi.ResourceProvisioningStatusError
-	case unikornv1.ConditionReasonDeprovisioning:
-		return openapi.ResourceProvisioningStatusDeprovisioning
-	}
-
-	return openapi.ResourceProvisioningStatusUnknown
-}
-
-// convertHealthCondition translates from Kubernetes heath conditions to API ones.
-func convertHealthCondition(in any) openapi.ResourceHealthStatus {
-	// Not a resource with status conditions, consider it healthy.
-	reader, ok := in.(unikornv1.StatusConditionReader)
-	if !ok {
-		return openapi.ResourceHealthStatusHealthy
-	}
-
-	// No condition yet, it's unknown.
-	condition, err := reader.StatusConditionRead(unikornv1.ConditionHealthy)
-	if err != nil {
-		return openapi.ResourceHealthStatusUnknown
-	}
-
-	//nolint:exhaustive
-	switch condition.Reason {
-	case unikornv1.ConditionReasonHealthy:
-		return openapi.ResourceHealthStatusHealthy
-	case unikornv1.ConditionReasonDegraded:
-		return openapi.ResourceHealthStatusDegraded
-	case unikornv1.ConditionReasonErrored:
-		return openapi.ResourceHealthStatusError
-	}
-
-	return openapi.ResourceHealthStatusUnknown
-}
-
 // ResourceReadMetadata extracts generic metadata from a resource for GET APIs.
 func ResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.ResourceReadMetadata {
 	labels := in.GetLabels()
@@ -112,8 +46,8 @@ func ResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.Reso
 		Id:                 in.GetName(),
 		Name:               labels[constants.NameLabel],
 		CreationTime:       in.GetCreationTimestamp().Time,
-		ProvisioningStatus: convertStatusCondition(in),
-		HealthStatus:       convertHealthCondition(in),
+		ProvisioningStatus: internal.ConvertStatusCondition(in),
+		HealthStatus:       internal.ConvertHealthCondition(in),
 	}
 
 	if v, ok := annotations[constants.DescriptionAnnotation]; ok {
@@ -146,7 +80,7 @@ func ResourceReadMetadata(in metav1.Object, tags unikornv1.TagList) openapi.Reso
 	return out
 }
 
-// OrganizationScopedResourceReadMetadata extracts organization scoped metdata from a resource
+// OrganizationScopedResourceReadMetadata extracts organization scoped metadata from a resource
 // for GET APIS.
 //
 //nolint:errchkjson
@@ -166,7 +100,7 @@ func OrganizationScopedResourceReadMetadata(in metav1.Object, tags unikornv1.Tag
 	return out
 }
 
-// ProjectScopedResourceReadMetadata extracts project scoped metdata from a resource for
+// ProjectScopedResourceReadMetadata extracts project scoped metadata from a resource for
 // GET APIs.
 //
 //nolint:errchkjson

pkg/server/conversion/conversion_blackbox_test.go

@@ -0,0 +1,217 @@
+/*
+Copyright 2025 the Unikorn Authors.
+Copyright 2026 Nscale.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package conversion_test
+
+import (
+	"errors"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	unikornv1 "github.com/unikorn-cloud/core/pkg/apis/unikorn/v1alpha1"
+	"github.com/unikorn-cloud/core/pkg/constants"
+	"github.com/unikorn-cloud/core/pkg/openapi"
+	"github.com/unikorn-cloud/core/pkg/server/conversion"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/ptr"
+)
+
+const (
+	id           = "passport"
+	name         = "cyril"
+	description  = "some text"
+	createdBy    = "shirley"
+	modifiedBy   = "eric"
+	tagKey       = "yale"
+	tagValue     = "lock"
+	organization = "acme"
+	project      = "foo"
+)
+
+//nolint:gochecknoglobals
+var (
+	creationTime = time.Date(1970, 0, 0, 0, 0, 0, 0, time.UTC)
+	deletionTime = time.Date(1980, 0, 0, 0, 0, 0, 0, time.UTC)
+	modifiedTime = time.Date(1990, 0, 0, 0, 0, 0, 0, time.UTC)
+
+	ErrAny = errors.New("some error happened")
+)
+
+type basicObject struct {
+	metav1.ObjectMeta
+}
+
+func newBasicObject() *basicObject {
+	return &basicObject{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:              id,
+			CreationTimestamp: metav1.Time{Time: creationTime},
+			Labels: map[string]string{
+				constants.NameLabel: name,
+			},
+		},
+	}
+}
+
+func (o *basicObject) StatusConditionRead(t unikornv1.ConditionType) (*unikornv1.Condition, error) {
+	return nil, ErrAny
+}
+
+type advancedObject struct {
+	metav1.ObjectMeta
+}
+
+func newAdvancedObject() *advancedObject {
+	return &advancedObject{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:              id,
+			CreationTimestamp: metav1.Time{Time: creationTime},
+			DeletionTimestamp: &metav1.Time{Time: deletionTime},
+			Labels: map[string]string{
+				constants.NameLabel:         name,
+				constants.OrganizationLabel: organization,
+				constants.ProjectLabel:      project,
+			},
+			Annotations: map[string]string{
+				constants.DescriptionAnnotation:       description,
+				constants.CreatorAnnotation:           createdBy,
+				constants.ModifierAnnotation:          modifiedBy,
+				constants.ModifiedTimestampAnnotation: modifiedTime.Format(time.RFC3339),
+			},
+		},
+	}
+}
+
+func (o *advancedObject) StatusConditionRead(t unikornv1.ConditionType) (*unikornv1.Condition, error) {
+	return nil, ErrAny
+}
+
+func tags() unikornv1.TagList {
+	return unikornv1.TagList{
+		{
+			Name:  tagKey,
+			Value: tagValue,
+		},
+	}
+}
+
+// TestResourceReadMetadataBasic checks that a minimal input yields a minimal output.
+func TestResourceReadMetadataBasic(t *testing.T) {
+	t.Parallel()
+
+	in := newBasicObject()
+
+	out := conversion.ResourceReadMetadata(in, nil)
+
+	require.Equal(t, id, out.Id)
+	require.Equal(t, name, out.Name)
+	require.Equal(t, creationTime, out.CreationTime)
+	require.Equal(t, openapi.ResourceProvisioningStatusUnknown, out.ProvisioningStatus)
+	require.Equal(t, openapi.ResourceHealthStatusUnknown, out.HealthStatus)
+
+	require.Nil(t, out.Description)
+	require.Nil(t, out.CreatedBy)
+	require.Nil(t, out.ModifiedBy)
+	require.Nil(t, out.ModifiedTime)
+	require.Nil(t, out.DeletionTime)
+	require.Nil(t, out.Tags)
+}
+
+// TestResourceReadMetadataAdvanced checks that a maximizes input yields a maximized output.
+func TestResourceReadMetadataAdvanced(t *testing.T) {
+	t.Parallel()
+
+	in := newAdvancedObject()
+
+	out := conversion.ResourceReadMetadata(in, tags())
+
+	require.Equal(t, id, out.Id)
+	require.Equal(t, name, out.Name)
+	require.Equal(t, creationTime, out.CreationTime)
+	require.Equal(t, openapi.ResourceProvisioningStatusDeprovisioning, out.ProvisioningStatus)
+	require.Equal(t, openapi.ResourceHealthStatusUnknown, out.HealthStatus)
+
+	require.Equal(t, ptr.To(description), out.Description)
+	require.Equal(t, ptr.To(createdBy), out.CreatedBy)
+	require.Equal(t, ptr.To(modifiedBy), out.ModifiedBy)
+	require.Equal(t, ptr.To(modifiedTime), out.ModifiedTime)
+	require.Equal(t, ptr.To(deletionTime), out.DeletionTime)
+	require.NotNil(t, out.Tags)
+	require.Len(t, *out.Tags, 1)
+	require.Equal(t, tagKey, (*out.Tags)[0].Name)
+	require.Equal(t, tagValue, (*out.Tags)[0].Value)
+}
+
+// TestOrganizationScopedResourceReadMetadataAdvanced tests that this extension of the advanced
+// cases works woth all the extra data.
+func TestOrganizationScopedResourceReadMetadataAdvanced(t *testing.T) {
+	t.Parallel()
+
+	in := newAdvancedObject()
+
+	out := conversion.OrganizationScopedResourceReadMetadata(in, tags())
+
+	require.Equal(t, id, out.Id)
+	require.Equal(t, name, out.Name)
+	require.Equal(t, creationTime, out.CreationTime)
+	require.Equal(t, openapi.ResourceProvisioningStatusDeprovisioning, out.ProvisioningStatus)
+	require.Equal(t, openapi.ResourceHealthStatusUnknown, out.HealthStatus)
+
+	require.Equal(t, ptr.To(description), out.Description)
+	require.Equal(t, ptr.To(createdBy), out.CreatedBy)
+	require.Equal(t, ptr.To(modifiedBy), out.ModifiedBy)
+	require.Equal(t, ptr.To(modifiedTime), out.ModifiedTime)
+	require.Equal(t, ptr.To(deletionTime), out.DeletionTime)
+	require.NotNil(t, out.Tags)
+	require.Len(t, *out.Tags, 1)
+	require.Equal(t, tagKey, (*out.Tags)[0].Name)
+	require.Equal(t, tagValue, (*out.Tags)[0].Value)
+
+	require.Equal(t, organization, out.OrganizationId)
+}
+
+// TestProjectScopedResourceReadMetadata tests that this extension of the advanced
+// cases works woth all the extra data.
+func TestProjectScopedResourceReadMetadata(t *testing.T) {
+	t.Parallel()
+
+	in := newAdvancedObject()
+
+	out := conversion.ProjectScopedResourceReadMetadata(in, tags())
+
+	require.Equal(t, id, out.Id)
+	require.Equal(t, name, out.Name)
+	require.Equal(t, creationTime, out.CreationTime)
+	require.Equal(t, openapi.ResourceProvisioningStatusDeprovisioning, out.ProvisioningStatus)
+	require.Equal(t, openapi.ResourceHealthStatusUnknown, out.HealthStatus)
+
+	require.Equal(t, ptr.To(description), out.Description)
+	require.Equal(t, ptr.To(createdBy), out.CreatedBy)
+	require.Equal(t, ptr.To(modifiedBy), out.ModifiedBy)
+	require.Equal(t, ptr.To(modifiedTime), out.ModifiedTime)
+	require.Equal(t, ptr.To(deletionTime), out.DeletionTime)
+	require.NotNil(t, out.Tags)
+	require.Len(t, *out.Tags, 1)
+	require.Equal(t, tagKey, (*out.Tags)[0].Name)
+	require.Equal(t, tagValue, (*out.Tags)[0].Value)
+
+	require.Equal(t, organization, out.OrganizationId)
+	require.Equal(t, project, out.ProjectId)
+}