feat(documents): support document labels

[d0weinberger]

Why this PR?

Adding document labels and description support and adapting to changes in the documents corelib client:

• removal of ExternalID, which means that Metadata.ID is used directly.
• introduction of Labels and Description
• change of function signatures (i.e. everything that is not content is passed via a Metadata struct)

What has changed?

• Users can now declare labels and description on any document config entry (dashboard, notebook, launchpad) in their config.yaml:

  type:
    document:
      kind: notebook
      description: This is my notebook
      labels:
        - team:foo
        - env:prod

• Labels are optional; existing configs without a labels field are unaffected.
• Description is option optional; existing configs without a description field are unaffected.
• monaco download preserves labels and descriptions, so downloaded configs include whatever labels and description the document already has in the environment.

How does it do it?

• The core library's new documents.Metadata struct bundles ID, Name, Type, IsPrivate, Description, and Labels into a single value; replacing the previous positional-parameter signatures with this struct was the natural place to thread labels through without touching every call-site individually.
• DeployAPI.Deploy builds the documents.Metadata value before calling upsertDocument, which then stamps the resolved ID into metadata.ID before each Update/Create call.
• Also, DeployAPI.Deploy now fails on an unknown document kind, instead of defaulting to an empty document type.
• getDocumentAttributesFromConfigType was removed; its logic is now inlined into Deploy as part of the Metadata construction.

How is it tested?

Unit test:

• config_loader_test.go: verifies labels and description are parsed from YAML into config.DocumentType
• config_writer_test.go: verifies it is serialized back out.
• Tests in deploy_test.go to check that labels and description reach the documents.Metadatapassed to the client.
• download_test.go updated to assert that labels and description from the API response are captured in the downloaded config.DocumentType.

Integration test:

• test/configtypes/documents/documents_test.go deploys a notebook with labels and description and then reads it back from the environment to verify Labels and Description match what was configured.

How does it affect users?

Users can now declare labels and description on any document config entry (dashboard, notebook, launchpad) in their config.yaml

Issue: PS-47482

[github-actions]

E2E Test Results

    3 files   -   2    133 suites   - 113   22m 34s ⏱️ - 1h 12m 24s
2 551 tests +  2  2 549 ✅ +  2  2 💤 ±0  0 ❌ ±0 
2 551 runs   - 324  2 549 ✅  - 324  2 💤 ±0  0 ❌ ±0 

Results for commit 4dd105c. ± Comparison against base commit c6590b7.

This pull request removes 5 and adds 7 tests. Note that renamed tests count towards both.

github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/resource/document ‑ TestDeploy_WithNotExistingDocumentKind_Succeeds
github.com/dynatrace/dynatrace-configuration-as-code/v2/test/account ‑ TestDeployAndDelete_AllResources
github.com/dynatrace/dynatrace-configuration-as-code/v2/test/account ‑ TestIdempotenceOfDeployment
github.com/dynatrace/dynatrace-configuration-as-code/v2/test/configuration/pagination ‑ TestPaginationClassic
github.com/dynatrace/dynatrace-configuration-as-code/v2/test/configuration/pagination ‑ TestPaginationPlatform

github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/config/loader ‑ Test_parseConfigs/Document_dashboard_config_with_description
github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/config/loader ‑ Test_parseConfigs/Document_dashboard_config_with_labels
github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/config/writer ‑ TestWriteConfigs/Document_with_description
github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/config/writer ‑ TestWriteConfigs/Document_with_labels
github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/resource/document ‑ TestDeploy_WithDescription_PropagatesDescriptionToMetadata
github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/resource/document ‑ TestDeploy_WithLabels_PropagatesLabelsToMetadata
github.com/dynatrace/dynatrace-configuration-as-code/v2/pkg/resource/document ‑ TestDeploy_WithNotExistingDocumentKind_Fails

♻️ This comment has been updated with latest results.

[Kirdock]

Regarding the failing test: Haven't looked much into it, but maybe it has the same root cause as in our Terraform provider
dynatrace-oss/terraform-provider-dynatrace#1203 (comment)

[Kirdock]

[nit] Theoretically we can merge a lot of the tests, as we don't need a separate test for each and every property in the YAML/documentMeta

[d0weinberger]

[nit] Theoretically we can merge a lot of the tests, as we don't need a separate test for each and every property in the YAML/documentMeta

Yes, but it also doesn't hurt, I think ... I'd keep the tests the way they are right now, if that's okay.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud