Add ConfiguredValueModifier extension point for plugins

[mcred]

Environment: All OS

Liquibase Version: 4.6.1 +

Liquibase Integration & Version: CLI

Pull Request Type

• Bug fix (non-breaking change which fixes an issue.)
• Enhancement/New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Description

Extensions should be able to modify the value of a property directly based on a loaded priority. Example: the value for a url in the properties file could be a placeholder and the extension should replace that value during runtime.

Testing

I was not able to get all of the unit tests to pass prior to developing this plugin, but the additional tests for ConfiguredValueTest pass and the existing tests for that class continue to pass.

Fast Track PR Acceptance Checklist:

• Build is successful and all new and existing tests pass
• Added Unit Test(s)
• Added Integration Test(s)
• Added Test Harness Test(s)
• Documentation Updated

Need Help?

Come chat with us on our discord channel

[mcred]

Rebased and updated test:

[INFO] Reactor Summary for liquibase 0-SNAPSHOT:
[INFO] 
[INFO] liquibase .......................................... SUCCESS [  0.985 s]
[INFO] liquibase-core ..................................... SUCCESS [01:06 min]
[INFO] liquibase-cli ...................................... SUCCESS [  2.595 s]
[INFO] liquibase-maven-plugin ............................. SUCCESS [  4.959 s]
[INFO] liquibase-cdi ...................................... SUCCESS [  5.388 s]
[INFO] liquibase-extension-testing ........................ SUCCESS [  2.865 s]
[INFO] liquibase-integration-tests ........................ SUCCESS [ 41.217 s]
[INFO] liquibase-dist ..................................... SUCCESS [  0.060 s]
[INFO] liquibase-extension-examples ....................... SUCCESS [  0.252 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  02:04 min
[INFO] Finished at: 2022-02-17T14:28:05-05:00
[INFO] ------------------------------------------------------------------------

[nvoxland]

I made some changes to your original PR:

• I moved the logic of applying the modifier into LiquibiseConfiguration which is the more "root" spot. That should make it be applied everywhere better
• I renamed ConfiguredValueModifier's getPriority() method to getOrder() since it's not really the "replacing" logic we use for plugins but an "order" like in CommandStep. Related to that, I made the factory not implement PluginFactory since it's not using the normal plugin replacement logic.
• I made ConfiguredValueModifier's logic be based around being another "override" spot vs. replacing values. I think that will work better with the tracking and logic we have around "nested" values.

[github-actions]

Unit Test Results

  4 512 files  ±  0    4 512 suites  ±0   31m 55s ⏱️ -34s
  4 423 tests +  4    4 209 ✔️ +  8     214 💤  - 4  0 ❌ ±0 
52 356 runs  +48  47 348 ✔️ +52  5 008 💤  - 4  0 ❌ ±0 

Results for commit 89e7a29. ± Comparison against base commit 4ab687b.

[nvoxland]

Notes and test results:

Things to be aware of

• The failing functional tests are unrelated to this change
• This adds a new extension point that 3rd parties can take advantage of. We are not currently using it in the liquibase code beyond the automated tests that were added

Things to worry about

• Nothing

[XDelphiGrl]

PR allows Liquibase extensions to modify configuration values based on a ordering (or priority) set by the extension.

• Code used by extension developers; no impact on Liquibase users beyond those using extensions that take advantage of this enhancement.
• New unit tests added.
• No additional testing required.

APPROVED

Functional Tests
Passing Test Harness Execution
NOTE: Test failures in the functional test suite are due to mismatch in expected console output and actual console output for the checks feature. These are unrelated to the changes in this PR and can be disregarded.