AWSParameterStore - Support Global Parameters

[codezninja]

• add support for global parameters

[codezninja]

TODO

• unit tests
• docs
• changelog

[codecov-commenter]

Codecov Report

Merging #302 into master will increase coverage by 0.54%.
The diff coverage is 80.00%.

@@            Coverage Diff             @@
##           master     #302      +/-   ##
==========================================
+ Coverage   78.43%   78.98%   +0.54%     
==========================================
  Files          41       41              
  Lines        1048     1061      +13     
  Branches      244      247       +3     
==========================================
+ Hits          822      838      +16     
+ Misses        105       99       -6     
- Partials      121      124       +3     

Impacted Files	Coverage Δ
src/ParameterStoreBuildWrapperPlugin.groovy	71.42% <80.00%> (+30.51%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 90843f2...84d5cfc. Read the comment docs.

[kmanning]

I like this test. It shows that you can call addGlobalParameters with or without options.

[kmanning]

Code coverage is going down because the apply methods were not previously tested, and your change requires that more lines of code be added to apply (which therefore increases the number of untested code lines).

Let's tackle that by first creating contexts for apply in our test suites. Since we have 2 apply's - one for TerraformValidateStage and another for TerraformEnvironmentStage - let's create an "ApplyForTerraformValidateStage" context, and a "ApplyForTerraformEnvironmentStage" context, so that each method can be unit tested separately. You can see this sort of pattern here - https://github.com/manheim/terraform-pipeline/blob/master/test/TagPluginTest.groovy#L114

Looking at the behavior of apply(TerraformValidateStage stage), I think I might say that there are 2 behaviors.

1. It does nothing if there are no global parameters
2. It adds each parameter as a decoration to the validate stage

To sketch out what that might look like in code:

    public class ApplyForValidateStage {
        @Test
        public void addsNoDecorationWhenThereAreNoGlobalParameters() {
            .... 
        }

        @Test
        public void addsADecorationForEachParameter() {
            .... 
        }

Zooming in on what addsNoDecorationWhenThereAreNoGlobalParameters might test, I think I'd setup a

• Given there are no global parameters
• When I call apply(validatestage)
• Then I should see that validatestage never had the decorate method called.

Zooming in on what addsADecorationForEachParameter might test, I think I'd setup a

• Given I have multiple global parameters (let's say 3)
• When I call apply(validatestage)
• Then I should see that validate stage got decorated with each parameter (3 times, with each of the parameters I added).

^-- taking the above, I could follow a similar process for "ApplyForTerraformEnvironmentStage". Looking at the implementation of that method, there's slightly more behavior. There's everything that's done to ValidateStage, and then some.

1. It does nothing if there are no global parameters
2. It adds each global parameter as a decoration to the environment stage during the PLAN command
3. It adds each global parameter as a decoration to the environment stage during the APPLY command
4. It adds each environment-specific parameter as a decoration to the environment stage during the PLAN command
5. It adds each environment-specific parameter as a decoration to the environment stage during the APPLY command

Each of those 5 behaviors could potentially be tested through a distinct unit test. If you wanted to limit the scope of tests to just what you changed, you could focus on tests 1, 2, 3, and say that 4 and 5 should have already been tested prior to your change.

[codezninja]

I need a second 👀 at the tests for 2-5

2-3 should be tested here
4-5 should be tested here

[kmanning]

Awesome! Thanks for the contribution, this feels like a super useful feature!