fix: Fixed ordering issue in terraform_wrapper_module_for_each hook #565

ajax-ryzhyi-r · 2023-09-04T08:36:19Z

Put an x into the box if that apply:

This PR introduces breaking change.
This PR fixes a bug.
This PR adds new functionality.
This PR enhances existing functionality.

Description of your changes

I have a module with variables defined in two .tf files. When I run the terraform_wrapper_module_for_each hook locally on macOS, no changes are shown. However, when the same hooks run against the same module by GitHub Actions on Ubuntu, a difference in the order of the wrapper module input variables is shown. After researching the root cause of this behavior, I discovered that the find utility returns files in a different order on macOS and Ubuntu because these OS use different virtual file systems:
https://unix.stackexchange.com/questions/13451/what-is-the-directory-order-of-files-in-a-directory-used-by-ls-u

To solve this issue, I added sorting for the outputs and variables before appending them to the wrapper module.

Note: These changes could cause updates to already generated wrappers.

How can we test changes

Run the hooks against module with the next structure in MacOS and Ubuntu:

main.tf
variables.tf             # Some variables are defined here
additional_variables.tf  # Some variables are defined here

…apper_module_for_each hook

yermulnik · 2023-09-04T09:05:23Z

hooks/terraform_wrapper_module_for_each.sh


    # Get names of module outputs in all terraform files
    # shellcheck disable=SC2207
-    module_outputs=($(echo "$all_tf_content" | hcledit block list | { grep output. | cut -d'.' -f 2 || true; }))
+    module_outputs=($(echo "$all_tf_content" | hcledit block list | { grep output. | cut -d'.' -f 2 | sort || true; }))

    # Get names of module providers in all terraform files
    module_providers=$(echo "$all_tf_content" | hcledit block list | { grep provider. || true; })


@ajax-ryzhyi-r Would it make sense to add sorting to this var definition as well for consistency?

@ajax-ryzhyi-r Would it make sense to add sorting to this var definition as well for consistency?

This variable is only used to check if the module contains provider definitions, so the ordering does not matter. However, for the sake of code consistency, sorting can be added here as well.

@MaxymVlasov What do you think? I'd add sorting for this var value too.

Good idea to add sort, but it is enough to have it just in module_vars as it is the only variable used in a loop when making a file.

Also, tflint may help with this. It would complain if variable blocks were defined in various places.

Good idea to add sort, but it is enough to have it just in module_vars as it is the only variable used in a loop when making a file.

Also, tflint may help with this. It would complain if variable blocks were defined in various places.

Yes, you're right. The order of outputs does not matter too. Thank you for pointing that out.

I am aware that tflint can detect such cases, but we still have some legacy modules where this structure is expected 😢

…apper_module_for_each hook

## [1.83.1](v1.83.0...v1.83.1) (2023-09-04) ### Bug Fixes * Fixed ordering issue in terraform_wrapper_module_for_each hook ([#565](#565)) ([dc12be1](dc12be1))

antonbabenko · 2023-09-04T10:10:18Z

This PR is included in version 1.83.1 🎉

fix: Fix issue with ordering of variables/outputs in the terraform_wr…

fdbbb4d

…apper_module_for_each hook

ajax-ryzhyi-r requested review from MaxymVlasov and yermulnik as code owners September 4, 2023 08:36

yermulnik reviewed Sep 4, 2023

View reviewed changes

fix: Fix issue with ordering of variables/outputs in the terraform_wr…

07b6262

…apper_module_for_each hook

antonbabenko approved these changes Sep 4, 2023

View reviewed changes

antonbabenko changed the title ~~fix: Fix ordering issue in terraform_wrapper_module_for_each hook~~ fix: Fixed ordering issue in terraform_wrapper_module_for_each hook Sep 4, 2023

antonbabenko merged commit dc12be1 into antonbabenko:master Sep 4, 2023

antonbabenko pushed a commit that referenced this pull request Sep 4, 2023

chore(release): version 1.83.1 [skip ci]

da379f6

## [1.83.1](v1.83.0...v1.83.1) (2023-09-04) ### Bug Fixes * Fixed ordering issue in terraform_wrapper_module_for_each hook ([#565](#565)) ([dc12be1](dc12be1))

antonbabenko mentioned this pull request Oct 27, 2023

feat!: Refactor module to use maps instead of lists terraform-aws-modules/terraform-aws-alb#305

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Fixed ordering issue in terraform_wrapper_module_for_each hook #565

fix: Fixed ordering issue in terraform_wrapper_module_for_each hook #565

ajax-ryzhyi-r commented Sep 4, 2023 •

edited

Loading

yermulnik Sep 4, 2023

ajax-ryzhyi-r Sep 4, 2023

yermulnik Sep 4, 2023

antonbabenko Sep 4, 2023

ajax-ryzhyi-r Sep 4, 2023

antonbabenko commented Sep 4, 2023

fix: Fixed ordering issue in terraform_wrapper_module_for_each hook #565

fix: Fixed ordering issue in terraform_wrapper_module_for_each hook #565

Conversation

ajax-ryzhyi-r commented Sep 4, 2023 • edited Loading

Description of your changes

Note: These changes could cause updates to already generated wrappers.

How can we test changes

yermulnik Sep 4, 2023

Choose a reason for hiding this comment

ajax-ryzhyi-r Sep 4, 2023

Choose a reason for hiding this comment

yermulnik Sep 4, 2023

Choose a reason for hiding this comment

antonbabenko Sep 4, 2023

Choose a reason for hiding this comment

ajax-ryzhyi-r Sep 4, 2023

Choose a reason for hiding this comment

antonbabenko commented Sep 4, 2023

ajax-ryzhyi-r commented Sep 4, 2023 •

edited

Loading