Fix plugin loading dependencies (#40)

* All plugin tests now passing, apart from the one currently expected to fail (for the issue that needs resolving)

* Plugin with dependencies test now working

* Add GitHub Actions workflow for PR tests

* Enhance PR test workflow: set timeout and enable detailed test output

* Fix Razor template formatting in tests

Added space before closing bracket in <TipContainer> tag
and improved readability of the ChildContent property.

* Add Blazor app initialization to test suite

Implement functionality to initialize a Blazor app in
`BlakeServeCommandTests.cs`. This includes handling the
initialization of a project with a specified `.csproj` file,
error handling for initialization failures, and the use of a
cancellation token for command execution.

* Add using directive for OptionsTest.Components

Enhance Razor template in BlakeServeCommandTests.cs
by including the @using OptionsTest.Components directive,
allowing access to additional components for improved functionality.

* Add CancellationToken support to async methods

This commit introduces a `CancellationToken` parameter to various asynchronous methods across multiple files, enhancing control over task cancellation and improving responsiveness. Key updates include:

- `InitProjectFile` in `ProjectFileBuilder.cs` now supports cancellation for file operations.
- Similar updates in `SampleContentBuilder.cs`, `SiteGenerator.cs`, and `TemplateService.cs` for long-running tasks.
- Logging statements have been modified to ensure consistent logging without null checks on the logger.
- The main execution flow in `Program.cs` has been updated to manage cancellation tokens, allowing for graceful shutdowns.

These changes collectively improve the application's resource management and logging consistency.

* Enhance logging and standardize command execution

Updated `Program.cs` to log the target path for baking the Blake site, improving traceability. Replaced instances of `RunBlakeFromDotnetAsync` with `RunBlakeCommandAsync` in `BlakeServeCommandTests.cs` for better argument handling. Adjusted test assertions to match the new logging format, enhancing clarity and maintainability.

* Increase timeout for PR tests and simplify test verbosity

Author: matt-goldman

.github/workflows/pr-tests.yml

@@ -0,0 +1,27 @@
+name: PR Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 9.0.x
+
+      - name: Build
+        run: |
+          dotnet build
+
+      - name: Test
+        run: |
+          dotnet test

src/Blake.BuildTools/Generator/ProjectFileBuilder.cs

@@ -4,20 +4,20 @@ namespace Blake.BuildTools.Generator;
 
 public static class ProjectFileBuilder
 {
-    public static async Task<int> InitProjectFile(string projectFilePath, ILogger? logger)
+    public static async Task<int> InitProjectFile(string projectFilePath, ILogger logger, CancellationToken cancellationToken)
     {
-        var projectContent = await File.ReadAllTextAsync(projectFilePath);
+        var projectContent = await File.ReadAllTextAsync(projectFilePath, cancellationToken);
 
         if (!projectContent.Contains("<Project Sdk=\"Microsoft.NET.Sdk.BlazorWebAssembly\">"))
         {
-            logger?.LogError("The specified project is not a Blazor WebAssembly app.");
+            logger.LogError("The specified project is not a Blazor WebAssembly app.");
             return 1;
         }
 
         // Check if the project already has Blake configured
         if (projectContent.Contains("<PackageReference Include=\"Blake.Types\""))
         {
-            logger?.LogInformation("Blake is already configured in this project.");
+            logger.LogInformation("Blake is already configured in this project.");
             return 0;
         }
 
@@ -32,7 +32,7 @@ public static async Task<int> InitProjectFile(string projectFilePath, ILogger? l
             var itemGroupIndex = projectContent.LastIndexOf("</ItemGroup>", StringComparison.Ordinal);
             if (itemGroupIndex == -1)
             {
-                logger?.LogError("Project file does not contain a valid ItemGroup.");
+                logger.LogError("Project file does not contain a valid ItemGroup.");
                 return 1;
             }
 
@@ -49,7 +49,7 @@ public static async Task<int> InitProjectFile(string projectFilePath, ILogger? l
         var projectEndIndex = projectContent.LastIndexOf("</Project>", StringComparison.Ordinal);
         if (projectEndIndex == -1)
         {
-            logger?.LogError("Project file does not end with </Project>.");
+            logger.LogError("Project file does not end with </Project>.");
             return 1;
         }
 
@@ -71,7 +71,7 @@ public static async Task<int> InitProjectFile(string projectFilePath, ILogger? l
 
 
         // Write the updated content back to the project file
-        await File.WriteAllTextAsync(projectFilePath, projectContent);
+        await File.WriteAllTextAsync(projectFilePath, projectContent, cancellationToken);
 
         return 0;
     }

src/Blake.BuildTools/Generator/SampleContentBuilder.cs

@@ -4,7 +4,7 @@ namespace Blake.BuildTools.Generator;
 
 public static class SampleContentBuilder
 {
-    public static async Task InitSampleContent(string projectFilePath, ILogger? logger)
+    public static async Task InitSampleContent(string projectFilePath, ILogger logger, CancellationToken cancellationToken)
     {
         var pagesFolder = Path.Combine(Path.GetDirectoryName(projectFilePath) ?? string.Empty, "Pages");
         if (!Directory.Exists(pagesFolder))
@@ -16,24 +16,24 @@ public static async Task InitSampleContent(string projectFilePath, ILogger? logg
 
         if (!File.Exists(samplePagePath))
         {
-            await File.WriteAllTextAsync(samplePagePath, SamplePageContent);
-            logger?.LogInformation("✅ Sample page created at: {samplePagePath}", samplePagePath);
+            await File.WriteAllTextAsync(samplePagePath, SamplePageContent, cancellationToken);
+            logger.LogInformation("✅ Sample page created at: {samplePagePath}", samplePagePath);
         }
         else
         {
-            logger?.LogInformation("Sample page already exists at: {samplePagePath}", samplePagePath);
+            logger.LogInformation("Sample page already exists at: {samplePagePath}", samplePagePath);
         }
 
         // Add sample template
         var templatePath = Path.Combine(pagesFolder, "template.razor");
         if (!File.Exists(templatePath))
         {
-            await File.WriteAllTextAsync(templatePath, SampleTemplate);
-            logger?.LogInformation("✅ Sample template created at: {templatePath}", templatePath);
+            await File.WriteAllTextAsync(templatePath, SampleTemplate, cancellationToken);
+            logger.LogInformation("✅ Sample template created at: {templatePath}", templatePath);
         }
         else
         {
-            logger?.LogInformation("Sample template already exists at: {templatePath}", templatePath);
+            logger.LogInformation("Sample template already exists at: {templatePath}", templatePath);
         }
 
         // Add sample component
@@ -47,20 +47,20 @@ public static async Task InitSampleContent(string projectFilePath, ILogger? logg
 
         if (!File.Exists(sampleComponentPath))
         {
-            await File.WriteAllTextAsync(sampleComponentPath, SampleComponent);
-           logger?.LogInformation("✅ Sample component created at: {sampleComponentPath}", sampleComponentPath);
+            await File.WriteAllTextAsync(sampleComponentPath, SampleComponent, cancellationToken);
+           logger.LogInformation("✅ Sample component created at: {sampleComponentPath}", sampleComponentPath);
         }
         else
         {
-            logger?.LogInformation("Sample component already exists at: {sampleComponentPath}", sampleComponentPath);
+            logger.LogInformation("Sample component already exists at: {sampleComponentPath}", sampleComponentPath);
         }
 
         // update the nav menu
         var navMenuPath = Path.Combine(Path.GetDirectoryName(projectFilePath) ?? string.Empty, "Layout", "NavMenu.razor");
 
         if (File.Exists(navMenuPath))
         {
-            var navMenuContent = await File.ReadAllTextAsync(navMenuPath);
+            var navMenuContent = await File.ReadAllTextAsync(navMenuPath, cancellationToken);
             if (navMenuContent.Contains("</nav>"))
             {
                 // Insert the new menu item before the closing </nav> tag
@@ -80,12 +80,12 @@ public static async Task InitSampleContent(string projectFilePath, ILogger? logg
                 if (insertIndex != -1)
                 {
                     navMenuContent = navMenuContent.Insert(insertIndex, $"{Environment.NewLine}{newMenuItem}{Environment.NewLine}");
-                    await File.WriteAllTextAsync(navMenuPath, navMenuContent);
-                    logger?.LogInformation("✅ Updated NavMenu.razor with dynamic content links.");
+                    await File.WriteAllTextAsync(navMenuPath, navMenuContent, cancellationToken);
+                    logger.LogInformation("✅ Updated NavMenu.razor with dynamic content links.");
                 }
                 else
                 {
-                    logger?.LogWarning("Could not find </nav> tag in NavMenu.razor to insert dynamic content links.");
+                    logger.LogWarning("Could not find </nav> tag in NavMenu.razor to insert dynamic content links.");
                 }
             }
         }