Docker image does not support CGO_ENABLED on Mac

[javaducky]

Some extensions depend on libraries written in C, requiring the CGO_ENABLED=1 environment setting. An example is xk6-sql to support using SQLite3 databases. The preference, of course, would be for extensions to utilize pure-Go libraries strictly, but this will not always be the case.

We need the xk6 builder image to allow for the CGO runtime.

[imiric]

The golang image the grafana/xk6 image is based on already has gcc installed.

So to compile a binary that requires cgo, you only need to set CGO_ENABLED=1 in the container.

E.g. this works for xk6-sql:

docker run --rm -it -u "$(id -u):$(id -g)" -v "${PWD}:/xk6" -e CGO_ENABLED=1 grafana/xk6 build \
  --with github.com/grafana/xk6-sql

[javaducky]

This may then be an issue on Mac.

[sivakusayan]

This seems to be broken on Ubuntu for me as well. I forked the xk6-sql-driver-sqlite3 repo and added make example as a step to the CI, and CI seems to fail.

I got this to work locally by naively deleting the code that sets CGO_ENABLED from the Compile struct. I'm not the most familiar with go, but it seems from the comments that it's intended for that structure to be populated from the go tool list -json command?

[sivakusayan]

I think a more "proper" fix is to call SupportedPlatforms() and do some parsing logic from there, since it doesn't seem to be used anywhere at the moment.

[darrenvechain]

@sivakusayan have you tried XK6_RACE_DETECTOR=1 xk6 build --with <pkg>

CGO is enforced when this flag is set: v0.13.4...v0.14.0#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L195

[sivakusayan]

@darrenvechain Sorry for responding to this late.

I did notice XK6_RACE_DETECTOR and tried to use that flag, but I got some other build issues when enabling that flag that I didn't get without. I found that the simplest solution for me was to just locally patch xk6 for now.