feat(IAM Policy Management): re-gen service after recent API changes,… #259

vivekj3 · 2023-05-19T08:51:33Z

PR summary

Added feature support for Enterprise IAM work, policy templates and get template assignments.

Issue: https://github.ibm.com/IAM/AM-issues/issues/1086

PR Checklist

Please make sure that your PR fulfills the following requirements:

The commit message follows the Angular Commit Message Guidelines.
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Current vs new behavior

Does this PR introduce a breaking change?

Yes
No

Other information

API defintion:
Staging
Prod

Test information:

Unit Tests:

Example Tests:

Integration Tests:

… Tests added for Policy Template Signed-off-by: Vivek.Jain3 <[email protected]>

CLAassistant · 2023-05-19T08:51:40Z

All committers have signed the CLA.

Signed-off-by: Vivek.Jain3 <[email protected]>

…dded for PolicyAssignment by id Signed-off-by: Vivek.Jain3 <[email protected]>

…ignment by id Signed-off-by: Vivek.Jain3 <[email protected]>

swcolley · 2023-05-23T13:29:49Z

iampolicymanagementv1/iam_policy_management_v1_integration_test.go

+		testPolicyTemplateETag    string = ""
+		testPolicyTemplateVersion string = ""
+		// change testPolicyAssignmentId id after prod account setup
+		testPolicyAssignmentId = "442c6fc4-2f74-41b2-bf4d-98342614cd22"


Why not use a flow like:

list policy assignments 2. Store an assignment id, 3. use stored id to call get assignment by id?
I think it is okay to hardcode an ID here, but I'm not sure if it matters whether it is production or test environment. These tests are for us to run locally and we can give production credentials in the iam_policy_management.env when we test locally to verify works in production.

I believe it is better to use assignment id from list policy assignments, as same assignment id will not be available in different accounts so even if we hardcode it will restricted to use same account.

Thanks i'll update

I updated the tests

I think your reasoning sounds good. We can try to make sure we create an assignment in the account we use for testing, but luckily there are some we can refer to currently.
Thanks for making that change.

I might not understand 100% of this discussion, but it sounds like you need to use an id of a pre-existing account that your tests rely on. The int tests and examples for this service already retrieve the "TEST_ACCOUNT_ID" config property from the .env file during startup. It is stored in the testAccountID variable in the integration tests and in exampleAccountID in the examples code.
It's way better to retrieve this value from the .env file than to keep having to update the hard-coded id within the actual source code.

swcolley · 2023-05-23T13:31:23Z

iampolicymanagementv1/iam_policy_management_v1_examples_test.go

+		examplePolicyTemplateETag    string
+		examplePolicyTemplateVersion string
+		// change testPolicyAssignmentId id after prod account setup
+		testPolicyAssignmentId = "442c6fc4-2f74-41b2-bf4d-98342614cd22"


Same as other comment.

Signed-off-by: Vivek.Jain3 <[email protected]>

swcolley

Looks good from my perspective :D

padamstx

There are some improvements that can be made in the integration tests and examples. I'd like to encourage you to update the API definition to define links where there are inter-operation dependencies. This will then let you avoid the manual changes to store off specific values and then use those values in downstream operations.
The tests and examples code are functional as they are, but the change I'm suggesting will make for easier maintenance in the future.
Let's discuss before we merge...

padamstx · 2023-05-31T17:12:58Z

iampolicymanagementv1/iam_policy_management_v1_examples_test.go

+			Expect(response.StatusCode).To(Equal(201))
+			Expect(policyTemplate).ToNot(BeNil())
+
+			examplePolicyTemplateID = *policyTemplate.ID


If you define the appropriate link objects in your API definition, the SDK generator will generate code like this to store off a value such as the policyTemplate.ID value, then generate code in the test of the consuming operation to use the stored value to initialize an operation parameter.
Take a look at the SDK squad's mock service that we use for various types of testing:
https://github.ibm.com/CloudEngineering/openapi-sdkgen/blob/main/src/test/resources/ansiform-service.yaml
and the associated Go code in the resulting Go SDK:
https://github.ibm.com/CloudEngineering/ansiform-go-sdk/tree/main/ansiformmockv1

Note that the integration tests and examples code were generated for this service with no required manual post-gen changes. This is due to the fact that example values and links are defined throughout the API definition.

padamstx · 2023-05-31T17:14:13Z

iampolicymanagementv1/iam_policy_management_v1_examples_test.go

+			Expect(policyTemplate.Name).ToNot(BeNil())
+			Expect(policyTemplate.Policy).ToNot(BeNil())
+
+			examplePolicyTemplateETag = response.GetHeaders().Get("ETag")


You can also use a link to store off ETag values and then use the value to initialize an "IfMatch" header param in downstream operations.

padamstx · 2023-05-31T17:16:35Z

iampolicymanagementv1/iam_policy_management_v1_integration_test.go

+			Expect(policyTemplate.Policy.Type).To(Equal(core.StringPtr("access")))
+			Expect(policyTemplate.AccountID).To(Equal(core.StringPtr(testAccountID)))
+
+			testPolicyTemplateID = *policyTemplate.ID


