Can `terraform init` fully initialize (for tests) if no `.tf` files exist the current working directory?

[brettcurtis]

Terraform Version

Terraform v1.8.1
on linux_amd64
+ provider registry.terraform.io/hashicorp/google v5.25.0

Use Cases

With terraform test you can now run tests from the root of a repo even if the root has no .tf files. A directory structure like this can't run tests unless an empty.tf file is added because we can't fully initialize with terraform init.

This is a current test/WA:

❯ terraform test -verbose
╷
│ Error: Module not installed
│ 
│   on tests/default.tftest.hcl line 4, in run "test":
│    4:   module {
│ 
│ This module is not yet installed. Run "terraform init" to install all modules required by this configuration.
╵
❯ terraform init
Terraform initialized in an empty directory!

The directory has no Terraform configuration files. You may begin working
with Terraform immediately by creating Terraform configuration files.
❯ terraform test -verbose
╷
│ Error: Module not installed
│ 
│   on tests/default.tftest.hcl line 4, in run "test":
│    4:   module {
│ 
│ This module is not yet installed. Run "terraform init" to install all modules required by this configuration.
╵
❯ touch empty.tf
❯ terraform init

Initializing the backend...
Initializing modules...
- test.tests.default.test in tests/fixtures/default
- test.tests.default.test.test in global

Initializing provider plugins...
- Finding latest version of hashicorp/google...
- Installing hashicorp/google v5.25.0...
- Installed hashicorp/google v5.25.0 (signed by HashiCorp)

Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.
❯ terraform test
tests/default.tftest.hcl... in progress
  run "test"... pass
tests/default.tftest.hcl... tearing down
tests/default.tftest.hcl... pass

Success! 1 passed, 0 failed.

Attempted Solutions

add empty.tf, change directory structure.

Proposal

No response

References

No response

[liamcervante]

Hi @brettcurtis, thanks for the feature request. Is there a reason you can't place the test files / test directory within your global directory and run terraform init and terraform test from there?

With that change you also wouldn't need to create the testing modules you have within the fixtures directory.

[brettcurtis]

Good questions, we find developers tend to write better modules if the tests are a representation of how the user will consume them. This is why we setup the fixtures the way we do, we also find they provided good examples for consumers of the modules since they do set the system up for testing.

As far as placing the test in global that would be reasonable for this module (simple use case) maybe but more complex modules we'd have tests all over the place and I'm particularly a fan of having a single tests directory structure. Here is an example of a more complex structure for reference: https://github.com/osinfra-io/terraform-google-kubernetes-engine/tree/main/regional. This one will expose some other testing limitations too.

Thanks!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.