huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Make AppVeyor builds more consistent by allowing retry for "npm install"

This commit is contained in:
Steve Sanderson 2017-11-24 11:02:05 +00:00
parent af23185c06
commit 1f92811ce0
4 changed files with 78 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
test/Templates.Test/Helpers/Npm.cs Normal file
View File

@ -0,0 +1,64 @@
using System;
using System.IO;
using Xunit.Abstractions;
namespace Templates.Test.Helpers
{
public static class Npm
{
private static object NpmInstallLock = new object();
public static void RestoreWithRetry(ITestOutputHelper output, string workingDirectory)
{
// "npm restore" sometimes fails randomly in AppVeyor with errors like:
// EPERM: operation not permitted, scandir <path>...
// This appears to be a general NPM reliability issue on Windows which has
// been reported many times (e.g., https://github.com/npm/npm/issues/18380)
// So, allow multiple attempts at the restore.
const int maxAttempts = 3;
var attemptNumber = 0;
while (true)
{
try
{
attemptNumber++;
Restore(output, workingDirectory);
break; // Success
}
catch (Exception ex)
{
if (attemptNumber < maxAttempts)
{
output.WriteLine(
$"NPM restore in {workingDirectory} failed on attempt {attemptNumber} of {maxAttempts}. " +
$"Error was: {ex}");
// Clean up the possibly-incomplete node_modules dir before retrying
var nodeModulesDir = Path.Combine(workingDirectory, "node_modules");
if (Directory.Exists(nodeModulesDir))
{
Directory.Delete(nodeModulesDir, recursive: true);
}
}
else
{
output.WriteLine(
$"Giving up attempting NPM restore in {workingDirectory} after {attemptNumber} attempts.");
throw;
}
}
}
}
private static void Restore(ITestOutputHelper output, string workingDirectory)
{
// It's not safe to run multiple NPM installs in parallel
// https://github.com/npm/npm/issues/2500
lock (NpmInstallLock)
{
output.WriteLine($"Restoring NPM packages in '{workingDirectory}' using npm...");
ProcessEx.RunViaShell(output, workingDirectory, "npm install");
}
}
}
}

10
test/Templates.Test/Helpers/ProcessEx.cs
View File

@ -3,6 +3,7 @@ using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.Text;
using Xunit.Abstractions;
@ -42,6 +43,15 @@ namespace Templates.Test.Helpers
return new ProcessEx(output, proc);
}
public static void RunViaShell(ITestOutputHelper output, string workingDirectory, string commandAndArgs)
{
var (shellExe, argsPrefix) = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
? ("cmd", "/c")
: ("bash", "-c");
Run(output, workingDirectory, shellExe, $"{argsPrefix} \"{commandAndArgs}\"")
.WaitForExit(assertSuccess: true);
}
public ProcessEx(ITestOutputHelper output, Process proc)
{
_output = output;

24
test/Templates.Test/Helpers/TemplateTestBase.cs
View File

@ -4,7 +4,6 @@
using System;
using System.IO;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Threading;
using Microsoft.Extensions.CommandLineUtils;
using Templates.Test.Helpers;
@ -16,7 +15,6 @@ namespace Templates.Test
public class TemplateTestBase : IDisposable
{
private static object DotNetNewLock = new object();
private static object NpmInstallLock = new object();
protected string ProjectName { get; set; }
protected string TemplateOutputDir { get; private set; }
@ -74,28 +72,6 @@ namespace Templates.Test
}
}
protected void InstallNpmPackages(string relativePath)
{
// It's not safe to run multiple NPM installs in parallel
// https://github.com/npm/npm/issues/2500
lock (NpmInstallLock)
{
var fullPath = Path.Combine(TemplateOutputDir, relativePath);
Output.WriteLine($"Restoring NPM packages in '{relativePath}' using npm...");
RunViaShell(fullPath, "npm install");
}
}
private void RunViaShell(string workingDirectory, string commandAndArgs)
{
var (shellExe, argsPrefix) = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
? ("cmd", "/c")
: ("bash", "-c");
ProcessEx
.Run(Output, workingDirectory, shellExe, $"{argsPrefix} \"{commandAndArgs}\"")
.WaitForExit(assertSuccess: true);
}
protected void AssertDirectoryExists(string path, bool shouldExist)
{
var fullPath = Path.Combine(TemplateOutputDir, path);

7
test/Templates.Test/SpaTemplateTest/SpaTemplateTestBase.cs
View File

@ -29,13 +29,14 @@ namespace Templates.Test.SpaTemplateTest
// build time, but by doing it up front we can avoid having multiple NPM
// installs run concurrently which otherwise causes errors when tests run
// in parallel.
if (File.Exists(Path.Combine(TemplateOutputDir, "ClientApp", "package.json")))
var clientAppSubdirPath = Path.Combine(TemplateOutputDir, "ClientApp");
if (File.Exists(Path.Combine(clientAppSubdirPath, "package.json")))
{
InstallNpmPackages("ClientApp");
Npm.RestoreWithRetry(Output, clientAppSubdirPath);
}
else if (File.Exists(Path.Combine(TemplateOutputDir, "package.json")))
{
InstallNpmPackages(".");
Npm.RestoreWithRetry(Output, TemplateOutputDir);
}
TestApplication(targetFrameworkOverride, publish: false);