controller-gen interprets path as numeric literal and fails

[Jean-Daniel]

When trying to run controller-gen, it fails with the following error, just because the path contains a dir with a name starting by 0.

Updating generated CRD deep-copy API code ...
Error: unable to parse option "object:headerFile=/var/folders/xt/087bdd_s6vd1j_jkk244w5bm0000gn/T/tmp.daYAU3yd": [invalid digit '8' in octal literal (at <input>:1:28)]

[SgtCoDFish]

We've just seen a similar (but slightly different) issue when testing cert-manager, where a standard tmpdir was interpreted as a hexadecimal floating point number:

$ /home/prow/go/src/github.com/cert-manager/cert-manager/_bin/tools/controller-gen \
	schemapatch:manifests=./deploy/crds \
	output:dir=/tmp/tmp.4paHkdEcpK \
	paths=./pkg/apis/...
Error: unable to parse option "output:dir=/tmp/tmp.4paHkdEcpK": ['p' exponent requires hexadecimal mantissa (at <input>:1:9) exponent has no digits (at <input>:1:9)]

The tmpdir was generated by a simple mktemp -d here.

edit: This was using controller-gen v0.10.0 installed via go install sigs.k8s.io/controller-tools/cmd/[email protected]

[camilamacedo86]

Hi @SgtCoDFish,

What changes in the spec were made for the error began to be faced?
Could you let us know how is possible to reproduce this scenario outside of the github.com/cert-manager?

We need to ensure that it is not a bug/issue introduced in the github.com/cert-manager project.

[SgtCoDFish]

I can reliably reproduce using these steps:

# latest checkout of cert-manager
git clone [email protected]:cert-manager/cert-manager.git && cd cert-manager

# install controller-gen v0.10.0 using "go install" - the make command is complicated but it's just running "go install"
make _bin/downloaded/tools/[email protected]_linux_amd64

# create tmpdir which caused the failure
mkdir -p /tmp/tmp.4paHkdEcpK

# run command as above
 ./_bin/downloaded/tools/[email protected]_linux_amd64 schemapatch:manifests=./deploy/crds \
        output:dir=/tmp/tmp.4paHkdEcpK \
        paths=./pkg/apis/...

This is a completely unmodified controller-gen at v0.10.0.

The next test run worked successfully with the same command, same files, just a differently named tmpdir:

/home/prow/go/src/github.com/cert-manager/cert-manager/_bin/tools/controller-gen \
	schemapatch:manifests=./deploy/crds \
	output:dir=/tmp/tmp.SgrxkiqbO4 \
	paths=./pkg/apis/...

We run controller-gen in this way on every PR raised against cert-manager, and I haven't personally seen this error before but I'd bet it's reliably common with certain named tmpdirs.

[Jean-Daniel]

We need to ensure that it is not a bug/issue introduced in the github.com/cert-manager project.

In my case, this is not related to cert-manager at all, as this is a locally developed controller.

[camilamacedo86]

Hi @Jean-Daniel,

So the problem here is that controller-gen is unable to generate the files when the output is like /tmp/tmp.SgrxkiqbO4 (it has in the name dots). Just for we are able to confirm: can you try without a name that does not have dot and number like test to ensure that works?

[SgtCoDFish]

I can reproduce the issue with /var/folders/xt/087bdd_s6vd1j_jkk244w5bm0000gn/T/tmp.daYAU3yd that @Jean-Daniel reported using the cert-manager codebase as well:

git clone [email protected]:cert-manager/cert-manager.git && cd cert-manager
make _bin/downloaded/tools/[email protected]_linux_amd64

mkdir -p /tmp/087bdd_s6vd1j_jkk244w5bm0000g

 ./_bin/downloaded/tools/[email protected]_linux_amd64 schemapatch:manifests=./deploy/crds \
        output:dir=/tmp/087bdd_s6vd1j_jkk244w5bm0000g \
        paths=./pkg/apis/...

Output:

Error: unable to parse option "output:dir=/tmp/087bdd_s6vd1j_jkk244w5bm0000gn": [invalid digit '8' in octal literal (at <input>:1:6)]

The cert-manager job works as expected if I use a tmpdir called /tmp/tmp.daYAU3yd - the problem is with the 087bdd_s6vd1j_jkk244w5bm0000gn being treated as an octal literal.

[Jean-Daniel]

Hi @Jean-Daniel,

So the problem here is that controller-gen is unable to generate the files when the output is like /tmp/tmp.SgrxkiqbO4 (it has in the name dots). Just for we are able to confirm: can you try without a name that does not have dot and number like test to ensure that works?

controller-gen, for some reason, tries to interpret each path component as a number literal. If a path component starts with 0, it assumes this is an octal literal, and crashes if it contains a 8 (which is invalid in octal literal). In the case of SgtCoDFish, it tries to parse tmp.4paHkdEcpK as a floating point literal, and obviously fails.

controller-gen MUST NOT try to interpret file names as some numeric literal.

[camilamacedo86]

Would you like to working on this change? If so, please feel free to push a PR.

[allenhaozi]

I have the same problem

kubebuilder init --domain 1pq.io --repo tutorial.kubebuilder.io/project
kubebuilder create api --group core --version v1alpha1 --kind CronJob
make manifests

got the following errors:

/Users/mahao/go/src/test/project/bin/controller-gen rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
/Users/mahao/go/src/test/project/api/v1alpha1/groupversion_info.go:19:1: 'p' exponent requires hexadecimal mantissa (at <input>:1:5)
/Users/mahao/go/src/test/project/api/v1alpha1/groupversion_info.go:19:1: exponent has no digits (at <input>:1:5)
/Users/mahao/go/src/test/project/api/v1alpha1/groupversion_info.go:19:1: 'p' exponent requires hexadecimal mantissa (at <input>:1:5)
/Users/mahao/go/src/test/project/api/v1alpha1/groupversion_info.go:19:1: exponent has no digits (at <input>:1:5)
/Users/mahao/go/src/test/project/api/v1alpha1/groupversion_info.go:19:1: 'p' exponent requires hexadecimal mantissa (at <input>:1:5)
/Users/mahao/go/src/test/project/api/v1alpha1/groupversion_info.go:19:1: exponent has no digits (at <input>:1:5)
/Users/mahao/go/src/test/project/api/v1alpha1/groupversion_info.go:19:1: 'p' exponent requires hexadecimal mantissa (at <input>:1:5)
/Users/mahao/go/src/test/project/api/v1alpha1/groupversion_info.go:19:1: exponent has no digits (at <input>:1:5)
/Users/mahao/go/src/test/project/controllers/cronjob_controller.go:36:1: 'p' exponent requires hexadecimal mantissa (at <input>:1:12)
/Users/mahao/go/src/test/project/controllers/cronjob_controller.go:36:1: exponent has no digits (at <input>:1:12)

The pattern of problems seems to be {number}p