Add login with access token mechanism to PolarionClient

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Polarion Changelog
 
+## 0.3.5
+
+- Add login with username and access token
+
 ## 0.3.3
 
 - Add new test configuration properties for Module/Revision API test data

src/Polarion.Tests/Integration/PolarionClientLoginWithTokenTests.cs

@@ -0,0 +1,53 @@
+using Xunit;
+using Polarion.Tests.Helpers;
+using FluentAssertions;
+
+namespace Polarion.Tests.Integration;
+
+public class PolarionClientLoginWithTokenTests : IAsyncLifetime
+{
+    private readonly TestConfiguration _config;
+    private PolarionClient _client = null!;
+
+    public PolarionClientLoginWithTokenTests()
+    {
+        // Load configuration from the test settings file
+        _config = TestConfigurationLoader.Load("../../../appsettings.loginWithToken.test.json");
+    }
+
+    public async Task InitializeAsync()
+    {
+        // Create the client before each test
+        var result = await PolarionClient.CreateAsync(_config.PolarionClient);
+        result.IsSuccess.Should().BeTrue("Polarion client should be created successfully");
+        _client = result.Value;
+        _client.Should().NotBeNull("Polarion client should be created successfully");
+    }
+
+    public Task DisposeAsync()
+    {
+        return Task.CompletedTask;
+    }
+
+
+    [Fact]
+    public async Task GetWorkItemById_ShouldReturnValidWorkItem()
+    {
+        // Arrange
+        var workItemId = _config.TestScenarioData.GetWorkItemByIdAsyncWorkItemId;
+
+        // Act
+        var result = await _client.GetWorkItemByIdAsync(workItemId);
+
+        // Assert
+        result.IsSuccess.Should().BeTrue("Work item retrieval should succeed");
+        var workItem = result.Value;
+        workItem.Should().NotBeNull();
+        workItem.id.Should().NotBeNullOrEmpty();
+        workItem.title.Should().NotBeNullOrEmpty();
+        workItem.type.id.Should().NotBeNullOrEmpty();
+        workItem.status.id.Should().NotBeNullOrEmpty();
+        workItem.author.name.Should().NotBeNullOrEmpty();
+        workItem.description.content.Should().NotBeNullOrEmpty();
+    }
+}

src/Polarion.Tests/appsettings.loginWithToken.json

@@ -0,0 +1,13 @@
+{
+    "PolarionClient": {
+        "ServerUrl": "",
+        "Username": "",
+        "Mechanism": "AccessToken",
+        "Token": "",
+        "ProjectId": "",
+        "TimeoutSeconds": 60
+    },
+    "TestScenarioData": {
+        "GetWorkItemByIdAsyncWorkItemId": ""
+    }
+}

src/Polarion/Client/PolarionClient_CreateAsync.cs

@@ -31,7 +31,15 @@ public static async Task<Result<PolarionClient>> CreateAsync(PolarionClientConfi
         try
         {
             // Login using the Session service
-            var loginResponse = await sessionClient.logInAsync(config.Username, config.Password);
+            Object loginResponse;
+            if (config.Mechanism is not null && "AccessToken".Equals(config.Mechanism))
+            {
+                loginResponse = await sessionClient.logInWithTokenAsync(config.Mechanism, config.Username, config.Token);
+            }
+            else
+            {
+                loginResponse = await sessionClient.logInAsync(config.Username, config.Password);
+            }
             if (loginResponse is null)
             {
                 return Result.Fail<PolarionClient>("Login failed - invalid credentials");

src/Polarion/Polarion.csproj

@@ -11,7 +11,7 @@
 
     <!-- Package Metadata -->
     <PackageId>Polarion</PackageId>
-    <Version>0.3.4</Version>
+    <Version>0.3.5</Version>
     <Authors>Todd Schavey</Authors>
     <Company>Peakflames</Company>
     <Description>A C# package to access the Polarion WSDL API. Complete API documentation available at: https://github.com/peakflames/PolarionApiClient/blob/main/api.md</Description>

src/Polarion/PolarionClientConfiguration.cs

@@ -6,16 +6,20 @@ public record PolarionClientConfiguration
     {
         public string ServerUrl { get; set; }
         public string Username { get; set; }
-        public string Password { get; set; }
+        public string? Password { get; set; }
+        public string? Mechanism { get; set; }
+        public string? Token { get; set; }
         public string ProjectId { get; set; }
         public int TimeoutSeconds { get; set; } = 30;
 
         [JsonConstructor]
-        public PolarionClientConfiguration(string serverUrl, string username, string password, string projectId, int timeoutSeconds = 30)
+        public PolarionClientConfiguration(string serverUrl, string username, string projectId, int timeoutSeconds = 30, string? password = null, string? mechanism = null, string? token = null)
         {
             ServerUrl = serverUrl;
             Username = username;
             Password = password;
+            Mechanism = mechanism;
+            Token = token;
             ProjectId = projectId;
             TimeoutSeconds = timeoutSeconds;
         }