Repair switch support for V1.7 YAML manifest #4041

Madhusudhan-MSFT · 2024-01-08T18:54:10Z

Add YAML manifest entries for winget repair behavior

Manifest Entries includes:
- The Repair switch, within InstallerSwitch, allows for custom repair of a package.
- The RepairBehavior enum field, present in the Installer & root level field, determines the repair behavior for the source package used to repair a package.
- Updated the test manifest (ManifestV1_7-MultiFile-Installer.yaml) and the test code that validate the Repair switch and RepairBehavior fields.

[How Validated:]

Made the necessary changes to the manifest
Ran the ManifestValidation tests that are part of AppInstallerCLITests and verified that all the tests passed

[Test Result:]

Filters: [ManifestValidation]
===============================================================================
All tests passed (4008 assertions in 30 test cases)

Filters: [ManifestCreation]
===============================================================================
All tests passed (1309 assertions in 7 test cases)

TODO's:

Determine the interdependency validation between the "RepairBehavior" and "Repair" fields. Should this be a semantic validation or a validation at the time of workflow execution as an early validation step?

I have signed the Contributor License Agreement.
This pull request is related to an issue.

Related to :

Repair an App that is behaving badly #148

Microsoft Reviewers: Open in CodeFlow

Manifest Entries includes: - The Repair switch, within InstallerSwitch, allows for custom repair of a package. - The RepairBehavior enum field, present in both the Installer and root nodes, determines the repair behavior for the source package used to repair a package.

…v1_7 manifest schema.

…pairBehavior

…ring only supported installers can specify repair behavior. [Why] This change is to prevent incorrect mapping for unsupported installers by disallowing RepairBehavior field at root level

…cope with Installer Object.

src/AppInstallerCommonCore/Public/winget/ManifestInstaller.h

schemas/JSON/manifests/v1.7.0/manifest.installer.1.7.0.json

src/AppInstallerCLITests/TestData/MultiFileManifestV1_7/ManifestV1_7-MultiFile-Installer.yaml

src/AppInstallerCommonCore/Public/winget/ManifestCommon.h

src/AppInstallerCommonCore/Manifest/ManifestYamlPopulator.cpp

src/AppInstallerCLITests/YamlManifest.cpp

… with the manifest design. This commit address two spacing alignment issues in manifest through this commit.

…epair� InstallerSwitch manifest read/parsing logic within manifest major version 1

…viorEnum to utilize string_view from last commit.

…d and added corresponding test

…avior and modified V1_7 test manifests. NOTE:Please note that RepairBehavior, Repair reference, and values in test manifest are for demonstration and validation only, not real samples.

Madhusudhan-MSFT · 2024-01-12T18:22:50Z

/azp run

azure-pipelines · 2024-01-12T18:22:59Z

Azure Pipelines successfully started running 1 pipeline(s).

Trenly · 2024-01-12T18:57:07Z

Does this PR also add support for it in the COM API?

Madhusudhan-MSFT · 2024-01-12T19:05:54Z

Does this PR also add support for it in the COM API?

The scope of this PR is limited to manifest support for the Repair functionality. While we do have plans to add support for the COM API, that change is not included in this PR. The repair workflow and COM API implementation will be addressed in separate PRs, allowing us to more effectively manage the complexity and address feedback on different aspects of the implementation.

Trenly · 2024-01-12T19:07:09Z

Does this PR also add support for it in the COM API?

The scope of this PR is limited to manifest support for the Repair functionality. While we do have plans to add support for the COM API, that change is not included in this PR. The repair workflow and COM API implementation will be addressed in separate PRs, allowing us to more effectively manage the complexity and address feedback on different aspects of the implementation.

I see; Thanks!

schemas/JSON/manifests/v1.7.0/manifest.installer.1.7.0.json

yao-msft

…a manifest to ensure consistency with other usage in the schema manifest.

Madhusudhan-MSFT added 7 commits December 19, 2023 17:12

Parse the repair manifest entries and populate them according to the …

a412c20

…v1_7 manifest schema.

Fix manifest parsing by adding RepairBehavior field to schema 1.7

74eed30

