[docs] How to fix in place version of framework and it's dependencies

[Tedlar]

What's the best way to fix in place version of terratest and it's components so we are not impacted by faulty, not compatible new versions?

For example currently we are impacted by issue with v0.52.0 and we would like to revert to previous version.
How can it be done?

Also could that be placed under official documentation?

[Tedlar]

We tried to run in pipeline:

go mod init "<MODULE_NAME>"
go mod edit -require github.com/gruntwork-io/terratest/modules/terraform@v0.51.0
go mod tidy

But such approach produces error:

go: to add module requirements and sums:
	go mod tidy
go: downloading github.com/gruntwork-io/terratest/modules/terraform v0.51.0
go: gitlab.sofa.dev/cloud/public/modules/product-teams/azure/terraform-azure-keyvault tested by
	gitlab.sofa.dev/cloud/public/modules/product-teams/azure/terraform-azure-keyvault.test imports
	github.com/gruntwork-io/terratest/modules/random: github.com/gruntwork-io/terratest/modules/terraform@v0.51.0: reading github.com/gruntwork-io/terratest/modules/terraform/go.mod at revision modules/terraform/v0.51.0: unknown revision modules/terraform/v0.51.0
go: gitlab.sofa.dev/cloud/public/modules/product-teams/azure/terraform-azure-keyvault tested by
	gitlab.sofa.dev/cloud/public/modules/product-teams/azure/terraform-azure-keyvault.test imports
	github.com/gruntwork-io/terratest/modules/terraform: reading github.com/gruntwork-io/terratest/modules/terraform/go.mod at revision modules/terraform/v0.51.0: unknown revision modules/terraform/v0.51.0
go: gitlab.sofa.dev/cloud/public/modules/product-teams/azure/terraform-azure-keyvault tested by
	gitlab.sofa.dev/cloud/public/modules/product-teams/azure/terraform-azure-keyvault.test imports
	github.com/stretchr/testify/assert: github.com/gruntwork-io/terratest/modules/terraform@v0.51.0: reading github.com/gruntwork-io/terratest/modules/terraform/go.mod at revision modules/terraform/v0.51.0: unknown revision modules/terraform/v0.51.0

[Tedlar]

It was issue on our side.
Switched to go mod edit -require github.com/gruntwork-io/terratest@v0.51.0 and it's working.
But is that a proper approach?

[james00012]

Thanks for raising this! You're correct - the approach you discovered (go mod edit -require github.com/gruntwork-io/terratest@v0.51.0 followed by go mod tidy) is the proper way to pin terratest to a specific version. The issue you encountered with v0.52.0 is a known problem related to #1613, where we attempted to modularize terratest into independent Go modules, which caused Go's module resolution to find packages in multiple locations and create ambiguous import errors.

We're reverting those changes in PR #1614. Going forward, always use the root module path rather than submodule paths, and commit both your go.mod and go.sum files to lock your dependencies. I agree this should be better documented - we'll work on adding version pinning guidance to our quick-start documentation once the v0.52.0 issues are resolved.

[james00012]

Update: We are preparing an RFC to introduce modularization into Terratest in a safer and more controlled way, ensuring issues like this do not occur in future attempts.

[hogarth-sv]

Calling go get is enough to work around this however that's still really nasty. My test script calling terratest currently looks like:

## This is locked to v0.54.0 specifically due to upstream bug: https://github.com/gruntwork-io/terratest/issues/1613
        cd tests && go mod init $(pwd | awk -F'/' '{print $NF}') \
        && go get github.com/gruntwork-io/terratest/modules/terraform@v0.54.0 \
        && go mod tidy \
        && go test -count=1 -timeout=60m -p 1