feat: initial no-op plugin implementation

Author: metacosm

go.mod

@@ -0,0 +1,7 @@
+module github.com/java-operator-sdk/kubebuilder-plugin
+
+go 1.15
+
+require github.com/spf13/pflag v1.0.5
+
+require sigs.k8s.io/kubebuilder/v3 v3.0.0-alpha.0.0.20210203175028-3c8e370d49c5

go.sum

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2021 The Java Operator SDK 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 v1
+
+import (
+	"fmt"
+	"github.com/spf13/pflag"
+	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
+)
+
+type createAPISubcommand struct {
+	config config.Config
+}
+
+var (
+	_ plugin.CreateAPISubcommand = &createAPISubcommand{}
+)
+
+func (p createAPISubcommand) UpdateContext(ctx *plugin.Context) {
+	ctx.Description = `Scaffold a Kubernetes API by creating a Resource definition and / or a Controller.
+
+create resource will prompt the user for if it should scaffold the Resource and / or Controller.  To only
+scaffold a Controller for an existing Resource, select "n" for Resource.  To only define
+the schema for a Resource without writing a Controller, select "n" for Controller.
+`
+}
+
+func (p *createAPISubcommand) BindFlags(fs *pflag.FlagSet) {
+}
+
+func (p *createAPISubcommand) InjectConfig(c config.Config) {
+	p.config = c
+}
+
+func (p *createAPISubcommand) Run() error {
+	fmt.Println("create called")
+	return nil
+}

pkg/java/v1/api.go

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2021 The Java Operator SDK 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 v1
+
+import (
+	"fmt"
+
+	"github.com/spf13/pflag"
+
+	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
+)
+
+type editSubcommand struct {
+	config config.Config
+}
+
+var (
+	_ plugin.EditSubcommand = &editSubcommand{}
+)
+
+func (p *editSubcommand) UpdateContext(ctx *plugin.Context) {
+	ctx.Description = `This command will edit the project configuration.`
+}
+
+func (p *editSubcommand) BindFlags(fs *pflag.FlagSet) {
+}
+
+func (p *editSubcommand) InjectConfig(c config.Config) {
+	p.config = c
+}
+
+func (p *editSubcommand) Run() error {
+	fmt.Println("edit called")
+	return nil
+}

pkg/java/v1/edit.go

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 The Java Operator SDK 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 v1
+
+import (
+	"fmt"
+	"github.com/spf13/pflag"
+
+	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
+)
+
+type initSubcommand struct {
+	config config.Config
+	// For help text.
+	commandName string
+}
+
+var (
+	_ plugin.InitSubcommand = &initSubcommand{}
+)
+
+func (p *initSubcommand) UpdateContext(ctx *plugin.Context) {
+	ctx.Description = `Initialize a new project based on the java-operator-sdk project.
+
+Writes the following files:
+- a basic, Quarkus-based operator set-up
+- a pom.xml file to build the project with Maven
+`
+	p.commandName = ctx.CommandName
+}
+
+func (p *initSubcommand) BindFlags(fs *pflag.FlagSet) {
+}
+
+func (p *initSubcommand) InjectConfig(c config.Config) {
+	p.config = c
+}
+
+func (p *initSubcommand) Run() error {
+	fmt.Println("init called")
+	return nil
+}

pkg/java/v1/init.go

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2021 The Java Operator SDK 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 v1
+
+import (
+	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	"sigs.k8s.io/kubebuilder/v3/pkg/model/stage"
+	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
+)
+
+const pluginName = "quarkus.javaoperatorsdk.io"
+
+var (
+	supportedProjectVersions = []config.Version{{
+		Number: 1,
+		Stage:  stage.Alpha,
+	}}
+	pluginVersion = plugin.Version{Number: 1}
+)
+
+var _ plugin.Full = Plugin{}
+
+// Plugin implements the plugin.Full interface
+type Plugin struct {
+	initSubcommand
+	createAPISubcommand
+	createWebhookSubcommand
+	editSubcommand
+}
+
+// Name returns the name of the plugin
+func (Plugin) Name() string { return pluginName }
+
+// Version returns the version of the plugin
+func (Plugin) Version() plugin.Version { return pluginVersion }
+
+// SupportedProjectVersions returns an array with all project versions supported by the plugin
+func (Plugin) SupportedProjectVersions() []config.Version { return supportedProjectVersions }
+
+// GetInitSubcommand will return the subcommand which is responsible for initializing and common scaffolding
+func (p Plugin) GetInitSubcommand() plugin.InitSubcommand { return &p.initSubcommand }
+
+// GetCreateAPISubcommand will return the subcommand which is responsible for scaffolding apis
+func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand { return &p.createAPISubcommand }
+
+// GetCreateWebhookSubcommand will return the subcommand which is responsible for scaffolding webhooks
+func (p Plugin) GetCreateWebhookSubcommand() plugin.CreateWebhookSubcommand {
+	return &p.createWebhookSubcommand
+}
+
+// GetEditSubcommand will return the subcommand which is responsible for editing the scaffold of the project
+func (p Plugin) GetEditSubcommand() plugin.EditSubcommand { return &p.editSubcommand }

pkg/java/v1/plugin.go

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2021 The Java Operator SDK 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 v1
+
+import (
+	"fmt"
+	"github.com/spf13/pflag"
+
+	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
+)
+
+type createWebhookSubcommand struct {
+	config config.Config
+	// For help text.
+	commandName string
+}
+
+var (
+	_ plugin.CreateWebhookSubcommand = &createWebhookSubcommand{}
+)
+
+func (p *createWebhookSubcommand) UpdateContext(ctx *plugin.Context) {
+	ctx.Description = `Scaffold a webhook for an API resource. You can choose to scaffold defaulting,
+validating and (or) conversion webhooks.
+`
+	p.commandName = ctx.CommandName
+}
+
+func (p *createWebhookSubcommand) BindFlags(fs *pflag.FlagSet) {
+}
+
+func (p *createWebhookSubcommand) InjectConfig(c config.Config) {
+	p.config = c
+}
+
+func (p *createWebhookSubcommand) Run() error {
+	fmt.Println("webhook called")
+	return nil
+}