Add SBRPTests

azure-pipelines/builds/ci.yml

@@ -30,6 +30,9 @@ stages:
           artifacts: true
           manifests: true
       enableSourceBuild: true
+  - template: /azure-pipelines/builds/generatescript-tests.yml
+    parameters:
+      buildConfiguration: Debug
 
 # Based on - https://github.com/dotnet/arcade/blob/9b3f304c7bc9fd4d11be9ca0b466b83e98d2a191/Documentation/CorePackages/Publishing.md#moving-away-from-the-legacy-pushtoblobfeed-task
 - ${{ if and(ne(variables['System.TeamProject'], 'public'), notin(variables['Build.Reason'], 'PullRequest')) }}:

azure-pipelines/builds/generatescript-tests.yml

@@ -0,0 +1,37 @@
+parameters:
+- name: buildConfiguration
+  type: string
+  values:
+  - Debug
+  - Release
+
+jobs:
+- job:
+  strategy:
+    matrix:
+      Windows_NT:
+        agentOs: Windows_NT
+        imageName: "windows-latest"
+      Linux:
+        agentOs: Linux
+        imageName: "ubuntu-latest" 
+  pool:
+    vmImage: $(imageName)
+
+  steps:
+  - checkout: self
+    clean: true
+  - script: $(Build.SourcesDirectory)/test.cmd
+    displayName: Windows NT GenerateScript Tests
+    condition: eq(variables.agentOs, 'Windows_NT')
+  - script: $(Build.SourcesDirectory)/test.sh
+    displayName: Linux GenerateScript Tests
+    condition: eq(variables.agentOs, 'Linux')
+  - task: PublishTestResults@2
+    displayName: Publish Test Results
+    inputs:
+      testRunner: xUnit
+      testResultsFiles: 'artifacts/TestResults/${{ parameters.buildConfiguration }}/*.xml'
+      testRunTitle: '$(agentOs)_GenerateScript_tests'
+      configuration: '${{ parameters.buildConfiguration }}'
+    condition: always()

eng/Build.props

@@ -4,7 +4,11 @@
     <ProjectToBuild Include="$(RepoRoot)src\packageSourceGenerator\PackageSourceGenerator.proj" />
   </ItemGroup>
 
-  <ItemGroup Condition="'$(GeneratePackageSource)' != 'true'">
+  <ItemGroup Condition="'$(Test)' == 'true'">
+    <ProjectToBuild Include="$(RepoRoot)tests\GenerateScriptTests\GenerateScript.Tests.csproj" Test="$(Test)" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(GeneratePackageSource)' != 'true' and '$(Test)' != 'true'">
     <!--
       The following DependencyPackageProjects are ones on which other packages depend on that do
       not exist in the source-build package cache. Adding them to this ItemGroup will ensure that
@@ -79,7 +83,7 @@
           DestinationFolder="$(LocalNuGetPackageCacheDirectory)" />
   </Target>
 
-  <ItemGroup Condition="'$(GeneratePackageSource)' != 'true' and '$(BuildDependencyPackageProjects)' != 'true'">
+  <ItemGroup Condition="'$(GeneratePackageSource)' != 'true' and '$(BuildDependencyPackageProjects)' != 'true' and '$(Test)' != 'true'">
     <TargetingPackageProject Include="$(RepoRoot)src\targetPacks\ILsrc\**\*.csproj" />
     <ProjectToBuild Include="@(TargetingPackageProject)" />
 

src/textOnlyPackages/src/microsoft.build.notargets/3.7.0/Microsoft.Build.NoTargets.3.7.0.csproj

@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>netstandard2.0</TargetFrameworks>
+    <AssemblyName>Microsoft.Build.NoTargets</AssemblyName>
+    <ProjectTemplateVersion>2</ProjectTemplateVersion>
+  </PropertyGroup>
+
+</Project>

src/textOnlyPackages/src/microsoft.build.notargets/3.7.0/microsoft.build.notargets.nuspec

@@ -1,12 +1,11 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <metadata>
     <id>Microsoft.Build.NoTargets</id>
     <version>3.7.0</version>
     <authors>Microsoft</authors>
     <license type="expression">MIT</license>
     <licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
