Merge pull request #71 from christianhelle/download-nswag

Download NSwag CLI on-demand
christianhelle · Dec 17, 2019 · 8f116eb · 8f116eb
2 parents 3838bce + e9018f0
commit 8f116eb
Show file tree

Hide file tree

Showing 13 changed files with 131 additions and 30 deletions.
diff --git a/src/ApiClientCodeGen.Core/DependencyDownloader.cs b/src/ApiClientCodeGen.Core/DependencyDownloader.cs
@@ -8,23 +8,21 @@ namespace ChristianHelle.DeveloperTools.CodeGenerators.ApiClient.Core
 {
     public static class DependencyDownloader
     {
-        public static void InstallAutoRest()
-        {
-            Trace.WriteLine("AutoRest not installed. Attempting to install through NPM");
+        public static void InstallAutoRest() => InstallNpmPackage("autorest");
 
-            var programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
-            var programFiles64 = programFiles.Replace(" (x86)", newValue: string.Empty);
+        public static void InstallNSwag() => InstallNpmPackage("nswag");
 
-            var npmCommand = Path.Combine(programFiles, "nodejs\\npm.cmd");
-            if (!File.Exists(npmCommand))
-            {
-                npmCommand = Path.Combine(programFiles64, "nodejs\\npm.cmd");
-                if (!File.Exists(npmCommand))
-                    throw new InvalidOperationException("Unable to find NPM. Please install Node.js");
-            }
-
-            new ProcessLauncher().Start(npmCommand, "install -g autorest");
-            Trace.WriteLine("AutoRest installed successfully through NPM");
+        private static void InstallNpmPackage(string packageName)
+        {
+            Trace.WriteLine($"Attempting to install {packageName} through NPM");
+
+            var processLauncher = new ProcessLauncher();
+            var npmPath = NpmHelper.GetNpmPath();
+            processLauncher.Start(
+                npmPath,
+                $"install -g {packageName}");
+
+            Trace.WriteLine($"{packageName} installed successfully through NPM");
         }
 
         public static string InstallOpenApiGenerator(string path = null)

diff --git a/src/ApiClientCodeGen.Core/Generators/NSwagStudio/NSwagStudioCodeGenerator.cs b/src/ApiClientCodeGen.Core/Generators/NSwagStudio/NSwagStudioCodeGenerator.cs
@@ -29,7 +29,7 @@ public string GenerateCode(IProgressReporter pGenerateProgress)
                 Trace.WriteLine(command + " does not exist! Retrying with default NSwag.exe path");
                 command = PathProvider.GetNSwagPath();
                 if (!File.Exists(command))
-                    throw new InvalidOperationException("NSwag not installed. Please install NSwagStudio");
+                    DependencyDownloader.InstallNSwag();
             }
 
             TryRemoveSwaggerJsonSpec(nswagStudioFile);

diff --git a/src/ApiClientCodeGen.Core/Generators/ProcessLauncher.cs b/src/ApiClientCodeGen.Core/Generators/ProcessLauncher.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Diagnostics;
+using System.Text;
 
 namespace ChristianHelle.DeveloperTools.CodeGenerators.ApiClient.Core.Generators
 {
@@ -11,15 +12,18 @@ public interface IProcessLauncher
     public class ProcessLauncher : IProcessLauncher
     {
         public void Start(string command, string arguments)
+            => Start(command, arguments, o => Trace.WriteLine(o), e => Trace.WriteLine(e));
+
+        public void Start(string command, string arguments, Action<string> onOutputData, Action<string> onErrorData)
         {
             Trace.WriteLine("Executing:");
             Trace.WriteLine($"{command} {arguments}");
 
             var processInfo = new ProcessStartInfo(command, arguments);
             using (var process = new Process { StartInfo = processInfo })
             {
-                process.OutputDataReceived += (s, e) => Trace.WriteLine(e.Data);
-                process.ErrorDataReceived += (s, e) => Trace.WriteLine(e.Data);
+                process.OutputDataReceived += (s, e) => onOutputData?.Invoke(e.Data);
+                process.ErrorDataReceived += (s, e) => onErrorData?.Invoke(e.Data);
                 process.StartInfo.RedirectStandardOutput = true;
                 process.StartInfo.RedirectStandardError = true;
                 process.StartInfo.RedirectStandardInput = true;

diff --git a/src/ApiClientCodeGen.Core/NpmHelper.cs b/src/ApiClientCodeGen.Core/NpmHelper.cs
@@ -0,0 +1,52 @@
+using System;
+using System.Diagnostics;
+using System.IO;
+using ChristianHelle.DeveloperTools.CodeGenerators.ApiClient.Core.Generators;
+
+namespace ChristianHelle.DeveloperTools.CodeGenerators.ApiClient.Core
+{
+    public static class NpmHelper
+    {
+        public static string GetNpmPath()
+        {
+            var programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
+            var programFiles64 = programFiles.Replace(" (x86)", newValue: String.Empty);
+
+            var npmCommand = Path.Combine(programFiles, "nodejs\\npm.cmd");
+            if (File.Exists(npmCommand))
+                return npmCommand;
+
+            npmCommand = Path.Combine(programFiles64, "nodejs\\npm.cmd");
+            if (!File.Exists(npmCommand))
+                throw new InvalidOperationException("Unable to find NPM. Please install Node.js");
+
+            return npmCommand;
+        }
+
+        public static string GetPrefixPath()
+            => TryGetNpmPrefixPathFromNpmConfig() ??
+               Path.Combine(
+                   Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
+                   "npm");
+
+        private static string TryGetNpmPrefixPathFromNpmConfig()
+        {
+            try
+            {
+                var npm = GetNpmPath();
+                string prefix = null;
+                new ProcessLauncher().Start(
+                    npm,
+                    "config get prefix",
+                    o => prefix += o,
+                    e => Trace.WriteLine(e));
+                return prefix;
+            }
+            catch (Exception e)
+            {
+                Trace.TraceError(e.ToString());
+                return null;
+            }
+        }
+    }
+}
diff --git a/src/ApiClientCodeGen.Core/Options/General/PathProvider.cs b/src/ApiClientCodeGen.Core/Options/General/PathProvider.cs
@@ -11,7 +11,7 @@ public static string GetJavaPath()
             try
             {
                 var javaHome = Environment.GetEnvironmentVariable("JAVA_HOME");
-                var javaExe = Path.Combine(javaHome, "bin\\java.exe");
+                var javaExe = Path.Combine(javaHome ?? throw new InvalidOperationException(), "bin\\java.exe");
                 return javaExe;
             }
             catch (Exception e)
@@ -35,16 +35,21 @@ public static string GetNpmPath()
             npmCommand = Path.Combine(programFiles64, "nodejs\\npm.cmd");
             return !File.Exists(npmCommand) ? null : npmCommand;
         }
-
-        public static string GetNSwagPath()
+        
+        public static string GetNSwagStudioPath()
             => Path.Combine(
                 Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86),
                 "Rico Suter\\NSwagStudio\\Win\\NSwag.exe");
 
+        public static string GetNSwagPath()
+            => Path.Combine(
+                NpmHelper.GetPrefixPath(),
+                "nswag.cmd");
+
         public static string GetAutoRestPath()
             => Path.Combine(
-                Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
-                "npm\\autorest.cmd");
+                NpmHelper.GetPrefixPath(),
+                "autorest.cmd");
 
         public static string GetSwaggerCodegenPath()
             => Path.Combine(

diff --git a/src/ApiClientCodeGen.Tests/ApiClientCodeGen.Tests.csproj b/src/ApiClientCodeGen.Tests/ApiClientCodeGen.Tests.csproj
@@ -57,6 +57,7 @@
     <None Include="Converters\CSharpToVisualBasicLanguageConverterTests.cs" />
     <Compile Include="CustomTool\SingleFileCodeGeneratorTests.cs" />
     <Compile Include="CustomTool\TestSingleFileCodeGenerator.cs" />
+    <Compile Include="DependencyDownloaderTests.cs" />
     <Compile Include="Extensions\GetDependenciesTests.cs" />
     <Compile Include="Extensions\GetSupportedCodeGeneratorTests.cs" />
     <Compile Include="Extensions\OpenApiDocumentExtensionsTests.cs" />
@@ -78,6 +79,7 @@
     <Compile Include="Generators\Swagger\SwaggerCSharpCodeGeneratorExceptionTests.cs" />
     <Compile Include="Generators\Swagger\SwaggerCSharpCodeGeneratorTests.cs" />
     <Compile Include="GlobalSuppressions.cs" />
+    <Compile Include="NpmHelperTests.cs" />
     <Compile Include="NuGet\PackageDependencyTests.cs" />
     <Compile Include="NuGet\SupportedCodeGeneratorExtensionsTests.cs" />
     <Compile Include="NuGet\PackageDependencyListProviderTests.cs" />

diff --git a/...grationTests/DependencyDownloaderTests.cs → ...odeGen.Tests/DependencyDownloaderTests.cs b/...grationTests/DependencyDownloaderTests.cs → ...odeGen.Tests/DependencyDownloaderTests.cs
@@ -3,7 +3,7 @@
 using FluentAssertions;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
-namespace ChristianHelle.DeveloperTools.CodeGenerators.ApiClient.IntegrationTests
+namespace ChristianHelle.DeveloperTools.CodeGenerators.ApiClient.Tests
 {
     [TestClass]
     public class DependencyDownloaderTests
@@ -27,5 +27,11 @@ public void InstallAutoRest_Returns_Path()
             => new Action(DependencyDownloader.InstallAutoRest)
                 .Should()
                 .NotThrow();
+
+        [TestMethod]
+        public void InstallNSwag_Returns_Path()
+            => new Action(DependencyDownloader.InstallNSwag)
+                .Should()
+                .NotThrow();
     }
 }
diff --git a/src/ApiClientCodeGen.Tests/NpmHelperTests.cs b/src/ApiClientCodeGen.Tests/NpmHelperTests.cs
@@ -0,0 +1,35 @@
+using System.IO;
+using ChristianHelle.DeveloperTools.CodeGenerators.ApiClient.Core;
+using FluentAssertions;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace ChristianHelle.DeveloperTools.CodeGenerators.ApiClient.Tests
+{
+    [TestClass]
+    public class NpmHelperTests
+    {
+        [TestMethod]
+        public void Can_GetNpmPath()
+            => NpmHelper.GetNpmPath()
+                .Should()
+                .NotBeNullOrWhiteSpace();
+
+        [TestMethod]
+        public void FileExists_GetNpmPath()
+            => File.Exists(NpmHelper.GetNpmPath())
+                .Should()
+                .BeTrue();
+
+        [TestMethod]
+        public void Can_GetNpmPrefixPath()
+            => NpmHelper.GetPrefixPath()
+                .Should()
+                .NotBeNullOrWhiteSpace();
+
+        [TestMethod]
+        public void DirectoryExists_GetNpmPrefixPath()
+            => Directory.Exists(NpmHelper.GetPrefixPath())
+                .Should()
+                .BeTrue();
+    }
+}
diff --git a/src/ApiClientCodeGen.Tests/Options/CustomPathOptionsNullOptionsTests.cs b/src/ApiClientCodeGen.Tests/Options/CustomPathOptionsNullOptionsTests.cs
@@ -36,7 +36,7 @@ public void NSwagPath_NotNullOrWhiteSpace()
 
         [TestMethod]
         public void NSwagPath_Reads_From_Options()
-            => sut.NSwagPath.Should().Be(PathProvider.GetNSwagPath());
+            => sut.NSwagPath.Should().Be(PathProvider.GetNSwagStudioPath());
 
         [TestMethod]
         public void SwaggerCodegenPath_NotNullOrWhiteSpace()

diff --git a/src/ApiClientCodeGen.VSIX/Options/General/CustomPathOptions.cs b/src/ApiClientCodeGen.VSIX/Options/General/CustomPathOptions.cs
@@ -24,7 +24,7 @@ public CustomPathOptions(IGeneralOptions options = null)
             {
                 JavaPath = PathProvider.GetJavaPath();
                 NpmPath = PathProvider.GetNpmPath();
-                NSwagPath = PathProvider.GetNSwagPath();
+                NSwagPath = PathProvider.GetNSwagStudioPath();
                 SwaggerCodegenPath = PathProvider.GetSwaggerCodegenPath();
                 OpenApiGeneratorPath = PathProvider.GetOpenApiGeneratorPath();
 

diff --git a/src/ApiClientCodeGen.VSIX/Options/General/GeneralOptionPage.cs b/src/ApiClientCodeGen.VSIX/Options/General/GeneralOptionPage.cs
@@ -16,7 +16,7 @@ public GeneralOptionPage()
         {
             JavaPath = PathProvider.GetJavaPath();
             NpmPath = PathProvider.GetNpmPath();
-            NSwagPath = PathProvider.GetNSwagPath();
+            NSwagPath = PathProvider.GetNSwagStudioPath();
         }
 
         [Category("File Paths")]
@@ -31,7 +31,7 @@ public GeneralOptionPage()
 
         [Category("File Paths")]
         [DisplayName("NSwag Path")]
-        [Description("Full path to nswag.exe")]
+        [Description("Full path to NSwag.exe (Installs from NPM if not found)")]
         public string NSwagPath { get; set; }
 
         [Category("File Paths")]

diff --git a/src/ApiClientCodeGen.VSIX/Windows/GeneralOptionsPageCustom.Designer.cs b/src/ApiClientCodeGen.VSIX/Windows/GeneralOptionsPageCustom.Designer.cs
diff --git a/src/ApiClientCodegen.IntegrationTests/ApiClientCodegen.IntegrationTests.csproj b/src/ApiClientCodegen.IntegrationTests/ApiClientCodegen.IntegrationTests.csproj
@@ -61,7 +61,6 @@
     <Compile Include="CustomTool\CSharpSingleFileCodeGenerator.cs" />
     <None Include="CustomTool\VisualBasicSingleFileCodeGeneratorTests.cs" />
     <None Include="CustomTool\VisualBasicSingleFileCodeGenerator.cs" />
-    <Compile Include="DependencyDownloaderTests.cs" />
     <Compile Include="Generators\NSwagStudioCodeGeneratorBuildTests.cs" />
     <Compile Include="GlobalSuppressions.cs" />
     <None Include="VisualBasic\AutoRestVisualBasicCodeGeneratorTests.cs" />