Follow symlinks when discovering root modules

[radeksimko]

Current Version

0.5.3

Use-cases

The discovery of root modules may not work reliably for users which use symlinks in the paths leading to root modules as we do not currently resolve symlinks. Discovered paths get compared with paths in module manifest files, which may or may not be resolved symlinks and therefore may or may not match.

Attempted Solutions

Always use resolved paths everywhere, or avoid symlinks.

Proposal

Resolve symlinks where necessary:

terraform-ls/internal/terraform/rootmodule/root_module_manager.go

Lines 84 to 88 in a1ff20f

	func (rmm *rootModuleManager) AddAndStartLoadingRootModule(ctx context.Context, dir string) (RootModule, error) {
	dir = filepath.Clean(dir)
	// TODO: Follow symlinks (requires proper test data)

terraform-ls/internal/terraform/rootmodule/root_module_manager.go

Lines 120 to 124 in 0503882

	func (rmm *rootModuleManager) RootModuleCandidatesByPath(path string) RootModules {
	path = filepath.Clean(path)
	// TODO: Follow symlinks (requires proper test data)

terraform-ls/internal/terraform/rootmodule/module_manifest.go

Line 73 in 0503882

// TODO: Follow symlinks (requires proper test data)

and add relevant test cases to verify functionality.