-    <icon>MSBuild-NuGet-Icon.png</icon>
     <projectUrl>https://github.com/Microsoft/MSBuildSdks</projectUrl>
     <description>Provides targets for projects that do not compile an assembly.</description>
     <copyright>© Microsoft Corporation. All rights reserved.</copyright>
@@ -16,7 +15,6 @@
     </packageTypes>
     <repository url="https://github.com/Microsoft/MSBuildSdks.git" />
     <dependencies>
-      <group targetFramework=".NETFramework4.0" />
       <group targetFramework=".NETStandard2.0" />
     </dependencies>
   </metadata>

test.cmd

@@ -0,0 +1,2 @@
+@echo off
+powershell -ExecutionPolicy ByPass -NoProfile -command "& """%~dp0eng\common\Build.ps1""" -restore -build -test %*"

test.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+source="${BASH_SOURCE[0]}"
+
+# resolve $SOURCE until the file is no longer a symlink
+while [[ -h $source ]]; do
+  scriptroot="$( cd -P "$( dirname "$source" )" && pwd )"
+  source="$(readlink "$source")"
+
+  # if $source was a relative symlink, we need to resolve it relative to the path where the
+  # symlink file was located
+  [[ $source != /* ]] && source="$scriptroot/$source"
+done
+
+scriptroot="$( cd -P "$( dirname "$source" )" && pwd )"
+
+export DOTNET_CLI_TELEMETRY_OPTOUT=1
+export DOTNET_SKIP_FIRST_TIME_EXPERIENCE=1
+export DOTNET_MULTILEVEL_LOOKUP=0
+
+"$scriptroot/eng/common/build.sh" --restore --build --test "$@"

tests/GenerateScriptTests/ExecuteHelper.cs

@@ -0,0 +1,119 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using System.Diagnostics;
+using System.Linq;
+using System.Text;
+using Xunit.Abstractions;
+
+namespace GenerateScriptTests;
+
+internal static class ExecuteHelper
+{
+    public static (Process Process, string StdOut, string StdErr) ExecuteProcess(
+        string fileName,
+        string args,
+        ITestOutputHelper outputHelper,
+        bool logOutput = false,
+        Action<Process>? configure = null,
+        int millisecondTimeout = -1)
+        {
+        outputHelper.WriteLine($"Executing: {fileName} {args}");
+
+        Process process = new()
+        {
+            EnableRaisingEvents = true,
+            StartInfo =
+            {
+                FileName = fileName,
+                Arguments = args,
+                RedirectStandardOutput = true,
+                RedirectStandardError = true,
+            }
+        };
+
+        configure?.Invoke(process);
+
+        StringBuilder stdOutput = new();
+        process.OutputDataReceived += new DataReceivedEventHandler(
+            (sender, e) =>
+            {
+                lock (stdOutput)
+                {
+                    stdOutput.AppendLine(e.Data);
+                }
+            });
+
+        StringBuilder stdError = new();
+        process.ErrorDataReceived += new DataReceivedEventHandler(
+            (sender, e) =>
+            {
+                lock (stdError)
+                {
+                    stdError.AppendLine(e.Data);
+                }
+            });
+
+        process.Start();
+        process.BeginOutputReadLine();
+        process.BeginErrorReadLine();
+        process.WaitForExit(millisecondTimeout);
+
+        if (!process.HasExited)
+        {
+            outputHelper.WriteLine($"Process did not exit. Killing {fileName} {args} after waiting {millisecondTimeout} milliseconds.");
+            process.Kill(true);
+            process.WaitForExit();
+        }
+
+        string output;
+        string error;
+
+        lock (stdOutput)
+        {
+            output = stdOutput.ToString().Trim();
+        }
+
+        lock (stdError)
+        {
+            error = stdError.ToString().Trim();
+        }
+
+        if (logOutput)
+        {
+            if (!string.IsNullOrWhiteSpace(output))
+            {
+                outputHelper.WriteLine(output);
+            }
+
+            if (string.IsNullOrWhiteSpace(error))
+            {
+                outputHelper.WriteLine(error);
+            }
+        }
+
+        return (process, output, error);
+    }
+
+    public static string ExecuteProcessValidateExitCode(string fileName, string args, ITestOutputHelper outputHelper)
+    {
+        (Process Process, string StdOut, string StdErr) result = ExecuteHelper.ExecuteProcess(fileName, args, outputHelper);
+        ValidateExitCode(result);
+
+        return result.StdOut;
+    }
+
+    public static void ValidateExitCode((Process Process, string StdOut, string StdErr) result, int expectedExitCode = 0)
+    {
+        if (result.Process.ExitCode != expectedExitCode)
+        {
+            ProcessStartInfo startInfo = result.Process.StartInfo;
+            string msg = $"Failed to execute {startInfo.FileName} {startInfo.Arguments}" +
+                $"{Environment.NewLine}Exit code: {result.Process.ExitCode}" +
+                $"{Environment.NewLine}{result.StdOut}" +
+                $"{Environment.NewLine}{result.StdErr}";
+            throw new InvalidOperationException(msg);
+        }
+    }
+}

tests/GenerateScriptTests/GenerateScript.Tests.csproj

@@ -0,0 +1,8 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>$(NetCurrent)</TargetFramework>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>

tests/GenerateScriptTests/GenerateScriptTests.cs

@@ -0,0 +1,65 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Runtime.InteropServices;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace GenerateScriptTests;
+
+public class GenerateScriptTests
+{
+    public enum PackageType
+    {
+        Reference,
+        Text
+    }
+
+    public static IEnumerable<object[]> Data => new List<object[]>
+    {
+        new object[] { "System.Xml.ReaderWriter", "4.0.11", PackageType.Reference },
+        new object[] { "Microsoft.Extensions.Logging.Abstractions", "7.0.1", PackageType.Reference },
+        new object[] { "Microsoft.CodeAnalysis.CSharp", "3.11.0", PackageType.Reference },
+        new object[] { "System.Security.Cryptography.Pkcs", "7.0.2", PackageType.Reference },
+        new object[] { "Microsoft.Build.NoTargets", "3.7.0", PackageType.Text },
+    };
+
+    public string SandboxDirectory { get; set; }
+    public string RepoRoot { get; set; }
+    public ITestOutputHelper output { get; set; }
+
+    public GenerateScriptTests(ITestOutputHelper output)
+    {
+        this.output = output;
+        RepoRoot = Environment.CurrentDirectory.Substring(0, Environment.CurrentDirectory.IndexOf("artifacts"));
+        SandboxDirectory = Path.Combine(Environment.CurrentDirectory, $"GenerateTests-{DateTimeOffset.UtcNow.ToUnixTimeSeconds().ToString()}");
+        Directory.CreateDirectory(SandboxDirectory);
+    }
+
+    [Theory]    
+    [MemberData(nameof(GenerateScriptTests.Data), MemberType = typeof(GenerateScriptTests))]
+    public void VerifyGenerateScript(string package, string version, PackageType type)
+    {
+        string command = Path.Combine(RepoRoot, RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "generate.cmd" : "generate.sh");
+        string arguments = $"-p {package},{version} -x -d {SandboxDirectory}";
+        string packageSrcDirectory = string.Empty;
+        string sandboxPackageGeneratedDirecotry = Path.Combine(SandboxDirectory, package.ToLower(), version);
+
+        switch (type)
+        {
+            case PackageType.Reference:
+                packageSrcDirectory = Path.Combine(RepoRoot, "src", "referencePackages", "src", package.ToLower(), version);
+                break;
+            case PackageType.Text:
+                arguments += " -t text";
+                packageSrcDirectory = Path.Combine(RepoRoot, "src", "textOnlyPackages", "src", package.ToLower(), version);
+                break;
+        }
+
+        ExecuteHelper.ExecuteProcess(command, arguments, output);
+        Assert.Empty(ExecuteHelper.ExecuteProcess("git", $"diff --no-index {packageSrcDirectory} {sandboxPackageGeneratedDirecotry}", output, true).StdOut);
+    }
+}