Fix API Type Unstructured Conversion (#140)

Author: spjmurray

charts/core/Chart.yaml

@@ -4,8 +4,8 @@ description: A Helm chart for deploying Unikorn Core
 
 type: application
 
-version: v1.1.0-rc4
-appVersion: v1.1.0-rc4
+version: v1.1.0-rc5
+appVersion: v1.1.0-rc5
 
 icon: https://assets.unikorn-cloud.org/images/logos/dark-on-light/icon.svg
 

pkg/apis/unikorn/v1alpha1/types.go

@@ -20,6 +20,7 @@ package v1alpha1
 import (
 	"encoding/json"
 	"errors"
+	"fmt"
 	"net"
 
 	"github.com/Masterminds/semver/v3"
@@ -132,7 +133,7 @@ func (a *IPv4Address) UnmarshalJSON(b []byte) error {
 
 	ip := net.ParseIP(str)
 	if ip == nil {
-		return ErrJSONUnmarshal
+		return fmt.Errorf("%w: not an IPv4 address '%s'", ErrJSONUnmarshal, str)
 	}
 
 	a.IP = ip
@@ -196,11 +197,11 @@ func (p *IPv4Prefix) UnmarshalJSON(b []byte) error {
 
 	_, network, err := net.ParseCIDR(str)
 	if err != nil {
-		return ErrJSONUnmarshal
+		return fmt.Errorf("%w: not an IPv4 prefix '%s'", ErrJSONUnmarshal, str)
 	}
 
 	if network == nil {
-		return ErrJSONUnmarshal
+		return fmt.Errorf("%w: not an IPv4 prefix '%s'", ErrJSONUnmarshal, str)
 	}
 
 	p.IPNet = *network
@@ -216,7 +217,7 @@ func (p *IPv4Prefix) MarshalJSON() ([]byte, error) {
 }
 
 func (p *IPv4Prefix) ToUnstructured() any {
-	return p.IP.String()
+	return p.String()
 }
 
 // There is no interface defined for these. See

pkg/apis/unikorn/v1alpha1/types_test.go

@@ -28,10 +28,12 @@ import (
 
 const (
 	// Expect IP addresses to be marshalled as strings in dotted quad format.
-	testAddressMarshaled = `"192.168.0.1"`
+	testAddressMarshaled    = `"192.168.0.1"`
+	testAddressUnstructured = "192.168.0.1"
 
 	// Expect IP prefixes to be marshalled as strings in dotted quad CIDR format.
-	testPrefixMarshaled = `"192.168.0.0/16"`
+	testPrefixMarshaled    = `"192.168.0.0/16"`
+	testPrefixUnstructured = "192.168.0.0/16"
 )
 
 var (
@@ -51,6 +53,7 @@ func TestSemanticVersionCanonical(t *testing.T) {
 	t.Parallel()
 
 	jsonSemver := `"1.2.3-foo+bar"`
+	unstructuredSemver := "1.2.3-foo+bar"
 
 	out := &v1alpha1.SemanticVersion{}
 
@@ -62,6 +65,9 @@ func TestSemanticVersionCanonical(t *testing.T) {
 	marshalled, err := out.MarshalJSON()
 	require.NoError(t, err)
 	require.Equal(t, jsonSemver, string(marshalled))
+
+	unstructured := out.ToUnstructured()
+	require.Equal(t, unstructuredSemver, unstructured)
 }
 
 func TestSemanticVersion(t *testing.T) {
@@ -111,13 +117,8 @@ func TestIPv4AddressUnmarshal(t *testing.T) {
 
 	output := &v1alpha1.IPv4Address{}
 
-	if err := output.UnmarshalJSON(input); err != nil {
-		t.Fatal(err)
-	}
-
-	if !output.Equal(testAddressUnmarshaled) {
-		t.Fatal("address mismatch")
-	}
+	require.NoError(t, output.UnmarshalJSON(input))
+	require.Equal(t, testAddressUnmarshaled, output.IP)
 }
 
 func TestIPv4AddressMarshal(t *testing.T) {
@@ -126,13 +127,12 @@ func TestIPv4AddressMarshal(t *testing.T) {
 	input := &v1alpha1.IPv4Address{IP: testAddressUnmarshaled}
 
 	output, err := input.MarshalJSON()
-	if err != nil {
-		t.Fatal()
-	}
+	require.NoError(t, err)
 
-	if string(output) != testAddressMarshaled {
-		t.Fatal("address mismatch")
-	}
+	require.Equal(t, testAddressMarshaled, string(output))
+
+	unstructured := input.ToUnstructured()
+	require.Equal(t, testAddressUnstructured, unstructured)
 }
 
 func TestIPv4PrefixUnmarshal(t *testing.T) {
@@ -142,13 +142,8 @@ func TestIPv4PrefixUnmarshal(t *testing.T) {
 
 	output := &v1alpha1.IPv4Prefix{}
 
-	if err := output.UnmarshalJSON(input); err != nil {
-		t.Fatal(nil)
-	}
-
-	if output.String() != testPrefixUnmarshaled.String() {
-		t.Fatal("prefix mismatch")
-	}
+	require.NoError(t, output.UnmarshalJSON(input))
+	require.Equal(t, testPrefixUnmarshaled.String(), output.String())
 }
 
 func TestIPv4PrefixMarshal(t *testing.T) {
@@ -157,11 +152,9 @@ func TestIPv4PrefixMarshal(t *testing.T) {
 	input := &v1alpha1.IPv4Prefix{IPNet: testPrefixUnmarshaled}
 
 	output, err := input.MarshalJSON()
-	if err != nil {
-		t.Fatal(err)
-	}
+	require.NoError(t, err)
+	require.Equal(t, testPrefixMarshaled, string(output))
 
-	if string(output) != testPrefixMarshaled {
-		t.Fatal("prefix mismatch")
-	}
+	unstructured := input.ToUnstructured()
+	require.Equal(t, testPrefixUnstructured, unstructured)
 }