Add ansible plugin scaffolding command into ansible-operator binary #149
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,69 @@ | ||
| // Copyright 2025 The 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 scaffold | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "runtime" | ||
|
|
||
| "github.com/operator-framework/ansible-operator-plugins/pkg/plugins/ansible/v1" | ||
| "github.com/spf13/cobra" | ||
|
|
||
| ver "github.com/operator-framework/ansible-operator-plugins/internal/version" | ||
| "sigs.k8s.io/kubebuilder/v4/pkg/cli" | ||
| cfgv3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3" | ||
| "sigs.k8s.io/kubebuilder/v4/pkg/plugin" | ||
| kustomizev2 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/common/kustomize/v2" | ||
| ) | ||
|
|
||
| func NewCmd() *cobra.Command { | ||
| cli := GetPluginsCLI() | ||
| return cli.Command() | ||
| } | ||
|
|
||
| func GetPluginsCLI() *cli.CLI { | ||
| ansibleBundle, _ := plugin.NewBundleWithOptions( | ||
| plugin.WithName(ansible.Plugin{}.Name()), | ||
|
There was a problem hiding this comment. We might not want to have base.ansible.sdk.operatorframework.io/v1 since it is not a base for Ansible ( only Ansible code without the config/ generated by kustomize/v2 ), so we might wish to to change it to be called There was a problem hiding this comment. Thanks for the suggestion. Updated the plugin name to reflect |
||
| plugin.WithVersion(ansible.Plugin{}.Version()), | ||
| plugin.WithPlugins( | ||
| kustomizev2.Plugin{}, | ||
| ansible.Plugin{}, | ||
| ), | ||
| ) | ||
|
|
||
| c, err := cli.New( | ||
| cli.WithCommandName("scaffold"), | ||
| cli.WithDescription("scaffolds ansible-operator"), | ||
| cli.WithVersion(makeVersionString()), | ||
| cli.WithPlugins( | ||
| ansibleBundle, | ||
| ), | ||
| cli.WithDefaultPlugins(cfgv3.Version, ansibleBundle), | ||
| cli.WithDefaultProjectVersion(cfgv3.Version), | ||
| cli.WithCompletion(), | ||
| ) | ||
|
|
||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| return c | ||
| } | ||
|
|
||
| func makeVersionString() string { | ||
| return fmt.Sprintf("scaffold version: %q, commit: %q, kubernetes version: %q, go version: %q, GOOS: %q, GOARCH: %q", | ||
| ver.GitVersion, ver.GitCommit, ver.KubernetesVersion, runtime.Version(), runtime.GOOS, runtime.GOARCH) | ||
| } | ||
This file contains hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should not include this code here.
Instead, we must ensure that the hack generator uses the actual binary, rather than mocking the CLI and invoking it directly.
The binary should be built locally and used during generation to validate that everything functions correctly—this is the approach taken in the Operator SDK.
Reference: operator-sdk/hack/generate/samples/generate_testdata.go#L30-L37
c/c @acornett21 ^
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the current approach follows a deliberate design choice made in #4 PR, after which we are now generating the testdata on the fly using the helper library.
This PR is trying to unify the testdata generation with the binary's command execution. We created a single entrypoint (
GetPluginsCLI()) that is called by both themainfunction for the final binary and by the hack script that generates the test samples.It ensures that our testdata is always generated using the exact same logic and configuration that the end-user's binary will have. It creates a tight coupling that prevents any possible divergence between the test suite and the released artifact.
This change is a continuation of the existing pattern. I think we are not breaking the testdata generation flow or logic.