Skip to content

Include command output in restore exception message #585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 26, 2020
Merged

Include command output in restore exception message #585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
715cc19
include command output in restore exception message
DanielEgbers Oct 21, 2020
6997171
add unit test for DotnetRestorer
DanielEgbers Oct 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/Dotnet.Script.DependencyModel/Context/DotnetRestorer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,13 @@ public void Restore(ProjectFileInfo projectFileInfo, string[] packageSources)

_logger.Debug($"Restoring {projectFileInfo.Path} using the dotnet cli. RuntimeIdentifier : {runtimeIdentifier} NugetConfigFile: {projectFileInfo.NuGetConfigFile}");

var exitcode = _commandRunner.Execute("dotnet", $"restore \"{projectFileInfo.Path}\" -r {runtimeIdentifier} {packageSourcesArgument} {configFileArgument}", workingDirectory);
if (exitcode != 0)
var commandPath = "dotnet";
var commandArguments = $"restore \"{projectFileInfo.Path}\" -r {runtimeIdentifier} {packageSourcesArgument} {configFileArgument}";
var commandResult = _commandRunner.Capture(commandPath, commandArguments, workingDirectory);
if (commandResult.ExitCode != 0)
{
// We must throw here, otherwise we may incorrectly run with the old 'project.assets.json'
throw new Exception($"Unable to restore packages from '{projectFileInfo.Path}'. Make sure that all script files contains valid NuGet references");
throw new Exception($"Unable to restore packages from '{projectFileInfo.Path}'{System.Environment.NewLine}Make sure that all script files contains valid NuGet references{System.Environment.NewLine}{System.Environment.NewLine}Details:{System.Environment.NewLine}{workingDirectory} : {commandPath} {commandArguments}{System.Environment.NewLine}{commandResult.StandardOut}");
}

string CreatePackageSourcesArguments()
Expand Down
80 changes: 80 additions & 0 deletions src/Dotnet.Script.Tests/DotnetRestorerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
using Dotnet.Script.DependencyModel.Context;
using Dotnet.Script.DependencyModel.Process;
using Dotnet.Script.DependencyModel.ProjectSystem;
using Dotnet.Script.Shared.Tests;
using System;
using System.IO;
using Xunit;
using Xunit.Abstractions;

namespace Dotnet.Script.Tests
{
public class DotnetRestorerTests
{
private PackageReference ValidPackageReferenceA => new PackageReference("Newtonsoft.Json", "12.0.3");
private PackageReference ValidPackageReferenceB => new PackageReference("Moq", "4.14.5");

private PackageReference InvalidPackageReferenceA => new PackageReference("7c63e1f5-2248-ed31-9480-e4cb5ac322fe", "1.0.0");

public DotnetRestorerTests(ITestOutputHelper testOutputHelper)
{
testOutputHelper.Capture();
}

[Fact]
public void ShouldRestoreProjectPackageReferences()
{
using (var projectFolder = new DisposableFolder())
{
var pathToProjectFile = Path.Combine(projectFolder.Path, "script.csproj");

var projectFile = new ProjectFile();
projectFile.PackageReferences.Add(ValidPackageReferenceA);
projectFile.PackageReferences.Add(ValidPackageReferenceB);
projectFile.Save(pathToProjectFile);

var projectFileInfo = new ProjectFileInfo(pathToProjectFile, string.Empty);

var logFactory = TestOutputHelper.CreateTestLogFactory();
var commandRunner = new CommandRunner(logFactory);
var restorer = new DotnetRestorer(commandRunner, logFactory);

var pathToProjectObjDirectory = Path.Combine(projectFolder.Path, "obj");

Assert.False(Directory.Exists(pathToProjectObjDirectory));

restorer.Restore(projectFileInfo, Array.Empty<string>());

Assert.True(Directory.Exists(pathToProjectObjDirectory));
}
}

[Fact]
public void ShouldThrowExceptionOnRestoreError()
{
using (var projectFolder = new DisposableFolder())
{
var pathToProjectFile = Path.Combine(projectFolder.Path, "script.csproj");

var projectFile = new ProjectFile();
projectFile.PackageReferences.Add(ValidPackageReferenceA);
projectFile.PackageReferences.Add(InvalidPackageReferenceA);
projectFile.PackageReferences.Add(ValidPackageReferenceB);
projectFile.Save(pathToProjectFile);

var projectFileInfo = new ProjectFileInfo(pathToProjectFile, string.Empty);

var logFactory = TestOutputHelper.CreateTestLogFactory();
var commandRunner = new CommandRunner(logFactory);
var restorer = new DotnetRestorer(commandRunner, logFactory);

var exception = Assert.Throws<Exception>(() =>
{
restorer.Restore(projectFileInfo, Array.Empty<string>());
});

Assert.Contains("NU1101", exception.Message); // unable to find package
}
}
}
}