Implement a --prerelease global option (#39)

* Implement a --prerelease global option

* Add messaging when pre image isn't present

* Remove --prerelease flag from arguments forwarded to container

Author: Chaseshak

src/ActionsImporter.UnitTests/AppTests.cs

@@ -39,7 +39,7 @@ public void AfterEachTest()
     public async Task CheckForUpdates_NoUpdatesNeeded(string? latestImage, string? currentImage, string result)
     {
         // Arrange
-        var image = "actions-importer/cli";
+        var image = "actions-importer/cli:latest";
         var server = "ghcr.io";
 
         using var stringWriter = new StringWriter();

src/ActionsImporter.UnitTests/Services/DockerServiceTests.cs

@@ -434,7 +434,7 @@ public void VerifyImagePresentAsync_IsPresent_NoException()
         ).Returns(Task.CompletedTask);
 
         // Act, Assert
-        Assert.DoesNotThrowAsync(() => _dockerService.VerifyImagePresentAsync(image, server, version));
+        Assert.DoesNotThrowAsync(() => _dockerService.VerifyImagePresentAsync(image, server, version, false));
         _processService.VerifyAll();
     }
 
@@ -457,21 +457,21 @@ public void VerifyImagePresentAsync_NotPresent_ThrowsException()
         ).ThrowsAsync(new Exception());
 
         // Act, Assert
