Skip to content

Add standalone ansible-cli command and release binaries #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/test-ansible.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,17 @@ jobs:
pip3 install --user --upgrade setuptools pip
pip3 install --user ansible-core~=2.17.4
make test-e2e-ansible-molecule
build-bin:
name: build-bin
runs-on: ubuntu-22.04
steps:
- name: Check out code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version-file: "go.mod"
- name: Run make build
run: make build
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
/dist
**/bin/
ansible-operator
ansible-cli

# Test artifacts
**/testbin/
Expand Down
16 changes: 15 additions & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ before:
- go mod tidy
- go mod download
builds:
- id: binary
- id: ansible-operator
main: ./cmd/ansible-operator/
binary: ansible-operator
asmflags: "{{ .Env.GO_BUILD_ASMFLAGS }}"
Expand All @@ -17,6 +17,20 @@ builds:
- arm64
- ppc64le
- s390x
- id: ansible-cli
main: ./cmd/ansible-cli/
binary: ansible-cli
asmflags: "{{ .Env.GO_BUILD_ASMFLAGS }}"
gcflags: "{{ .Env.GO_BUILD_GCFLAGS }}"
ldflags: "{{ .Env.GO_BUILD_LDFLAGS }}"
mod_timestamp: "{{ .CommitTimestamp }}"
goos:
- linux
goarch:
- amd64
- arm64
- ppc64le
- s390x
dockers:
- image_templates:
- "{{ .Env.IMAGE_REPO }}:{{ .Env.IMAGE_TAG }}-amd64"
Expand Down
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,16 @@ clean: ## Cleanup build artifacts and tool binaries.
##@ Build

.PHONY: install
install: ## Install ansible-operator
GOOS=$(BUILD_GOOS) GOARCH=$(BUILD_GOARCH) go install $(GO_BUILD_ARGS) ./cmd/ansible-operator
install: ## Install ansible-operator and ansible-cli.
GOOS=$(BUILD_GOOS) GOARCH=$(BUILD_GOARCH) go install $(GO_BUILD_ARGS) ./cmd/{ansible-operator,ansible-cli}

.PHONY: build
build: ## Build ansible-operator
build: ## Build ansible-operator and ansible-cli.
@mkdir -p $(BUILD_DIR)
GOOS=$(BUILD_GOOS) GOARCH=$(BUILD_GOARCH) go build $(GO_BUILD_ARGS) -o $(BUILD_DIR) ./cmd/ansible-operator
GOOS=$(BUILD_GOOS) GOARCH=$(BUILD_GOARCH) go build $(GO_BUILD_ARGS) -o $(BUILD_DIR) ./cmd/{ansible-operator,ansible-cli}
Copy link

@camilamacedo86 camilamacedo86 Jun 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought in some names:

ansdk
ansctl
opsible

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/cc: @acornett21 for thoughts.
I liked the ansdk naming. If we all agree with this, we can rename it.


.PHONY: build/ansible-operator
build/ansible-operator:
.PHONY: build/ansible-operator build/ansible-cli
build/ansible-operator build/ansible-cli:
GOOS=$(BUILD_GOOS) GOARCH=$(BUILD_GOARCH) go build $(GO_BUILD_ARGS) -o $(BUILD_DIR)/$(@F) ./cmd/$(@F)

##@ Dev image build
Expand Down
28 changes: 28 additions & 0 deletions cmd/ansible-cli/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// 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 main

import (
"log"

"github.com/operator-framework/ansible-operator-plugins/internal/cmd/ansible-cli/cli"
_ "k8s.io/client-go/plugin/pkg/client/auth"
)

func main() {
if err := cli.Run(); err != nil {
log.Fatal(err)
}
}
25 changes: 2 additions & 23 deletions hack/generate/samples/ansible/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,9 @@ import (
log "github.com/sirupsen/logrus"
"k8s.io/apimachinery/pkg/runtime/schema"
"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"
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang"

"github.com/operator-framework/ansible-operator-plugins/hack/generate/samples/internal/pkg"
"github.com/operator-framework/ansible-operator-plugins/pkg/plugins/ansible/v1"
ansiblecli "github.com/operator-framework/ansible-operator-plugins/internal/cmd/ansible-cli/cli"
"github.com/operator-framework/ansible-operator-plugins/pkg/testutils/command"
"github.com/operator-framework/ansible-operator-plugins/pkg/testutils/e2e"
"github.com/operator-framework/ansible-operator-plugins/pkg/testutils/sample"
Expand All @@ -43,24 +39,7 @@ var memcachedGVK = schema.GroupVersionKind{
}

func getCli() *cli.CLI {
ansibleBundle, _ := plugin.NewBundleWithOptions(
plugin.WithName(golang.DefaultNameQualifier),
plugin.WithVersion(ansible.Plugin{}.Version()),
plugin.WithPlugins(kustomizev2.Plugin{}, ansible.Plugin{}),
)

c, err := cli.New(
cli.WithCommandName("cli"),
cli.WithVersion("v0.0.0"),
cli.WithPlugins(
ansibleBundle,
),
cli.WithDefaultPlugins(cfgv3.Version, ansibleBundle),
cli.WithDefaultProjectVersion(cfgv3.Version),
cli.WithCompletion(),
)
pkg.CheckError("getting cli implementation:", err)
return c
return ansiblecli.GetPluginsCLI()
Copy link

@camilamacedo86 camilamacedo86 Jun 20, 2025

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 ^

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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 (cli.GetPluginsCLI()) that is called by both the main function 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.

}

func GenerateMemcachedSamples(rootPath string) []sample.Sample {
Expand Down
67 changes: 67 additions & 0 deletions internal/cmd/ansible-cli/cli/cli.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// 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 cli

import (
"fmt"
"log"
"runtime"

"github.com/operator-framework/ansible-operator-plugins/pkg/plugins/ansible/v1"

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 Run() error {
c := GetPluginsCLI()
return c.Run()
}

func GetPluginsCLI() *cli.CLI {
ansibleBundle, _ := plugin.NewBundleWithOptions(
plugin.WithName(ansible.Plugin{}.Name()),
plugin.WithVersion(ansible.Plugin{}.Version()),
plugin.WithPlugins(
kustomizev2.Plugin{},
ansible.Plugin{},
),
)

c, err := cli.New(
cli.WithCommandName("ansible-cli"),
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("ansible-cli 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)
}
4 changes: 1 addition & 3 deletions pkg/plugins/ansible/v1/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,9 @@ import (
"sigs.k8s.io/kubebuilder/v4/pkg/config"
cfgv3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3"
"sigs.k8s.io/kubebuilder/v4/pkg/plugin"

"github.com/operator-framework/ansible-operator-plugins/pkg/plugins"
)

const pluginName = "base.ansible" + plugins.DefaultNameQualifier
const pluginName = "ansible.operatorframework.io"

var (
pluginVersion = plugin.Version{Number: 1}
Expand Down
2 changes: 1 addition & 1 deletion testdata/memcached-molecule-operator/PROJECT
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# More info: https://book.kubebuilder.io/reference/project-config.html
domain: example.com
layout:
- go.kubebuilder.io/v1
- ansible.operatorframework.io/v1
multigroup: true
projectName: memcached-molecule-operator
resources:
Expand Down