Add manifest resource extensions to AssemblyExtensions

PowerKit.Tests/AssemblyExtensionsTests.cs

@@ -1,22 +1,74 @@
+using System.IO;
 using System.Reflection;
+using System.Threading.Tasks;
 using FluentAssertions;
+using PowerKit;
 using PowerKit.Extensions;
 using Xunit;
 
 namespace PowerKit.Tests;
 
 public class AssemblyExtensionsTests
 {
+    private static readonly Assembly ThisAssembly = typeof(AssemblyExtensionsTests).Assembly;
+
+    // The embedded resource name follows the default MSBuild convention:
+    // <RootNamespace>.<RelativePath> with path separators replaced by dots.
+    private const string ResourceName = "PowerKit.Tests.TestResource.txt";
+
     [Fact]
     public void TryGetVersionString_Test()
+    {
+        // Act
+        var version = ThisAssembly.TryGetVersionString();
+
+        // Assert
+        version.Should().NotBeNullOrWhiteSpace();
+    }
+
+    [Fact]
+    public void GetManifestResourceString_Test()
+    {
+        // Act
+        var content = ThisAssembly.GetManifestResourceString(ResourceName);
+
+        // Assert
+        content.Should().Be("hello");
+    }
+
+    [Fact]
+    public async Task GetManifestResourceStringAsync_Test()
+    {
+        // Act
+        var content = await ThisAssembly.GetManifestResourceStringAsync(ResourceName);
+
+        // Assert
+        content.Should().Be("hello");
+    }
+
+    [Fact]
+    public void ExtractManifestResource_Test()
     {
         // Arrange
-        var assembly = typeof(AssemblyExtensionsTests).Assembly;
+        using var tempFile = TempFile.Create();
 
         // Act
-        var version = assembly.TryGetVersionString();
+        ThisAssembly.ExtractManifestResource(ResourceName, tempFile.Path);
 
         // Assert
-        version.Should().NotBeNullOrWhiteSpace();
+        File.ReadAllText(tempFile.Path).Should().Be("hello");
+    }
+
+    [Fact]
+    public async Task ExtractManifestResourceAsync_Test()
+    {
+        // Arrange
+        using var tempFile = TempFile.Create();
+
+        // Act
+        await ThisAssembly.ExtractManifestResourceAsync(ResourceName, tempFile.Path);
+
+        // Assert
+        File.ReadAllText(tempFile.Path).Should().Be("hello");
     }
 }

PowerKit.Tests/PowerKit.Tests.csproj

@@ -11,6 +11,10 @@
     <Compile Include="../PowerKit/**/*.cs" Exclude="../PowerKit/obj/**/*.cs" />
   </ItemGroup>
 
+  <ItemGroup>
+    <EmbeddedResource Include="TestResource.txt" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="coverlet.collector" />
     <PackageReference Include="GitHubActionsTestLogger" />

PowerKit.Tests/TestResource.txt

@@ -0,0 +1 @@
+hello

PowerKit/Extensions/AssemblyExtensions.cs

@@ -1,4 +1,9 @@
+using System.IO;
 using System.Reflection;
+using System.Resources;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
 
 namespace PowerKit.Extensions;
 
@@ -15,5 +20,78 @@ internal static class AssemblyExtensions
             assembly
                 .GetCustomAttribute<AssemblyInformationalVersionAttribute>()
                 ?.InformationalVersion ?? assembly.GetName().Version?.ToString();
+
+        /// <summary>
+        /// Reads the specified manifest resource as a UTF-8 string.
+        /// Throws <see cref="MissingManifestResourceException" /> if the resource is not found.
+        /// </summary>
+        public string GetManifestResourceString(string resourceName)
+        {
+            using var stream =
+                assembly.GetManifestResourceStream(resourceName)
+                ?? throw new MissingManifestResourceException(
+                    $"Failed to find resource '{resourceName}'."
+                );
+
+            using var reader = new StreamReader(stream, Encoding.UTF8);
+
+            return reader.ReadToEnd();
+        }
+
+        /// <summary>
+        /// Reads the specified manifest resource as a UTF-8 string asynchronously.
+        /// Throws <see cref="MissingManifestResourceException" /> if the resource is not found.
+        /// </summary>
+        public async Task<string> GetManifestResourceStringAsync(
+            string resourceName,
+            CancellationToken cancellationToken = default
+        )
+        {
+            await using var stream =
+                assembly.GetManifestResourceStream(resourceName)
+                ?? throw new MissingManifestResourceException(
+                    $"Failed to find resource '{resourceName}'."
+                );
+
+            using var reader = new StreamReader(stream, Encoding.UTF8);
+
+            return await reader.ReadToEndAsync(cancellationToken).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Extracts the specified manifest resource to a file at the given path.
+        /// Throws <see cref="MissingManifestResourceException" /> if the resource is not found.
+        /// </summary>
+        public void ExtractManifestResource(string resourceName, string filePath)
+        {
+            using var stream =
+                assembly.GetManifestResourceStream(resourceName)
+                ?? throw new MissingManifestResourceException(
+                    $"Failed to find resource '{resourceName}'."
+                );
+
+            using var fileStream = File.Create(filePath);
+            stream.CopyTo(fileStream);
+        }
+
+        /// <summary>
+        /// Extracts the specified manifest resource to a file at the given path asynchronously.
+        /// Throws <see cref="MissingManifestResourceException" /> if the resource is not found.
+        /// </summary>
+        public async Task ExtractManifestResourceAsync(
+            string resourceName,
+            string filePath,
+            CancellationToken cancellationToken = default
+        )
+        {
+            await using var stream =
+                assembly.GetManifestResourceStream(resourceName)
+                ?? throw new MissingManifestResourceException(
+                    $"Failed to find resource '{resourceName}'."
+                );
+
+            await using var fileStream = File.Create(filePath);
+            await stream.CopyToAsync(fileStream, cancellationToken).ConfigureAwait(false);
+        }
     }
 }