Align RepairBehaviorEnum values with manifest schema specifications

1488788

[Tests:] Add tests for manifest entries Repair installerswitch and Re…

5ac8de3

…pairBehavior

Update RepairBehavior field scope to apply to Installers object, ensu…

5bc2fcf

…ring only supported installers can specify repair behavior. [Why] This change is to prevent incorrect mapping for unsupported installers by disallowing RepairBehavior field at root level

Modify V1.7 manifest validation tests to align RepairBehavior field s…

e059aee

…cope with Installer Object.

Madhusudhan-MSFT marked this pull request as ready for review January 8, 2024 20:24

Madhusudhan-MSFT requested a review from a team as a code owner January 8, 2024 20:24

JohnMcPMS previously approved these changes Jan 10, 2024

View reviewed changes

src/AppInstallerCommonCore/Public/winget/ManifestInstaller.h Outdated Show resolved Hide resolved

Review comment fix: Remove inline TODO comment

6fc3b06

Madhusudhan-MSFT dismissed JohnMcPMS’s stale review via 6fc3b06 January 10, 2024 23:44

JohnMcPMS previously approved these changes Jan 10, 2024

View reviewed changes

yao-msft reviewed Jan 10, 2024

View reviewed changes

Madhusudhan-MSFT added 5 commits January 11, 2024 10:08

Add RepairBehavior field support to YAML manifest root level to align…

dfa4595

… with the manifest design. This commit address two spacing alignment issues in manifest through this commit.

Update ConvertToRepairBehaviorEnum to utilize string_view and move �R…

42a4ced

…epair� InstallerSwitch manifest read/parsing logic within manifest major version 1

Resolve missed header file declaration update for ConvertToRepairBeha…

01c9387

…viorEnum to utilize string_view from last commit.

Updated YamlWriter.cpp to include RepairBehavior & Repair Switch fiel…

2603766

…d and added corresponding test

Updated VerifyV1ManifestContent test to validate root level RepairBeh…

283eb8e

…avior and modified V1_7 test manifests. NOTE:Please note that RepairBehavior, Repair reference, and values in test manifest are for demonstration and validation only, not real samples.

Madhusudhan-MSFT dismissed JohnMcPMS’s stale review via 283eb8e January 11, 2024 23:35

Madhusudhan-MSFT requested review from yao-msft and JohnMcPMS January 12, 2024 21:45

yao-msft reviewed Jan 16, 2024

View reviewed changes

schemas/JSON/manifests/v1.7.0/manifest.installer.1.7.0.json Outdated Show resolved Hide resolved

yao-msft previously approved these changes Jan 16, 2024

View reviewed changes

Fixing PR comment by addressing single quotes characters in the schem…

7ef33c6

…a manifest to ensure consistency with other usage in the schema manifest.

Madhusudhan-MSFT dismissed yao-msft’s stale review via 7ef33c6 January 16, 2024 22:01

yao-msft approved these changes Jan 16, 2024

View reviewed changes

Madhusudhan-MSFT merged commit 4993e4b into microsoft:master Jan 17, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repair switch support for V1.7 YAML manifest #4041

Repair switch support for V1.7 YAML manifest #4041

Madhusudhan-MSFT commented Jan 8, 2024 •

edited

Madhusudhan-MSFT commented Jan 12, 2024

azure-pipelines bot commented Jan 12, 2024

Trenly commented Jan 12, 2024

Madhusudhan-MSFT commented Jan 12, 2024

Trenly commented Jan 12, 2024

yao-msft left a comment

Repair switch support for V1.7 YAML manifest #4041

Repair switch support for V1.7 YAML manifest #4041

Conversation

Madhusudhan-MSFT commented Jan 8, 2024 • edited

Microsoft Reviewers: Open in CodeFlow

Madhusudhan-MSFT commented Jan 12, 2024

azure-pipelines bot commented Jan 12, 2024

Trenly commented Jan 12, 2024

Madhusudhan-MSFT commented Jan 12, 2024

Trenly commented Jan 12, 2024

yao-msft left a comment

Choose a reason for hiding this comment

Madhusudhan-MSFT commented Jan 8, 2024 •

edited