✨: Add go mod tidy to be executed after the scaffolding api

[dastergon]

This PR adds an extra step in the API creation subcommand to update go.mod after scaffolding the API to make sure we have a fresh go.mod in cases of new dependencies introduced by the generated controllers.

My setup

• Go: 1.16 darwin/arm64
• Kubebuilder: version.Version{KubeBuilderVersion:"2.3.2", KubernetesVendor:"unknown", GitCommit:"5da27b892ae310e875c8719d94a5a04302c597d0", BuildDate:"2021-02-22T21:16:26-08:00", GoOs:"darwin", GoArch:"arm64"}
• operator-sdk: v1.4.2, commit: "4b083393be65589358b3e0416573df04f4ae8d9b
• Kubernetes: v1.19.4

What is the issue?

Initially, I used the operator-sdk to create a new operator, but, after creating an API I stumbled upon the following issue:

$ operator-sdk init --domain example.com --repo github.com/example/memcached-operator
$ operator-sdk create api --group cache --version v1alpha1 --kind Memcached --resource --controller
Writing scaffold for you to edit...
api/v1alpha1/memcached_types.go
controllers/memcached_controller.go
....
/Users/xxxxxx/memcached-operator/bin/controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./..."
Error: go [-e -json -compiled=true -test=false -export=false -deps=true -find=false -tags ignore_autogenerated -- ./...]: exit status 1: go: github.com/example/memcached-operator/controllers: package github.com/go-logr/logr imported from implicitly required module; to add missing requirements, run:
        go get github.com/go-logr/[email protected]
....

FATA[0000] failed to create API with "go.kubebuilder.io/v3": exit status 2

Then, after investigating the code, I found that the error was coming from kubebuilder code and consequently, I looked at generating the controller via kubebuilder to double-check. After running the basic commands, I got the same error:

$ kubebuilder init --domain my.domain
$ kubebuilder create api --group webapp --version v1 --kind Guestbook
...
/Users/xxxxx/go/bin/controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./..."
Error: go [list -e -json -compiled=true -test=false -export=false -deps=true -find=false -tags ignore_autogenerated -- ./...]: exit status 1: go: example/controllers: package github.com/go-logr/logr imported from implicitly required module; to add missing requirements, run:
        go get github.com/go-logr/[email protected]
....
run `controller-gen object:headerFile=hack/boilerplate.go.txt paths=./... -w` to see all available markers, or `controller-gen object:headerFile=hack/boilerplate.go.txt paths=./... -h` for usage
make: *** [generate] Error 1
2021/02/24 22:24:31 failed to create API: exit status 2

Then, to double-check I executed the tests of a fresh clone of the kubebuilder repo and I received the same error:

$ make test
....
Preparing test directory /tmp/kubebuilder/test
Running kubebuilder commands in test directory /tmp/kubebuilder/test
Restoring cached project 'init'
Creating api and controller
Create Resource [y/n]
Create Controller [y/n]
Writing scaffold for you to edit...
api/v1beta1/bee_types.go
controllers/bee_controller.go
Running make:
$ make generate
go: creating new go.mod: module tmp
Downloading sigs.k8s.io/controller-tools/cmd/[email protected]
go get: added sigs.k8s.io/controller-tools v0.4.1
/tmp/kubebuilder/test/bin/controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./..."
Error: go [-e -json -compiled=true -test=false -export=false -deps=true -find=false -tags ignore_autogenerated -- ./...]: exit status 1: go: kubebuilder.io/test/controllers: package github.com/go-logr/logr imported from implicitly required module; to add missing requirements, run:
        go get github.com/go-logr/[email protected]
....
2021/02/24 22:33:24 failed to create API with "go.kubebuilder.io/v3": exit status 2
make: *** [test-integration] Error 1

How I solved the issue

Instead of introducing go mod tidy in the Makefile template, I decided to add it in the PostScaffolding func of API creation subcommand for both v2 and v3, since a similar action is done in init subcommand as well.

After I made the code changes, the tests in kubebuilder passed successfully. Also, I executed make generate to update the mock data for this PR.

PTAL. I am open to alternative solutions, in case this one is adding extra complexity.

[k8s-ci-robot]

Welcome @dastergon!

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 @dastergon. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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/test-infra repository.

[camilamacedo86]

/ok-to-test

[camilamacedo86]

Could you please squash the commits?

[dastergon]

Hi @camilamacedo86,

I rebased and squashed the commits.

[dastergon]

@camilamacedo86 it looks like that the issue is fixed, but there's a new go.sum issue with the generated mock data. What do you think could be causing it?

[camilamacedo86]

Hi @dastergon,

The #2040 will solve that. Thank you.

[Adirio]

• Go: 1.16 darwin/arm64

Can you try with go 1.15 please? Go 1.16 is not officially supported.

[dastergon]

@Adirio I own an MB Air with Apple Silicon and I can only use Go >=1.16.

[camilamacedo86]

Hi @dastergon,

MB Air with Apple Silicon and I can only use Go >=1.16.

I am not sure why you can only use the latest release of GO. I also use Mac and 1.15 on it.

For we officially support 1.16 we need to upgrade the KB tool and the files which are scaffolded by it.
However, we cannot do that until it gets done for controller-runtime and k8s org. It usually takes a while after the go version is released. See that go 1.16 just was released.

You are free to use go 1.16. However, we cannot ensure that it will work well for all scenarios yet.

Could you please rebase it with the master for we are able to get your PR merged.

[dastergon]

@camilamacedo86 rebase done ✅

I use 1.16 because it now supports M1 (Apple Silicon).

[Adirio]

I think this error is related to go1.16 somehow, so I would consider this a feature (✨) unless we can replicate this with go1.15, in which case I would keep the bugfix (🐛) emoji.

[Adirio]

/lgtm
/hold

Holding until we can check if this is a bug-fix or a new feature

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Adirio, dastergon

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

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [Adirio]

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

[camilamacedo86]

HI @dastergon,

Could you change your commit message for something such as ✨:Add go mod tidy to be executed after scaffold an api generation. Then, it solved the @Adirio concern and imo we can get it merged.

[dastergon]

@camilamacedo86 I rebased and updated the commit message.

[Adirio]

/lgtm
/unhold