feat: added missing examples and plugged test gaps #384

Aditya-ranjan-16 · 2025-01-09T06:46:57Z

Description

added missing examples and covered test gaps

GIT Issue

Release required?

No release
Patch release (x.x.X)
Minor release (x.X.x)
Major release (X.x.x)

Release notes content

adds missing examples and covers test gaps

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

If relevant, a test for the change is included or updated with this PR.
If relevant, documentation for the change is included or updated with this PR.

For mergers

Use a conventional commit message to set the release level. Follow the guidelines.
Include information that users need to know about the PR in the commit message. The commit message becomes part of the GitHub release notes.
Use the Squash and merge option.

Aditya-ranjan-16 · 2025-01-27T08:02:06Z

/run pipeline

Aditya-ranjan-16 · 2025-01-27T08:17:00Z

/run pipeline

Aditya-ranjan-16 · 2025-01-27T09:17:36Z

/run pipeline

Aditya-ranjan-16 · 2025-01-27T11:32:37Z

pipeline failing by the error

    tests.go:140: 
        	Error Trace:	/go/pkg/mod/github.com/terraform-ibm-modules/[email protected]/testschematic/tests.go:140
        	            				/__w/terraform-ibm-icd-elasticsearch/terraform-ibm-icd-elasticsearch/tests/pr_test.go:146
        	Error:      	Received unexpected error:
        	            	time exceeded waiting for schematic job to finish
        	Test:       	TestRunStandardSolutionSchematics
        	Messages:   	error waiting for APPLY to finish - [ els-sr-da-fllhsk (us-south.workspace.els-sr-da-fllhsk.3db90209) ]
    schematics.go:367: [SCHEMATICS] RETRY DestroyWorkspaceCommand, status code: 409
    schematics.go:367: [SCHEMATICS] RETRY DestroyWorkspaceCommand, status code: 409
    schematics.go:367: [SCHEMATICS] RETRY DestroyWorkspaceCommand, status code: 409
    schematics.go:367: [SCHEMATICS] RETRY DestroyWorkspaceCommand, status code: 409
    schematics.go:367: [SCHEMATICS] RETRY DestroyWorkspaceCommand, status code: 409
    tests.go:155: 
        	Error Trace:	/go/pkg/mod/github.com/terraform-ibm-modules/[email protected]/testschematic/tests.go:155
        	            				/__w/terraform-ibm-icd-elasticsearch/terraform-ibm-icd-elasticsearch/tests/pr_test.go:146
        	Error:      	Received unexpected error:
        	            	The workspace was temporarily locked by [email protected] at 2025-01-27 09:28:06.763463705 +0000 UTC. Please wait until any current actions against your Workspace have completed.
        	Test:       	TestRunStandardSolutionSchematics
        	Messages:   	error creating DESTROY - [ els-sr-da-fllhsk (us-south.workspace.els-sr-da-fllhsk.3db90209) ]
--- FAIL: TestRunStandardSolutionSchematics (3927.42s)

re-running the pipeline

Aditya-ranjan-16 · 2025-01-27T11:32:52Z

/run pipeline

Aditya-ranjan-16 · 2025-01-27T19:39:26Z

pipeline failing by the error