-        Assert.ThrowsAsync<Exception>(() => _dockerService.VerifyImagePresentAsync(image, server, version));
+        Assert.ThrowsAsync<Exception>(() => _dockerService.VerifyImagePresentAsync(image, server, version, false));
         _processService.VerifyAll();
     }
 
     [Test]
     public async Task GetCurrentImageDigest_ParsesDigestCorrectly()
     {
         // Arrange
-        var image = "actions-importer/cli";
+        var image = "actions-importer/cli:latest";
         var server = "ghcr.io";
 
         _processService.Setup(handler =>
             handler.RunAndCaptureAsync(
                 "docker",
-                $"image inspect --format={{{{.Id}}}} {server}/{image}:latest",
+                $"image inspect --format={{{{.Id}}}} {server}/{image}",
                 It.IsAny<string?>(),
                 It.IsAny<IEnumerable<(string, string)>?>(),
                 It.IsAny<bool>(),
@@ -491,7 +491,7 @@ public async Task GetCurrentImageDigest_ParsesDigestCorrectly()
     public async Task GetLatestImageDigest_ParsesDigestCorrectly()
     {
         // Arrange
-        var image = "actions-importer/cli";
+        var image = "actions-importer/cli:latest";
         var server = "ghcr.io";
         var manifestResult = @"
 {
@@ -554,7 +554,7 @@ public async Task GetLatestImageDigest_ParsesDigestCorrectly()
         _processService.Setup(handler =>
             handler.RunAndCaptureAsync(
                 "docker",
-                $"manifest inspect {server}/{image}:latest",
+                $"manifest inspect {server}/{image}",
                 It.IsAny<string?>(),
                 It.IsAny<IEnumerable<(string, string)>?>(),
                 It.IsAny<bool>(),

src/ActionsImporter/App.cs

@@ -12,6 +12,12 @@ public class App
     private readonly IProcessService _processService;
     private readonly IConfigurationService _configurationService;
 
+    public bool IsPrerelease { get; set; }
+
+    private string ImageTag => IsPrerelease ? "pre" : "latest";
+
+    private string ImageName => $"{ActionsImporterImage}:{ImageTag}";
+
     public App(IDockerService dockerService, IProcessService processService, IConfigurationService configurationService)
     {
         _dockerService = dockerService;
@@ -37,7 +43,7 @@ public async Task<int> UpdateActionsImporterAsync(string? username = null, strin
         await _dockerService.UpdateImageAsync(
             ActionsImporterImage,
             ActionsImporterContainerRegistry,
-            "latest",
+            ImageTag,
             username,
             password,
             passwordStdin
@@ -52,13 +58,14 @@ public async Task<int> ExecuteActionsImporterAsync(string[] args)
         await _dockerService.VerifyImagePresentAsync(
             ActionsImporterImage,
             ActionsImporterContainerRegistry,
-            "latest"
+            ImageTag,
+            IsPrerelease
         ).ConfigureAwait(false);
 
         await _dockerService.ExecuteCommandAsync(
             ActionsImporterImage,
             ActionsImporterContainerRegistry,
-            "latest",
+            ImageTag,
             args.Select(x => x.EscapeIfNeeded()).ToArray()
         );
         return 0;
@@ -68,7 +75,7 @@ public async Task<int> GetVersionAsync()
     {
         var (standardOutput, standardError, exitCode) = await _processService.RunAndCaptureAsync("gh", "version");
         var ghActionsImporterVersion = await _processService.RunAndCaptureAsync("gh", "extension list");
-        var actionsImporterVersion = await _processService.RunAndCaptureAsync("docker", $"run --rm {ActionsImporterContainerRegistry}/{ActionsImporterImage}:latest version", throwOnError: false);
+        var actionsImporterVersion = await _processService.RunAndCaptureAsync("docker", $"run --rm {ActionsImporterContainerRegistry}/{ImageName} version", throwOnError: false);
 
         var formattedGhVersion = standardOutput.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries).FirstOrDefault();
         var formattedGhActionsImporterVersion = ghActionsImporterVersion.standardOutput.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries)
@@ -77,7 +84,7 @@ public async Task<int> GetVersionAsync()
 
         Console.WriteLine(formattedGhVersion);
         Console.WriteLine(formattedGhActionsImporterVersion);
-        Console.WriteLine($"actions-importer/cli\t{formattedActionsImporterVersion}");
+        Console.WriteLine($"actions-importer/cli:{ImageTag}\t{formattedActionsImporterVersion}");
 
         return 0;
     }
@@ -86,8 +93,8 @@ public async Task CheckForUpdatesAsync()
     {
         try
         {
-            var latestImageDigestTask = _dockerService.GetLatestImageDigestAsync(ActionsImporterImage, ActionsImporterContainerRegistry);
-            var currentImageDigestTask = _dockerService.GetCurrentImageDigestAsync(ActionsImporterImage, ActionsImporterContainerRegistry);
+            var latestImageDigestTask = _dockerService.GetLatestImageDigestAsync(ImageName, ActionsImporterContainerRegistry);
+            var currentImageDigestTask = _dockerService.GetCurrentImageDigestAsync(ImageName, ActionsImporterContainerRegistry);
 
             await Task.WhenAll(latestImageDigestTask, currentImageDigestTask);
 

src/ActionsImporter/Commands/Common.cs

@@ -6,6 +6,12 @@ namespace ActionsImporter.Commands;
 public static class Common
 {
 
+    public static readonly Option<bool> Prerelease = new("--prerelease")
+    {
+        Description = "Use prerelease image for GitHub Actions Importer",
+        IsRequired = false,
+    };
+
     public static Command AppendTransformerOptions(this Command command)
     {
         ArgumentNullException.ThrowIfNull(command);
@@ -73,6 +79,15 @@ public static Command AppendTransformerOptions(this Command command)
         return command;
     }
 
+    public static Command AppendPrereleaseOption(this Command command)
+    {
+        ArgumentNullException.ThrowIfNull(command);
+
+        command.AddGlobalOption(Prerelease);
+
+        return command;
+    }
+
     public static Command AppendGeneralOptions(this Command command)
     {
         ArgumentNullException.ThrowIfNull(command);
@@ -105,6 +120,8 @@ public static Command AppendGeneralOptions(this Command command)
             }
         );
 
+        command.AddGlobalOption(Prerelease);
+
         return command;
     }
 

src/ActionsImporter/Commands/ContainerCommand.cs

@@ -10,7 +10,8 @@ public abstract class ContainerCommand : BaseCommand
 
     protected ContainerCommand(string[] args)
     {
-        _args = args;
+        // Don't forward the --prerelease flag to GitHub Actions Importer image
+        _args = args.Where(arg => !arg.Contains(Common.Prerelease.Name, StringComparison.Ordinal)).ToArray();
     }
 
     protected abstract ImmutableArray<Option> Options { get; }

src/ActionsImporter/Commands/Update.cs

@@ -33,6 +33,7 @@ protected override Command GenerateCommand(App app)
         command.AddOption(UsernameOption);
         command.AddOption(PasswordOption);
         command.AddOption(PasswordStdInOption);
+        command.AppendPrereleaseOption();
 
         command.Handler = CommandHandler.Create((string? username, string? password, bool passwordStdin) => app.UpdateActionsImporterAsync(username, password, passwordStdin));
 

src/ActionsImporter/Commands/Version.cs

@@ -14,6 +14,8 @@ protected override Command GenerateCommand(App app)
 
         var command = base.GenerateCommand(app);
 
+        command.AppendPrereleaseOption();
+
         command.Handler = CommandHandler.Create(app.GetVersionAsync);
 
         return command;

src/ActionsImporter/Interfaces/IDockerService.cs

@@ -8,7 +8,7 @@ public interface IDockerService
 
     Task VerifyDockerRunningAsync();
 
-    Task VerifyImagePresentAsync(string image, string server, string version);
+    Task VerifyImagePresentAsync(string image, string server, string version, bool isPrerelease);
 
     Task<string?> GetLatestImageDigestAsync(string image, string server);
 

src/ActionsImporter/Program.cs

@@ -43,6 +43,9 @@
     .CancelOnProcessTermination()
     .Build();
 
+
+app.IsPrerelease = parser.Parse(args).HasOption(Common.Prerelease);
+
 try
 {
     if (!Array.Exists(args, x => x == "update"))

src/ActionsImporter/Services/DockerService.cs

@@ -84,8 +84,10 @@ await _processService.RunAsync(
         }
     }
 
-    public async Task VerifyImagePresentAsync(string image, string server, string version)
+    public async Task VerifyImagePresentAsync(string image, string server, string version, bool isPrerelease)
     {
+        var imageName = $"{server}/{image}:{version}";
+        var preReleaseOption = isPrerelease ? " --prerelease" : string.Empty;
         try
         {
             await _processService.RunAsync(
@@ -94,23 +96,24 @@ await _processService.RunAsync(
                 output: false
             );
         }
+
         catch (Exception)
         {
-            throw new Exception("Unable to locate GitHub Actions Importer image locally. Please run `gh actions-importer update` to fetch the latest image prior to running this command.");
+            throw new Exception($"Unable to locate {imageName} image locally. Please run `gh actions-importer update{preReleaseOption}` to fetch the latest image prior to running this command.");
         }
     }
 
     public async Task<string?> GetLatestImageDigestAsync(string image, string server)
     {
-        var (standardOutput, _, _) = await _processService.RunAndCaptureAsync("docker", $"manifest inspect {server}/{image}:latest");
+        var (standardOutput, _, _) = await _processService.RunAndCaptureAsync("docker", $"manifest inspect {server}/{image}");
         Manifest? manifest = JsonSerializer.Deserialize<Manifest>(standardOutput);
 
         return manifest?.GetDigest();
     }
 
     public async Task<string?> GetCurrentImageDigestAsync(string image, string server)
     {
-        var (standardOutput, _, _) = await _processService.RunAndCaptureAsync("docker", $"image inspect --format={{{{.Id}}}} {server}/{image}:latest");
+        var (standardOutput, _, _) = await _processService.RunAndCaptureAsync("docker", $"image inspect --format={{{{.Id}}}} {server}/{image}");
 
         return standardOutput.Split(":").ElementAtOrDefault(1)?.Trim();
     }