Files
cozystack/internal/crdinstall/install_test.go
Myasnikov Daniil 5d263a1e25 test(crdinstall): assert no-delete label survives Install + merge
Address review feedback from @lllamnyp on internal/crdinstall/install.go:
the deletion-protection label loop was untested — TestInstall_appliesAllCRDs
only checked that Install returned no error, so a refactor dropping the loop
would have shipped green and silently disabled VAP coverage on every Cozystack
CRD.

- Extend TestInstall_appliesAllCRDs to read each applied CRD back from the fake
  client and assert platform.cozystack.io/no-delete=true is present.
- Add TestInstall_preservesExistingLabels: feeds in a CRD whose manifest already
  carries app.kubernetes.io/managed-by=foo, asserts both that label and the
  deletion-protection label end up on the applied object. Locks down the merge
  contract in install.go:92-101 (the GetLabels()==nil branch is still covered
  by the first test).

Verified the new assertions fail when the label-stamping loop is removed.

Assisted-By: Claude <noreply@anthropic.com>
Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
2026-05-26 15:12:52 +05:00

374 lines
11 KiB
Go

/*
Copyright 2025 The Cozystack 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 crdinstall
import (
"context"
"fmt"
"os"
"path/filepath"
"strings"
"testing"
"time"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
)
func TestWriteEmbeddedManifests(t *testing.T) {
tmpDir := t.TempDir()
if err := WriteEmbeddedManifests(tmpDir); err != nil {
t.Fatalf("WriteEmbeddedManifests() error = %v", err)
}
entries, err := os.ReadDir(tmpDir)
if err != nil {
t.Fatalf("failed to read output dir: %v", err)
}
var yamlFiles []string
for _, e := range entries {
if strings.HasSuffix(e.Name(), ".yaml") {
yamlFiles = append(yamlFiles, e.Name())
}
}
if len(yamlFiles) == 0 {
t.Error("WriteEmbeddedManifests() produced no YAML files")
}
expectedFiles := []string{
"cozystack.io_packages.yaml",
"cozystack.io_packagesources.yaml",
}
for _, expected := range expectedFiles {
found := false
for _, actual := range yamlFiles {
if actual == expected {
found = true
break
}
}
if !found {
t.Errorf("expected file %q not found in output, got %v", expected, yamlFiles)
}
}
// Verify files are non-empty
for _, f := range yamlFiles {
data, err := os.ReadFile(filepath.Join(tmpDir, f))
if err != nil {
t.Errorf("failed to read %s: %v", f, err)
continue
}
if len(data) == 0 {
t.Errorf("file %s is empty", f)
}
}
}
func TestWriteEmbeddedManifests_filePermissions(t *testing.T) {
tmpDir := t.TempDir()
if err := WriteEmbeddedManifests(tmpDir); err != nil {
t.Fatalf("WriteEmbeddedManifests() error = %v", err)
}
entries, err := os.ReadDir(tmpDir)
if err != nil {
t.Fatalf("failed to read output dir: %v", err)
}
for _, e := range entries {
if !strings.HasSuffix(e.Name(), ".yaml") {
continue
}
info, err := e.Info()
if err != nil {
t.Errorf("failed to get info for %s: %v", e.Name(), err)
continue
}
perm := info.Mode().Perm()
if perm&0o077 != 0 {
t.Errorf("file %s has overly permissive mode %o, expected no group/other access", e.Name(), perm)
}
}
}
// newCRDManifestWriter returns a function that writes test CRD YAML files.
func newCRDManifestWriter(crds ...string) func(string) error {
return func(dir string) error {
for i, crd := range crds {
filename := filepath.Join(dir, fmt.Sprintf("crd%d.yaml", i+1))
if err := os.WriteFile(filename, []byte(crd), 0600); err != nil {
return err
}
}
return nil
}
}
var testCRD1 = `apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: packages.cozystack.io
spec:
group: cozystack.io
names:
kind: Package
plural: packages
scope: Namespaced
versions:
- name: v1alpha1
served: true
storage: true
schema:
openAPIV3Schema:
type: object
`
var testCRD2 = `apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: packagesources.cozystack.io
spec:
group: cozystack.io
names:
kind: PackageSource
plural: packagesources
scope: Namespaced
versions:
- name: v1alpha1
served: true
storage: true
schema:
openAPIV3Schema:
type: object
`
// establishedInterceptor simulates CRDs becoming Established in the API server.
func establishedInterceptor() interceptor.Funcs {
return interceptor.Funcs{
Get: func(ctx context.Context, c client.WithWatch, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error {
if err := c.Get(ctx, key, obj, opts...); err != nil {
return err
}
u, ok := obj.(*unstructured.Unstructured)
if !ok {
return nil
}
if u.GetKind() == "CustomResourceDefinition" {
_ = unstructured.SetNestedSlice(u.Object, []interface{}{
map[string]interface{}{
"type": "Established",
"status": "True",
},
}, "status", "conditions")
}
return nil
},
}
}
func TestInstall_appliesAllCRDs(t *testing.T) {
log.SetLogger(zap.New(zap.UseDevMode(true)))
scheme := runtime.NewScheme()
if err := apiextensionsv1.AddToScheme(scheme); err != nil {
t.Fatalf("failed to add apiextensions to scheme: %v", err)
}
fakeClient := fake.NewClientBuilder().
WithScheme(scheme).
WithInterceptorFuncs(establishedInterceptor()).
Build()
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
ctx = log.IntoContext(ctx, log.FromContext(context.Background()))
err := Install(ctx, fakeClient, newCRDManifestWriter(testCRD1, testCRD2))
if err != nil {
t.Fatalf("Install() error = %v", err)
}
for _, name := range []string{"packages.cozystack.io", "packagesources.cozystack.io"} {
applied := &unstructured.Unstructured{}
applied.SetGroupVersionKind(apiextensionsv1.SchemeGroupVersion.WithKind("CustomResourceDefinition"))
if err := fakeClient.Get(ctx, client.ObjectKey{Name: name}, applied); err != nil {
t.Fatalf("failed to read back applied CRD %s: %v", name, err)
}
labels := applied.GetLabels()
if labels["platform.cozystack.io/no-delete"] != "true" {
t.Errorf("CRD %s missing platform.cozystack.io/no-delete=true label; got labels=%v", name, labels)
}
}
}
// testCRDWithLabels mirrors testCRD1 but already carries a non-cozystack label.
// Exercises the merge path in Install: the existing label must survive, and the
// deletion-protection label must be added alongside it.
var testCRDWithLabels = `apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: packages.cozystack.io
labels:
app.kubernetes.io/managed-by: foo
spec:
group: cozystack.io
names:
kind: Package
plural: packages
scope: Namespaced
versions:
- name: v1alpha1
served: true
storage: true
schema:
openAPIV3Schema:
type: object
`
func TestInstall_preservesExistingLabels(t *testing.T) {
log.SetLogger(zap.New(zap.UseDevMode(true)))
scheme := runtime.NewScheme()
if err := apiextensionsv1.AddToScheme(scheme); err != nil {
t.Fatalf("failed to add apiextensions to scheme: %v", err)
}
fakeClient := fake.NewClientBuilder().
WithScheme(scheme).
WithInterceptorFuncs(establishedInterceptor()).
Build()
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
ctx = log.IntoContext(ctx, log.FromContext(context.Background()))
if err := Install(ctx, fakeClient, newCRDManifestWriter(testCRDWithLabels)); err != nil {
t.Fatalf("Install() error = %v", err)
}
applied := &unstructured.Unstructured{}
applied.SetGroupVersionKind(apiextensionsv1.SchemeGroupVersion.WithKind("CustomResourceDefinition"))
if err := fakeClient.Get(ctx, client.ObjectKey{Name: "packages.cozystack.io"}, applied); err != nil {
t.Fatalf("failed to read back applied CRD: %v", err)
}
labels := applied.GetLabels()
if labels["app.kubernetes.io/managed-by"] != "foo" {
t.Errorf("existing label app.kubernetes.io/managed-by=foo was lost; got labels=%v", labels)
}
if labels["platform.cozystack.io/no-delete"] != "true" {
t.Errorf("deletion-protection label missing after merge; got labels=%v", labels)
}
}
func TestInstall_noManifests(t *testing.T) {
log.SetLogger(zap.New(zap.UseDevMode(true)))
scheme := runtime.NewScheme()
fakeClient := fake.NewClientBuilder().WithScheme(scheme).Build()
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
ctx = log.IntoContext(ctx, log.FromContext(context.Background()))
err := Install(ctx, fakeClient, func(string) error { return nil })
if err == nil {
t.Error("Install() expected error for empty manifests, got nil")
}
if !strings.Contains(err.Error(), "no YAML manifest files found") {
t.Errorf("Install() error = %v, want error containing 'no YAML manifest files found'", err)
}
}
func TestInstall_writeManifestsFails(t *testing.T) {
log.SetLogger(zap.New(zap.UseDevMode(true)))
scheme := runtime.NewScheme()
fakeClient := fake.NewClientBuilder().WithScheme(scheme).Build()
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
ctx = log.IntoContext(ctx, log.FromContext(context.Background()))
err := Install(ctx, fakeClient, func(string) error { return os.ErrPermission })
if err == nil {
t.Error("Install() expected error when writeManifests fails, got nil")
}
}
func TestInstall_rejectsNonCRDObjects(t *testing.T) {
log.SetLogger(zap.New(zap.UseDevMode(true)))
scheme := runtime.NewScheme()
if err := apiextensionsv1.AddToScheme(scheme); err != nil {
t.Fatalf("failed to add apiextensions to scheme: %v", err)
}
fakeClient := fake.NewClientBuilder().WithScheme(scheme).Build()
nonCRD := `apiVersion: v1
kind: Namespace
metadata:
name: should-not-be-applied
`
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
ctx = log.IntoContext(ctx, log.FromContext(context.Background()))
err := Install(ctx, fakeClient, newCRDManifestWriter(nonCRD))
if err == nil {
t.Fatal("Install() expected error for non-CRD object, got nil")
}
if !strings.Contains(err.Error(), "unexpected object") {
t.Errorf("Install() error = %v, want error containing 'unexpected object'", err)
}
}
func TestInstall_crdNotEstablished(t *testing.T) {
log.SetLogger(zap.New(zap.UseDevMode(true)))
scheme := runtime.NewScheme()
if err := apiextensionsv1.AddToScheme(scheme); err != nil {
t.Fatalf("failed to add apiextensions to scheme: %v", err)
}
// No interceptor: CRDs will never get Established condition
fakeClient := fake.NewClientBuilder().WithScheme(scheme).Build()
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
ctx = log.IntoContext(ctx, log.FromContext(context.Background()))
err := Install(ctx, fakeClient, newCRDManifestWriter(testCRD1))
if err == nil {
t.Fatal("Install() expected error when CRDs never become established, got nil")
}
if !strings.Contains(err.Error(), "CRDs not established") {
t.Errorf("Install() error = %v, want error containing 'CRDs not established'", err)
}
}