Dotnet list package json output implementation by erdembayar · Pull Request #4855 · NuGet/NuGet.Client

erdembayar · 2022-10-13T20:42:15Z

Bug

Regression? Last working version:

Description

Implement Dotnet List Package Machine Readable Json Output spec (spec PR), e.g. dotnet list package --format json will give you json output.
If there any error with json generation then application will return non-zero value.
This PR also include MVC style refactoring of the existing dotnet list package to console output logic.
Here get the report model/data

NuGet.Client/src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/PackageReferenceCommands/ListPackage/ListPackageCommandRunner.cs

Line 38 in 7691366

    
           (int exitCode, ListPackageReportModel reportModel) = await GetReportDataAsync(listPackageArgs);

and it's shared by both console and json output options. So that means any existing tests like DotnetListPackageTests.cs already covers up until

NuGet.Client/src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/PackageReferenceCommands/ListPackage/ListPackageCommandRunner.cs

Line 39 in 7691366

reportRenderer.Render(reportModel);

point, this reduces the need for adding many duplicate tests. Only after this implementation details diverge between them, so I added tests for json report Renderer implementation by passing report model.
I added most basic unit tests, I'll add more later if needed.

PR Checklist

PR has a meaningful title
PR has a linked issue.
Described changes
Tests
- Automated tests added, I'll add tests after getting confirmation on my current implementation is good enough.
  - Created follow up issue for integration tests: Add integration tests dotnet list package json outputs Home#12167
- OR
- Test exception
- OR
- N/A
Documentation
- Documentation PR or issue filled
  - https://github.com/NuGet/docs.microsoft.com-nuget/issues/2922
- OR
- N/A

....CommandLine.XPlat/Commands/PackageReferenceCommands/ListPackage/ListPackageCommandRunner.cs

erdembayar · 2022-10-19T02:20:13Z

test/NuGet.Core.FuncTests/NuGet.XPlat.FuncTest/XplatListPackageJsonRendererTests.cs

+                var projectAPath = Path.Combine(pathContext.SolutionRoot, "projectA.csproj");
+                var projectBPath = Path.Combine(pathContext.SolutionRoot, "projectB.csproj");
+
+                using (FileStream stream = new FileStream(consoleOutputFileName, FileMode.Create))


Json output is redirected to consoleOutput.txt file. Later this file content compared to expected output for assertion.

…sole

nkolev92

Just some minor comments at this point.

There are some tests failing, so approving it wouldn't help much :D

....CommandLine.XPlat/Commands/PackageReferenceCommands/ListPackage/ListPackageCommandRunner.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/ListPackage/ListPackageOutputContent.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/ListPackage/ListReportPackage.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/ListPackage/ListPackageConsoleRenderer.cs

src/NuGet.Core/NuGet.CommandLine.XPlat/ListPackage/ListPackageOutputContent.cs

rohitcoder · 2022-11-07T15:28:39Z

@nkolev92 @erdembayar I wanted to check if we have the same feature but for dependency graph relation. Something like showing child dependencies in the parent (Simply a dependency relation JSON graph).

erdembayar · 2022-11-07T16:22:55Z

@nkolev92 Nikolche Kolev FTE @erdembayar Erick Yondon FTE I wanted to check if we have the same feature but for dependency graph relation. Something like showing child dependencies in the parent (Simply a dependency relation JSON graph).

I don't believe we have one considering this is the 1st ever json output we have. You can create a feature request here.

* Dotnet list package machine readable output implementation

erdembayar mentioned this pull request Oct 13, 2022

Add new option for json output of dotnet list package dotnet/sdk#28564

Closed

erdembayar force-pushed the dev-eryondon-dotnetlistpackage-jsonoutput branch 15 times, most recently from 2d69c1a to 9d12028 Compare October 18, 2022 02:17

erdembayar mentioned this pull request Oct 18, 2022

Add integration tests dotnet list package json outputs NuGet/Home#12167

Open

erdembayar force-pushed the dev-eryondon-dotnetlistpackage-jsonoutput branch 6 times, most recently from f9afd82 to 1d974c7 Compare October 18, 2022 22:27

erdembayar marked this pull request as ready for review October 18, 2022 22:39

erdembayar requested a review from a team as a code owner October 18, 2022 22:39

erdembayar force-pushed the dev-eryondon-dotnetlistpackage-jsonoutput branch 2 times, most recently from a637450 to ee4f557 Compare October 19, 2022 00:54

erdembayar commented Oct 19, 2022

View reviewed changes