Error: StandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ Error: [ERROR] Error while creating key ring : kp.Error: correlation_id='65d51186-fb41-4c44-8de6-344e9bef892e', msg='This operation cannot be completed. Please try your request at a later time. If the issue persists, please contact IBM KeyProtect.'
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ 
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   with module.kms[0].module.kms_key_rings["elasticsearch-key-ring"].ibm_kms_key_rings.key_ring,
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   on .terraform/modules/kms.kms_key_rings/main.tf line 5, in resource "ibm_kms_key_rings" "key_ring":
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │    5: resource "ibm_kms_key_rings" "key_ring" {
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ 
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ ---
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ id: terraform-46882f4c
Error: StandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ summary: '[ERROR] Error while creating key ring : kp.Error:
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ correlation_id=''65d51186-fb41-4c44-8de6-344e9bef892e'',
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   msg=''This operation cannot be completed. Please try your request at a later time.
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   If the issue persists, please contact IBM KeyProtect.'''
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ severity: error
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ resource: ibm_kms_key_rings
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ operation: create
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ component:
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   name: github.com/IBM-Cloud/terraform-provider-ibm
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   version: 1.74.0
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ ---
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ 
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: ╵

re-running the pipeline

Aditya-ranjan-16 · 2025-01-27T19:39:37Z

/run pipeline

shemau · 2025-01-28T10:07:15Z

pipeline failing by the error

Error: StandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ Error: [ERROR] Error while creating key ring : kp.Error: correlation_id='65d51186-fb41-4c44-8de6-344e9bef892e', msg='This operation cannot be completed. Please try your request at a later time. If the issue persists, please contact IBM KeyProtect.'
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ 
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   with module.kms[0].module.kms_key_rings["elasticsearch-key-ring"].ibm_kms_key_rings.key_ring,
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   on .terraform/modules/kms.kms_key_rings/main.tf line 5, in resource "ibm_kms_key_rings" "key_ring":
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │    5: resource "ibm_kms_key_rings" "key_ring" {
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ 
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ ---
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ id: terraform-46882f4c
Error: StandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ summary: '[ERROR] Error while creating key ring : kp.Error:
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ correlation_id=''65d51186-fb41-4c44-8de6-344e9bef892e'',
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   msg=''This operation cannot be completed. Please try your request at a later time.
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   If the issue persists, please contact IBM KeyProtect.'''
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ severity: error
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ resource: ibm_kms_key_rings
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ operation: create
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ component:
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   name: github.com/IBM-Cloud/terraform-provider-ibm
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │   version: 1.74.0
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ ---
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: │ 
TestRunStandardUpgradeSolution 2025-01-27T11:43:36Z logger.go:66: ╵

re-running the pipeline

This was because the KMS (us-south HPCS) was being upgraded/migrated at the time the test ran.

shemau

At a higher level, it should be unnecessary to include common-dev-assets in a PR. This should be bumped on a standalone cycle and by including it, there is a risk of merge conflicts as the main branch changes or potentially rolling it back.

It is good to see backup-restore coverage being added to elasticsearch. However, when compared to etcd and mongodb example it is different. The ICD module tests should be converging, not diverging with every commit.

The basic example changes are good. Converging the source, so that it is more consistent across modules. This reduces maintenance moving forward, allow for cut-n-paste or possibly cherry picking changes from one module to another.

examples/backup-restore/main.tf

examples/backup-restore/variables.tf

solutions/standard/main.tf

tests/pr_test.go

Aditya-ranjan-16 · 2025-01-31T06:58:30Z

/run pipeline

Aditya-ranjan-16 · 2025-01-31T09:03:45Z

/run pipeline

Aditya-ranjan-16 · 2025-02-03T06:56:12Z

/run pipeline

Aditya-ranjan-16 · 2025-02-04T05:59:42Z

At a higher level, it should be unnecessary to include common-dev-assets in a PR. This should be bumped on a standalone cycle and by including it, there is a risk of merge conflicts as the main branch changes or potentially rolling it back.

It is good to see backup-restore coverage being added to elasticsearch. However, when compared to etcd and mongodb example it is different. The ICD module tests should be converging, not diverging with every commit.

The basic example changes are good. Converging the source, so that it is more consistent across modules. This reduces maintenance moving forward, allow for cut-n-paste or possibly cherry picking changes from one module to another.

The main branch common-dev-assets was last updated a long time back 3 months ago , and it doesn't include the latest elastic search permanent CRN I added recently . hence I updated common-dev-assets to point to a latest commit in my branch

Not sure why this is the case , but I don't see any recent renovate PR to update CI depnedecies

shemau · 2025-02-04T11:07:49Z

/run pipeline

shemau

LGTM

I will follow up as to why renovate is not bumping common-dev-assets automatically.

ocofaigh · 2025-02-04T14:53:12Z

/run pipeline

Aditya-ranjan-16 · 2025-02-04T21:18:54Z

/run pipeline

Aditya-ranjan-16 · 2025-02-05T06:07:37Z

/run pipeline

Aditya-ranjan-16 · 2025-02-05T06:13:20Z

/run pipeline

Aditya-ranjan-16 · 2025-02-05T07:25:06Z

/run pipeline

shemau

LGTM. All issues addressed.

ocofaigh · 2025-02-05T14:22:53Z

@Aditya-ranjan-16 FYI, there are no code changes to the module or DA, just the example and test - so this means we do no need a new release. See Release versioning for more info

terraform-ibm-modules-ops · 2025-02-09T04:20:52Z

🎉 This PR is included in version 1.28.2 🎉

The release is available on:

GitHub release
v1.28.2

Your semantic-release bot 📦🚀

Aditya-ranjan-16 and others added 4 commits January 9, 2025 12:12

feat: added missing examples and plugged test gaps

32a34ec

Merge branch 'main' into test-coverage

3a06e3e

Merge branch 'main' into test-coverage

ca80ff5

feat: added existing instance test and refactored tests

aca906b

Aditya-ranjan-16 changed the title ~~[WIP]feat: added missing examples and plugged test gaps~~ feat: added missing examples and plugged test gaps Jan 27, 2025

Aditya-ranjan-16 marked this pull request as ready for review January 27, 2025 08:01

Aditya-ranjan-16 requested review from daniel-butler-irl and shemau as code owners January 27, 2025 08:01

Aditya-ranjan-16 linked an issue Jan 27, 2025 that may be closed by this pull request

Review module test coverage/gaps #337

Closed

fix: pre-commit

b9ea717

Aashiq-J mentioned this pull request Jan 28, 2025

test: add test for existing ES #379

Closed

6 tasks

shemau requested changes Jan 28, 2025

View reviewed changes

fix

5179634

Aditya-ranjan-16 requested a review from shemau January 31, 2025 07:02

fix: pre-commit

fdcf49e

Merge branch 'main' into test-coverage

b6a4d7c

Merge branch 'main' into test-coverage

8fe95d5

shemau previously approved these changes Feb 4, 2025

View reviewed changes

Merge branch 'main' into test-coverage

7b7f417

ocofaigh dismissed shemau’s stale review via 7b7f417 February 4, 2025 14:53

Merge branch 'main' into test-coverage

9e8049f

Aditya-ranjan-16 requested a review from shemau February 4, 2025 21:20

fix:doc changes

74cac69

fix:pre commit

25378ba

fix pre-commit

e2be1a2

Aditya-ranjan-16 self-assigned this Feb 5, 2025

shemau approved these changes Feb 5, 2025

View reviewed changes

ocofaigh merged commit 2095c3d into main Feb 5, 2025
2 checks passed

ocofaigh deleted the test-coverage branch February 5, 2025 14:23

terraform-ibm-modules-ops added the released label Feb 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: added missing examples and plugged test gaps #384

feat: added missing examples and plugged test gaps #384

Aditya-ranjan-16 commented Jan 9, 2025 •

edited by ocofaigh

Loading

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

shemau commented Jan 28, 2025

shemau left a comment

Aditya-ranjan-16 commented Jan 31, 2025

Aditya-ranjan-16 commented Jan 31, 2025

Aditya-ranjan-16 commented Feb 3, 2025

Aditya-ranjan-16 commented Feb 4, 2025

shemau commented Feb 4, 2025

shemau left a comment

ocofaigh commented Feb 4, 2025

Aditya-ranjan-16 commented Feb 4, 2025

Aditya-ranjan-16 commented Feb 5, 2025

Aditya-ranjan-16 commented Feb 5, 2025

Aditya-ranjan-16 commented Feb 5, 2025

shemau left a comment

ocofaigh commented Feb 5, 2025

terraform-ibm-modules-ops commented Feb 9, 2025

feat: added missing examples and plugged test gaps #384

feat: added missing examples and plugged test gaps #384

Conversation

Aditya-ranjan-16 commented Jan 9, 2025 • edited by ocofaigh Loading

Description

Release required?

Release notes content

Run the pipeline

Checklist for reviewers

For mergers

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

Aditya-ranjan-16 commented Jan 27, 2025

shemau commented Jan 28, 2025

shemau left a comment

Choose a reason for hiding this comment

Aditya-ranjan-16 commented Jan 31, 2025

Aditya-ranjan-16 commented Jan 31, 2025

Aditya-ranjan-16 commented Feb 3, 2025

Aditya-ranjan-16 commented Feb 4, 2025

shemau commented Feb 4, 2025

shemau left a comment

Choose a reason for hiding this comment

ocofaigh commented Feb 4, 2025

Aditya-ranjan-16 commented Feb 4, 2025

Aditya-ranjan-16 commented Feb 5, 2025

Aditya-ranjan-16 commented Feb 5, 2025

Aditya-ranjan-16 commented Feb 5, 2025

shemau left a comment

Choose a reason for hiding this comment

ocofaigh commented Feb 5, 2025

terraform-ibm-modules-ops commented Feb 9, 2025

Aditya-ranjan-16 commented Jan 9, 2025 •

edited by ocofaigh

Loading