Add `ConvertTo-CliXml` and `ConvertFrom-CliXml` cmdlets by ArmaanMcleod · Pull Request #21063 · PowerShell/PowerShell

ArmaanMcleod · 2024-01-13T07:14:38Z

PR Summary

Add ConvertTo-CliXml and ConvertFrom-CliXml cmdlets to work with CliXml objects in memory without needing to read/write to file system.

PR Context

Parameter sets

ConvertTo-CliXml [-InputObject] <psobject> [-Depth <int>] [<CommonParameters>]

ConvertFrom-CliXml [-InputObject] <string> [<CommonParameters>]

Usage

> $cliXmlString = [pscustomobject]@{'hello' = 1} | ConvertTo-CliXML
> $cliXmlString
<Objs Version="1.1.0.1" xmlns="http://schemas.microsoft.com/powershell/2004/04">
  <Obj RefId="0">
    <TN RefId="0">
      <T>System.Management.Automation.PSCustomObject</T>
      <T>System.Object</T>
    </TN>
    <MS>
      <I32 N="hello">1</I32>
    </MS>
  </Obj>
</Objs>
> $cliXmlString | ConvertFrom-CliXml

hello
-----
    1

Also included internal static string Serialize(IList<object> source, int depth, bool enumerate) in PSSerializer API. This was to be able to enumerate and serialize objects one at a time instead of writing one top level object.

PR Checklist

iSazonov

LGTM with minor comments

iSazonov · 2024-01-13T14:44:59Z

src/Microsoft.PowerShell.Commands.Utility/commands/utility/XmlCommands.cs

+    /// Implements ConvertTo-CliXml command.
+    /// </summary>
+    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2243:AttributeStringLiteralsShouldParseCorrectly")]
+    [Cmdlet(VerbsData.ConvertTo, "CliXml", HelpUri = "")]


/cc @sdwheeler Please create HelpUri-s for new cmdlwts.

test/powershell/Modules/Microsoft.PowerShell.Utility/XMLCommand.Tests.ps1

…content

pull-request-quantifier-deprecated · 2024-01-14T00:14:17Z

This PR has 326 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Large
Size       : +316 -10
Percentile : 72.6%

Total files changed: 8

Change summary by file extension:
.cs : +83 -0
.psd1 : +3 -2
.ps1 : +230 -8

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

JamesWTruher

Really nice, just some comments about the tests

test/powershell/Modules/Microsoft.PowerShell.Utility/clixml.tests.ps1

test/powershell/Modules/Microsoft.PowerShell.Utility/XMLCommand.Tests.ps1

ArmaanMcleod · 2024-06-21T22:56:02Z

@JamesWTruher Thanks for the PR feedback, I have made the changes to the tests. Let me know if you want anything else changed 🙂

…ssage

iSazonov · 2024-07-23T04:08:09Z

@sdwheeler We need HelpURI for the new cmdlets. Please create.

sdwheeler

Please commit the HelpUri changes.

src/Microsoft.PowerShell.Commands.Utility/commands/utility/XmlCommands.cs

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

src/Microsoft.PowerShell.Commands.Utility/commands/utility/XmlCommands.cs

microsoft-github-policy-service · 2024-07-26T17:13:03Z

📣 Hey @ArmaanMcleod, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

Microsoft Forms

iSazonov · 2024-07-26T17:13:08Z

@ArmaanMcleod Thanks for your contribution!

…1063)

ArmaanMcleod added 2 commits January 13, 2024 18:10

Added ConvertTo-CliXml & ConvertFrom-CliXml cmdlets

7d95cd9

Added tests

36646a3

pull-request-quantifier-deprecated bot added the Large label Jan 13, 2024

This was referenced Jan 13, 2024

Add ConvertTo-CliXml and ConvertFrom-CliXml cmdlets #21011

Closed

Document ConvertTo-CliXml and ConvertFrom-CliXml cmdlets MicrosoftDocs/PowerShell-Docs#10773

Closed

iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jan 13, 2024

iSazonov approved these changes Jan 13, 2024

View reviewed changes

iSazonov requested review from SteveL-MSFT and TravisEz13 January 13, 2024 14:57

iSazonov added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label Jan 13, 2024

Use FileContentMatchMultiline assertion in tests to match multi line …

fdb2003

…content

microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Jan 21, 2024

JamesWTruher approved these changes Jun 17, 2024

View reviewed changes

ArmaanMcleod added 2 commits June 22, 2024 08:08

Merge branch 'master' into convert-clixml-cmdlets-v2

1bb84ec

Fixes to tests from PR feedback

64a1e76

ArmaanMcleod added 3 commits July 7, 2024 21:03

Fixing up XMLCommand DRT tests

a428077

Fix serializer tests to get list assembly display name in expected me…

d16380d

…ssage

Remove checks which make ubuntu tests fail

6769cfc

SteveL-MSFT approved these changes Jul 22, 2024

View reviewed changes

SteveL-MSFT assigned iSazonov Jul 22, 2024

microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Jul 22, 2024

sdwheeler suggested changes Jul 23, 2024

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/XmlCommands.cs Outdated Show resolved Hide resolved

src/Microsoft.PowerShell.Commands.Utility/commands/utility/XmlCommands.cs Outdated Show resolved Hide resolved

microsoft-github-policy-service bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 23, 2024

Add new HelpURIs

08e277b

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

ArmaanMcleod commented Jul 23, 2024

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/XmlCommands.cs Outdated Show resolved Hide resolved

src/Microsoft.PowerShell.Commands.Utility/commands/utility/XmlCommands.cs Outdated Show resolved Hide resolved

microsoft-github-policy-service bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 23, 2024

Remove suppressions

b978ace

iSazonov merged commit b39b5f4 into PowerShell:master Jul 26, 2024

ArmaanMcleod deleted the convert-clixml-cmdlets-v2 branch July 26, 2024 21:43

chrisdent-de pushed a commit to chrisdent-de/PowerShell that referenced this pull request Sep 12, 2024

Add ConvertTo-CliXml and ConvertFrom-CliXml cmdlets (PowerShell#2…

1cbc7fd

…1063)

mklement0 mentioned this pull request Sep 20, 2024

Allow ConvertTo-Xml to emit CLIXML (the same XML format as Export-Clixml) #8311

Closed

Conversation

ArmaanMcleod commented Jan 13, 2024

PR Summary

PR Context

Parameter sets

Usage

PR Checklist

Uh oh!

iSazonov left a comment

Choose a reason for hiding this comment

Uh oh!

iSazonov Jan 13, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pull-request-quantifier-deprecated bot commented Jan 14, 2024

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

JamesWTruher left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ArmaanMcleod commented Jun 21, 2024

Uh oh!

iSazonov commented Jul 23, 2024

Uh oh!

sdwheeler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

microsoft-github-policy-service bot commented Jul 26, 2024 • edited by unfurl-links bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iSazonov commented Jul 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

microsoft-github-policy-service bot commented Jul 26, 2024 •

edited by unfurl-links bot

Loading