From 068f1b6d0517f62d2a76c7b1a761f15104220644 Mon Sep 17 00:00:00 2001 From: Dmitriy Matrenichev Date: Mon, 13 Jun 2022 20:14:28 +0800 Subject: [PATCH] feat: add ctest package and base for test suite This change adds ctest package which adds DefaultSuite and helper functions. Signed-off-by: Dmitriy Matrenichev --- .../machined/pkg/controllers/ctest/ctest.go | 131 ++++++++++ .../controllers/secrets/api_cert_sans_test.go | 172 +++++------- .../pkg/controllers/secrets/api_test.go | 164 +++++------- .../pkg/controllers/secrets/kubelet_test.go | 73 ++---- .../secrets/kubernetes_cert_sans_test.go | 212 ++++++--------- .../controllers/secrets/kubernetes_test.go | 245 +++++++----------- .../controllers/siderolink/manager_test.go | 222 ++++++---------- 7 files changed, 533 insertions(+), 686 deletions(-) create mode 100644 internal/app/machined/pkg/controllers/ctest/ctest.go diff --git a/internal/app/machined/pkg/controllers/ctest/ctest.go b/internal/app/machined/pkg/controllers/ctest/ctest.go new file mode 100644 index 000000000..bae9c96b8 --- /dev/null +++ b/internal/app/machined/pkg/controllers/ctest/ctest.go @@ -0,0 +1,131 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +// Package ctest provides basic types and functions for controller testing. +package ctest + +import ( + "context" + "log" + "sync" + "testing" + "time" + + "github.com/cosi-project/runtime/pkg/controller/runtime" + "github.com/cosi-project/runtime/pkg/resource" + "github.com/cosi-project/runtime/pkg/safe" + "github.com/cosi-project/runtime/pkg/state" + "github.com/cosi-project/runtime/pkg/state/impl/inmem" + "github.com/cosi-project/runtime/pkg/state/impl/namespaced" + "github.com/stretchr/testify/require" + "github.com/stretchr/testify/suite" + "github.com/talos-systems/go-retry/retry" + + "github.com/talos-systems/talos/pkg/logging" +) + +// DefaultSuite is a base suite for controller testing. +type DefaultSuite struct { //nolint:govet + suite.Suite + + state state.State + + runtime *runtime.Runtime + wg sync.WaitGroup + + ctx context.Context //nolint:containedctx + ctxCancel context.CancelFunc + + AfterSetup func(suite *DefaultSuite) + AfterTearDown func(suite *DefaultSuite) +} + +// SetupTest is a function for setting up a test. +func (suite *DefaultSuite) SetupTest() { + suite.ctx, suite.ctxCancel = context.WithTimeout(context.Background(), 3*time.Minute) + + suite.state = state.WrapCore(namespaced.NewState(inmem.Build)) + + var err error + + suite.runtime, err = runtime.NewRuntime(suite.state, logging.Wrap(log.Writer())) + suite.Require().NoError(err) + + suite.startRuntime() + + if suite.AfterSetup != nil { + suite.AfterSetup(suite) + } +} + +func (suite *DefaultSuite) startRuntime() { + suite.wg.Add(1) + + go func() { + defer suite.wg.Done() + + suite.Assert().NoError(suite.runtime.Run(suite.ctx)) + }() +} + +// Runtime returns the runtime of the suite. +func (suite *DefaultSuite) Runtime() *runtime.Runtime { + return suite.runtime +} + +// State returns the state of the suite. +func (suite *DefaultSuite) State() state.State { + return suite.state +} + +// Ctx returns the context of the suite. +func (suite *DefaultSuite) Ctx() context.Context { + return suite.ctx +} + +// AssertWithin asserts that fn returns within the given duration without an error. +func (suite *DefaultSuite) AssertWithin(d time.Duration, rate time.Duration, fn func() error) { + retryer := retry.Constant(d, retry.WithUnits(rate)) + suite.Assert().NoError(retryer.Retry(fn)) +} + +// TearDownTest is a function for tearing down a test. +func (suite *DefaultSuite) TearDownTest() { + suite.T().Log("tear down") + + suite.ctxCancel() + + suite.wg.Wait() + + if suite.AfterTearDown != nil { + suite.AfterTearDown(suite) + } +} + +// Suite is a type which dectibes the suite type. +type Suite interface { + T() *testing.T + Require() *require.Assertions + State() state.State + Ctx() context.Context +} + +// UpdateWithConflicts is a type safe wrapper around state.UpdateWithConflicts which uses the provided suite. +func UpdateWithConflicts[T resource.Resource](suite Suite, res T, updateFn func(T) error, options ...state.UpdateOption) T { //nolint:ireturn + suite.T().Helper() + result, err := safe.StateUpdateWithConflicts(suite.Ctx(), suite.State(), res.Metadata(), updateFn, options...) + suite.Require().NoError(err) + + return result +} + +// GetUsingResource is a type safe wrapper around state.StateGetResource which uses the provided suite. +func GetUsingResource[T resource.Resource](suite Suite, res T, options ...state.GetOption) (T, error) { //nolint:ireturn + return safe.StateGetResource(suite.Ctx(), suite.State(), res, options...) +} + +// Get is a type safe wrapper around state.Get which uses the provided suite. +func Get[T resource.Resource](suite Suite, ptr resource.Pointer, options ...state.GetOption) (T, error) { //nolint:ireturn + return safe.StateGet[T](suite.Ctx(), suite.State(), ptr, options...) +} diff --git a/internal/app/machined/pkg/controllers/secrets/api_cert_sans_test.go b/internal/app/machined/pkg/controllers/secrets/api_cert_sans_test.go index 95a96faee..7d8bce8d0 100644 --- a/internal/app/machined/pkg/controllers/secrets/api_cert_sans_test.go +++ b/internal/app/machined/pkg/controllers/secrets/api_cert_sans_test.go @@ -6,65 +6,36 @@ package secrets_test import ( - "context" "fmt" - "log" "reflect" - "sync" "testing" "time" - "github.com/cosi-project/runtime/pkg/controller/runtime" "github.com/cosi-project/runtime/pkg/resource" "github.com/cosi-project/runtime/pkg/state" - "github.com/cosi-project/runtime/pkg/state/impl/inmem" - "github.com/cosi-project/runtime/pkg/state/impl/namespaced" "github.com/stretchr/testify/suite" "github.com/talos-systems/go-retry/retry" "inet.af/netaddr" + "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/ctest" secretsctrl "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/secrets" - "github.com/talos-systems/talos/pkg/logging" "github.com/talos-systems/talos/pkg/machinery/resources/k8s" "github.com/talos-systems/talos/pkg/machinery/resources/network" "github.com/talos-systems/talos/pkg/machinery/resources/secrets" ) +func TestAPICertSANsSuite(t *testing.T) { + suite.Run(t, &APICertSANsSuite{ + DefaultSuite: ctest.DefaultSuite{ + AfterSetup: func(suite *ctest.DefaultSuite) { + suite.Require().NoError(suite.Runtime().RegisterController(&secretsctrl.APICertSANsController{})) + }, + }, + }) +} + type APICertSANsSuite struct { - suite.Suite - - state state.State - - runtime *runtime.Runtime - wg sync.WaitGroup - - ctx context.Context //nolint:containedctx - ctxCancel context.CancelFunc -} - -func (suite *APICertSANsSuite) SetupTest() { - suite.ctx, suite.ctxCancel = context.WithTimeout(context.Background(), 3*time.Minute) - - suite.state = state.WrapCore(namespaced.NewState(inmem.Build)) - - var err error - - suite.runtime, err = runtime.NewRuntime(suite.state, logging.Wrap(log.Writer())) - suite.Require().NoError(err) - - suite.Require().NoError(suite.runtime.RegisterController(&secretsctrl.APICertSANsController{})) - - suite.startRuntime() -} - -func (suite *APICertSANsSuite) startRuntime() { - suite.wg.Add(1) - - go func() { - defer suite.wg.Done() - - suite.Assert().NoError(suite.runtime.Run(suite.ctx)) - }() + ctest.DefaultSuite } func (suite *APICertSANsSuite) TestReconcileControlPlane() { @@ -72,12 +43,12 @@ func (suite *APICertSANsSuite) TestReconcileControlPlane() { rootSecrets.TypedSpec().CertSANDNSNames = []string{"some.org"} rootSecrets.TypedSpec().CertSANIPs = []netaddr.IP{netaddr.MustParseIP("10.4.3.2"), netaddr.MustParseIP("10.2.1.3")} - suite.Require().NoError(suite.state.Create(suite.ctx, rootSecrets)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), rootSecrets)) hostnameStatus := network.NewHostnameStatus(network.NamespaceName, network.HostnameID) hostnameStatus.TypedSpec().Hostname = "bar" hostnameStatus.TypedSpec().Domainname = "some.org" - suite.Require().NoError(suite.state.Create(suite.ctx, hostnameStatus)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), hostnameStatus)) nodeAddresses := network.NewNodeAddress( network.NamespaceName, @@ -87,84 +58,63 @@ func (suite *APICertSANsSuite) TestReconcileControlPlane() { netaddr.MustParseIPPrefix("10.2.1.3/24"), netaddr.MustParseIPPrefix("172.16.0.1/32"), } - suite.Require().NoError(suite.state.Create(suite.ctx, nodeAddresses)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), nodeAddresses)) - suite.Assert().NoError( - retry.Constant(10*time.Second, retry.WithUnits(100*time.Millisecond)).Retry( - func() error { - certSANs, err := suite.state.Get( - suite.ctx, - resource.NewMetadata( - secrets.NamespaceName, - secrets.CertSANType, - secrets.CertSANAPIID, - resource.VersionUndefined, - ), - ) - if err != nil { - if state.IsNotFoundError(err) { - return retry.ExpectedError(err) - } + suite.AssertWithin(10*time.Second, 100*time.Millisecond, func() error { + certSANs, err := ctest.Get[*secrets.CertSAN]( + suite, + resource.NewMetadata( + secrets.NamespaceName, + secrets.CertSANType, + secrets.CertSANAPIID, + resource.VersionUndefined, + ), + ) + if err != nil { + if state.IsNotFoundError(err) { + return retry.ExpectedError(err) + } - return err - } + return err + } - spec := certSANs.(*secrets.CertSAN).TypedSpec() + spec := certSANs.TypedSpec() - suite.Assert().Equal([]string{"bar", "bar.some.org", "some.org"}, spec.DNSNames) - suite.Assert().Equal("[10.2.1.3 10.4.3.2 172.16.0.1]", fmt.Sprintf("%v", spec.IPs)) - suite.Assert().Equal("bar.some.org", spec.FQDN) - - return nil - }, - ), - ) - - _, err := suite.state.UpdateWithConflicts(suite.ctx, rootSecrets.Metadata(), func(r resource.Resource) error { - r.(*secrets.OSRoot).TypedSpec().CertSANDNSNames = []string{"other.org"} + suite.Assert().Equal([]string{"bar", "bar.some.org", "some.org"}, spec.DNSNames) + suite.Assert().Equal("[10.2.1.3 10.4.3.2 172.16.0.1]", fmt.Sprintf("%v", spec.IPs)) + suite.Assert().Equal("bar.some.org", spec.FQDN) return nil }) - suite.Require().NoError(err) - suite.Assert().NoError( - retry.Constant(10*time.Second, retry.WithUnits(100*time.Millisecond)).Retry( - func() error { - certSANs, err := suite.state.Get( - suite.ctx, - resource.NewMetadata( - secrets.NamespaceName, - secrets.CertSANType, - secrets.CertSANAPIID, - resource.VersionUndefined, - ), - ) - if err != nil { - return err - } + ctest.UpdateWithConflicts(suite, rootSecrets, func(rootSecrets *secrets.OSRoot) error { + rootSecrets.TypedSpec().CertSANDNSNames = []string{"other.org"} - spec := certSANs.(*secrets.CertSAN).TypedSpec() + return nil + }) - expectedDNSNames := []string{"bar", "bar.some.org", "other.org"} + suite.AssertWithin(10*time.Second, 100*time.Millisecond, func() error { + certSANs, err := ctest.Get[*secrets.CertSAN]( + suite, + resource.NewMetadata( + secrets.NamespaceName, + secrets.CertSANType, + secrets.CertSANAPIID, + resource.VersionUndefined, + ), + ) + if err != nil { + return err + } - if !reflect.DeepEqual(expectedDNSNames, spec.DNSNames) { - return retry.ExpectedErrorf("expected %v, got %v", expectedDNSNames, spec.DNSNames) - } + spec := certSANs.TypedSpec() - return nil - }, - ), - ) -} - -func (suite *APICertSANsSuite) TearDownTest() { - suite.T().Log("tear down") - - suite.ctxCancel() - - suite.wg.Wait() -} - -func TestAPICertSANsSuite(t *testing.T) { - suite.Run(t, new(APICertSANsSuite)) + expectedDNSNames := []string{"bar", "bar.some.org", "other.org"} + + if !reflect.DeepEqual(expectedDNSNames, spec.DNSNames) { + return retry.ExpectedErrorf("expected %v, got %v", expectedDNSNames, spec.DNSNames) + } + + return nil + }) } diff --git a/internal/app/machined/pkg/controllers/secrets/api_test.go b/internal/app/machined/pkg/controllers/secrets/api_test.go index d4cc56776..dfbb02310 100644 --- a/internal/app/machined/pkg/controllers/secrets/api_test.go +++ b/internal/app/machined/pkg/controllers/secrets/api_test.go @@ -6,26 +6,20 @@ package secrets_test import ( - "context" stdlibx509 "crypto/x509" "fmt" - "log" - "sync" "testing" "time" - "github.com/cosi-project/runtime/pkg/controller/runtime" "github.com/cosi-project/runtime/pkg/resource" "github.com/cosi-project/runtime/pkg/state" - "github.com/cosi-project/runtime/pkg/state/impl/inmem" - "github.com/cosi-project/runtime/pkg/state/impl/namespaced" "github.com/stretchr/testify/suite" "github.com/talos-systems/crypto/x509" "github.com/talos-systems/go-retry/retry" "inet.af/netaddr" + "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/ctest" secretsctrl "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/secrets" - "github.com/talos-systems/talos/pkg/logging" "github.com/talos-systems/talos/pkg/machinery/config/types/v1alpha1/machine" "github.com/talos-systems/talos/pkg/machinery/resources/config" "github.com/talos-systems/talos/pkg/machinery/resources/network" @@ -33,41 +27,18 @@ import ( "github.com/talos-systems/talos/pkg/machinery/role" ) +func TestAPISuite(t *testing.T) { + suite.Run(t, &APISuite{ + DefaultSuite: ctest.DefaultSuite{ + AfterSetup: func(suite *ctest.DefaultSuite) { + suite.Require().NoError(suite.Runtime().RegisterController(&secretsctrl.APIController{})) + }, + }, + }) +} + type APISuite struct { - suite.Suite - - state state.State - - runtime *runtime.Runtime - wg sync.WaitGroup - - ctx context.Context //nolint:containedctx - ctxCancel context.CancelFunc -} - -func (suite *APISuite) SetupTest() { - suite.ctx, suite.ctxCancel = context.WithTimeout(context.Background(), 3*time.Minute) - - suite.state = state.WrapCore(namespaced.NewState(inmem.Build)) - - var err error - - suite.runtime, err = runtime.NewRuntime(suite.state, logging.Wrap(log.Writer())) - suite.Require().NoError(err) - - suite.Require().NoError(suite.runtime.RegisterController(&secretsctrl.APIController{})) - - suite.startRuntime() -} - -func (suite *APISuite) startRuntime() { - suite.wg.Add(1) - - go func() { - defer suite.wg.Done() - - suite.Assert().NoError(suite.runtime.Run(suite.ctx)) - }() + ctest.DefaultSuite } func (suite *APISuite) TestReconcileControlPlane() { @@ -85,16 +56,16 @@ func (suite *APISuite) TestReconcileControlPlane() { rootSecrets.TypedSpec().CertSANDNSNames = []string{"example.com"} rootSecrets.TypedSpec().CertSANIPs = []netaddr.IP{netaddr.MustParseIP("10.4.3.2"), netaddr.MustParseIP("10.2.1.3")} rootSecrets.TypedSpec().Token = "something" - suite.Require().NoError(suite.state.Create(suite.ctx, rootSecrets)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), rootSecrets)) machineType := config.NewMachineType() machineType.SetMachineType(machine.TypeControlPlane) - suite.Require().NoError(suite.state.Create(suite.ctx, machineType)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), machineType)) networkStatus := network.NewStatus(network.NamespaceName, network.StatusID) networkStatus.TypedSpec().AddressReady = true networkStatus.TypedSpec().HostnameReady = true - suite.Require().NoError(suite.state.Create(suite.ctx, networkStatus)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), networkStatus)) certSANs := secrets.NewCertSAN(secrets.NamespaceName, secrets.CertSANAPIID) certSANs.TypedSpec().Append( @@ -108,77 +79,60 @@ func (suite *APISuite) TestReconcileControlPlane() { certSANs.TypedSpec().FQDN = "foo.example.com" - suite.Require().NoError(suite.state.Create(suite.ctx, certSANs)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), certSANs)) + suite.AssertWithin(10*time.Second, 100*time.Millisecond, func() error { + certs, err := ctest.Get[*secrets.API]( + suite, + resource.NewMetadata( + secrets.NamespaceName, + secrets.APIType, + secrets.APIID, + resource.VersionUndefined, + ), + ) + if err != nil { + if state.IsNotFoundError(err) { + return retry.ExpectedError(err) + } - suite.Assert().NoError( - retry.Constant(10*time.Second, retry.WithUnits(100*time.Millisecond)).Retry( - func() error { - certs, err := suite.state.Get( - suite.ctx, - resource.NewMetadata( - secrets.NamespaceName, - secrets.APIType, - secrets.APIID, - resource.VersionUndefined, - ), - ) - if err != nil { - if state.IsNotFoundError(err) { - return retry.ExpectedError(err) - } + return err + } - return err - } + apiCerts := certs.TypedSpec() - apiCerts := certs.(*secrets.API).TypedSpec() + suite.Assert().Equal(talosCA.CrtPEM, apiCerts.CA.Crt) + suite.Assert().Nil(apiCerts.CA.Key) - suite.Assert().Equal(talosCA.CrtPEM, apiCerts.CA.Crt) - suite.Assert().Nil(apiCerts.CA.Key) + serverCert, err := apiCerts.Server.GetCert() + suite.Require().NoError(err) - serverCert, err := apiCerts.Server.GetCert() - suite.Require().NoError(err) + suite.Assert().Equal([]string{"example.com", "foo", "foo.example.com"}, serverCert.DNSNames) + suite.Assert().Equal("[10.2.1.3 10.4.3.2 172.16.0.1]", fmt.Sprintf("%v", serverCert.IPAddresses)) - suite.Assert().Equal([]string{"example.com", "foo", "foo.example.com"}, serverCert.DNSNames) - suite.Assert().Equal("[10.2.1.3 10.4.3.2 172.16.0.1]", fmt.Sprintf("%v", serverCert.IPAddresses)) + suite.Assert().Equal("foo.example.com", serverCert.Subject.CommonName) + suite.Assert().Empty(serverCert.Subject.Organization) - suite.Assert().Equal("foo.example.com", serverCert.Subject.CommonName) - suite.Assert().Empty(serverCert.Subject.Organization) + suite.Assert().Equal( + stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, + serverCert.KeyUsage, + ) + suite.Assert().Equal([]stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageServerAuth}, serverCert.ExtKeyUsage) - suite.Assert().Equal( - stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, - serverCert.KeyUsage, - ) - suite.Assert().Equal([]stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageServerAuth}, serverCert.ExtKeyUsage) + clientCert, err := apiCerts.Client.GetCert() + suite.Require().NoError(err) - clientCert, err := apiCerts.Client.GetCert() - suite.Require().NoError(err) + suite.Assert().Empty(clientCert.DNSNames) + suite.Assert().Empty(clientCert.IPAddresses) - suite.Assert().Empty(clientCert.DNSNames) - suite.Assert().Empty(clientCert.IPAddresses) + suite.Assert().Equal("foo.example.com", clientCert.Subject.CommonName) + suite.Assert().Equal([]string{string(role.Impersonator)}, clientCert.Subject.Organization) - suite.Assert().Equal("foo.example.com", clientCert.Subject.CommonName) - suite.Assert().Equal([]string{string(role.Impersonator)}, clientCert.Subject.Organization) + suite.Assert().Equal( + stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, + clientCert.KeyUsage, + ) + suite.Assert().Equal([]stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageClientAuth}, clientCert.ExtKeyUsage) - suite.Assert().Equal( - stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, - clientCert.KeyUsage, - ) - suite.Assert().Equal([]stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageClientAuth}, clientCert.ExtKeyUsage) - - return nil - }, - ), - ) -} - -func (suite *APISuite) TearDownTest() { - suite.T().Log("tear down") - - suite.ctxCancel() - - suite.wg.Wait() -} - -func TestAPISuite(t *testing.T) { - suite.Run(t, new(APISuite)) + return nil + }) } diff --git a/internal/app/machined/pkg/controllers/secrets/kubelet_test.go b/internal/app/machined/pkg/controllers/secrets/kubelet_test.go index 0193ab257..b2a7326a3 100644 --- a/internal/app/machined/pkg/controllers/secrets/kubelet_test.go +++ b/internal/app/machined/pkg/controllers/secrets/kubelet_test.go @@ -6,64 +6,35 @@ package secrets_test import ( - "context" - "log" "net/url" - "sync" "testing" "time" - "github.com/cosi-project/runtime/pkg/controller/runtime" "github.com/cosi-project/runtime/pkg/resource" "github.com/cosi-project/runtime/pkg/state" - "github.com/cosi-project/runtime/pkg/state/impl/inmem" - "github.com/cosi-project/runtime/pkg/state/impl/namespaced" "github.com/stretchr/testify/suite" "github.com/talos-systems/crypto/x509" "github.com/talos-systems/go-retry/retry" + "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/ctest" secretsctrl "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/secrets" - "github.com/talos-systems/talos/pkg/logging" "github.com/talos-systems/talos/pkg/machinery/config/types/v1alpha1" "github.com/talos-systems/talos/pkg/machinery/resources/config" "github.com/talos-systems/talos/pkg/machinery/resources/secrets" ) +func TestKubeletSuite(t *testing.T) { + suite.Run(t, &KubeletSuite{ + DefaultSuite: ctest.DefaultSuite{ + AfterSetup: func(suite *ctest.DefaultSuite) { + suite.Require().NoError(suite.Runtime().RegisterController(&secretsctrl.KubeletController{})) + }, + }, + }) +} + type KubeletSuite struct { - suite.Suite - - state state.State - - runtime *runtime.Runtime - wg sync.WaitGroup - - ctx context.Context //nolint:containedctx - ctxCancel context.CancelFunc -} - -func (suite *KubeletSuite) SetupTest() { - suite.ctx, suite.ctxCancel = context.WithTimeout(context.Background(), 3*time.Minute) - - suite.state = state.WrapCore(namespaced.NewState(inmem.Build)) - - var err error - - suite.runtime, err = runtime.NewRuntime(suite.state, logging.Wrap(log.Writer())) - suite.Require().NoError(err) - - suite.Require().NoError(suite.runtime.RegisterController(&secretsctrl.KubeletController{})) - - suite.startRuntime() -} - -func (suite *KubeletSuite) startRuntime() { - suite.wg.Add(1) - - go func() { - defer suite.wg.Done() - - suite.Assert().NoError(suite.runtime.Run(suite.ctx)) - }() + ctest.DefaultSuite } func (suite *KubeletSuite) TestReconcile() { @@ -91,13 +62,13 @@ func (suite *KubeletSuite) TestReconcile() { }, ) - suite.Require().NoError(suite.state.Create(suite.ctx, cfg)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), cfg)) suite.Assert().NoError( retry.Constant(10*time.Second, retry.WithUnits(100*time.Millisecond)).Retry( func() error { - kubeletSecrets, err := suite.state.Get( - suite.ctx, + kubeletSecrets, err := ctest.Get[*secrets.Kubelet]( + suite, resource.NewMetadata( secrets.NamespaceName, secrets.KubeletType, @@ -113,7 +84,7 @@ func (suite *KubeletSuite) TestReconcile() { return err } - spec := kubeletSecrets.(*secrets.Kubelet).TypedSpec() + spec := kubeletSecrets.TypedSpec() suite.Assert().Equal("https://foo:6443", spec.Endpoint.String()) suite.Assert().Equal(k8sCA, spec.CA) @@ -125,15 +96,3 @@ func (suite *KubeletSuite) TestReconcile() { ), ) } - -func (suite *KubeletSuite) TearDownTest() { - suite.T().Log("tear down") - - suite.ctxCancel() - - suite.wg.Wait() -} - -func TestKubeletSuite(t *testing.T) { - suite.Run(t, new(KubeletSuite)) -} diff --git a/internal/app/machined/pkg/controllers/secrets/kubernetes_cert_sans_test.go b/internal/app/machined/pkg/controllers/secrets/kubernetes_cert_sans_test.go index ba3510b96..50b758a65 100644 --- a/internal/app/machined/pkg/controllers/secrets/kubernetes_cert_sans_test.go +++ b/internal/app/machined/pkg/controllers/secrets/kubernetes_cert_sans_test.go @@ -6,67 +6,38 @@ package secrets_test import ( - "context" "fmt" - "log" "net" "net/url" "reflect" - "sync" "testing" "time" - "github.com/cosi-project/runtime/pkg/controller/runtime" "github.com/cosi-project/runtime/pkg/resource" "github.com/cosi-project/runtime/pkg/state" - "github.com/cosi-project/runtime/pkg/state/impl/inmem" - "github.com/cosi-project/runtime/pkg/state/impl/namespaced" "github.com/stretchr/testify/suite" "github.com/talos-systems/go-retry/retry" "inet.af/netaddr" + "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/ctest" secretsctrl "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/secrets" - "github.com/talos-systems/talos/pkg/logging" "github.com/talos-systems/talos/pkg/machinery/resources/k8s" "github.com/talos-systems/talos/pkg/machinery/resources/network" "github.com/talos-systems/talos/pkg/machinery/resources/secrets" ) type KubernetesCertSANsSuite struct { - suite.Suite - - state state.State - - runtime *runtime.Runtime - wg sync.WaitGroup - - ctx context.Context //nolint:containedctx - ctxCancel context.CancelFunc + ctest.DefaultSuite } -func (suite *KubernetesCertSANsSuite) SetupTest() { - suite.ctx, suite.ctxCancel = context.WithTimeout(context.Background(), 3*time.Minute) - - suite.state = state.WrapCore(namespaced.NewState(inmem.Build)) - - var err error - - suite.runtime, err = runtime.NewRuntime(suite.state, logging.Wrap(log.Writer())) - suite.Require().NoError(err) - - suite.Require().NoError(suite.runtime.RegisterController(&secretsctrl.KubernetesCertSANsController{})) - - suite.startRuntime() -} - -func (suite *KubernetesCertSANsSuite) startRuntime() { - suite.wg.Add(1) - - go func() { - defer suite.wg.Done() - - suite.Assert().NoError(suite.runtime.Run(suite.ctx)) - }() +func TestKubernetesCertSANsSuite(t *testing.T) { + suite.Run(t, &KubernetesCertSANsSuite{ + DefaultSuite: ctest.DefaultSuite{ + AfterSetup: func(suite *ctest.DefaultSuite) { + suite.Require().NoError(suite.Runtime().RegisterController(&secretsctrl.KubernetesCertSANsController{})) + }, + }, + }) } func (suite *KubernetesCertSANsSuite) TestReconcile() { @@ -82,12 +53,12 @@ func (suite *KubernetesCertSANsSuite) TestReconcile() { rootSecrets.TypedSpec().LocalEndpoint, err = url.Parse("https://localhost:6443/") suite.Require().NoError(err) - suite.Require().NoError(suite.state.Create(suite.ctx, rootSecrets)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), rootSecrets)) hostnameStatus := network.NewHostnameStatus(network.NamespaceName, network.HostnameID) hostnameStatus.TypedSpec().Hostname = "foo" hostnameStatus.TypedSpec().Domainname = "example.com" - suite.Require().NoError(suite.state.Create(suite.ctx, hostnameStatus)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), hostnameStatus)) nodeAddresses := network.NewNodeAddress( network.NamespaceName, @@ -97,109 +68,86 @@ func (suite *KubernetesCertSANsSuite) TestReconcile() { netaddr.MustParseIPPrefix("10.2.1.3/24"), netaddr.MustParseIPPrefix("172.16.0.1/32"), } - suite.Require().NoError(suite.state.Create(suite.ctx, nodeAddresses)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), nodeAddresses)) - suite.Assert().NoError( - retry.Constant(10*time.Second, retry.WithUnits(100*time.Millisecond)).Retry( - func() error { - var certSANs resource.Resource + suite.AssertWithin(10*time.Second, 100*time.Millisecond, func() error { + certSANs, err := ctest.Get[*secrets.CertSAN]( + suite, + resource.NewMetadata( + secrets.NamespaceName, + secrets.CertSANType, + secrets.CertSANKubernetesID, + resource.VersionUndefined, + ), + ) + if err != nil { + if state.IsNotFoundError(err) { + return retry.ExpectedError(err) + } - certSANs, err = suite.state.Get( - suite.ctx, - resource.NewMetadata( - secrets.NamespaceName, - secrets.CertSANType, - secrets.CertSANKubernetesID, - resource.VersionUndefined, - ), - ) - if err != nil { - if state.IsNotFoundError(err) { - return retry.ExpectedError(err) - } + return err + } - return err - } + spec := certSANs.TypedSpec() - spec := certSANs.(*secrets.CertSAN).TypedSpec() + suite.Assert().Equal( + []string{ + "example.com", + "foo", + "foo.example.com", + "kubernetes", + "kubernetes.default", + "kubernetes.default.svc", + "kubernetes.default.svc.cluster.remote", + "localhost", + "some.url", + }, spec.DNSNames, + ) + suite.Assert().Equal("[10.2.1.3 10.4.3.2 172.16.0.1]", fmt.Sprintf("%v", spec.IPs)) - suite.Assert().Equal( - []string{ - "example.com", - "foo", - "foo.example.com", - "kubernetes", - "kubernetes.default", - "kubernetes.default.svc", - "kubernetes.default.svc.cluster.remote", - "localhost", - "some.url", - }, spec.DNSNames, - ) - suite.Assert().Equal("[10.2.1.3 10.4.3.2 172.16.0.1]", fmt.Sprintf("%v", spec.IPs)) + return nil + }) - return nil - }, - ), - ) - - _, err = suite.state.UpdateWithConflicts(suite.ctx, rootSecrets.Metadata(), func(r resource.Resource) error { - r.(*secrets.KubernetesRoot).TypedSpec().Endpoint, err = url.Parse("https://some.other.url:6443/") + ctest.UpdateWithConflicts(suite, rootSecrets, func(rootSecrets *secrets.KubernetesRoot) error { + var err error + rootSecrets.TypedSpec().Endpoint, err = url.Parse("https://some.other.url:6443/") return err }) - suite.Require().NoError(err) - suite.Assert().NoError( - retry.Constant(10*time.Second, retry.WithUnits(100*time.Millisecond)).Retry( - func() error { - var certSANs resource.Resource + suite.AssertWithin(10*time.Second, 100*time.Millisecond, func() error { + var certSANs resource.Resource + certSANs, err := ctest.Get[*secrets.CertSAN]( + suite, + resource.NewMetadata( + secrets.NamespaceName, + secrets.CertSANType, + secrets.CertSANKubernetesID, + resource.VersionUndefined, + ), + ) + if err != nil { + return err + } - certSANs, err = suite.state.Get( - suite.ctx, - resource.NewMetadata( - secrets.NamespaceName, - secrets.CertSANType, - secrets.CertSANKubernetesID, - resource.VersionUndefined, - ), - ) - if err != nil { - return err - } + spec := certSANs.(*secrets.CertSAN).TypedSpec() - spec := certSANs.(*secrets.CertSAN).TypedSpec() + expectedDNSNames := []string{ + "example.com", + "foo", + "foo.example.com", + "kubernetes", + "kubernetes.default", + "kubernetes.default.svc", + "kubernetes.default.svc.cluster.remote", + "localhost", + "some.other.url", + } - expectedDNSNames := []string{ - "example.com", - "foo", - "foo.example.com", - "kubernetes", - "kubernetes.default", - "kubernetes.default.svc", - "kubernetes.default.svc.cluster.remote", - "localhost", - "some.other.url", - } + if !reflect.DeepEqual(spec.DNSNames, expectedDNSNames) { + return retry.ExpectedErrorf("expected %v, got %v", expectedDNSNames, spec.DNSNames) + } - if !reflect.DeepEqual(spec.DNSNames, expectedDNSNames) { - return retry.ExpectedErrorf("expected %v, got %v", expectedDNSNames, spec.DNSNames) - } - - return nil - }, - ), - ) -} - -func (suite *KubernetesCertSANsSuite) TearDownTest() { - suite.T().Log("tear down") - - suite.ctxCancel() - - suite.wg.Wait() -} - -func TestKubernetesCertSANsSuite(t *testing.T) { - suite.Run(t, new(KubernetesCertSANsSuite)) + return nil + }) } diff --git a/internal/app/machined/pkg/controllers/secrets/kubernetes_test.go b/internal/app/machined/pkg/controllers/secrets/kubernetes_test.go index ef361e2e1..ce339930d 100644 --- a/internal/app/machined/pkg/controllers/secrets/kubernetes_test.go +++ b/internal/app/machined/pkg/controllers/secrets/kubernetes_test.go @@ -6,28 +6,22 @@ package secrets_test import ( - "context" stdlibx509 "crypto/x509" "fmt" - "log" "net" "net/url" - "sync" "testing" "time" - "github.com/cosi-project/runtime/pkg/controller/runtime" "github.com/cosi-project/runtime/pkg/resource" "github.com/cosi-project/runtime/pkg/state" - "github.com/cosi-project/runtime/pkg/state/impl/inmem" - "github.com/cosi-project/runtime/pkg/state/impl/namespaced" "github.com/stretchr/testify/suite" "github.com/talos-systems/crypto/x509" "github.com/talos-systems/go-retry/retry" "k8s.io/client-go/tools/clientcmd" + "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/ctest" secretsctrl "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/secrets" - "github.com/talos-systems/talos/pkg/logging" "github.com/talos-systems/talos/pkg/machinery/config/types/v1alpha1/machine" "github.com/talos-systems/talos/pkg/machinery/constants" "github.com/talos-systems/talos/pkg/machinery/resources/config" @@ -36,41 +30,18 @@ import ( timeresource "github.com/talos-systems/talos/pkg/machinery/resources/time" ) +func TestKubernetesSuite(t *testing.T) { + suite.Run(t, &KubernetesSuite{ + DefaultSuite: ctest.DefaultSuite{ + AfterSetup: func(suite *ctest.DefaultSuite) { + suite.Require().NoError(suite.Runtime().RegisterController(&secretsctrl.KubernetesController{})) + }, + }, + }) +} + type KubernetesSuite struct { - suite.Suite - - state state.State - - runtime *runtime.Runtime - wg sync.WaitGroup - - ctx context.Context //nolint:containedctx - ctxCancel context.CancelFunc -} - -func (suite *KubernetesSuite) SetupTest() { - suite.ctx, suite.ctxCancel = context.WithTimeout(context.Background(), 3*time.Minute) - - suite.state = state.WrapCore(namespaced.NewState(inmem.Build)) - - var err error - - suite.runtime, err = runtime.NewRuntime(suite.state, logging.Wrap(log.Writer())) - suite.Require().NoError(err) - - suite.Require().NoError(suite.runtime.RegisterController(&secretsctrl.KubernetesController{})) - - suite.startRuntime() -} - -func (suite *KubernetesSuite) startRuntime() { - suite.wg.Add(1) - - go func() { - defer suite.wg.Done() - - suite.Assert().NoError(suite.runtime.Run(suite.ctx)) - }() + ctest.DefaultSuite } func (suite *KubernetesSuite) TestReconcile() { @@ -111,16 +82,16 @@ func (suite *KubernetesSuite) TestReconcile() { rootSecrets.TypedSpec().CertSANs = []string{"example.com"} rootSecrets.TypedSpec().APIServerIPs = []net.IP{net.ParseIP("10.4.3.2"), net.ParseIP("10.2.1.3")} rootSecrets.TypedSpec().DNSDomain = "cluster.remote" - suite.Require().NoError(suite.state.Create(suite.ctx, rootSecrets)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), rootSecrets)) machineType := config.NewMachineType() machineType.SetMachineType(machine.TypeControlPlane) - suite.Require().NoError(suite.state.Create(suite.ctx, machineType)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), machineType)) networkStatus := network.NewStatus(network.NamespaceName, network.StatusID) networkStatus.TypedSpec().AddressReady = true networkStatus.TypedSpec().HostnameReady = true - suite.Require().NoError(suite.state.Create(suite.ctx, networkStatus)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), networkStatus)) certSANs := secrets.NewCertSAN(secrets.NamespaceName, secrets.CertSANKubernetesID) certSANs.TypedSpec().Append( @@ -137,128 +108,112 @@ func (suite *KubernetesSuite) TestReconcile() { "10.4.3.2", "172.16.0.1", ) - suite.Require().NoError(suite.state.Create(suite.ctx, certSANs)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), certSANs)) timeSync := timeresource.NewStatus() *timeSync.TypedSpec() = timeresource.StatusSpec{ Synced: true, } - suite.Require().NoError(suite.state.Create(suite.ctx, timeSync)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), timeSync)) - suite.Assert().NoError( - retry.Constant(10*time.Second, retry.WithUnits(100*time.Millisecond)).Retry( - func() error { - certs, err := suite.state.Get( - suite.ctx, - resource.NewMetadata( - secrets.NamespaceName, - secrets.KubernetesType, - secrets.KubernetesID, - resource.VersionUndefined, - ), - ) - if err != nil { - if state.IsNotFoundError(err) { - return retry.ExpectedError(err) - } + suite.AssertWithin(10*time.Second, 100*time.Millisecond, func() error { + certs, err := ctest.Get[*secrets.Kubernetes]( + suite, + resource.NewMetadata( + secrets.NamespaceName, + secrets.KubernetesType, + secrets.KubernetesID, + resource.VersionUndefined, + ), + ) + if err != nil { + if state.IsNotFoundError(err) { + return retry.ExpectedError(err) + } - return err - } + return err + } - kubernetesCerts := certs.(*secrets.Kubernetes).TypedSpec() + kubernetesCerts := certs.TypedSpec() - apiCert, err := kubernetesCerts.APIServer.GetCert() - suite.Require().NoError(err) + apiCert, err := kubernetesCerts.APIServer.GetCert() + suite.Require().NoError(err) - suite.Assert().Equal( - []string{ - "example.com", - "foo", - "foo.example.com", - "kubernetes", - "kubernetes.default", - "kubernetes.default.svc", - "kubernetes.default.svc.cluster.remote", - "localhost", - "some.url", - }, apiCert.DNSNames, - ) - suite.Assert().Equal("[10.2.1.3 10.4.3.2 172.16.0.1]", fmt.Sprintf("%v", apiCert.IPAddresses)) + suite.Assert().Equal( + []string{ + "example.com", + "foo", + "foo.example.com", + "kubernetes", + "kubernetes.default", + "kubernetes.default.svc", + "kubernetes.default.svc.cluster.remote", + "localhost", + "some.url", + }, apiCert.DNSNames, + ) + suite.Assert().Equal("[10.2.1.3 10.4.3.2 172.16.0.1]", fmt.Sprintf("%v", apiCert.IPAddresses)) - suite.Assert().Equal("kube-apiserver", apiCert.Subject.CommonName) - suite.Assert().Equal([]string{"kube-master"}, apiCert.Subject.Organization) + suite.Assert().Equal("kube-apiserver", apiCert.Subject.CommonName) + suite.Assert().Equal([]string{"kube-master"}, apiCert.Subject.Organization) - suite.Assert().Equal( - stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, - apiCert.KeyUsage, - ) - suite.Assert().Equal([]stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageServerAuth}, apiCert.ExtKeyUsage) + suite.Assert().Equal( + stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, + apiCert.KeyUsage, + ) + suite.Assert().Equal([]stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageServerAuth}, apiCert.ExtKeyUsage) - clientCert, err := kubernetesCerts.APIServerKubeletClient.GetCert() - suite.Require().NoError(err) + clientCert, err := kubernetesCerts.APIServerKubeletClient.GetCert() + suite.Require().NoError(err) - suite.Assert().Empty(clientCert.DNSNames) - suite.Assert().Empty(clientCert.IPAddresses) + suite.Assert().Empty(clientCert.DNSNames) + suite.Assert().Empty(clientCert.IPAddresses) - suite.Assert().Equal( - constants.KubernetesAPIServerKubeletClientCommonName, - clientCert.Subject.CommonName, - ) - suite.Assert().Equal( - []string{constants.KubernetesAdminCertOrganization}, - clientCert.Subject.Organization, - ) + suite.Assert().Equal( + constants.KubernetesAPIServerKubeletClientCommonName, + clientCert.Subject.CommonName, + ) + suite.Assert().Equal( + []string{constants.KubernetesAdminCertOrganization}, + clientCert.Subject.Organization, + ) - suite.Assert().Equal( - stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, - clientCert.KeyUsage, - ) - suite.Assert().Equal([]stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageClientAuth}, clientCert.ExtKeyUsage) + suite.Assert().Equal( + stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, + clientCert.KeyUsage, + ) + suite.Assert().Equal([]stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageClientAuth}, clientCert.ExtKeyUsage) - frontProxyCert, err := kubernetesCerts.FrontProxy.GetCert() - suite.Require().NoError(err) + frontProxyCert, err := kubernetesCerts.FrontProxy.GetCert() + suite.Require().NoError(err) - suite.Assert().Empty(frontProxyCert.DNSNames) - suite.Assert().Empty(frontProxyCert.IPAddresses) + suite.Assert().Empty(frontProxyCert.DNSNames) + suite.Assert().Empty(frontProxyCert.IPAddresses) - suite.Assert().Equal("front-proxy-client", frontProxyCert.Subject.CommonName) - suite.Assert().Empty(frontProxyCert.Subject.Organization) + suite.Assert().Equal("front-proxy-client", frontProxyCert.Subject.CommonName) + suite.Assert().Empty(frontProxyCert.Subject.Organization) - suite.Assert().Equal( - stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, - frontProxyCert.KeyUsage, - ) - suite.Assert().Equal( - []stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageClientAuth}, - frontProxyCert.ExtKeyUsage, - ) + suite.Assert().Equal( + stdlibx509.KeyUsageDigitalSignature|stdlibx509.KeyUsageKeyEncipherment, + frontProxyCert.KeyUsage, + ) + suite.Assert().Equal( + []stdlibx509.ExtKeyUsage{stdlibx509.ExtKeyUsageClientAuth}, + frontProxyCert.ExtKeyUsage, + ) - for _, kubeconfig := range []string{ - kubernetesCerts.ControllerManagerKubeconfig, - kubernetesCerts.SchedulerKubeconfig, - kubernetesCerts.LocalhostAdminKubeconfig, - kubernetesCerts.AdminKubeconfig, - } { - config, err := clientcmd.Load([]byte(kubeconfig)) - suite.Require().NoError(err) + for _, kubeconfig := range []string{ + kubernetesCerts.ControllerManagerKubeconfig, + kubernetesCerts.SchedulerKubeconfig, + kubernetesCerts.LocalhostAdminKubeconfig, + kubernetesCerts.AdminKubeconfig, + } { + config, err := clientcmd.Load([]byte(kubeconfig)) + suite.Require().NoError(err) - suite.Assert().NoError(clientcmd.ConfirmUsable(*config, config.CurrentContext)) - } + suite.Assert().NoError(clientcmd.ConfirmUsable(*config, config.CurrentContext)) + } - return nil - }, - ), - ) -} - -func (suite *KubernetesSuite) TearDownTest() { - suite.T().Log("tear down") - - suite.ctxCancel() - - suite.wg.Wait() -} - -func TestKubernetesSuite(t *testing.T) { - suite.Run(t, new(KubernetesSuite)) + return nil + }) } diff --git a/internal/app/machined/pkg/controllers/siderolink/manager_test.go b/internal/app/machined/pkg/controllers/siderolink/manager_test.go index ee61410b5..027f3cea2 100644 --- a/internal/app/machined/pkg/controllers/siderolink/manager_test.go +++ b/internal/app/machined/pkg/controllers/siderolink/manager_test.go @@ -7,17 +7,12 @@ package siderolink_test import ( "context" "fmt" - "log" "net" - "sync" "testing" "time" - "github.com/cosi-project/runtime/pkg/controller/runtime" "github.com/cosi-project/runtime/pkg/resource" "github.com/cosi-project/runtime/pkg/state" - "github.com/cosi-project/runtime/pkg/state/impl/inmem" - "github.com/cosi-project/runtime/pkg/state/impl/namespaced" "github.com/siderolabs/go-pointer" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/suite" @@ -27,24 +22,38 @@ import ( "google.golang.org/grpc" "inet.af/netaddr" + "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/ctest" siderolinkctrl "github.com/talos-systems/talos/internal/app/machined/pkg/controllers/siderolink" - "github.com/talos-systems/talos/pkg/logging" "github.com/talos-systems/talos/pkg/machinery/constants" "github.com/talos-systems/talos/pkg/machinery/nethelpers" "github.com/talos-systems/talos/pkg/machinery/resources/network" ) +func TestManagerSuite(t *testing.T) { + var m ManagerSuite + m.AfterSetup = func(suite *ctest.DefaultSuite) { + lis, err := net.Listen("tcp", "localhost:0") + suite.Require().NoError(err) + + m.s = grpc.NewServer() + pb.RegisterProvisionServiceServer(m.s, mockServer{}) + + go func() { + suite.Require().NoError(m.s.Serve(lis)) + }() + + cmdline := procfs.NewCmdline(fmt.Sprintf("%s=%s", constants.KernelParamSideroLink, lis.Addr().String())) + + suite.Require().NoError(suite.Runtime().RegisterController(&siderolinkctrl.ManagerController{ + Cmdline: cmdline, + })) + } + + suite.Run(t, &m) +} + type ManagerSuite struct { - suite.Suite - - state state.State - - runtime *runtime.Runtime - wg sync.WaitGroup - - ctx context.Context //nolint:containedctx - ctxCancel context.CancelFunc - + ctest.DefaultSuite s *grpc.Server } @@ -68,141 +77,82 @@ func (srv mockServer) Provision(ctx context.Context, req *pb.ProvisionRequest) ( }, nil } -func (suite *ManagerSuite) SetupTest() { - suite.ctx, suite.ctxCancel = context.WithTimeout(context.Background(), 3*time.Minute) - - suite.state = state.WrapCore(namespaced.NewState(inmem.Build)) - - var err error - - suite.runtime, err = runtime.NewRuntime(suite.state, logging.Wrap(log.Writer())) - suite.Require().NoError(err) - - suite.startRuntime() - - lis, err := net.Listen("tcp", "localhost:0") - suite.Require().NoError(err) - - suite.s = grpc.NewServer() - pb.RegisterProvisionServiceServer(suite.s, mockServer{}) - - go func() { - suite.Require().NoError(suite.s.Serve(lis)) - }() - - cmdline := procfs.NewCmdline(fmt.Sprintf("%s=%s", constants.KernelParamSideroLink, lis.Addr().String())) - - suite.Require().NoError( - suite.runtime.RegisterController( - &siderolinkctrl.ManagerController{ - Cmdline: cmdline, - }, - ), - ) -} - -func (suite *ManagerSuite) startRuntime() { - suite.wg.Add(1) - - go func() { - defer suite.wg.Done() - - suite.Assert().NoError(suite.runtime.Run(suite.ctx)) - }() -} - func (suite *ManagerSuite) TestReconcile() { networkStatus := network.NewStatus(network.NamespaceName, network.StatusID) networkStatus.TypedSpec().AddressReady = true - suite.Require().NoError(suite.state.Create(suite.ctx, networkStatus)) + suite.Require().NoError(suite.State().Create(suite.Ctx(), networkStatus)) nodeAddress := netaddr.MustParseIPPrefix(mockNodeAddressPrefix) - suite.Assert().NoError( - retry.Constant(5*time.Second, retry.WithUnits(100*time.Millisecond)).Retry( - func() error { - addressResource, err := suite.state.Get( - suite.ctx, resource.NewMetadata( - network.ConfigNamespaceName, - network.AddressSpecType, - network.LayeredID( - network.ConfigOperator, - network.AddressID(constants.SideroLinkName, nodeAddress), - ), - resource.VersionUndefined, - ), - ) - if err != nil { - if state.IsNotFoundError(err) { - return retry.ExpectedError(err) - } + suite.AssertWithin(10*time.Second, 100*time.Millisecond, func() error { + addressResource, err := ctest.Get[*network.AddressSpec]( + suite, + resource.NewMetadata( + network.ConfigNamespaceName, + network.AddressSpecType, + network.LayeredID( + network.ConfigOperator, + network.AddressID(constants.SideroLinkName, nodeAddress), + ), + resource.VersionUndefined, + ), + ) + if err != nil { + if state.IsNotFoundError(err) { + return retry.ExpectedError(err) + } - return err - } + return err + } - address := addressResource.(*network.AddressSpec).TypedSpec() + address := addressResource.TypedSpec() - suite.Assert().Equal(nodeAddress, address.Address) - suite.Assert().Equal(network.ConfigOperator, address.ConfigLayer) - suite.Assert().Equal(nethelpers.FamilyInet6, address.Family) - suite.Assert().Equal(constants.SideroLinkName, address.LinkName) + suite.Assert().Equal(nodeAddress, address.Address) + suite.Assert().Equal(network.ConfigOperator, address.ConfigLayer) + suite.Assert().Equal(nethelpers.FamilyInet6, address.Family) + suite.Assert().Equal(constants.SideroLinkName, address.LinkName) - linkResource, err := suite.state.Get( - suite.ctx, resource.NewMetadata( - network.ConfigNamespaceName, - network.LinkSpecType, - network.LayeredID(network.ConfigOperator, network.LinkID(constants.SideroLinkName)), - resource.VersionUndefined, - ), - ) - if err != nil { - if state.IsNotFoundError(err) { - return retry.ExpectedError(err) - } + linkResource, err := ctest.Get[*network.LinkSpec]( + suite, + resource.NewMetadata( + network.ConfigNamespaceName, + network.LinkSpecType, + network.LayeredID(network.ConfigOperator, network.LinkID(constants.SideroLinkName)), + resource.VersionUndefined, + ), + ) + if err != nil { + if state.IsNotFoundError(err) { + return retry.ExpectedError(err) + } - return err - } + return err + } - link := linkResource.(*network.LinkSpec).TypedSpec() + link := linkResource.TypedSpec() - suite.Assert().Equal("wireguard", link.Kind) - suite.Assert().Equal(network.ConfigOperator, link.ConfigLayer) - suite.Assert().NotEmpty(link.Wireguard.PrivateKey) - suite.Assert().Len(link.Wireguard.Peers, 1) - suite.Assert().Equal(mockServerEndpoint, link.Wireguard.Peers[0].Endpoint) - suite.Assert().Equal(mockServerPublicKey, link.Wireguard.Peers[0].PublicKey) - suite.Assert().Equal( - []netaddr.IPPrefix{ - netaddr.IPPrefixFrom( - netaddr.MustParseIP(mockServerAddress), - 128, - ), - }, link.Wireguard.Peers[0].AllowedIPs, - ) - suite.Assert().Equal( - constants.SideroLinkDefaultPeerKeepalive, - link.Wireguard.Peers[0].PersistentKeepaliveInterval, - ) + suite.Assert().Equal("wireguard", link.Kind) + suite.Assert().Equal(network.ConfigOperator, link.ConfigLayer) + suite.Assert().NotEmpty(link.Wireguard.PrivateKey) + suite.Assert().Len(link.Wireguard.Peers, 1) + suite.Assert().Equal(mockServerEndpoint, link.Wireguard.Peers[0].Endpoint) + suite.Assert().Equal(mockServerPublicKey, link.Wireguard.Peers[0].PublicKey) + suite.Assert().Equal( + []netaddr.IPPrefix{ + netaddr.IPPrefixFrom( + netaddr.MustParseIP(mockServerAddress), + 128, + ), + }, link.Wireguard.Peers[0].AllowedIPs, + ) + suite.Assert().Equal( + constants.SideroLinkDefaultPeerKeepalive, + link.Wireguard.Peers[0].PersistentKeepaliveInterval, + ) - return nil - }, - ), - ) -} - -func (suite *ManagerSuite) TearDownTest() { - suite.T().Log("tear down") - - suite.s.Stop() - - suite.ctxCancel() - - suite.wg.Wait() -} - -func TestManagerSuite(t *testing.T) { - suite.Run(t, new(ManagerSuite)) + return nil + }) } func TestParseJoinToken(t *testing.T) {