ci: Artifactbuilder parses output from nuget pack (#1699)

* Modifies Nuget build / validation to capture and parse stdout from the `nuget pack` command, to obtain the actual filename of the NuGet package that was generated and use that in content validation. * Use regex to parse output from nuget pack
newrelic · Jun 7, 2023 · 3520f7f · 3520f7f
1 parent 0e86e4b
commit 3520f7f
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 18 deletions.
diff --git a/build/ArtifactBuilder/Artifacts/AzureSiteExtension.cs b/build/ArtifactBuilder/Artifacts/AzureSiteExtension.cs
@@ -11,6 +11,7 @@ public class AzureSiteExtension : Artifact
         private const string NuGetHelperLibraryName = "NewRelic.NuGetHelper.dll";
 
         private string _version;
+        private string _nuGetPackageName;
 
         public AzureSiteExtension() : base(nameof(AzureSiteExtension))
         {
@@ -26,7 +27,7 @@ protected override void InternalBuild()
             package.CopyToContent($@"{RepoRootDirectory}\build\NewRelic.NuGetHelper\bin\{NuGetLibraryName}");
             package.CopyToContent($@"{RepoRootDirectory}\build\NewRelic.NuGetHelper\bin\{XmlLibraryName}");
             package.SetVersion(_version);
-            package.Pack();
+            _nuGetPackageName = package.Pack();
         }
 
         private string ReadVersionFromFile()
@@ -68,8 +69,11 @@ private void ValidateContent()
 
         private string Unpack()
         {
+            if (string.IsNullOrEmpty(_nuGetPackageName))
+                throw new PackagingException("NuGet package name not found. Did you call InternalBuild()?");
+
             var unpackDir = Path.Join(OutputDirectory, "unpacked");
-            var nugetFile = Path.Join(OutputDirectory, $"NewRelic.Azure.WebSites.Extension.{_version}.nupkg");
+            var nugetFile = Path.Join(OutputDirectory, _nuGetPackageName);
             NuGetHelpers.Unpack(nugetFile, unpackDir);
             return unpackDir;
         }

diff --git a/build/ArtifactBuilder/Artifacts/NugetAgent.cs b/build/ArtifactBuilder/Artifacts/NugetAgent.cs
@@ -11,6 +11,7 @@ public class NugetAgent : Artifact
         private readonly AgentComponents _coreAgentComponents;
         private readonly AgentComponents _coreAgentArm64Components;
         private readonly AgentComponents _coreAgentX86Components;
+        private string _nuGetPackageName;
 
         public NugetAgent(string configuration)
             : base(nameof(NugetAgent))
@@ -76,7 +77,7 @@ protected override void InternalBuild()
 
             package.SetVersion(_frameworkAgentComponents.Version);
 
-            package.Pack();
+            _nuGetPackageName = package.Pack();
         }
 
         private static void TransformNewRelicConfig(string newRelicConfigPath)
@@ -120,8 +121,11 @@ private void ValidateContent()
 
         private string Unpack()
         {
+            if (string.IsNullOrEmpty(_nuGetPackageName))
+                throw new PackagingException("NuGet package name not found. Did you call InternalBuild()?");
+
             var unpackDir = Path.Join(OutputDirectory, "unpacked");
-            var nugetFile = Path.Join(OutputDirectory, $"NewRelic.Agent.{_frameworkAgentComponents.MaybeSemanticVersion}.nupkg");
+            var nugetFile = Path.Join(OutputDirectory, _nuGetPackageName);
             NuGetHelpers.Unpack(nugetFile, unpackDir);
             return unpackDir;
         }