Same comments here re: links/examples as in the examples code above.

padamstx · 2023-05-31T17:17:38Z

iampolicymanagementv1/iam_policy_management_v1_integration_test.go

+		})
+		It(`ListPolicyTemplates(listPolicyTemplatesOptions *ListPolicyTemplatesOptions)`, func() {
+			listPolicyTemplatesOptions := &iampolicymanagementv1.ListPolicyTemplatesOptions{
+				AccountID:      core.StringPtr(testAccountID),


Suggested change

AccountID: core.StringPtr(testAccountID),

AccountID: &testAccountID,

The core.StringPtr() function is only needed when using a string literal. For a variable, we can just use the & operator directly.

Signed-off-by: Vivek.Jain3 <[email protected]>

… Tests update for Policy Template Signed-off-by: Vivek.Jain3 <[email protected]>

# [0.43.0](v0.42.1...v0.43.0) (2023-08-09) ### Features * **IAM Policy Management:** re-gen service after recent API changes,… ([#259](#259)) ([2837a98](2837a98))

ibm-devx-sdk · 2023-08-09T15:25:17Z

🎉 This PR is included in version 0.43.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

feat(IAM Policy Management): re-gen service after recent API changes,…

e1fe0be

… Tests added for Policy Template Signed-off-by: Vivek.Jain3 <[email protected]>

vivekj3 added 4 commits May 19, 2023 14:57

feat(IAM Policy Management): policy assignment test update

685c8f6

Signed-off-by: Vivek.Jain3 <[email protected]>

feat(IAM Policy Management): regenerate sdk after yaml update

2a3fd59

Signed-off-by: Vivek.Jain3 <[email protected]>

feat(IAM Policy Management): regenerate sdk after yaml update, test a…

1d30ad4

…dded for PolicyAssignment by id Signed-off-by: Vivek.Jain3 <[email protected]>

feat(IAM Policy Management): integration test added for GET PolicyAss…

cae8648

…ignment by id Signed-off-by: Vivek.Jain3 <[email protected]>

swcolley reviewed May 23, 2023

View reviewed changes

feat(IAM Policy Management): test flow update, code refactor

24cc68a

Signed-off-by: Vivek.Jain3 <[email protected]>

swcolley reviewed May 25, 2023

View reviewed changes

vivekj3 marked this pull request as ready for review May 29, 2023 08:51

Merge branch 'main' into update-iampolicymanagementv1-service

9f15e34

padamstx approved these changes May 31, 2023

View reviewed changes

feat(IAM Policy Management): code refactor integration test

cc724b7

Signed-off-by: Vivek.Jain3 <[email protected]>

padamstx self-assigned this Jun 21, 2023

padamstx and others added 7 commits June 21, 2023 15:05

Merge branch 'main' into update-iampolicymanagementv1-service

f638d65

feat(IAM Policy Management): re-gen API service model

cb0b4fd

Signed-off-by: Vivek.Jain3 <[email protected]>

Merge branch 'main' into update-iampolicymanagementv1-service

150303d

Merge branch 'main' into update-iampolicymanagementv1-service

7746325

feat(IAM Policy Management): re-gen service after recent API changes,…

73fd1e2

… Tests update for Policy Template Signed-off-by: Vivek.Jain3 <[email protected]>

Merge branch 'main' into update-iampolicymanagementv1-service

fdfafde

Merge branch 'main' into update-iampolicymanagementv1-service

55415cb

padamstx merged commit 2837a98 into IBM:main Aug 9, 2023

ibm-devx-sdk added the released label Aug 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(IAM Policy Management): re-gen service after recent API changes,… #259

feat(IAM Policy Management): re-gen service after recent API changes,… #259

vivekj3 commented May 19, 2023 •

edited by padamstx

Loading

CLAassistant commented May 19, 2023 •

edited

Loading

swcolley May 23, 2023

vivekj3 May 25, 2023

vivekj3 May 25, 2023

swcolley May 25, 2023

padamstx May 31, 2023

swcolley May 23, 2023

swcolley left a comment

padamstx left a comment

padamstx May 31, 2023

padamstx May 31, 2023

padamstx May 31, 2023

padamstx May 31, 2023

ibm-devx-sdk commented Aug 9, 2023

	AccountID: core.StringPtr(testAccountID),
	AccountID: &testAccountID,

feat(IAM Policy Management): re-gen service after recent API changes,… #259

feat(IAM Policy Management): re-gen service after recent API changes,… #259

Conversation

vivekj3 commented May 19, 2023 • edited by padamstx Loading

PR summary

PR Checklist

Current vs new behavior

Does this PR introduce a breaking change?

Other information

CLAassistant commented May 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

swcolley left a comment

Choose a reason for hiding this comment

padamstx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ibm-devx-sdk commented Aug 9, 2023

vivekj3 commented May 19, 2023 •

edited by padamstx

Loading

CLAassistant commented May 19, 2023 •

edited

Loading