✨ (go/v4): Add allowed files about tools version management files in go init v4

[robinlioret]

Motivation

I'm using mise-en-place to manage my tools versions. When I want to create a new kubebuilder project. I start by creating a mise.toml file with the versions of go and kubebuilder I want to use. Then run the kubebuilder init ... command. Since .toml files are allowed, I get the error

ERROR CLI run failed error=error executing command: failed to initialize project: unable to run pre-scaffold tasks of "base.go.kubebuilder.io/v4": error walking directory: target directory is not empty and contains a disallowed file "mise.toml". files with the following extensions [.go, .yaml, .mod, .sum] are not allowed to avoid conflicts with the tooling

I would like to be able to use mise tool stack, so we need to allow tools management files like mise-en-place and asdf.

Description of the change

Adding a simple check of the filename against an hardcoded list. It's the same principle as for the extension check but against the whole filename.

Prerequisites

• make test-unit : FAILED, even on master I was not able to run the unit tests successfully
• make install
• make lint
• make check-testdata
• make test-e2e-local: FAILED, even on master I was not able to run the e2e tests successfully ( unlinkat /usr/bin/kustomize: permission denied, i didn't look further)
• Manual test using the compiled binary (empty dir with mise.toml, then kubebuilder init, ok)

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: robinlioret / name: Robin LIORET (17978ef, 82ff374, 8d571bd, 90b515f, 97251cf)

[k8s-ci-robot]

Welcome @robinlioret!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @robinlioret. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[camilamacedo86]

Thank you so much for raising this one 🎉

Could we check why it’s being blocked instead?
It seems we shouldn’t block these since they’re not in disallowedExtensions.

If we start creating a full list like that, it could get huge —
so it might be better to only block the specific required cases.

What do you think? Could you please take a look? 🙂

[robinlioret]

You're welcome!

Actually, I think the variable disallowedExtensions is misnamed. It should be allowedExtensions since it is treated as a guard clause before returning the error.

I agree, init should block the files that are created by kubebuilder and leave the rest be. But, maybe there were a reason why this was implemented in the first place.

I'll dig into the repo to find out why andupdate this PR.

[camilamacedo86]

Thank you a lot !!!. Sure, the reason is:

We cannot initialize or scaffold files when the target directory already contains files that the tool itself is meant to scaffold. Doing so can lead to conflicts during the command execution — and, even worse, it may overwrite existing files with different content.

To avoid these issues, the initialization process must ensure that the directory is either empty or does not contain files that overlap with those that will be generated by the scaffolding tool.

[robinlioret]

I reworked the function so it only checks for kubebuilder reserved files and directories.
Since my tests are failing when I run them locally. I tested it manually.

make install
mkdir testdata/project-v4-invalid-dir && cd testdata/project-v4-invalid-dir

touch .devcontainer Makefile mise.toml .tools-version go.mod
mkdir accepted && touch accepted/Makefile

kubebuilder init --domain=dummy.io --repo=github.com/dummy-io --license=apache2  --plugins go/v4
#>  target directory contains kubebuilder reserved directory or file: ".devcontainer" (.devcontainer, .github, api, bin, cmd, config, dist, hack, internal, test, .dockerignore, .gitignore, .golangci.yml, Dockerfile, Makefile, PROJECT, README.md, grafana)

rm .devcontainer
kubebuilder init --domain=dummy.io --repo=github.com/dummy-io --license=apache2  --plugins go/v4
#> target directory contains kubebuilder reserved directory or file: "Makefile" (...)

rm Makefile
kubebuilder init --domain=dummy.io --repo=github.com/dummy-io --license=apache2  --plugins go/v4
# No error

make generate
# It works

cd ..
rm -rf project-v4-invalid-dir

[camilamacedo86]

That is definitely an option.
I will need some time to think about it.

[camilamacedo86]

The main issue here is how to maintain this list.
Moreover: In a multi-repository project, there will typically be a .github directory — and that’s probably fine. However, the tool would need to scaffold files inside that directory, which raises the question of how to manage and keep the list consistent across repositories.

[camilamacedo86]

The main issue here is how to maintain this list.
Moreover: In a multi-repository project, there will typically be a .github directory — and that’s probably fine. However, the tool would need to scaffold files inside that directory, which raises the question of how to manage and keep the list consistent across repositories.

I need time to evaluate not sure if that is the best approach

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: robinlioret
Once this PR has been reviewed and has the lgtm label, please assign kavinjsir for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[robinlioret]

I understand, I'm not experienced enough with more complex usage of Kubebuilder. This approch is the opposite of the previous one.

May be it is possible to dynamically build the list from the templates.