diff --git a/build/ArtifactBuilder/Artifacts/NugetAgentApi.cs b/build/ArtifactBuilder/Artifacts/NugetAgentApi.cs
@@ -9,6 +9,7 @@ public class NugetAgentApi : Artifact
     {
         private readonly AgentComponents _frameworkAgentComponents;
         private readonly AgentComponents _coreAgentComponents;
+        private string _nuGetPackageName;
 
         public NugetAgentApi(string configuration)
             : base(nameof(NugetAgentApi))
@@ -34,7 +35,7 @@ protected override void InternalBuild()
             package.CopyToRoot(_frameworkAgentComponents.NewRelicLicenseFile);
             package.CopyToRoot(_frameworkAgentComponents.NewRelicThirdPartyNoticesFile);
             package.SetVersion(_frameworkAgentComponents.Version);
-            package.Pack();
+            _nuGetPackageName = package.Pack();
         }
 
         private void ValidateContent()
@@ -52,8 +53,11 @@ private void ValidateContent()
 
         private string Unpack()
         {
+            if (string.IsNullOrEmpty(_nuGetPackageName))
+                throw new PackagingException("NuGet package name not found. Did you call InternalBuild()?");
+
             var unpackDir = Path.Join(OutputDirectory, "unpacked");
-            var nugetFile = Path.Join(OutputDirectory, $"NewRelic.Agent.Api.{_frameworkAgentComponents.MaybeSemanticVersion}.nupkg");
+            var nugetFile = Path.Join(OutputDirectory, _nuGetPackageName);
             NuGetHelpers.Unpack(nugetFile, unpackDir);
             return unpackDir;
         }

diff --git a/build/ArtifactBuilder/Artifacts/NugetAzureCloudServices.cs b/build/ArtifactBuilder/Artifacts/NugetAzureCloudServices.cs
@@ -7,6 +7,7 @@ namespace ArtifactBuilder.Artifacts
     public class NugetAzureCloudServices : Artifact
     {
         private readonly AgentComponents _frameworkAgentComponents;
+        private string _nuGetPackageName;
 
         public NugetAzureCloudServices(string configuration)
             : base(nameof(NugetAzureCloudServices))
@@ -29,7 +30,7 @@ protected override void InternalBuild()
             package.CopyToLib(_frameworkAgentComponents.AgentApiDll);
             package.CopyToContent($@"{RepoRootDirectory}\src\_build\x64-{Configuration}\Installer\{GetMsiName()}");
             package.SetVersion(_frameworkAgentComponents.Version);
-            package.Pack();
+            _nuGetPackageName = package.Pack();
         }
 
         private void DoInstallerReplacements(string agentInstaller)
@@ -77,8 +78,11 @@ private void ValidateContent()
 
         private string Unpack()
         {
+            if (string.IsNullOrEmpty(_nuGetPackageName))
+                throw new PackagingException("NuGet package name not found. Did you call InternalBuild()?");
+
             var unpackDir = Path.Join(OutputDirectory, "unpacked");
-            var nugetFile = Path.Join(OutputDirectory, $"NewRelicWindowsAzure.{_frameworkAgentComponents.MaybeSemanticVersion}.nupkg");
+            var nugetFile = Path.Join(OutputDirectory, _nuGetPackageName);
             NuGetHelpers.Unpack(nugetFile, unpackDir);
             return unpackDir;
         }

diff --git a/build/ArtifactBuilder/Artifacts/NugetAzureWebSites.cs b/build/ArtifactBuilder/Artifacts/NugetAzureWebSites.cs
@@ -19,6 +19,7 @@ public NugetAzureWebSites(string platform, string configuration)
         public string Configuration { get; }
         public string Platform { get; }
         private readonly AgentComponents _frameworkAgentComponents;
+        private string _nuGetPackageName;
 
         private string RootDirectory => $@"{StagingDirectory}\content\newrelic";
 
@@ -38,7 +39,7 @@ protected override void InternalBuild()
 
             agentInfo.WriteToDisk(RootDirectory);
             package.SetVersion(_frameworkAgentComponents.Version);
-            package.Pack();
+            _nuGetPackageName = package.Pack();
         }
 
         private void TransformNewRelicConfig()