....CommandLine.XPlat/Commands/PackageReferenceCommands/ListPackage/ListPackageCommandRunner.cs Show resolved Hide resolved

erdembayar commented Oct 19, 2022

View reviewed changes

....CommandLine.XPlat/Commands/PackageReferenceCommands/ListPackage/ListPackageCommandRunner.cs Outdated Show resolved Hide resolved

erdembayar commented Oct 19, 2022

View reviewed changes

erdembayar added 3 commits November 1, 2022 17:53

Address latest comment about problem level.

2a89fde

Remove Information enum from ProblemType enums.

fb4c2bd

MSBuildAPIUtility.GetResolvedVersions shouldn't print anything to con…

abb5159

…sole

erdembayar force-pushed the dev-eryondon-dotnetlistpackage-jsonoutput branch from f41ee35 to abb5159 Compare November 2, 2022 02:34

erdembayar added 2 commits November 1, 2022 19:46

Remove LoggerWarning type

9374c1c

In case of error need to stop processing for Console.Output

345c354

nkolev92 reviewed Nov 2, 2022

View reviewed changes

Make ListReportPackage immutable

86650d0

erdembayar force-pushed the dev-eryondon-dotnetlistpackage-jsonoutput branch from bf7a26c to 4ce40e8 Compare November 3, 2022 01:00

Fix failing test

ff6b93b

erdembayar force-pushed the dev-eryondon-dotnetlistpackage-jsonoutput branch from 4ce40e8 to ff6b93b Compare November 3, 2022 01:35

erdembayar requested a review from nkolev92 November 3, 2022 15:37

nkolev92 reviewed Nov 3, 2022

View reviewed changes

src/NuGet.Core/NuGet.CommandLine.XPlat/ListPackage/ListPackageConsoleRenderer.cs Outdated Show resolved Hide resolved

src/NuGet.Core/NuGet.CommandLine.XPlat/ListPackage/ListPackageOutputContent.cs Outdated Show resolved Hide resolved

erdembayar added 3 commits November 3, 2022 12:58

Make logger 1

ce33770

Remove duplicate jsonserialization

96524d5

Remove unnecessary file

d0fbf0c

nkolev92 approved these changes Nov 3, 2022

View reviewed changes

erdembayar merged commit 0358502 into dev Nov 4, 2022

erdembayar deleted the dev-eryondon-dotnetlistpackage-jsonoutput branch November 4, 2022 15:24

This was referenced Nov 4, 2022

Machine readable output for dotnet list package NuGet/Home#7752

Closed

Add errors handling scenario for json output spec NuGet/Home#11983

Merged

rohitcoder mentioned this pull request Nov 7, 2022

Can we have dependency graph feature ? (Showing Parent & Child relationship of different dependencies) NuGet/Home#12218

Closed

jeffkl pushed a commit that referenced this pull request Nov 8, 2022

Dotnet list package json output implementation (#4855)

b2cf0f7

* Dotnet list package machine readable output implementation

This was referenced Nov 10, 2022

Add new option for json output of dotnet list package to release 7.2.xx branch dotnet/sdk#29017

Merged

Warn when using deprecated Nuget packages NuGet/Home#12244

Open

erdembayar mentioned this pull request Dec 2, 2022

Add option for specifying the version of machine-readable output of dotnet list package command dotnet/sdk#29367

Merged

erdembayar mentioned this pull request Dec 21, 2022

Machine readable output for dotnet list package NuGet/Announcements#35

Closed

jeffkl mentioned this pull request Apr 3, 2023

dotnet list package returns error if solution includes a docker-compose project microsoft/MSBuildSdks#433

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dotnet list package json output implementation#4855

Dotnet list package json output implementation#4855
erdembayar merged 54 commits intodevfrom
dev-eryondon-dotnetlistpackage-jsonoutput

erdembayar commented Oct 13, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

erdembayar Oct 19, 2022

Uh oh!

nkolev92 left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rohitcoder commented Nov 7, 2022

Uh oh!

erdembayar commented Nov 7, 2022 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

erdembayar commented Oct 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bug

Description

PR Checklist

Uh oh!

Uh oh!

Uh oh!

erdembayar Oct 19, 2022

Choose a reason for hiding this comment

Uh oh!

nkolev92 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rohitcoder commented Nov 7, 2022

Uh oh!

erdembayar commented Nov 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

erdembayar commented Oct 13, 2022 •

edited

Loading

nkolev92 left a comment •

edited

Loading

erdembayar commented Nov 7, 2022 •

edited

Loading