[release-2.0] flavor: add id field for creation

api/v1alpha1/flavor_types.go

@@ -24,6 +24,14 @@ type FlavorResourceSpec struct {
 	// +optional
 	Name *OpenStackName `json:"name,omitempty"`
 
+	// id will be the id of the created resource. If not specified, a random
+	// UUID will be generated by OpenStack.
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=255
+	// +kubebuilder:validation:Pattern=^[a-zA-Z0-9._-]([a-zA-Z0-9. _-]*[a-zA-Z0-9._-])?$
+	// +optional
+	ID string `json:"id,omitempty"` //nolint:kubeapilinter // intentionally allow raw ID
+
 	// description contains a free form description of the flavor.
 	// +kubebuilder:validation:MinLength:=1
 	// +kubebuilder:validation:MaxLength:=65535

config/crd/bases/openstack.k-orc.cloud_flavors.yaml

@@ -189,6 +189,14 @@ spec:
                     format: int32
                     minimum: 0
                     type: integer
+                  id:
+                    description: |-
+                      id will be the id of the created resource. If not specified, a random
+                      UUID will be generated by OpenStack.
+                    maxLength: 255
+                    minLength: 1
+                    pattern: ^[a-zA-Z0-9._-]([a-zA-Z0-9. _-]*[a-zA-Z0-9._-])?$
+                    type: string
                   isPublic:
                     description: isPublic flags a flavor as being available to all
                       projects or not.

internal/controllers/flavor/actuator.go

@@ -152,6 +152,7 @@ func (actuator flavorActuator) CreateResource(ctx context.Context, obj orcObject
 		IsPublic:    resource.IsPublic,
 		Ephemeral:   ptr.To(int(resource.Ephemeral)),
 		Description: ptr.Deref(resource.Description, ""),
+		ID:          resource.ID,
 	}
 
 	osResource, err := actuator.osClient.CreateFlavor(ctx, createOpts)

internal/controllers/flavor/tests/flavor-create-full/00-assert.yaml

@@ -4,6 +4,7 @@ kind: Flavor
 metadata:
   name: flavor-create-full
 status:
+  id: testId-123
   resource:
     name: flavor-create-full-override
     description: Flavor from "create full" test
@@ -12,4 +13,4 @@ status:
     disk: 20
     swap: 2
     isPublic: false
-    ephemeral: 1
+    ephemeral: 1

internal/controllers/flavor/tests/flavor-create-full/00-create-resource.yaml

@@ -17,3 +17,4 @@ spec:
     swap: 2
     isPublic: false
     ephemeral: 1
+    id: testId-123

test/apivalidations/flavor_test.go

@@ -137,7 +137,6 @@ var _ = Describe("ORC Flavor API validations", func() {
 		maxString := strings.Repeat("a", 65536)
 		patch.Spec.WithResource(applyconfigv1alpha1.FlavorResourceSpec().WithRAM(1).WithVcpus(1).WithDescription(maxString))
 		Expect(applyObj(ctx, flavor, patch)).To(MatchError(ContainSubstring("spec.resource.description: Too long")))
-
 	})
 
 	It("should reject import filter with value less than minimal", func(ctx context.Context) {
@@ -149,4 +148,20 @@ var _ = Describe("ORC Flavor API validations", func() {
 				WithFilter(applyconfigv1alpha1.FlavorFilter().WithRAM(0)))
 		Expect(applyObj(ctx, flavor, patch)).To(MatchError(ContainSubstring("spec.import.filter.ram in body should be greater than or equal to 1")))
 	})
+
+	It("should reject flavor IDs which are not according to the specified regex", func(ctx context.Context) {
+		flavor := flavorStub(namespace)
+		patch := baseFlavorPatch(flavor)
+		maxString := strings.Repeat("a", 256)
+		patch.Spec.WithResource(applyconfigv1alpha1.FlavorResourceSpec().WithID(" test").WithRAM(1).WithVcpus(1).WithDescription("test").WithDisk(1))
+		Expect(applyObj(ctx, flavor, patch)).To(MatchError(ContainSubstring("spec.resource.id: Invalid value")))
+		patch.Spec.WithResource(applyconfigv1alpha1.FlavorResourceSpec().WithID("test ").WithRAM(1).WithVcpus(1).WithDescription("test").WithDisk(1))
+		Expect(applyObj(ctx, flavor, patch)).To(MatchError(ContainSubstring("spec.resource.id: Invalid value")))
+		patch.Spec.WithResource(applyconfigv1alpha1.FlavorResourceSpec().WithID(maxString).WithRAM(1).WithVcpus(1).WithDescription("test").WithDisk(1))
+		Expect(applyObj(ctx, flavor, patch)).To(MatchError(ContainSubstring("spec.resource.id: Too long")))
+		patch.Spec.WithResource(applyconfigv1alpha1.FlavorResourceSpec().WithID("").WithRAM(1).WithVcpus(1).WithDescription("test").WithDisk(1))
+		Expect(applyObj(ctx, flavor, patch)).To(MatchError(ContainSubstring("spec.resource.id in body should be at least 1 chars long")))
+		patch.Spec.WithResource(applyconfigv1alpha1.FlavorResourceSpec().WithID("test.id -123_").WithRAM(1).WithVcpus(1).WithDescription("test").WithDisk(1))
+		Expect(applyObj(ctx, flavor, patch)).To(Succeed())
+	})
 })

website/docs/crd-reference.md

@@ -1016,6 +1016,7 @@ _Appears in:_
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
 | `name` _[OpenStackName](#openstackname)_ | name will be the name of the created resource. If not specified, the<br />name of the ORC object will be used. |  | MaxLength: 255 <br />MinLength: 1 <br />Pattern: `^[^,]+$` <br />Optional: \{\} <br /> |
+| `id` _string_ | id will be the id of the created resource. If not specified, a random<br />UUID will be generated by OpenStack. |  | MaxLength: 255 <br />MinLength: 1 <br />Pattern: `^[a-zA-Z0-9._-]([a-zA-Z0-9. _-]*[a-zA-Z0-9._-])?$` <br />Optional: \{\} <br /> |
 | `description` _string_ | description contains a free form description of the flavor. |  | MaxLength: 65535 <br />MinLength: 1 <br />Optional: \{\} <br /> |
 | `ram` _integer_ | ram is the memory of the flavor, measured in MB. |  | Minimum: 1 <br />Required: \{\} <br /> |
 | `vcpus` _integer_ | vcpus is the number of vcpus for the flavor. |  | Minimum: 1 <br />Required: \{\} <br /> |