ENG-14612: Implement cyral_policy_wizards resource

[yoursnerdly]

Description of the change

As title

Type of change

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklists

Development

• Lint rules pass locally
• The code changed/added as part of this pull request has been covered with tests
• All tests related to the changed code pass in development

Code review

• This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
• Jira issue referenced in commit message and/or PR title

Testing

• With wizard-id specified, the data source state shows only the requested wizard.
• With no wizard-id specified, the data source state shows the list of all supported wizards.

[wcmjunior]

A few suggestions:

1. If the api is policyWizard in the singular, please use the same convention for the resource. I remember mentioning it should be in plural, but it was a mistake on my end as I did not check if the API was plural as well.
2. As for code hygiene, I suggest to keep the policy_wizard in its own package. Seems like the package structure should be:

- policy
   |- set
   |- wizard

[yoursnerdly]

1. If the api is policyWizard in the singular, please use the same convention for the resource. I remember mentioning it should be in plural, but it was a mistake on my end as I did not check if the API was plural as well.

Well the REST path is GET /v1/policyWizards (plural) with optional id at the end. The gRPC methods are called ReadPolicyWizard (singular because it pertains to ONE wizard) and ListPolicyWizards (plural).

Also given that the data source returns a list of wizards, I'd suggest retaining the plural.

[yoursnerdly]

This is an unused private variable that causes a linter warning.

[yoursnerdly]

- policy
   |- set
   |- wizard

Thanks for the suggestion, this is incorporated in the latest commit.

[gengdahlCyral]

LGTM

[wcmjunior]

The convention documented here used throughout the whole codebase makes it faster to anyone reading it to understand what is going on. Maybe the docs are not good enough to ask to follow the same naming conventions, but if you check all the other resources they will look the very same as the changes I propose in the review.

As we use clear and descriptive package names like policy.set and policy.wizard, we can use the same standards to make it easier to anyone used to read any of our resources and data sources. We also end up avoid Smurf naming convention.

[yoursnerdly]

The convention documented here used throughout the whole codebase makes it faster to anyone reading it to understand what is going on. Maybe the docs are not good enough to ask to follow the same naming conventions, but if you check all the other resources they will look the very same as the changes I propose in the review.

As we use clear and descriptive package names like policy.set and policy.wizard, we can use the same standards to make it easier to anyone used to read any of our resources and data sources. We also end up avoid Smurf naming convention.

Yeah, this happened due to refactoring out into separate packages for policy set and wizard - I had to use different names when they were in the same package. Will fix.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarQube Cloud