fix: cat type_metadata validaiton #1081

Ak-sky · 2025-11-27T13:56:36Z

Description

Validation fix for type mismatch errors for catalog inputs.

Release required?

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

Release notes content

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.

daniel-butler-irl

Please add or update some of the test data for the mismatch types to ensure different widgets work https://github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/tree/main/cloudinfo/testdata

I am not sure if we should add new tests or enhance the existing mismatch type test

Ak-sky · 2025-11-27T15:31:53Z

Please add or update some of the test data for the mismatch types to ensure different widgets work https://github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/tree/main/cloudinfo/testdata

I am not sure if we should add new tests or enhance the existing mismatch type test

@daniel-butler-irl
I have updated the test in this file ibm_catalog_with_config_overrides_type_mismatch and renamed it with ibm_catalog_with_config_overrides_type_and_type_metadata_mismatch

daniel-butler-irl · 2025-11-28T11:37:10Z

/run pipeline

Ak-sky · 2025-11-30T23:20:51Z

/run pipeline

Ak-sky · 2025-12-01T08:23:32Z

/run pipeline

Ak-sky · 2025-12-01T09:22:27Z

/run pipeline

Ak-sky · 2025-12-01T18:13:21Z

Unit tests were failing, added new tests.

=== RUN   TestProjectsServiceTestSuite/TestCreateStackFromConfigFile/Default_values_from_ibm_catalog.json,_should_override_values_from_stack_definition.json
    projects_test.go:1132: 
        	Error Trace:	/__w/ibmcloud-terratest-wrapper/ibmcloud-terratest-wrapper/cloudinfo/projects_test.go:1132
        	            				/go/pkg/mod/github.com/stretchr/testify@v1.11.1/suite/suite.go:115
        	Error:      	Not equal: 
        	            	expected: &projectv1.StackDefinition{ID:(*string)(0xc000587c90), CreatedAt:(*strfmt.DateTime)(nil), ModifiedAt:(*strfmt.DateTime)(nil), Configuration:(*projectv1.StackDefinitionMetadataConfiguration)(nil), Href:(*string)(nil), StackDefinition:(*projectv1.StackDefinitionBlock)(0xc000610050)}
        	            	actual  : &projectv1.StackDefinition{ID:(*string)(0xc00048f6a0), CreatedAt:(*strfmt.DateTime)(nil), ModifiedAt:(*strfmt.DateTime)(nil), Configuration:(*projectv1.StackDefinitionMetadataConfiguration)(nil), Href:(*string)(nil), StackDefinition:(*projectv1.StackDefinitionBlock)(0xc000446460)}
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -7,3 +7,3 @@
        	            	  StackDefinition: (*projectv1.StackDefinitionBlock)({
        	            	-  Inputs: ([]projectv1.StackDefinitionInputVariable) (len=4) {
        	            	+  Inputs: ([]projectv1.StackDefinitionInputVariable) (len=7) {
        	            	    (projectv1.StackDefinitionInputVariable) {
        	            	@@ -37,2 +37,26 @@
        	            	     Default: (*bool)(true),
        	            	+    Required: (*bool)(false),
        	            	+    Hidden: (*bool)(false)
        	            	+   },
        	            	+   (projectv1.StackDefinitionInputVariable) {
        	            	+    Name: (*string)((len=6) "input5"),
        	            	+    Type: (*string)((len=6) "string"),
        	            	+    Description: (*string)(""),
        	            	+    Default: (*string)((len=13) "stack_value_5"),
        	            	+    Required: (*bool)(false),
        	            	+    Hidden: (*bool)(false)
        	            	+   },
        	            	+   (projectv1.StackDefinitionInputVariable) {
        	            	+    Name: (*string)((len=6) "input6"),
        	            	+    Type: (*string)((len=6) "string"),
        	            	+    Description: (*string)(""),
        	            	+    Default: (*string)((len=13) "stack_value_6"),
        	            	+    Required: (*bool)(false),
        	            	+    Hidden: (*bool)(false)
        	            	+   },
        	            	+   (projectv1.StackDefinitionInputVariable) {
        	            	+    Name: (*string)((len=6) "input7"),
        	            	+    Type: (*string)((len=6) "string"),
        	            	+    Description: (*string)(""),
        	            	+    Default: (*string)((len=13) "stack_value_7"),
        	            	     Required: (*bool)(false),
        	Test:       	TestProjectsServiceTestSuite/TestCreateStackFromConfigFile/Default_values_from_ibm_catalog.json,_should_override_values_from_stack_definition.json
=== RUN   TestProjectsServiceTestSuite/TestCreateStackFromConfigFile/Default_values_from_ibm_catalog.json_with_a_default_not_set,_should_override_values_from_stack_definition.json
    projects_test.go:1132: 
        	Error Trace:	/__w/ibmcloud-terratest-wrapper/ibmcloud-terratest-wrapper/cloudinfo/projects_test.go:1132
        	            				/go/pkg/mod/github.com/stretchr/testify@v1.11.1/suite/suite.go:115
        	Error:      	Not equal: 
        	            	expected: &projectv1.StackDefinition{ID:(*string)(0xc000587ec0), CreatedAt:(*strfmt.DateTime)(nil), ModifiedAt:(*strfmt.DateTime)(nil), Configuration:(*projectv1.StackDefinitionMetadataConfiguration)(nil), Href:(*string)(nil), StackDefinition:(*projectv1.StackDefinitionBlock)(0xc000610190)}
        	            	actual  : &projectv1.StackDefinition{ID:(*string)(0xc000607540), CreatedAt:(*strfmt.DateTime)(nil), ModifiedAt:(*strfmt.DateTime)(nil), Configuration:(*projectv1.StackDefinitionMetadataConfiguration)(nil), Href:(*string)(nil), StackDefinition:(*projectv1.StackDefinitionBlock)(0xc000446690)}
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -7,3 +7,3 @@
        	            	  StackDefinition: (*projectv1.StackDefinitionBlock)({
        	            	-  Inputs: ([]projectv1.StackDefinitionInputVariable) (len=4) {
        	            	+  Inputs: ([]projectv1.StackDefinitionInputVariable) (len=7) {
        	            	    (projectv1.StackDefinitionInputVariable) {
        	            	@@ -37,2 +37,26 @@
        	            	     Default: (*bool)(false),
        	            	+    Required: (*bool)(false),
        	            	+    Hidden: (*bool)(false)
        	            	+   },
        	            	+   (projectv1.StackDefinitionInputVariable) {
        	            	+    Name: (*string)((len=6) "input5"),
        	            	+    Type: (*string)((len=6) "string"),
        	            	+    Description: (*string)(""),
        	            	+    Default: (*string)((len=13) "stack_value_5"),
        	            	+    Required: (*bool)(false),
        	            	+    Hidden: (*bool)(false)
        	            	+   },
        	            	+   (projectv1.StackDefinitionInputVariable) {
        	            	+    Name: (*string)((len=6) "input6"),
        	            	+    Type: (*string)((len=6) "string"),
        	            	+    Description: (*string)(""),
        	            	+    Default: (*string)((len=13) "stack_value_6"),
        	            	+    Required: (*bool)(false),
        	            	+    Hidden: (*bool)(false)
        	            	+   },
        	            	+   (projectv1.StackDefinitionInputVariable) {
        	            	+    Name: (*string)((len=6) "input7"),
        	            	+    Type: (*string)((len=6) "string"),
        	            	+    Description: (*string)(""),
        	            	+    Default: (*string)((len=13) "stack_value_7"),
        	            	     Required: (*bool)(false),
        	Test:       	TestProjectsServiceTestSuite/TestCreateStackFromConfigFile/Default_values_from_ibm_catalog.json_with_a_default_not_set,_should_override_values_from_stack_definition.json

So had to redo some stuff.

Ak-sky · 2025-12-01T18:20:26Z

/run pipeline

Ak-sky · 2025-12-01T18:25:34Z

/run pipeline

cloudinfo/testdata/stack_definition_with_type_metadata_only.json

Ak-sky · 2025-12-02T13:35:34Z

/run pipeline

whoffler · 2025-12-02T13:51:03Z

cloudinfo/projects_test.go

+			stackConfigPath: "testdata/stack_definition_with_type_metadata_only.json",
+			catalogJsonPath: "testdata/ibm_catalog_with_type_metadata_only.json",
+			expectedConfig:  nil,
+			expectedError: fmt.Errorf("catalog configuration type_metadata mismatch in product 'Product Name', flavor 'Flavor Name': input5 expected type: string, got: int\n" +


Should this read

"catalog configuration type_metadata mismatch in product 'Product Name', flavor 'Flavor Name': input5 expected type: int, got: string\n"

?

expectedType is string from stack definition and catalog catalogInput.TypeMetadata is int, so this should be correct!

stack def-

"inputs": [ { "name": "input5", "required": false, "type_metadata": "string", "hidden": false, "default": "stack_value_5" },

catalog val-

"configuration": [ { "key": "input5", "type_metadata": "int", "description": "Description for input5", "default_value": "default_value_5", "required": false, "display_name": "Input 5" },

whoffler · 2025-12-02T13:51:33Z

cloudinfo/projects_test.go

+			catalogJsonPath: "testdata/ibm_catalog_with_type_metadata_only.json",
+			expectedConfig:  nil,
+			expectedError: fmt.Errorf("catalog configuration type_metadata mismatch in product 'Product Name', flavor 'Flavor Name': input5 expected type: string, got: int\n" +
+				"catalog configuration type_metadata mismatch in product 'Product Name', flavor 'Flavor Name': input6 expected type: string, got: bool"),


And this

"catalog configuration type_metadata mismatch in product 'Product Name', flavor 'Flavor Name': input6 expected type: bool, got: string"),

?

here also

stack def-

{ "name": "input6", "required": false, "type_metadata": "string", "hidden": false, "default": "stack_value_6" },

catalog val-

{ "key": "input6", "type_metadata": "bool", "description": "Description for input6", "default_value": "", "required": false, "display_name": "Input 6" },

fix: cat type_metadata validaiton

313fb2e

Ak-sky requested review from daniel-butler-irl and whoffler as code owners November 27, 2025 13:56

daniel-butler-irl requested changes Nov 27, 2025

View reviewed changes

updated tests

0b9c945

Ak-sky requested a review from daniel-butler-irl November 27, 2025 15:32

whoffler previously approved these changes Nov 28, 2025

View reviewed changes

Merge remote-tracking branch 'origin/main' into cat-validation

b80f508

Ak-sky dismissed whoffler’s stale review via b80f508 November 30, 2025 23:20

fix tedst failure

2fbdabc

added new test for type_metadata

1220d92

fix EOF

363ac28

Ak-sky requested a review from whoffler December 1, 2025 18:27

whoffler reviewed Dec 2, 2025

View reviewed changes

cloudinfo/testdata/stack_definition_with_type_metadata_only.json Show resolved Hide resolved

ocofaigh mentioned this pull request Dec 2, 2025

fix(deps): Update stack definition member versions terraform-ibm-modules/stack-ibm-core-security-services#270

Open

Ak-sky added 2 commits December 2, 2025 18:58

addressed review comments

ef59d77

removed files

c3dba90

Ak-sky requested a review from whoffler December 2, 2025 13:35

whoffler reviewed Dec 2, 2025

View reviewed changes

Ak-sky requested a review from whoffler December 2, 2025 23:22

fix: cat type_metadata validaiton #1081

Are you sure you want to change the base?

fix: cat type_metadata validaiton #1081

Conversation

Ak-sky commented Nov 27, 2025

Description

Release required?

Release notes content

Run the pipeline

Checklist for reviewers

For mergers

Uh oh!

daniel-butler-irl left a comment

Choose a reason for hiding this comment

Uh oh!

Ak-sky commented Nov 27, 2025

Uh oh!

daniel-butler-irl commented Nov 28, 2025

Uh oh!

Ak-sky commented Nov 30, 2025

Uh oh!

Ak-sky commented Dec 1, 2025

Uh oh!

Ak-sky commented Dec 1, 2025

Uh oh!

Ak-sky commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ak-sky commented Dec 1, 2025

Uh oh!

Ak-sky commented Dec 1, 2025

Uh oh!

Uh oh!

Ak-sky commented Dec 2, 2025

Uh oh!

whoffler Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ak-sky Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

whoffler Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Ak-sky Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Ak-sky commented Dec 1, 2025 •

edited

Loading

whoffler Dec 2, 2025 •

edited

Loading