Add PackageRepository.Package overload that accept .nupkg file (#276)

MattKotsenas · web-flow · commit ca14cff82fb5 · 2024-03-07T17:23:48.000-08:00
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/PackageFeedTests/PackageFeedTestBase.cs b/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/PackageFeedTests/PackageFeedTestBase.cs
@@ -66,11 +66,6 @@ protected string GetNuspec(Package package)
             return GetFileContents(package.FullPath, filePath => filePath.EndsWith($"{package.Id}.nuspec", StringComparison.OrdinalIgnoreCase));
         }
 
-        protected NuspecReader GetNuspecReader(Package package)
-        {
-            return new NuspecReader(GetNuspec(package));
-        }
-
         protected Assembly? LoadAssembly(string packageFullPath, string filePath)
         {
             byte[]? bytes = GetFileBytes(packageFullPath, filePath);
@@ -85,6 +80,11 @@ protected void ShouldThrowExceptionIfNoPackageAdded(Action action)
             exception.Message.ShouldBe(Strings.ErrorWhenAddingAnythingBeforePackage);
         }
 
+        private protected NuspecReader GetNuspecReader(Package package)
+        {
+            return new NuspecReader(GetNuspec(package));
+        }
+
         private T? ReadFile<T>(ZipArchive nupkg, string filePath, Func<Stream, ZipArchiveEntry, T> streamFunc)
         {
             ZipArchiveEntry? archiveEntry = nupkg.GetEntry(filePath);
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/PackageRepositoryTests/RepositoryTests.cs b/src/Microsoft.Build.Utilities.ProjectCreation.UnitTests/PackageRepositoryTests/RepositoryTests.cs
@@ -227,5 +227,44 @@ public void CanUseNuGetSdkResolver()
                 }
             }
         }
+
+        [Fact]
+        public void CanCreatePackageFromNupkg()
+        {
+            string feedRootPath = Path.Combine(TestRootPath, "Feed");
+            string targetFramework = "netstandard2.0";
+            string contentFileText = "b7e41f28-0e3e-4824-90d3-025da699630e";
+
+            // Create a .nupkg to use as a source
+            using (PackageFeed.Create(feedRootPath)
+                .Package("PackageA", "1.2.3", out Package originalPackage, "John Smith", "Custom Description", developmentDependency: true)
+                    .Library(targetFramework)
+                    .ContentFileText("file.txt", contentFileText, targetFramework)
+                .Save())
+            {
+                originalPackage.FullPath.ShouldNotBeNull();
+
+                using (PackageRepository.Create(TestRootPath)
+                    .Package(new FileInfo(originalPackage.FullPath), out Package newPackage))
+                {
+                    newPackage.Author.ShouldBe("John Smith");
+                    newPackage.Description.ShouldBe("Custom Description");
+                    newPackage.DevelopmentDependency.ShouldBeTrue();
+                    newPackage.Id.ShouldBe("PackageA");
+                    newPackage.Version.ShouldBe("1.2.3");
+
+                    newPackage.FullPath.ShouldNotBeNullOrEmpty();
+                    DirectoryInfo? baseDir = new FileInfo(newPackage.FullPath).Directory;
+                    baseDir.ShouldNotBeNull().ShouldExist();
+
+                    new FileInfo(Path.Combine(baseDir.FullName, "lib", targetFramework, $"{newPackage.Id}.dll"))
+                        .ShouldExist();
+
+                    new FileInfo(Path.Combine(baseDir.FullName, "contentFiles", "any", targetFramework, "file.txt"))
+                        .ShouldExist()
+                        .ReadAsText().ShouldBe(contentFileText);
+                }
+            }
+        }
     }
 }
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/ExtensionMethods.cs b/src/Microsoft.Build.Utilities.ProjectCreation/ExtensionMethods.cs
@@ -141,5 +141,11 @@ internal static void WriteElementStringIfNotNull(this XmlWriter writer, string l
                 writer.WriteElementString(localName, value.Value ? "true" : "false");
             }
         }
+
+        internal static string ReadAsText(this FileInfo file)
+        {
+            using StreamReader reader = file.OpenText();
+            return reader.ReadToEnd();
+        }
     }
 }
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/NuspecReader.cs b/src/Microsoft.Build.Utilities.ProjectCreation/NuspecReader.cs
@@ -9,9 +9,9 @@
 using System.Xml.Linq;
 using System.Xml.XPath;
 
