-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Add scaffolding for the webhook test suite
- Loading branch information
Showing
9 changed files
with
565 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
194 changes: 194 additions & 0 deletions
194
pkg/plugin/v3/scaffolds/internal/templates/config/api/webhook_suite.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
package api | ||
|
||
import ( | ||
"fmt" | ||
"path/filepath" | ||
|
||
"sigs.k8s.io/kubebuilder/pkg/model/file" | ||
) | ||
|
||
var _ file.Template = &WebhookSuite{} | ||
var _ file.Inserter = &WebhookSuite{} | ||
|
||
// WebhookSuite scaffolds the webhook_suite.go file to setup the webhook test | ||
type WebhookSuite struct { | ||
file.TemplateMixin | ||
file.MultiGroupMixin | ||
file.BoilerplateMixin | ||
file.ResourceMixin | ||
|
||
// BaseDirectoryRelativePath define the Path for the base directory when it is multigroup | ||
BaseDirectoryRelativePath string | ||
} | ||
|
||
// SetTemplateDefaults implements file.Template | ||
func (f *WebhookSuite) SetTemplateDefaults() error { | ||
if f.Path == "" { | ||
if f.MultiGroup { | ||
if f.Resource.Group != "" { | ||
f.Path = filepath.Join("apis", "%[group]", "%[version]", "webhook_suite_test.go") | ||
} else { | ||
f.Path = filepath.Join("apis", "%[version]", "webhook_suite_test.go") | ||
} | ||
} else { | ||
f.Path = filepath.Join("api", "%[version]", "webhook_suite_test.go") | ||
} | ||
} | ||
f.Path = f.Resource.Replacer().Replace(f.Path) | ||
|
||
f.TemplateBody = fmt.Sprintf(webhookTestSuiteTemplate, | ||
file.NewMarkerFor(f.Path, addWebhookManagerMarker), | ||
) | ||
|
||
// If is multigroup the path needs to be ../../ since it has | ||
// the group dir. | ||
f.BaseDirectoryRelativePath = `"..", ".."` | ||
if f.MultiGroup && f.Resource.Group != "" { | ||
f.BaseDirectoryRelativePath = `"..", "..",".."` | ||
} | ||
|
||
return nil | ||
} | ||
|
||
const ( | ||
addWebhookManagerMarker = "webhook" | ||
) | ||
|
||
// GetMarkers implements file.Inserter | ||
func (f *WebhookSuite) GetMarkers() []file.Marker { | ||
return []file.Marker{ | ||
file.NewMarkerFor(f.Path, addWebhookManagerMarker), | ||
} | ||
} | ||
|
||
const ( | ||
addWebhookManagerCodeFragment = `err = (&%s{}).SetupWebhookWithManager(mgr) | ||
Expect(err).NotTo(HaveOccurred()) | ||
` | ||
) | ||
|
||
// GetCodeFragments implements file.Inserter | ||
func (f *WebhookSuite) GetCodeFragments() file.CodeFragmentsMap { | ||
fragments := make(file.CodeFragmentsMap, 2) | ||
|
||
// Generate add webhookManager code fragments | ||
addWebhookManager := make([]string, 0) | ||
addWebhookManager = append(addWebhookManager, fmt.Sprintf(addWebhookManagerCodeFragment, f.Resource.Kind)) | ||
|
||
// Only store code fragments in the map if the slices are non-empty | ||
if len(addWebhookManager) != 0 { | ||
fragments[file.NewMarkerFor(f.Path, addWebhookManagerMarker)] = addWebhookManager | ||
} | ||
|
||
return fragments | ||
} | ||
|
||
const ( | ||
webhookTestSuiteTemplate = ` | ||
package {{ .Resource.Version }} | ||
import ( | ||
"path/filepath" | ||
"testing" | ||
"fmt" | ||
. "github.com/onsi/ginkgo" | ||
. "github.com/onsi/gomega" | ||
"k8s.io/client-go/kubernetes/scheme" | ||
"k8s.io/client-go/rest" | ||
admissionv1 "k8s.io/api/admission/v1" | ||
"k8s.io/apimachinery/pkg/runtime" | ||
ctrl "sigs.k8s.io/controller-runtime" | ||
"sigs.k8s.io/controller-runtime/pkg/client" | ||
"sigs.k8s.io/controller-runtime/pkg/envtest" | ||
"sigs.k8s.io/controller-runtime/pkg/envtest/printer" | ||
logf "sigs.k8s.io/controller-runtime/pkg/log" | ||
"sigs.k8s.io/controller-runtime/pkg/log/zap" | ||
) | ||
// These tests use Ginkgo (BDD-style Go testing framework). Refer to | ||
// http://onsi.github.io/ginkgo/ to learn more about Ginkgo. | ||
var cfg *rest.Config | ||
var k8sClient client.Client | ||
var testEnv *envtest.Environment | ||
var stopCh = make(chan struct{}) | ||
func TestAPIs(t *testing.T) { | ||
RegisterFailHandler(Fail) | ||
RunSpecsWithDefaultAndCustomReporters(t, | ||
"Webhook Suite", | ||
[]Reporter{printer.NewlineReporter{}}) | ||
} | ||
var _ = BeforeSuite(func(done Done) { | ||
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true))) | ||
By("bootstrapping test environment") | ||
testEnv = &envtest.Environment{ | ||
CRDDirectoryPaths: []string{filepath.Join({{ .BaseDirectoryRelativePath }}, "config", "crd", "bases")}, | ||
WebhookInstallOptions: envtest.WebhookInstallOptions{ | ||
DirectoryPaths: []string{filepath.Join({{ .BaseDirectoryRelativePath }}, "config", "webhook")}, | ||
}, | ||
} | ||
var err error | ||
cfg, err = testEnv.Start() | ||
Expect(err).ToNot(HaveOccurred()) | ||
Expect(cfg).ToNot(BeNil()) | ||
scheme := runtime.NewScheme() | ||
err = AddToScheme(scheme) | ||
Expect(err).NotTo(HaveOccurred()) | ||
err = admissionv1.AddToScheme(scheme) | ||
Expect(err).NotTo(HaveOccurred()) | ||
k8sClient, err = client.New(cfg, client.Options{Scheme: scheme}) | ||
Expect(err).ToNot(HaveOccurred()) | ||
Expect(k8sClient).ToNot(BeNil()) | ||
// start webhook server using Manager | ||
wio := &testEnv.WebhookInstallOptions | ||
mgr, err := ctrl.NewManager(cfg, ctrl.Options{ | ||
Scheme: scheme, | ||
Host: wio.LocalServingHost, | ||
Port: wio.LocalServingPort, | ||
CertDir: wio.LocalServingCertDir, | ||
LeaderElection: false, | ||
MetricsBindAddress: "0", | ||
}) | ||
Expect(err).ToNot(HaveOccurred()) | ||
%s | ||
go func() { | ||
err := mgr.Start(stopCh) | ||
if err != nil { | ||
panic(err) | ||
} | ||
}() | ||
// wait for the webhook server to get ready | ||
dialer := &net.Dialer{Timeout: time.Second} | ||
addrPort := wio.LocalServingHost + ":" + fmt.Sprint(wio.LocalServingPort) | ||
Eventually(func() error { | ||
conn, err := tls.DialWithDialer(dialer, "tcp", addrPort, &tls.Config{InsecureSkipVerify: true}) | ||
if err != nil { | ||
return err | ||
} | ||
conn.Close() | ||
return nil | ||
}).Should(Succeed()) | ||
close(done) | ||
}, 60) | ||
var _ = AfterSuite(func() { | ||
close(stopCh) | ||
By("tearing down the test environment") | ||
err := testEnv.Stop() | ||
Expect(err).ToNot(HaveOccurred()) | ||
}) | ||
` | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.