Migrate pp gateway, managementapp, solution, and tenant commands to Zod#7423
Open
waldekmastykarz wants to merge 3 commits into
Open
Migrate pp gateway, managementapp, solution, and tenant commands to Zod#7423waldekmastykarz wants to merge 3 commits into
waldekmastykarz wants to merge 3 commits into
Conversation
Migrates the following commands from legacy #initOptions()/#initValidators()/ #initTelemetry() pattern to Zod schema-based validation: - pp gateway get - pp managementapp add - pp managementapp list - pp solution get - pp solution list - pp solution publish - pp solution publisher add - pp solution publisher get - pp solution publisher list - pp solution publisher remove - pp solution remove - pp tenant settings set Closes pnp#7314 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates a set of Power Platform (pp) commands from the legacy initOptions/initValidators/initTelemetry pattern to Zod schema-based option definition/validation, and updates the corresponding unit tests to validate options through the schema.
Changes:
- Introduces exported Zod
optionsschemas (withschema/getRefinedSchema) across the migratedppcommands. - Reworks validation tests to use
commandOptionsSchema.safeParse()and action tests to passcommandOptionsSchema.parse(...). - Adds “fails validation with unknown options” coverage to the updated spec files.
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 21 comments.
Show a summary per file
| File | Description |
|---|---|
| src/m365/pp/commands/tenant/tenant-settings-set.ts | Migrates tenant settings set command to Zod schema + refined “at least one option” validation |
| src/m365/pp/commands/tenant/tenant-settings-set.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/solution/solution-remove.ts | Migrates solution remove command to Zod schema + option-set refinement |
| src/m365/pp/commands/solution/solution-remove.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/solution/solution-publisher-remove.ts | Migrates publisher remove command to Zod schema + option-set refinement |
| src/m365/pp/commands/solution/solution-publisher-remove.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/solution/solution-publisher-list.ts | Migrates publisher list command to Zod schema |
| src/m365/pp/commands/solution/solution-publisher-list.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/solution/solution-publisher-get.ts | Migrates publisher get command to Zod schema + option-set refinement |
| src/m365/pp/commands/solution/solution-publisher-get.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/solution/solution-publisher-add.ts | Migrates publisher add command to Zod schema and updates validation logic |
| src/m365/pp/commands/solution/solution-publisher-add.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/solution/solution-publish.ts | Migrates solution publish command to Zod schema + option-set refinement |
| src/m365/pp/commands/solution/solution-publish.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/solution/solution-list.ts | Migrates solution list command to Zod schema |
| src/m365/pp/commands/solution/solution-list.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/solution/solution-get.ts | Migrates solution get command to Zod schema + option-set refinement |
| src/m365/pp/commands/solution/solution-get.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/managementapp/managementapp-list.ts | Adds schema for managementapp list (global options only) |
| src/m365/pp/commands/managementapp/managementapp-list.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/managementapp/managementapp-add.ts | Migrates managementapp add command to Zod schema + option-set refinement |
| src/m365/pp/commands/managementapp/managementapp-add.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
| src/m365/pp/commands/gateway/gateway-get.ts | Migrates gateway get command to Zod schema |
| src/m365/pp/commands/gateway/gateway-get.spec.ts | Updates tests to use schema parsing + unknown option validation coverage |
- Changed message: to error: in all refine() calls to match repo convention - Fixed args.options.environment to args.options.environmentName in solution-publish.ts Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates the following commands from the legacy
#initOptions()/#initValidators()/#initTelemetry()pattern to Zod schema-based validation:pp gateway getpp managementapp addpp managementapp listpp solution getpp solution listpp solution publishpp solution publisher addpp solution publisher getpp solution publisher listpp solution publisher removepp solution removepp tenant settings setChanges
#initOptions(),#initValidators(),#initTelemetry(),#initTypes(), and#initOptionSets()with exported Zod schemasschemagetter andgetRefinedSchema()where cross-field validation is neededcommandOptionsSchema.safeParse()for validation tests andcommandOptionsSchema.parse()for action testsCloses #7314