-namespace Microsoft.Build.Utilities.ProjectCreation.UnitTests
+namespace Microsoft.Build.Utilities.ProjectCreation
 {
-    public class NuspecReader
+    internal class NuspecReader
     {
         private static readonly XNamespace NuspecNamespace = "http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd";
 
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PackageRepository.Package.cs b/src/Microsoft.Build.Utilities.ProjectCreation/PackageRepository.Package.cs
@@ -5,6 +5,8 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.IO.Compression;
+using System.Linq;
 
 namespace Microsoft.Build.Utilities.ProjectCreation
 {
@@ -44,6 +46,64 @@ public string GetManifestFilePath(string packageId, string version)
             return Path.Combine(GetInstallPath(packageId, version), $"{packageId.ToLowerInvariant()}.nuspec");
         }
 
+        /// <summary>
+        /// Creates a new package.
+        /// </summary>
+        /// <param name="nupkg">A <see cref="FileInfo"/> object that corresponds to the .nupkg file.</param>
+        /// <param name="package">Receives a <see cref="ProjectCreation.Package" /> object representing the package.</param>
+        /// <returns>The current <see cref="PackageRepository" />.</returns>
+        /// <exception cref="FileNotFoundException">The <paramref name="nupkg"/> does not exist.</exception>
+        /// <exception cref="InvalidOperationException">The package's ID or version is <c>null</c>.</exception>
+        public PackageRepository Package(FileInfo nupkg, out Package package)
+        {
+            if (!nupkg.Exists)
+            {
+                throw new FileNotFoundException("The specified .nupkg file does not exist", nupkg.FullName);
+            }
+
+            using ZipArchive zip = new ZipArchive(System.IO.File.OpenRead(nupkg.FullName), ZipArchiveMode.Read, leaveOpen: false);
+
+            ZipArchiveEntry? nuspecEntry = zip.Entries.SingleOrDefault(entry => entry.Name.EndsWith(".nuspec", StringComparison.OrdinalIgnoreCase)) ?? throw new InvalidOperationException($"The .nupkg file '{nupkg.FullName}' does not contain a .nuspec file");
+            using StreamReader nuspecStream = new StreamReader(nuspecEntry.Open());
+
+            NuspecReader reader = new NuspecReader(nuspecStream.ReadToEnd());
+
+            Package(
+                id: reader.Id ?? throw new InvalidOperationException($"The .nupkg file '{nupkg.FullName}' does not contain an ID"),
+                version: reader.Version ?? throw new InvalidOperationException($"The .nupkg file '{nupkg.FullName}' does not contain a version"),
+                package: out package,
+                authors: reader.Authors,
+                description: reader.Description,
+                copyright: reader.Copyright,
+                developmentDependency: reader.DevelopmentDependency,
+                icon: reader.Icon,
+                iconUrl: reader.IconUrl,
+                language: reader.Language,
+                licenseUrl: reader.LicenseUrl,
+                licenseExpression: reader.LicenseExpression,
+                licenseVersion: reader.LicenseVersion,
+                owners: reader.Owners,
+                packageTypes: reader.PackageTypes,
+                projectUrl: reader.ProjectUrl,
+                releaseNotes: reader.ReleaseNotes,
+                repositoryType: reader.RepositoryType,
+                repositoryUrl: reader.RepositoryUrl,
+                repositoryBranch: reader.RepositoryBranch,
+                repositoryCommit: reader.RepositoryCommit,
+                requireLicenseAcceptance: reader.RequireLicenseAcceptance,
+                serviceable: reader.Serviceable,
+                summary: reader.Summary,
+                tags: reader.Tags,
+                title: reader.Title);
+
+            foreach (ZipArchiveEntry entry in zip.Entries.Where(entry => entry != nuspecEntry))
+            {
+                File(entry.FullName, fi => entry.ExtractToFile(fi.FullName));
+            }
+
+            return this;
+        }
+
         /// <summary>
         /// Creates a new package.
         /// </summary>
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net472/PublicAPI.Shipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net472/PublicAPI.Shipped.txt
@@ -168,6 +168,7 @@ Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Library(string! targ
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.NuGetConfigPath.get -> string!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! id, string! version, out Microsoft.Build.Utilities.ProjectCreation.Package! package, string? authors = "UserA", string? description = "Description", string? copyright = null, bool developmentDependency = false, string? icon = null, string? iconUrl = null, string? language = null, string? licenseUrl = null, string? licenseExpression = null, string? licenseVersion = null, string? owners = null, System.Collections.Generic.IEnumerable<string!>? packageTypes = null, string? projectUrl = null, string? releaseNotes = null, string? repositoryType = null, string? repositoryUrl = null, string? repositoryBranch = null, string? repositoryCommit = null, bool requireLicenseAcceptance = false, bool serviceable = false, string? summary = null, string? tags = null, string? title = null) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! id, string! version, string? authors = null, string? description = null, string? copyright = null, bool developmentDependency = false, string? icon = null, string? iconUrl = null, string? language = null, string? licenseUrl = null, string? licenseExpression = null, string? licenseVersion = null, string? owners = null, System.Collections.Generic.IEnumerable<string!>? packageTypes = null, string? projectUrl = null, string? releaseNotes = null, string? repositoryType = null, string? repositoryUrl = null, string? repositoryBranch = null, string? repositoryCommit = null, bool requireLicenseAcceptance = false, bool serviceable = false, string? summary = null, string? tags = null, string? title = null) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
+Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(System.IO.FileInfo! nupkg, out Microsoft.Build.Utilities.ProjectCreation.Package! package) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Packages.get -> System.Collections.Generic.IReadOnlyCollection<Microsoft.Build.Utilities.ProjectCreation.Package!>!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Choose(string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net6.0/PublicAPI.Shipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net6.0/PublicAPI.Shipped.txt
@@ -168,6 +168,7 @@ Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Library(string! targ
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.NuGetConfigPath.get -> string!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! id, string! version, out Microsoft.Build.Utilities.ProjectCreation.Package! package, string? authors = "UserA", string? description = "Description", string? copyright = null, bool developmentDependency = false, string? icon = null, string? iconUrl = null, string? language = null, string? licenseUrl = null, string? licenseExpression = null, string? licenseVersion = null, string? owners = null, System.Collections.Generic.IEnumerable<string!>? packageTypes = null, string? projectUrl = null, string? releaseNotes = null, string? repositoryType = null, string? repositoryUrl = null, string? repositoryBranch = null, string? repositoryCommit = null, bool requireLicenseAcceptance = false, bool serviceable = false, string? summary = null, string? tags = null, string? title = null) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! id, string! version, string? authors = null, string? description = null, string? copyright = null, bool developmentDependency = false, string? icon = null, string? iconUrl = null, string? language = null, string? licenseUrl = null, string? licenseExpression = null, string? licenseVersion = null, string? owners = null, System.Collections.Generic.IEnumerable<string!>? packageTypes = null, string? projectUrl = null, string? releaseNotes = null, string? repositoryType = null, string? repositoryUrl = null, string? repositoryBranch = null, string? repositoryCommit = null, bool requireLicenseAcceptance = false, bool serviceable = false, string? summary = null, string? tags = null, string? title = null) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
+Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(System.IO.FileInfo! nupkg, out Microsoft.Build.Utilities.ProjectCreation.Package! package) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Packages.get -> System.Collections.Generic.IReadOnlyCollection<Microsoft.Build.Utilities.ProjectCreation.Package!>!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Choose(string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net7.0/PublicAPI.Shipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net7.0/PublicAPI.Shipped.txt
@@ -168,6 +168,7 @@ Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Library(string! targ
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.NuGetConfigPath.get -> string!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! id, string! version, out Microsoft.Build.Utilities.ProjectCreation.Package! package, string? authors = "UserA", string? description = "Description", string? copyright = null, bool developmentDependency = false, string? icon = null, string? iconUrl = null, string? language = null, string? licenseUrl = null, string? licenseExpression = null, string? licenseVersion = null, string? owners = null, System.Collections.Generic.IEnumerable<string!>? packageTypes = null, string? projectUrl = null, string? releaseNotes = null, string? repositoryType = null, string? repositoryUrl = null, string? repositoryBranch = null, string? repositoryCommit = null, bool requireLicenseAcceptance = false, bool serviceable = false, string? summary = null, string? tags = null, string? title = null) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! id, string! version, string? authors = null, string? description = null, string? copyright = null, bool developmentDependency = false, string? icon = null, string? iconUrl = null, string? language = null, string? licenseUrl = null, string? licenseExpression = null, string? licenseVersion = null, string? owners = null, System.Collections.Generic.IEnumerable<string!>? packageTypes = null, string? projectUrl = null, string? releaseNotes = null, string? repositoryType = null, string? repositoryUrl = null, string? repositoryBranch = null, string? repositoryCommit = null, bool requireLicenseAcceptance = false, bool serviceable = false, string? summary = null, string? tags = null, string? title = null) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
+Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(System.IO.FileInfo! nupkg, out Microsoft.Build.Utilities.ProjectCreation.Package! package) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Packages.get -> System.Collections.Generic.IReadOnlyCollection<Microsoft.Build.Utilities.ProjectCreation.Package!>!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Choose(string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!
diff --git a/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net8.0/PublicAPI.Shipped.txt b/src/Microsoft.Build.Utilities.ProjectCreation/PublicAPI/net8.0/PublicAPI.Shipped.txt
@@ -168,6 +168,7 @@ Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Library(string! targ
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.NuGetConfigPath.get -> string!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! id, string! version, out Microsoft.Build.Utilities.ProjectCreation.Package! package, string? authors = "UserA", string? description = "Description", string? copyright = null, bool developmentDependency = false, string? icon = null, string? iconUrl = null, string? language = null, string? licenseUrl = null, string? licenseExpression = null, string? licenseVersion = null, string? owners = null, System.Collections.Generic.IEnumerable<string!>? packageTypes = null, string? projectUrl = null, string? releaseNotes = null, string? repositoryType = null, string? repositoryUrl = null, string? repositoryBranch = null, string? repositoryCommit = null, bool requireLicenseAcceptance = false, bool serviceable = false, string? summary = null, string? tags = null, string? title = null) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(string! id, string! version, string? authors = null, string? description = null, string? copyright = null, bool developmentDependency = false, string? icon = null, string? iconUrl = null, string? language = null, string? licenseUrl = null, string? licenseExpression = null, string? licenseVersion = null, string? owners = null, System.Collections.Generic.IEnumerable<string!>? packageTypes = null, string? projectUrl = null, string? releaseNotes = null, string? repositoryType = null, string? repositoryUrl = null, string? repositoryBranch = null, string? repositoryCommit = null, bool requireLicenseAcceptance = false, bool serviceable = false, string? summary = null, string? tags = null, string? title = null) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
+Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Package(System.IO.FileInfo! nupkg, out Microsoft.Build.Utilities.ProjectCreation.Package! package) -> Microsoft.Build.Utilities.ProjectCreation.PackageRepository!
 Microsoft.Build.Utilities.ProjectCreation.PackageRepository.Packages.get -> System.Collections.Generic.IReadOnlyCollection<Microsoft.Build.Utilities.ProjectCreation.Package!>!
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator
 Microsoft.Build.Utilities.ProjectCreation.ProjectCreator.Choose(string? label = null) -> Microsoft.Build.Utilities.ProjectCreation.ProjectCreator!

Original file line number	Diff line number	Diff line change
`@@ -66,11 +66,6 @@ protected string GetNuspec(Package package)`
`66`	`66`	`return GetFileContents(package.FullPath, filePath => filePath.EndsWith($"{package.Id}.nuspec", StringComparison.OrdinalIgnoreCase));`
`67`	`67`	`}`
`68`	`68`
`69`		`- protected NuspecReader GetNuspecReader(Package package)`
`70`		`- {`
`71`		`- return new NuspecReader(GetNuspec(package));`
`72`		`- }`
`73`		`-`
`74`	`69`	`protected Assembly? LoadAssembly(string packageFullPath, string filePath)`
`75`	`70`	`{`
`76`	`71`	`byte[]? bytes = GetFileBytes(packageFullPath, filePath);`
`@@ -85,6 +80,11 @@ protected void ShouldThrowExceptionIfNoPackageAdded(Action action)`
`85`	`80`	`exception.Message.ShouldBe(Strings.ErrorWhenAddingAnythingBeforePackage);`
`86`	`81`	`}`
`87`	`82`
	`83`	`+ private protected NuspecReader GetNuspecReader(Package package)`
	`84`	`+ {`
	`85`	`+ return new NuspecReader(GetNuspec(package));`
	`86`	`+ }`
	`87`	`+`
`88`	`88`	`private T? ReadFile<T>(ZipArchive nupkg, string filePath, Func<Stream, ZipArchiveEntry, T> streamFunc)`
`89`	`89`	`{`
`90`	`90`	`ZipArchiveEntry? archiveEntry = nupkg.GetEntry(filePath);`
Original file line number	Diff line number	Diff line change
`@@ -141,5 +141,11 @@ internal static void WriteElementStringIfNotNull(this XmlWriter writer, string l`
`141`	`141`	`writer.WriteElementString(localName, value.Value ? "true" : "false");`
`142`	`142`	`}`
`143`	`143`	`}`
	`144`	`+`
	`145`	`+ internal static string ReadAsText(this FileInfo file)`
	`146`	`+ {`
	`147`	`+ using StreamReader reader = file.OpenText();`
	`148`	`+ return reader.ReadToEnd();`
	`149`	`+ }`
`144`	`150`	`}`
`145`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,9 @@`
`9`	`9`	`using System.Xml.Linq;`
`10`	`10`	`using System.Xml.XPath;`
`11`	`11`
`12`		`-namespace Microsoft.Build.Utilities.ProjectCreation.UnitTests`
	`12`	`+namespace Microsoft.Build.Utilities.ProjectCreation`
`13`	`13`	`{`
`14`		`- public class NuspecReader`
	`14`	`+ internal class NuspecReader`
`15`	`15`	`{`
`16`	`16`	`private static readonly XNamespace NuspecNamespace = "http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd";`
`17`	`17`