Adds orders apply helper function

Signed-off-by: joshvanl <vleeuwenjoshua@gmail.com>
This commit is contained in:
joshvanl 2022-01-28 17:20:55 +00:00
parent 56d9423744
commit 4e73b60a32
5 changed files with 184 additions and 0 deletions

View File

@ -17,6 +17,7 @@ filegroup(
"//internal/controller/certificates:all-srcs",
"//internal/controller/feature:all-srcs",
"//internal/controller/issuers:all-srcs",
"//internal/controller/orders:all-srcs",
"//internal/ingress:all-srcs",
"//internal/plugin:all-srcs",
"//internal/test/paths:all-srcs",

View File

@ -0,0 +1,40 @@
load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
go_library(
name = "go_default_library",
srcs = ["apply.go"],
importpath = "github.com/cert-manager/cert-manager/internal/controller/orders",
visibility = ["//:__subpackages__"],
deps = [
"//pkg/apis/acme/v1:go_default_library",
"//pkg/client/clientset/versioned:go_default_library",
"@io_k8s_apimachinery//pkg/apis/meta/v1:go_default_library",
"@io_k8s_apimachinery//pkg/types:go_default_library",
"@io_k8s_utils//pointer:go_default_library",
],
)
go_test(
name = "go_default_test",
srcs = ["apply_test.go"],
embed = [":go_default_library"],
deps = [
"//pkg/apis/acme/v1:go_default_library",
"@com_github_google_gofuzz//:go_default_library",
"@com_github_stretchr_testify//assert:go_default_library",
],
)
filegroup(
name = "package-srcs",
srcs = glob(["**"]),
tags = ["automanaged"],
visibility = ["//visibility:private"],
)
filegroup(
name = "all-srcs",
srcs = [":package-srcs"],
tags = ["automanaged"],
visibility = ["//visibility:public"],
)

View File

@ -0,0 +1,4 @@
filters:
"^apply(_test)?\\.go$":
required_reviewers:
- joshvanl

View File

@ -0,0 +1,67 @@
/*
Copyright 2020 The cert-manager Authors.
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 orders
import (
"context"
"encoding/json"
"fmt"
cmclient "github.com/jetstack/cert-manager/pkg/client/clientset/versioned"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
apitypes "k8s.io/apimachinery/pkg/types"
"k8s.io/utils/pointer"
cmacme "github.com/jetstack/cert-manager/pkg/apis/acme/v1"
)
// ApplyStatus will make a Apply API call with the given client to the order's
// status sub-resource endpoint. All data in the given Order object is dropped;
// expect for the name, namespace, and status object. The given fieldManager is
// will be used as the FieldManager in the Apply call.
// Always sets Force Apply to true.
func ApplyStatus(ctx context.Context, cl cmclient.Interface, fieldManager string, order *cmacme.Order) error {
orderData, err := serializeApplyStatus(order)
if err != nil {
return err
}
_, err = cl.AcmeV1().Orders(order.Namespace).Patch(
ctx, order.Name, apitypes.ApplyPatchType, orderData,
metav1.PatchOptions{Force: pointer.Bool(true), FieldManager: fieldManager}, "status",
)
return err
}
// serializeApplyStatus converts the given Order object in JSON. Only the name,
// namespace, and status field values will be copied and encoded into the
// serialized slice. All other fields will be left at their zero value.
// TypeMeta will be populated with the Kind "Order" and API Version
// "acme.cert-manager.io/v1" respectively.
func serializeApplyStatus(order *cmacme.Order) ([]byte, error) {
order = &cmacme.Order{
TypeMeta: metav1.TypeMeta{Kind: cmacme.OrderKind, APIVersion: cmacme.SchemeGroupVersion.Identifier()},
ObjectMeta: metav1.ObjectMeta{Namespace: order.Namespace, Name: order.Name},
Status: order.Status,
}
orderData, err := json.Marshal(order)
if err != nil {
return nil, fmt.Errorf("failed to marshal order object: %w", err)
}
return orderData, nil
}

View File

@ -0,0 +1,72 @@
/*
Copyright 2020 The cert-manager Authors.
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 orders
import (
"strconv"
"sync"
"testing"
fuzz "github.com/google/gofuzz"
"github.com/stretchr/testify/assert"
cmacme "github.com/jetstack/cert-manager/pkg/apis/acme/v1"
)
func Test_serializeApplyStatus(t *testing.T) {
const (
expReg = `^{"kind":"Order","apiVersion":"acme.cert-manager.io/v1","metadata":{"name":"foo","namespace":"bar","creationTimestamp":null},"spec":{"request":null,"issuerRef":{"name":""}},"status":{.*}$`
expEmpty = `{"kind":"Order","apiVersion":"acme.cert-manager.io/v1","metadata":{"name":"foo","namespace":"bar","creationTimestamp":null},"spec":{"request":null,"issuerRef":{"name":""}},"status":{}}`
numJobs = 10000
)
var wg sync.WaitGroup
jobs := make(chan int)
wg.Add(numJobs)
for i := 0; i < 3; i++ {
go func() {
for j := range jobs {
t.Run("fuzz_"+strconv.Itoa(j), func(t *testing.T) {
var order cmacme.Order
fuzz.New().NilChance(0.5).Fuzz(&order)
order.Name = "foo"
order.Namespace = "bar"
// Test regex with non-empty status.
orderData, err := serializeApplyStatus(&order)
assert.NoError(t, err)
assert.Regexp(t, expReg, string(orderData))
// String match on empty status.
order.Status = cmacme.OrderStatus{}
orderData, err = serializeApplyStatus(&order)
assert.NoError(t, err)
assert.Equal(t, expEmpty, string(orderData))
wg.Done()
})
}
}()
}
for i := 0; i < numJobs; i++ {
jobs <- i
}
close(jobs)
wg.Wait()
}