Global tools package obtain #8035

wli3 · 2017-11-16T16:54:48Z

This is a model. It is not used by dotnet.dll yet for easy code review. Given a tools package id, it can create a fake project and restore to correct folder

Includes:

DI, aka no circular dependency of commands
Parser of config XML
I try to create test nupkg at build time, so I can run test and debug
easily with VSCode. The code is in test csproj.

Given a tools package id, it can create a fake project and restore to correct folder Includes: - DI, aka no circular dependency of commands - Parser of config XML = I try to create test nupkg at build time, so I can run test and debug easily with VSCode. The code is in test csproj.

src/Microsoft.DotNet.ExecutablePackageObtainer/DotnetToolsConfig.cs

@@ -0,0 +1,55 @@
+//------------------------------------------------------------------------------


src/Microsoft.DotNet.ExecutablePackageObtainer/ICanAddPackageToProjectFile.cs

+
+using Microsoft.Extensions.EnvironmentAbstractions;
+
+namespace Microsoft.DotNet.ExecutablePackageObtainer


src/Microsoft.DotNet.ExecutablePackageObtainer/ToolConfiguration.cs

+            string commandName,
+            string toolAssemblyEntryPoint)
+        {
+            if (string.IsNullOrWhiteSpace(commandName))


src/Microsoft.DotNet.ExecutablePackageObtainer/ToolConfigurationAndExecutableDirectory.cs

+{
+    public class ToolConfigurationAndExecutableDirectory
+    {
+        public ToolConfigurationAndExecutableDirectory(


src/dotnet/commands/dotnet-install/ProjectRestorer.cs

+                $"/p:BaseIntermediateOutputPath={assetJsonOutput.ToEscapedString()}"
+            });
+
+            var command = new DotNetCommandFactory(alwaysRunOutOfProc: true)


src/dotnet/commands/dotnet-install/PackageToProjectFileAdder.cs

+                "--no-restore"
+            };
+
+            var command = new DotNetCommandFactory(alwaysRunOutOfProc: true)


src/dotnet/commands/dotnet-install/PackageToProjectFileAdder.cs

+            var result = command.Execute();
+            if (result.ExitCode != 0)
+            {
+                throw new PackageObtainException("Failed to add package. " +


...tNet.ExecutablePackageObtainer.Tests/Microsoft.DotNet.ExecutablePackageObtainer.Tests.csproj

+    <None Remove="SampleGlobalTool/**" />
+  </ItemGroup>
+
+  <Target Name="CreateNupkgFromSource" BeforeTargets="Build">


...Microsoft.DotNet.ExecutablePackageObtainer/Microsoft.DotNet.ExecutablePackageObtainer.csproj

+    <ProjectReference Include="..\Microsoft.DotNet.InternalAbstractions\Microsoft.DotNet.InternalAbstractions.csproj" />
+    <ProjectReference Include="..\Microsoft.DotNet.Cli.Utils\Microsoft.DotNet.Cli.Utils.csproj" />
+  </ItemGroup>
+</Project>


wli3 · 2017-11-17T02:16:37Z

@dotnet-bot test Ubuntu x64 Release Build

src/dotnet/BundledTargetFramework.cs

+
+                return NuGetFramework
+                    .Parse(targetFrameworkAttribute.FrameworkName)
+                    .GetShortFolderName();


src/Microsoft.DotNet.InternalAbstractions/Path.cs

+
+        public string ToEscapedString()
+        {
+            return $"\"{Value}\"";


src/Microsoft.DotNet.InternalAbstractions/Path.cs

+
+namespace Microsoft.Extensions.EnvironmentAbstractions
+{
+    public class DirectoryPath


src/Microsoft.DotNet.InternalAbstractions/Path.cs

+            Value = value;
+        }
+
+        public DirectoryPath WithCombineFollowing(params string[] paths)


src/Microsoft.DotNet.InternalAbstractions/Path.cs

+            return new DirectoryPath(Path.Combine(insertValueInFront));
+        }
+
+        public FilePath CreateFilePathWithCombineFollowing(string fileName)


src/Microsoft.DotNet.InternalAbstractions/Path.cs

+        }
+    }
+
+    public class FilePath


src/dotnet/ExecutablePackageObtainer/ExecutablePackageObtainer.cs

+{
+    public class ExecutablePackageObtainer
+    {
+


src/dotnet/ExecutablePackageObtainer/ExecutablePackageObtainer.cs

+
+            ToolConfiguration toolConfiguration =
+                ToolConfigurationDeserializer.Deserialize(toolConfigurationPath.Value);
+            return toolConfiguration;


src/dotnet/ExecutablePackageObtainer/ExecutablePackageObtainer.cs

+        }
+
+        private const string TemporaryProjectTemplate = @"<Project Sdk=""Microsoft.NET.Sdk"">
+  <PropertyGroup>


src/dotnet/ExecutablePackageObtainer/ICanAddPackageToProjectFile.cs

@@ -0,0 +1,13 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+


src/dotnet/ExecutablePackageObtainer/ExecutablePackageObtainer.cs

+            FilePath? nugetconfig = null,
+            string targetframework = null)
+        {
+            if (packageId == null) throw new ArgumentNullException(nameof(packageId));


src/dotnet/ExecutablePackageObtainer/ExecutablePackageObtainer.cs

+                        new XElement("RestorePackagesPath", individualToolVersion.Value),
+                        new XElement("DisableImplicitFrameworkReferences", "true")
+                    ),
+                    packageVersion.IsConcreteValue


src/dotnet/ExecutablePackageObtainer/PackageVersion.cs

+            }
+        }
+
+        public bool IsPlaceHolder { get; }