@@ -85,13 +86,12 @@ private void ValidateContent()
 
         private string Unpack()
         {
+            if (string.IsNullOrEmpty(_nuGetPackageName))
+                throw new PackagingException("NuGet package name not found. Did you call InternalBuild()?");
+
             var unpackDir = Path.Join(OutputDirectory, "unpacked");
 
-            // The two packages have different naming conventions
-            var fileName = Platform == "x64" ?
-                $"NewRelic.Azure.WebSites.{Platform}.{_frameworkAgentComponents.MaybeSemanticVersion}.nupkg" :
-                $"NewRelic.Azure.WebSites.{_frameworkAgentComponents.MaybeSemanticVersion}.nupkg";
-            var nugetFile = Path.Join(OutputDirectory, fileName);
+            var nugetFile = Path.Join(OutputDirectory, _nuGetPackageName);
 
             NuGetHelpers.Unpack(nugetFile, unpackDir);
             return unpackDir;

diff --git a/build/ArtifactBuilder/NuGetHelpers.cs b/build/ArtifactBuilder/NuGetHelpers.cs
@@ -1,17 +1,28 @@
 using System;
 using System.Diagnostics;
 using System.IO;
+using System.Text.RegularExpressions;
 
 namespace ArtifactBuilder
 {
     public static class NuGetHelpers
     {
         private static readonly string _nugetPath = Path.Combine(FileHelpers.GetRepoRootDirectory(), @"Build\Tools\nuget.exe");
 
-        public static void Pack(string nuspecFilePath, string outputDirectory)
+        public static string Pack(string nuspecFilePath, string outputDirectory)
         {
             var parameters = $@"Pack -NoPackageAnalysis ""{nuspecFilePath}"" -OutputDirectory ""{outputDirectory}""";
-            var process = Process.Start(_nugetPath, parameters);
+            var process = new Process();
+
+            var startInfo = new ProcessStartInfo
+            {
+                FileName = _nugetPath,
+                Arguments = parameters,
+                RedirectStandardOutput = true
+            };
+            process.StartInfo = startInfo;
+
+            process.Start();
             process.WaitForExit(30000);
             if (!process.HasExited)
             {
@@ -22,6 +33,30 @@ public static void Pack(string nuspecFilePath, string outputDirectory)
             {
                 throw new Exception($"Nuget pack failed with exit code {process.ExitCode}.");
             }
+
+            var stdOut = process.StandardOutput;
+            var output = stdOut.ReadToEnd();
+            Console.WriteLine(output);
+
+            // output is expected to look like:
+            // Attempting to build package from 'NewRelic.Azure.WebSites.x64.nuspec'.
+            // Successfully created package 'C:\Source\Repos\newrelic-dotnet-agent\Build\BuildArtifacts\NugetAzureWebSites-x64\NewRelic.Azure.WebSites.x64.10.11.0.nupkg'.
+
+            // capture the full path
+            var regex = ".*Successfully created package '(.*)'.*";
+            var matches = Regex.Match(output, regex);
+            if (matches.Success && matches.Groups.Count > 1)
+            {
+                var packagePath = matches.Groups[1].Value;
+
+                // verify the file exists, then return the filename
+                if (File.Exists(packagePath))
+                {
+                    return Path.GetFileName(packagePath);
+                }
+            }
+
+            throw new PackagingException("Failed to parse NuGet package filename.");
         }
 
         public static void Unpack(string nupkgFile, string outputDirectory)

diff --git a/build/ArtifactBuilder/NugetPackage.cs b/build/ArtifactBuilder/NugetPackage.cs
@@ -98,9 +98,9 @@ public void CopyToRoot(IEnumerable<string> filePaths, string subDirectory = null
             FileHelpers.CopyFile(filePaths, $@"{StagingDirectory}\{subDirectory}");
         }
 
-        public void Pack()
+        public string Pack()
         {
-            NuGetHelpers.Pack(NuspecFilePath, OutputDirectory);
+            return NuGetHelpers.Pack(NuspecFilePath, OutputDirectory);
         }
     }
 }