make provider.prepare fails

[ngauje]

What happened?

When following the README, make provider.prepare provider=${provider_name} command fails

How can we reproduce it?

Git clone the project then follow the readme.

❯ export provider_name=MyProvider
❯ make provider.prepare provider=${provider_name}
rm 'apis/sample/sample.go'
rm 'apis/sample/v1alpha1/doc.go'
rm 'apis/sample/v1alpha1/groupversion_info.go'
rm 'apis/sample/v1alpha1/mytype_types.go'
rm 'apis/sample/v1alpha1/zz_generated.deepcopy.go'
rm 'apis/sample/v1alpha1/zz_generated.managed.go'
rm 'apis/sample/v1alpha1/zz_generated.managedlist.go'
rm 'internal/controller/mytype/mytype.go'
rm 'internal/controller/mytype/mytype_test.go'
Removing Makefile.bak
Removing PROVIDER_CHECKLIST.md.bak
Removing README.md.bak
Removing apis/template.go.bak
Removing apis/v1alpha1/doc.go.bak
Removing apis/v1alpha1/register.go.bak
Removing apis/v1alpha1/types.go.bak
Removing cluster/images/provider-template/Dockerfile.bak
Removing cluster/local/integration_tests.sh.bak
Removing cmd/provider/main.go.bak
Removing examples/provider/config.yaml.bak
Removing examples/sample/mytype.yaml.bak
Removing go.mod.bak
Removing internal/controller/config/config.go.bak
Removing internal/controller/register.go.bak
Removing package/crds/sample.template.crossplane.io_mytypes.yaml.bak
Removing package/crds/template.crossplane.io_clusterproviderconfigs.yaml.bak
Removing package/crds/template.crossplane.io_clusterproviderconfigusages.yaml.bak
Removing package/crds/template.crossplane.io_providerconfigs.yaml.bak
Removing package/crds/template.crossplane.io_providerconfigusages.yaml.bak
Removing package/crossplane.yaml.bak
fatal: bad source, source=internal/controller/template.go, destination=internal/controller/myprovider.go
make: *** [Makefile:133: provider.prepare] Error 128

What environment did it happen in?

Latest provider-template version.

Looks like renaming the provider go template file (internal/controller/template.go -> internal/controller/register.go) fix the issue:

diff --git a/hack/helpers/prepare.sh b/hack/helpers/prepare.sh
index b2f9111..05c1d5a 100755
--- a/hack/helpers/prepare.sh
+++ b/hack/helpers/prepare.sh
@@ -37,5 +37,5 @@ sed -i.bak "s/provider-template/provider-${ProviderNameLower}/g" go.mod
 git clean -fd

 git mv "apis/template.go" "apis/${ProviderNameLower}.go"
-git mv "internal/controller/template.go" "internal/controller/${ProviderNameLower}.go"
+git mv "internal/controller/register.go" "internal/controller/${ProviderNameLower}.go"
 git mv "cluster/images/provider-template" "cluster/images/provider-${ProviderNameLower}"

Anything else to do?

[jlroskens]

Had the same issue. The template.go doesn't exist in internal/controller directory.

prepare.sh#L40

git mv "apis/template.go" "apis/${ProviderNameLower}.go"
git mv "internal/controller/template.go" "internal/controller/${ProviderNameLower}.go"  # <- template.go doesn't exist
git mv "cluster/images/provider-template" "cluster/images/provider-${ProviderNameLower}"

Looks like the #141 PR fixes this, but waiting on approval. Can workaround by recloning the repo and updating prepare.sh#L40 as @ngauje mentioned. Repo must be cloned again as the prepare.sh script leaves things in an unrecoverable state, failing trying to remove directories it already removed the first time it ran.

[cychiang]

Hi, thanks for the report. After you run the script, it renames lots of files so it's hard to reverse it but re-do it again.

[cychiang]

fixed by #141