src/dotnet/ExecutablePackageObtainer/ToolConfiguration.cs

+            ToolAssemblyEntryPoint = toolAssemblyEntryPoint;
+        }
+
+        private void EnsureNoInvalidCharacters(string commandName, string nameOfParam)


src/dotnet/ExecutablePackageObtainer/ToolConfiguration.cs

+        public string ToolAssemblyEntryPoint { get; }
+    }
+
+    public class ToolConfigurationException : ArgumentException


src/dotnet/commands/dotnet-install/PackageToProjectFileAdder.cs

+    {
+        public void Add(FilePath projectPath, string packageId)
+        {
+            if (packageId == null) throw new ArgumentNullException(nameof(packageId));


src/dotnet/commands/dotnet-install/PackageToProjectFileAdder.cs

+            var result = command.Execute();
+            if (result.ExitCode != 0)
+            {
+                throw new PackageObtainException("Failed to add package. " +


src/dotnet/commands/dotnet-install/ProjectRestorer.cs

+
+namespace Microsoft.DotNet.Cli
+{
+    internal class ProjectRestorer : ICanRestoreProject


src/dotnet/commands/dotnet-install/ProjectRestorer.cs

+            DirectoryPath assetJsonOutput,
+            FilePath? nugetconfig)
+        {
+            var argsToPassToRestore = new List<string>();


src/dotnet/commands/dotnet-install/ProjectRestorer.cs

+            var result = command.Execute();
+            if (result.ExitCode != 0)
+            {
+                throw new PackageObtainException("Failed to restore package. " +


test/Microsoft.DotNet.ExecutablePackageObtainer.Tests/ExecutablePackageObtainerTests.cs

+    public class ExecutablePackageObtainerTests : TestBase
+    {
+        [Fact]
+        public void GivenNugetConfigAndPackageNameAndVersionAndTargetFrameworkWhenCallItCanDownloadThePacakge()


test/Microsoft.DotNet.ExecutablePackageObtainer.Tests/ExecutablePackageObtainerTests.cs

+        }
+
+        [Fact]
+        public void GivenAllButNoNugetConfigFilePathtCanDownloadThePacakge()


test/Microsoft.DotNet.ExecutablePackageObtainer.Tests/ExecutablePackageObtainerTests.cs

+            var toolsPath = Path.Combine(Directory.GetCurrentDirectory(), Path.GetRandomFileName());
+
+            Directory.CreateDirectory(tempProjectDirectory.Value);
+            File.Copy(nugetConfigPath.Value,


test/Microsoft.DotNet.ExecutablePackageObtainer.Tests/ExecutablePackageObtainerTests.cs

+        }
+
+        [Fact]
+        public void GivenAllButNoPackageVersionItCanDownloadThePacakge()


test/Microsoft.DotNet.ExecutablePackageObtainer.Tests/ExecutablePackageObtainerTests.cs

+        }
+
+        [Fact]
+        public void GivenAllButNoTargetFrameworkItCanDownloadThePacakge()


test/Microsoft.DotNet.ExecutablePackageObtainer.Tests/DotnetToolsConfigGolden.xml

+<?xml version="1.0" encoding="utf-8" ?>
+<DotnetToolMetadata>
+  <CommandName>sayhello</CommandName>
+  <ToolAssemblyEntryPoint>consoleappababab.dll</ToolAssemblyEntryPoint>


test/dotnet.Tests/dotnet.Tests.csproj

-          BeforeTargets="BeforeBuild"
-          DependsOnTargets="PrepareForBuild">
-
+  <Target Name="WriteExpectedVersion" BeforeTargets="BeforeBuild" DependsOnTargets="PrepareForBuild">


test/dotnet.Tests/dotnet.Tests.csproj

    <ItemGroup>
      <Content Include="$(ExpectedVersionFileInIntermediateFolder)" CopyToOutputDirectory="PreserveNewest" />
      <FileWrites Include="$(ExpectedVersionFileInIntermediateFolder)" />
    </ItemGroup>
  </Target>
-
+  <Target Name="WriteExpectedTargetFrameworkMoniker" BeforeTargets="BeforeBuild" DependsOnTargets="PrepareForBuild">


wli3 · 2017-11-22T00:58:52Z

Resolved all code review, I will squash merge once CI is done @livarcocc @nguerrera

wli3 force-pushed the global-tools-package-obtain branch from 49976f0 to f2d2ac8 Compare November 16, 2017 17:11