feat(config): Warn when undefined environments or groups are used in overrides

[arthurpitman]

Why this PR?

When copying and pasting configs between projects, it is easy to forget to update any overrides. Currently, this is silent: the overrides simply have no effect, which can have undesirable consequences.

What has changed?

With this PR, a warning is emitted when an override references an environment or environment group that is not defined in the manifest.

A decision was made not to emit an error, at least for now, as this would be a breaking change.

How does it do it?

This PR builds on #1897, which adds the names of all environments and groups to the loaded manifest, regardless of whether they're selected to be deployed or not.

In this PR, when a config entry is loaded, the environment or group name of each override is checked against those in the manifest.

How is it tested?

• Existing tests are updated
• Two extra tests are added to that explicitly check that warnings are logged:
  • TestLoadProjects_GroupOverrideWithUndefinedGroupProducesWarning
  • TestLoadProjects_EnvironmentOverrideWithUndefinedEnvironmentProducesWarning

How does it affect users?

Users will now receive a warning when an override references an environment or environment group that is not defined in the manifest.

[github-actions]

E2E Test Results

    3 files  ± 0    263 suites  ±0   25m 30s ⏱️ + 2m 57s
2 151 tests  - 23  2 134 ✅  - 34  2 💤 ±0  15 ❌ +11 
2 381 runs   - 24  2 364 ✅  - 35  2 💤 ±0  15 ❌ +11 

For more details on these failures, see this check.

Results for commit 92c2c3b. ± Comparison against base commit 784755a.

This pull request removes 26 and adds 3 tests. Note that renamed tests count towards both.

github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestDeployReport
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestDeployReport/ensure_that_monaco_runs_without_generating_report
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestDeployReport/report_is_generated
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestMonacoVersionLogging
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestMonacoVersionLogging/Account_deploy_should_log_version
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestMonacoVersionLogging/Account_download_should_log_version
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestMonacoVersionLogging/Deploy_should_log_version
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestMonacoVersionLogging/Download_should_log_version
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestMonacoVersionLogging/Help_should_not_log_version
github.com/dynatrace/dynatrace-configuration-as-code/v2/cmd/monaco/integrationtest/v2 ‑ TestMonacoVersionLogging/Incomplete_account_should_not_log_version
…

TestMain
github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/project ‑ TestLoadProjects_EnvironmentOverrideWithUndefinedEnvironmentProducesWarning
github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/project ‑ TestLoadProjects_GroupOverrideWithUndefinedGroupProducesWarning

♻️ This comment has been updated with latest results.

[tomazpu]

I would move each check into a separate function to decrease the complexity and have an opportunity to comment on what is checked under which assumption.

My opinion you decide if it makes sense.

[arthurpitman]

I have also improved the actual log message.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
88.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud