feat: implements better commandline args parsing with '--version' and '--help' outputs

.gitlab-ci.yml

@@ -1,26 +1,18 @@
-# You can override the included template(s) by including variable overrides
-# SAST customization: https://docs.gitlab.com/ee/user/application_security/sast/#customizing-the-sast-settings
-# Secret Detection customization: https://docs.gitlab.com/ee/user/application_security/secret_detection/#customizing-settings
-# Dependency Scanning customization: https://docs.gitlab.com/ee/user/application_security/dependency_scanning/#customizing-the-dependency-scanning-settings
-# Note that environment variables can be set in several places
-# See https://docs.gitlab.com/ee/ci/variables/#cicd-variable-precedence
 stages:
-- test
-- publish
+  - test
+  - publish
+
 running tests for tag:
   image: mcr.microsoft.com/dotnet/sdk:5.0
   stage: test
   script:
-  - dotnet test tests/update-tag.tests
+    - dotnet test tests/update-tag.tests
+
 publish to nuget:
   only:
-  - "/^\\d*.\\d*.\\d*$/"
+    - /^v+\d*.\d*.\d*$/ # gets triggered if the commit tag is in the form n.n.n where n is any number
   image: mcr.microsoft.com/dotnet/sdk:5.0
   stage: publish
   script:
