Create/Update support for BillingEntities (#146)

Author: bastjan

.goreleaser.yml

@@ -27,13 +27,17 @@ dockers:
       - "--platform=linux/amd64"
     image_templates:
       - "ghcr.io/appuio/control-api:v{{ .Version }}-amd64"
+    extra_files:
+      - countries.yaml
 
   - goarch: arm64
     use: buildx
     build_flag_templates:
       - "--platform=linux/arm64/v8"
     image_templates:
       - "ghcr.io/appuio/control-api:v{{ .Version }}-arm64"
+    extra_files:
+      - countries.yaml
 
 docker_manifests:
   # For prereleases, updating `latest` does not make sense.

Dockerfile

@@ -11,6 +11,7 @@ RUN \
   mkdir /.cache && chmod -R g=u /.cache
 
 COPY control-api /usr/local/bin/
+COPY countries.yaml .
 
 RUN chmod a+x /usr/local/bin/control-api
 

api.go

@@ -19,6 +19,7 @@ import (
 	"github.com/appuio/control-api/apiserver/authwrapper"
 	billingStore "github.com/appuio/control-api/apiserver/billing"
 	"github.com/appuio/control-api/apiserver/billing/odoostorage"
+	"github.com/appuio/control-api/apiserver/billing/odoostorage/odoo/odoo8/countries"
 	orgStore "github.com/appuio/control-api/apiserver/organization"
 	"github.com/appuio/control-api/apiserver/secretstorage"
 	"github.com/appuio/control-api/apiserver/user"
@@ -57,6 +58,7 @@ func APICommand() *cobra.Command {
 	cmd.Flags().BoolVar(&ob.billingEntityFakeMetadataSupport, "billing-entity-fake-metadata-support", false, "Enable metadata support for the fake storage backend")
 	cmd.Flags().StringVar(&ob.odoo8URL, "billing-entity-odoo8-url", "http://localhost:8069", "URL of the Odoo instance to use for billing entities")
 	cmd.Flags().BoolVar(&ob.odoo8DebugTransport, "billing-entity-odoo8-debug-transport", false, "Enable debug logging for the Odoo transport")
+	cmd.Flags().StringVar(&ob.odoo8CountryListPath, "billing-entity-odoo8-country-list", "countries.yaml", "Path to the country list file in the format of [{name: \"Germany\", code: \"DE\", id: 81},...]")
 
 	cmd.Flags().StringVar(&ib.backingNS, "invitation-storage-backing-ns", "default", "Namespace to store invitation secrets in")
 
@@ -79,18 +81,20 @@ func APICommand() *cobra.Command {
 }
 
 type odooStorageBuilder struct {
-	billingEntityStorage, odoo8URL                        string
+	billingEntityStorage, odoo8URL, odoo8CountryListPath  string
 	billingEntityFakeMetadataSupport, odoo8DebugTransport bool
 }
 
 func (o *odooStorageBuilder) Build(s *runtime.Scheme, g genericregistry.RESTOptionsGetter) (rest.Storage, error) {
-	fmt.Printf("Building storage with options: %#v\n", o)
-
 	switch o.billingEntityStorage {
 	case "fake":
 		return billingStore.New(odoostorage.NewFakeStorage(o.billingEntityFakeMetadataSupport).(authwrapper.StorageScoper))(s, g)
 	case "odoo8":
-		return billingStore.New(odoostorage.NewOdoo8Storage(o.odoo8URL, o.odoo8DebugTransport).(authwrapper.StorageScoper))(s, g)
+		countryIDs, err := countries.LoadCountryIDs(o.odoo8CountryListPath)
+		if err != nil {
+			return nil, err
+		}
+		return billingStore.New(odoostorage.NewOdoo8Storage(o.odoo8URL, o.odoo8DebugTransport, countryIDs).(authwrapper.StorageScoper))(s, g)
 	default:
 		return nil, fmt.Errorf("unknown billing entity storage: %s", o.billingEntityStorage)
 	}

apiserver/billing/odoostorage/odoo/fake/fake.go

@@ -6,8 +6,10 @@ import (
 	"sync"
 	"sync/atomic"
 
+	"github.com/google/uuid"
 	"golang.org/x/exp/slices"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	apitypes "k8s.io/apimachinery/pkg/types"
 
 	billingv1 "github.com/appuio/control-api/apis/billing/v1"
 	"github.com/appuio/control-api/apiserver/billing/odoostorage/odoo"
@@ -45,6 +47,7 @@ func (s *fakeOdooStorage) Create(ctx context.Context, be *billingv1.BillingEntit
 	id := formatID(s.nextID())
 
 	be.Name = id
+	be.UID = apitypes.UID(uuid.NewString())
 
 	s.cleanMetadata(be)
 
@@ -104,10 +107,13 @@ func (s *fakeOdooStorage) nextID() uint64 {
 func (s *fakeOdooStorage) cleanMetadata(be *billingv1.BillingEntity) {
 	meta := metav1.ObjectMeta{
 		Name: be.Name,
+		// Without UID patch requests fail with a 404 error.
+		UID: be.UID,
 	}
 	if s.metadataSupport {
 		meta = metav1.ObjectMeta{
 			Name:            be.Name,
+			UID:             be.UID,
 			ResourceVersion: be.ResourceVersion,
 			Annotations:     be.Annotations,
 			Labels:          be.Labels,

apiserver/billing/odoostorage/odoo/odoo8/client/clientmock/session.go

@@ -0,0 +1,16 @@
+package model_test
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/appuio/control-api/apiserver/billing/odoostorage/odoo/odoo8/client/model"
+	"github.com/stretchr/testify/require"
+)
+
+func TestCategoryIDs_MarshalJSON(t *testing.T) {
+	m, err := json.Marshal(model.CategoryIDs{1, 2, 3})
+
+	require.NoError(t, err)
+	require.Equal(t, `[[6,false,[1,2,3]]]`, string(m))
+}

apiserver/billing/odoostorage/odoo/odoo8/client/model/category_id_test.go

@@ -0,0 +1,12 @@
+package model
+
+import "encoding/json"
+
+type CategoryIDs []int
+
+func (t CategoryIDs) MarshalJSON() ([]byte, error) {
+	// Values observed on test and prod instances.
+	// Seems to be some kinda update join table command.
+	// Also observed in other n..m relations.
+	return json.Marshal([][]any{{6, false, []int(t)}})
+}

apiserver/billing/odoostorage/odoo/odoo8/client/model/category_ids.go

@@ -13,6 +13,14 @@ type Nullable[T any] struct {
 	Valid bool
 }
 
+// NewNullable creates a new Nullable[T] with the given value.
+func NewNullable[T any](v T) Nullable[T] {
+	return Nullable[T]{
+		Value: v,
+		Valid: true,
+	}
+}
+
 func (t *Nullable[T]) UnmarshalJSON(b []byte) error {
 	// Odoo returns false (not null) if a field is not set.
 	if bytes.Equal(b, []byte("false")) {

apiserver/billing/odoostorage/odoo/odoo8/client/model/nullable.go

@@ -9,6 +9,12 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+func Test_NewNullable(t *testing.T) {
+	subject := model.NewNullable("test")
+	require.True(t, subject.Valid)
+	require.Equal(t, "test", subject.Value)
+}
+
 func Test_Nullable(t *testing.T) {
 	type mt struct {
 		NullableString model.Nullable[string] `json:"nullable_string"`

apiserver/billing/odoostorage/odoo/odoo8/client/model/nullable_test.go

@@ -24,6 +24,15 @@ type OdooCompositeID struct {
 	Name string
 }
 
+// NewCompositeID creates a new, valid OdooCompositeID.
+func NewCompositeID(id int, name string) OdooCompositeID {
+	return OdooCompositeID{
+		Valid: true,
+		ID:    id,
+		Name:  name,
+	}
+}
+
 // UnmarshalJSON handles deserialization of OdooCompositeID.
 func (t *OdooCompositeID) UnmarshalJSON(b []byte) error {
 	// Odoo returns false (not null) if a field is not set.
@@ -66,5 +75,10 @@ func (t *OdooCompositeID) UnmarshalJSON(b []byte) error {
 
 // MarshalJSON handles serialization of OdooCompositeID.
 func (t OdooCompositeID) MarshalJSON() ([]byte, error) {
-	return json.Marshal([...]any{t.ID, t.Name})
+	if !t.Valid {
+		return []byte("false"), nil
+	}
+
+	// Write path wants just the ID, not the tuple.
+	return json.Marshal(t.ID)
 }