chore(terraform): option to pass in instanced logger

[Emyrk]

Description

Create new option OptionWithLogger to pass in an instanced logger, rather than using the global. By default, the global is still used.

There is 1 behavior change. The key module=<module_name> is passed to the evaluator and other child components (like the resolver). I intentionally kept this, as it helps log the current scope of the recursive nature of the parsing.

Eval logs before

2025-04-15T20:05:03-05:00	DEBUG	[terraform evaluator] Starting submodules evaluation...
2025-04-15T20:05:03-05:00	DEBUG	[terraform evaluator] Evaluating submodule	name="echo"
2025-04-15T20:05:03-05:00	DEBUG	[terraform evaluator] Starting module evaluation...	path="echo"
2025-04-15T20:05:03-05:00	DEBUG	[terraform evaluator] Starting iteration	iteration=0
2025-04-15T20:05:03-05:00	DEBUG	[terraform evaluator] Starting iteration	iteration=1

Eval logs after

2025-04-15T20:02:16-05:00	DEBUG	[terraform evaluator] Starting submodules evaluation...	module="root"
2025-04-15T20:02:16-05:00	DEBUG	[terraform evaluator] Evaluating submodule	module="root" name="echo"
2025-04-15T20:02:18-05:00	DEBUG	[terraform evaluator] Starting module evaluation...	module="echo" path="echo"
2025-04-15T20:02:18-05:00	DEBUG	[terraform evaluator] Starting iteration	module="echo" iteration=0
2025-04-15T20:02:18-05:00	DEBUG	[terraform evaluator] Starting iteration	module="echo" iteration=1
2025-04-15T20:02:18-05:00	DEBUG	[terraform evaluator] Context unchanged	module="echo" iteration=1
2025-04-15T20:02:18-05:00	DEBUG	[terraform evaluator] Starting post-submodules evaluation...	module="echo"

Checklist

• I've read the guidelines for contributing to this repository.
• I've followed the conventions in the PR title.
• I've added tests that prove my fix is effective or that my feature works.
• I've updated the documentation with the relevant information (if needed).
• I've added usage information (if the PR introduces new options)
• I've included a "before" and "after" example to the description (if the PR is a user interface change).

[simar7]

lgtm, thanks for the very detailed tests! @nikpivkin could you also take a look?

[simar7]

@Emyrk I think we will have to update the tests.

[nikpivkin]

LGTM. Need to fix a assertion in one test after a logger update.

[nikpivkin]

It seems that for nested modules the module attribute is repeated, which can be confusing:

2025-04-16T11:45:29+06:00       DEBUG   [terraform evaluator] Starting post-submodules evaluation...    module="root" module="a" module="b"
2025-04-16T11:45:29+06:00       DEBUG   [terraform evaluator] Starting iteration        module="root" module="a" module="b" iteration=0
2025-04-16T11:45:29+06:00       DEBUG   [terraform evaluator] Starting iteration        module="root" module="a" module="b" iteration=1

What if module contains the full name of the module, for example, module="root.a.b"?

[Emyrk]

@Emyrk I think we will have to update the tests.

My mistake, updated. The test is a nice example of the new module key in the logs:

d019ac7

What if module contains the full name of the module, for example, module="root.a.b"?

@nikpivkin I had thought about that too. We do not store the Parent parser as a field, just children. So it would require some extra code to get the full context of the Parent hierarchy from the newModuleParser function.

.With("module", p.moduleName + "." + moduleName) is only the immediate parent. It does not include the parents of your parent.

[simar7]

@Emyrk I think we will have to update the tests.

My mistake, updated. The test is a nice example of the new module key in the logs:

d019ac7

What if module contains the full name of the module, for example, module="root.a.b"?

@nikpivkin I had thought about that too. We do not store the Parent parser as a field, just children. So it would require some extra code to get the full context of the Parent hierarchy from the newModuleParser function.

.With("module", p.moduleName + "." + moduleName) is only the immediate parent. It does not include the parents of your parent.

I think we can tackle this in a future PR since we don't store the Parent anyway today.