-  - dotnet pack src/Cli -o ./packaged
-  - dotnet nuget push ./packaged/*.nupkg -k $NUGET_API_KEY -s https://api.nuget.org/v3/index.json
-sast:
-  stage: test
-include:
-- template: Security/SAST.gitlab-ci.yml
+    - dotnet pack src/Cli -o ./packaged
+    - dotnet nuget push ./packaged/*.nupkg -k $NUGET_API_KEY -s https://api.nuget.org/v3/index.json

src/Cli/AppRunner.cs

@@ -98,11 +98,20 @@ namespace Cli
                         .Title("[red]Error evaluating version from newest tag.[/]\nAdd new version tag **AND** push to origin?)")
                         .PageSize(10)
                         .AddChoices(
-                            new Selection("yes", new Version(0, 1, 0)),
-                            new Selection("yes", new Version(0, 1, 0, 1)),
+                            new Selection("yes", new Version(0, 1, 0, true)),
+                            new Selection("yes", new Version(0, 1, 0, 1, true)),
                             new Selection("no", null)
                         )
                 );
+                var serviceName = AnsiConsole.Prompt(
+                    new TextPrompt<string>("[grey][[Optional]][/] Enter [green]service name[/]:")
+                        .AllowEmpty()
+                );
+
+                if (!string.IsNullOrWhiteSpace(serviceName))
+                {
+                    selection.Version.SetService(serviceName.Trim());
+                }
             }
 
             if (selection.Version == null)

src/Cli/Cli.csproj

@@ -6,10 +6,11 @@
         <RootNamespace>Cli</RootNamespace>
         <PackAsTool>true</PackAsTool>
         <ToolCommandName>update-tag</ToolCommandName>
+        <AssemblyTitle>update-tag</AssemblyTitle>
         <PackageId>Novaloop.UpdateTag</PackageId>
         <title>Updates the tag of a repo to the next chosen version according the semver symantic.</title>
         <PackageTags>semver;update-tag;tag;git</PackageTags>
-        <Version>0.1.7</Version>
+        <Version>0.5.0</Version>
         <Authors>Matthias Langhard</Authors>
         <Company>Novaloop AG</Company>
         <PackageProjectUrl>https://gitlab.com/novaloop-oss/novaloop.update-tag</PackageProjectUrl>
@@ -18,6 +19,7 @@
 
 
     <ItemGroup>
+        <PackageReference Include="CommandLineParser" Version="2.8.0"/>
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="5.0.2"/>
         <PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.0"/>
         <PackageReference Include="Spectre.Console" Version="0.42.0"/>

src/Cli/Models/CliParams.cs

@@ -0,0 +1,10 @@
+using CommandLine;
+
+namespace Cli.Models
+{
+    public class CliParams
+    {
+        [Option('r', "repository-path", Required = false, HelpText = "Run update-tag on a git repository other than the current directory.")]
+        public string RepositoryPath { get; set; }
+    }
+}

src/Cli/Program.cs

@@ -1,7 +1,8 @@
 using System;
-using System.Linq;
 using System.Threading.Tasks;
 using Application;
+using Cli.Models;
+using CommandLine;
 using Infrastructure;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
@@ -21,9 +22,14 @@ namespace Cli
                 .ServiceProvider
                 .GetRequiredService<AppRunner>();
 
-            await appRunner.Run(args.FirstOrDefault() ?? Environment.CurrentDirectory);
+            await Parser.Default
+                .ParseArguments<CliParams>(args)
+                .WithParsedAsync(
+                    async options => { await appRunner.Run(options.RepositoryPath ?? Environment.CurrentDirectory); }
+                );
         }
 
+
         private static IHostBuilder CreateHostBuilder()
         {
             return Host.CreateDefaultBuilder()

src/Core/Models/Version.cs

@@ -13,37 +13,41 @@ namespace Application.Models
     /// </summary>
     public class Version
     {
-        public Version(int major, int minor, int patch)
+        public Version(int major, int minor, int patch, bool hasVPrefix)
         {
             Major = major;
             Minor = minor;
             Patch = patch;
+            _hasVPrefix = hasVPrefix;
         }
 
-        public Version(int major, int minor, int patch, int? rc)
+        public Version(int major, int minor, int patch, int? rc, bool hasVPrefix)
         {
             Major = major;
             Minor = minor;
             Patch = patch;
             Rc = rc;
+            _hasVPrefix = hasVPrefix;
         }
 
-        public Version(int major, int minor, int patch, string rc, string service)
+        public Version(int major, int minor, int patch, string rc, string service, bool hasVPrefix)
         {
             Major = major;
             Minor = minor;
             Patch = patch;
             Rc = rc == null ? null : ExtractNumberFromRcString(rc);
             Service = service ?? "";
+            _hasVPrefix = hasVPrefix;
         }
 
-        public Version(int major, int minor, int patch, int? rc, string service)
+        public Version(int major, int minor, int patch, int? rc, string service, bool hasVPrefix)
         {
             Major = major;
             Minor = minor;
             Patch = patch;
             Rc = rc;
             Service = service ?? "";
+            _hasVPrefix = hasVPrefix;
         }
 
         private static int? ExtractNumberFromRcString(string rc)
@@ -57,12 +61,17 @@ namespace Application.Models
         public int Minor { get; private set; }
         public int Patch { get; private set; }
         public int? Rc { get; private set; }
-        public string Service { get; }
-
+        public string Service { get; private set; }
+        private readonly bool _hasVPrefix;
 
         public override string ToString()
         {
             var sb = new StringBuilder();
+            if (_hasVPrefix)
+            {
+                sb.Append('v');
+            }
+
             sb.Append(Major);
             sb.Append('.');
             sb.Append(Minor);
@@ -87,7 +96,7 @@ namespace Application.Models
 
         private Version Copy()
         {
-            return new Version(Major, Minor, Patch, Rc, Service);
+            return new Version(Major, Minor, Patch, Rc, Service, _hasVPrefix);
         }
 
         public Version NextMajor()
@@ -190,7 +199,7 @@ namespace Application.Models
                 throw new ArgumentException("Cannot release RC. Not an RC.");
             }
 
-            var nextVersion = new Version(Major, Minor, Patch, (string)null, Service);
+            var nextVersion = new Version(Major, Minor, Patch, (string)null, Service, _hasVPrefix);
             return nextVersion;
         }
 
@@ -198,5 +207,10 @@ namespace Application.Models
         {
             return Rc != null;
         }
+
+        public void SetService(string service)
+        {
+            Service = service;
+        }
     }
 }

src/Core/Queries/GetVersionInformationFromRepo.cs

@@ -1,12 +1,14 @@
 using System;
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using Application.Interfaces;
 using Application.Models;
 using MediatR;
 
 namespace Application.Queries
 {
-    public class GetVersionInformationFromRepo : RequestHandler<GetVersionInformationFromRepo.Query, VersionInformation>
+    public class GetVersionInformationFromRepo : IRequestHandler<GetVersionInformationFromRepo.Query, VersionInformation>
     {
         public class Query : IRequest<VersionInformation>
         {
@@ -27,7 +29,7 @@ namespace Application.Queries
             _gitRepoReadService = gitRepoReadService;
         }
 
-        protected override VersionInformation Handle(Query request)
+        public async Task<VersionInformation> Handle(Query request, CancellationToken cancellationToken)
         {
             var versions = _gitRepoReadService
                 .GetAllVersions(request.RepositoryPath);
@@ -42,10 +44,11 @@ namespace Application.Queries
                 .OrderByDescending(v => v.Major)
                 .ThenByDescending(v => v.Minor)
                 .ThenByDescending(v => v.Patch)
+                .ThenByDescending(v => v.Rc == null)
                 .ThenByDescending(v => v.Rc)
                 .FirstOrDefault();
 
-            return currentVersion == null ? null : new VersionInformation(currentVersion);
+            return await Task.FromResult(currentVersion == null ? null : new VersionInformation(currentVersion));
         }
     }
 }

src/Infrastructure/Services/GitRepoReadService.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using Application.Interfaces;
@@ -27,21 +28,23 @@ namespace Infrastructure.Services
             {
                 if (TryParse(tag.FriendlyName, out var semver))
                 {
-                    yield return new Version(semver.Major, semver.Minor, semver.Patch, semver.Prerelease, semver.Build);
+                    yield return semver;
                 }
             }
         }
 
-        private static bool TryParse(string version, out SemVersion semverVersion)
+        private static bool TryParse(string versionStr, out Version version)
         {
             try
             {
-                semverVersion = SemVersion.Parse(version.TrimStart('v').TrimStart('V'));
+                var semver = SemVersion.Parse(versionStr.TrimStart('v').TrimStart('V'));
+                var hasVPrefix = versionStr.StartsWith("v", StringComparison.InvariantCultureIgnoreCase);
+                version = new Version(semver.Major, semver.Minor, semver.Patch, semver.Prerelease, semver.Build, hasVPrefix);
                 return true;
             }
             catch
             {
-                semverVersion = null;
+                version = null;
                 return false;
             }
         }

tests/update-tag.tests/GetVersionInformationFromRepoTests.cs

@@ -0,0 +1,63 @@
+using System.Collections.Generic;
+using System.Threading;
+using Application.Interfaces;
+using Application.Models;
+using Application.Queries;
+using Moq;
+using Xunit;
+
+namespace UpdateTag.Tests
+{
+    public class GetVersionInformationFromRepoTests
+    {
+        [Fact]
+        public async void DoesReadCurrentVersionCorrectly()
+        {
+            // Arrange
+            var mockedVersionList = new List<Version>
+            {
+                new Version(0, 1, 5, false),
+                new Version(0, 1, 7, false),
+                new Version(0, 2, 0, false),
+                new Version(0, 2, 0, 0, false),
+                new Version(0, 2, 0, 1, false),
+                new Version(0, 2, 0, 2, false)
+            };
+            var gitRepoMock = new Mock<IGitRepoReadService>();
+            gitRepoMock.Setup(m => m.GetAllVersions(It.IsAny<string>()))
+                .Returns(mockedVersionList);
+            var handler = new GetVersionInformationFromRepo(gitRepoMock.Object);
+            var query = new GetVersionInformationFromRepo.Query("");
+
+            // Act
+            var versionInformation = await handler.Handle(query, CancellationToken.None);
+
+            // Assert
+            Assert.Equal("0.2.0", versionInformation.CurrentVersion.ToString());
+        }
+
+        [Theory]
+        [InlineData(0, 2, 0, true, "v0.2.0")]
+        [InlineData(0, 2, 0, false, "0.2.0")]
+        public async void AddVPrefixToNextVersionIfCurrentVersionHasOne(int major, int minor, int patch, bool hasVPrefix,
+            string expectedVersionOutput)
+        {
+            // Arrange
+            var mockedVersionList = new List<Version>
+            {
+                new Version(major, minor, patch, hasVPrefix)
+            };
+            var gitRepoMock = new Mock<IGitRepoReadService>();
+            gitRepoMock.Setup(m => m.GetAllVersions(It.IsAny<string>()))
+                .Returns(mockedVersionList);
+            var handler = new GetVersionInformationFromRepo(gitRepoMock.Object);
+            var query = new GetVersionInformationFromRepo.Query("");
+
+            // Act
+            var versionInformation = await handler.Handle(query, CancellationToken.None);
+
+            // Assert
+            Assert.Equal(expectedVersionOutput, versionInformation.CurrentVersion.ToString());
+        }
+    }
+}

tests/update-tag.tests/VersionInformationTests.cs

@@ -11,7 +11,7 @@ namespace UpdateTag.Tests
 
         {
             // Arrange
-            var version = new Version(1, 0, 1, 1);
+            var version = new Version(1, 0, 1, 1, false);
 
             // Act
             var versionInformation = new VersionInformation(version);
@@ -28,7 +28,7 @@ namespace UpdateTag.Tests
 
         {
             // Arrange
-            var version = new Version(1, 0, 1);
+            var version = new Version(1, 0, 1, false);
 
             // Act
             var versionInformation = new VersionInformation(version);

tests/update-tag.tests/VersionTests.cs

@@ -12,7 +12,7 @@ namespace UpdateTag.Tests
         public void NextMajor(int major, int minor, int patch, string rc, string service, string expected)
 
         {
-            var version = new Version(major, minor, patch, rc, service).NextMajor();
+            var version = new Version(major, minor, patch, rc, service, false).NextMajor();
             Assert.Equal(expected, version.ToString());
         }
 
@@ -24,7 +24,7 @@ namespace UpdateTag.Tests
         public void NextMinor(int major, int minor, int patch, string rc, string service, string expected)
 
         {
-            var version = new Version(major, minor, patch, rc, service).NextMinor();
+            var version = new Version(major, minor, patch, rc, service, false).NextMinor();
             Assert.Equal(expected, version.ToString());
         }
 
@@ -35,7 +35,7 @@ namespace UpdateTag.Tests
         public void NextPatch(int major, int minor, int patch, string rc, string service, string expected)
 
         {
-            var version = new Version(major, minor, patch, rc, service).NextPatch();
+            var version = new Version(major, minor, patch, rc, service, false).NextPatch();
             Assert.Equal(expected, version.ToString());
         }
 
@@ -45,7 +45,7 @@ namespace UpdateTag.Tests
         public void NextRc(int major, int minor, int patch, string rc, string service, string expected)
 
         {
-            var version = new Version(major, minor, patch, rc, service).NextRc();
+            var version = new Version(major, minor, patch, rc, service, false).NextRc();
             Assert.Equal(expected, version.ToString());
         }
 
@@ -54,7 +54,7 @@ namespace UpdateTag.Tests
         [InlineData(1, 1, 1, null, "ErpNext", "1.1.2-RC.0+ErpNext")]
         public void CreatePatchRc(int major, int minor, int patch, string rc, string service, string expected)
         {
-            var version = new Version(major, minor, patch, rc, service).CreatePatchRc();
+            var version = new Version(major, minor, patch, rc, service, false).CreatePatchRc();
             Assert.Equal(expected, version.ToString());
         }
 
@@ -63,7 +63,7 @@ namespace UpdateTag.Tests
         [InlineData(1, 1, 1, null, "ErpNext", "1.2.0-RC.0+ErpNext")]
         public void CreateMinorRc(int major, int minor, int patch, string rc, string service, string expected)
         {
-            var version = new Version(major, minor, patch, rc, service).CreateMinorRc();
+            var version = new Version(major, minor, patch, rc, service, false).CreateMinorRc();
             Assert.Equal(expected, version.ToString());
         }
 
@@ -72,7 +72,7 @@ namespace UpdateTag.Tests
         [InlineData(1, 1, 1, null, "ErpNext", "2.0.0-RC.0+ErpNext")]
         public void CreateMajroRc(int major, int minor, int patch, string rc, string service, string expected)
         {
-            var version = new Version(major, minor, patch, rc, service).CreateMajorRc();
+            var version = new Version(major, minor, patch, rc, service, false).CreateMajorRc();
             Assert.Equal(expected, version.ToString());
         }
 
@@ -81,7 +81,7 @@ namespace UpdateTag.Tests
         [InlineData(1, 1, 1, "RC.4", "ErpNext", "1.1.1+ErpNext")]
         public void ReleaseRc(int major, int minor, int patch, string rc, string service, string expected)
         {
-            var version = new Version(major, minor, patch, rc, service).ReleaseRc();
+            var version = new Version(major, minor, patch, rc, service, false).ReleaseRc();
             Assert.Equal(expected, version.ToString());
         }
     }

tests/update-tag.tests/update-tag.tests.csproj

@@ -9,6 +9,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.4" />
+    <PackageReference Include="Moq" Version="4.16.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>