Fix IssueStatus xml deserialization

Author: zapadi

src/redmine-net-api/Types/Issue.cs

@@ -59,7 +59,7 @@ public sealed class Issue :
         /// Gets or sets the status.Possible values: open, closed, * to get open and closed issues, status id
         /// </summary>
         /// <value>The status.</value>
-        public IdentifiableName Status { get; set; }
+        public IssueStatus Status { get; set; }
 
         /// <summary>
         /// Gets or sets the priority.
@@ -307,7 +307,7 @@ public override void ReadXml(XmlReader reader)
                     case RedmineKeys.RELATIONS: Relations = reader.ReadElementContentAsCollection<IssueRelation>(); break;
                     case RedmineKeys.SPENT_HOURS: SpentHours = reader.ReadElementContentAsNullableFloat(); break;
                     case RedmineKeys.START_DATE: StartDate = reader.ReadElementContentAsNullableDateTime(); break;
-                    case RedmineKeys.STATUS: Status = new IdentifiableName(reader); break;
+                    case RedmineKeys.STATUS: Status = new IssueStatus(reader); break;
                     case RedmineKeys.SUBJECT: Subject = reader.ReadElementContentAsString(); break;
                     case RedmineKeys.TOTAL_ESTIMATED_HOURS: TotalEstimatedHours = reader.ReadElementContentAsNullableFloat(); break;
                     case RedmineKeys.TOTAL_SPENT_HOURS: TotalSpentHours = reader.ReadElementContentAsNullableFloat(); break;
@@ -406,7 +406,7 @@ public override void ReadJson(JsonReader reader)
                     case RedmineKeys.RELATIONS: Relations = reader.ReadAsCollection<IssueRelation>(); break;
                     case RedmineKeys.SPENT_HOURS: SpentHours = (float?)reader.ReadAsDouble(); break;
                     case RedmineKeys.START_DATE: StartDate = reader.ReadAsDateTime(); break;
-                    case RedmineKeys.STATUS: Status = new IdentifiableName(reader); break;
+                    case RedmineKeys.STATUS: Status = new IssueStatus(reader); break;
                     case RedmineKeys.SUBJECT: Subject = reader.ReadAsString(); break;
                     case RedmineKeys.TOTAL_ESTIMATED_HOURS: TotalEstimatedHours = (float?)reader.ReadAsDouble(); break;
                     case RedmineKeys.TOTAL_SPENT_HOURS: TotalSpentHours = (float?)reader.ReadAsDouble(); break;

src/redmine-net-api/Types/IssueStatus.cs

@@ -30,8 +30,44 @@ namespace Redmine.Net.Api.Types
     /// </summary>
     [DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
     [XmlRoot(RedmineKeys.ISSUE_STATUS)]
-    public sealed class IssueStatus : IdentifiableName, IEquatable<IssueStatus>
+    public sealed class IssueStatus : IdentifiableName, IEquatable<IssueStatus>, ICloneable<IssueStatus>
     {
+        public IssueStatus()
+        {
+            
+        }
+        
+        /// <summary>
+        /// 
+        /// </summary>
+        internal IssueStatus(int id, string name, bool isDefault = false, bool isClosed = false)
+        {
+            Id = id;
+            Name = name;
+            IsClosed = isClosed;
+            IsDefault = isDefault;
+        }
+        
+        internal IssueStatus(XmlReader reader)
+        {
+            Initialize(reader);
+        }
+        
+        internal IssueStatus(JsonReader reader)
+        {
+            Initialize(reader);
+        }
+
+        private void Initialize(XmlReader reader)
+        {
+            ReadXml(reader);
+        }
+
+        private void Initialize(JsonReader reader)
+        {
+            ReadJson(reader);
+        }
+        
         #region Properties
         /// <summary>
         /// Gets or sets a value indicating whether IssueStatus is default.
@@ -55,6 +91,16 @@ public sealed class IssueStatus : IdentifiableName, IEquatable<IssueStatus>
         /// <param name="reader"></param>
         public override void ReadXml(XmlReader reader)
         {
+            if (reader.HasAttributes && reader.Name == "status")
+            {
+                Id = reader.ReadAttributeAsInt(RedmineKeys.ID);
+                IsClosed = reader.ReadAttributeAsBoolean(RedmineKeys.IS_CLOSED);
+                IsDefault = reader.ReadAttributeAsBoolean(RedmineKeys.IS_DEFAULT);
+                Name = reader.GetAttribute(RedmineKeys.NAME);
+                reader.Read();
+                return;
+            }
+            
             reader.Read();
             while (!reader.EOF)
             {
@@ -121,6 +167,22 @@ public bool Equals(IssueStatus other)
                    && IsDefault == other.IsDefault;
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="resetId"></param>
+        /// <returns></returns>
+        public new IssueStatus Clone(bool resetId)
+        {
+            return new IssueStatus
+            {
+                Id = Id,
+                Name = Name,
+                IsClosed = IsClosed,
+                IsDefault = IsDefault
+            };
+        }
+
         /// <summary>
         /// 
         /// </summary>

tests/redmine-net-api.Tests/Clone/IssueCloneTests.cs

@@ -94,7 +94,7 @@ private static Issue CreateSampleIssue()
             Id = 1,
             Project = new IdentifiableName(100, "Test Project"),
             Tracker = new IdentifiableName(200, "Bug"),
-            Status = new IdentifiableName(300, "New"),
+            Status = new IssueStatus(300, "New"),
             Priority = new IdentifiableName(400, "Normal"),
             Author = new IdentifiableName(500, "John Doe"),
             Subject = "Test Issue",

tests/redmine-net-api.Tests/Equality/IssueEqualityTests.cs

@@ -88,7 +88,7 @@ private static Issue CreateSampleIssue()
             Id = 1,
             Project = new IdentifiableName { Id = 100, Name = "Test Project" },
             Tracker = new IdentifiableName { Id = 1, Name = "Bug" },
-            Status = new IdentifiableName { Id = 1, Name = "New" },
+            Status = new IssueStatus { Id = 1, Name = "New" },
             Priority = new IdentifiableName { Id = 1, Name = "Normal" },
             Author = new IdentifiableName { Id = 1, Name = "John Doe" },
             Subject = "Test Issue",

tests/redmine-net-api.Tests/Serialization/Json/IssuesTests.cs

@@ -0,0 +1,99 @@
+using System;
+using System.Linq;
+using Padi.DotNet.RedmineAPI.Tests.Infrastructure;
+using Padi.DotNet.RedmineAPI.Tests.Infrastructure.Fixtures;
+using Xunit;
+
+namespace Padi.DotNet.RedmineAPI.Tests.Serialization.Json;
+
+[Collection(Constants.JsonRedmineSerializerCollection)]
+public class IssuesTests(JsonSerializerFixture fixture)
+{
+    [Fact]
+    public void Should_Deserialize_Issue_With_Watchers()
+    {
+        const string input = """
+         {
+           "issue": {
+             "id": 5,
+             "project": {
+               "id": 1,
+               "name": "Project-Test"
+             },
+             "tracker": {
+               "id": 1,
+               "name": "Bug"
+             },
+             "status": {
+               "id": 1,
+               "name": "New",
+               "is_closed": true
+             },
+             "priority": {
+               "id": 2,
+               "name": "Normal"
+             },
+             "author": {
+               "id": 90,
+               "name": "Admin User"
+             },
+             "fixed_version": {
+               "id": 2,
+               "name": "version2"
+             },
+             "subject": "#380",
+             "description": "",
+             "start_date": "2025-04-28",
+             "due_date": null,
+             "done_ratio": 0,
+             "is_private": false,
+             "estimated_hours": null,
+             "total_estimated_hours": null,
+             "spent_hours": 0.0,
+             "total_spent_hours": 0.0,
+             "created_on": "2025-04-28T17:58:42Z",
+             "updated_on": "2025-04-28T17:58:42Z",
+             "closed_on": null,
+             "watchers": [
+               {
+                 "id": 91,
+                 "name": "Normal User"
+               },
+               {
+                 "id": 90,
+                 "name": "Admin User"
+               }
+             ]
+           }
+         }
+         """;
+                             
+        var output = fixture.Serializer.Deserialize<Redmine.Net.Api.Types.Issue>(input);
+        
+        Assert.NotNull(output);
+        Assert.Equal(5, output.Id);
+        Assert.Equal("Project-Test", output.Project.Name);
+        Assert.Equal(1, output.Project.Id);
+        Assert.Equal("Bug", output.Tracker.Name);
+        Assert.Equal(1, output.Tracker.Id);
+        Assert.Equal("New", output.Status.Name);
+        Assert.Equal(1, output.Status.Id);
+        Assert.True(output.Status.IsClosed);
+        Assert.False(output.Status.IsDefault);
+        Assert.Equal(2, output.FixedVersion.Id);
+        Assert.Equal("version2", output.FixedVersion.Name);
+        Assert.Equal(new DateTime(2025, 4, 28), output.StartDate);
+        Assert.Null(output.DueDate);
+        Assert.Equal(0, output.DoneRatio);
+        Assert.Null(output.EstimatedHours);
+        Assert.Null(output.TotalEstimatedHours);
+
+        var watchers = output.Watchers.ToList();
+        Assert.Equal(2, watchers.Count);
+        
+        Assert.Equal(91, watchers[0].Id);
+        Assert.Equal("Normal User", watchers[0].Name);
+        Assert.Equal(90, watchers[1].Id);
+        Assert.Equal("Admin User", watchers[1].Name);
+    }
+}

tests/redmine-net-api.Tests/Serialization/Xml/IssueTests.cs

@@ -117,10 +117,8 @@ This is not to be confused with another useful proposed feature that
             </issue>
             <issue>
                 <id>4325</id>
-                <journals type="array">
-                </journals>
-                <changesets type="array">
-                </changesets>
+                <journals type="array"/>
+                <changesets type="array"/>
                 <custom_fields type="array">
                     <custom_field name="Affected version" id="1">
                         <value>1.0.1</value>
@@ -134,6 +132,48 @@ This is not to be confused with another useful proposed feature that
         """;
 
         var output = fixture.Serializer.DeserializeToPagedResults<Redmine.Net.Api.Types.Issue>(input);
+        
+        Assert.NotNull(output);
+        Assert.Equal(2, output.TotalItems);
+
+        var issues = output.Items.ToList();
+        Assert.Equal(4326, issues[0].Id);
+        Assert.Equal("Redmine", issues[0].Project.Name);
+        Assert.Equal(1, issues[0].Project.Id);
+        Assert.Equal("Feature", issues[0].Tracker.Name);
+        Assert.Equal(2, issues[0].Tracker.Id);
+        Assert.Equal("New", issues[0].Status.Name);
+        Assert.Equal(1, issues[0].Status.Id);
+        Assert.Equal("Normal", issues[0].Priority.Name);
+        Assert.Equal(4, issues[0].Priority.Id);
+        Assert.Equal("John Smith", issues[0].Author.Name);
+        Assert.Equal(10106, issues[0].Author.Id);
+        Assert.Equal("Email notifications", issues[0].Category.Name);
+        Assert.Equal(9, issues[0].Category.Id);
+        Assert.Contains("Aggregate Multiple Issue Changes for Email Notifications", issues[0].Subject);
+        Assert.Contains("This is not to be confused with another useful proposed feature", issues[0].Description);
+        Assert.Equal(new DateTime(2009, 12, 3), issues[0].StartDate);
+        Assert.Null(issues[0].DueDate);
+        Assert.Equal(0, issues[0].DoneRatio);
+        Assert.Null(issues[0].EstimatedHours);
+        
+        Assert.NotNull(issues[0].CustomFields);
+        var issueCustomFields = issues[0].CustomFields.ToList();
+        Assert.Equal(4, issueCustomFields.Count);
+        
+        Assert.Equal(2,issueCustomFields[0].Id);
+        Assert.Equal("Duplicate",issueCustomFields[0].Values[0].Info);
+        Assert.False(issueCustomFields[0].Multiple);
+        Assert.Equal("Resolution",issueCustomFields[0].Name);
+        
+        Assert.NotNull(issues[1].CustomFields);
+        issueCustomFields = issues[1].CustomFields.ToList();
+        Assert.Equal(2, issueCustomFields.Count);
+        
+        Assert.Equal(1,issueCustomFields[0].Id);
+        Assert.Equal("1.0.1",issueCustomFields[0].Values[0].Info);
+        Assert.False(issueCustomFields[0].Multiple);
+        Assert.Equal("Affected version",issueCustomFields[0].Name);
     }
 
     [Fact]
@@ -200,5 +240,67 @@ public void Should_Deserialize_Issue_With_Journals()
         Assert.Equal("8", details[0].NewValue);
 
     }
+
+    [Fact]
+    public void Should_Deserialize_Issue_With_Watchers()
+    {
+        const string input = """
+        <?xml version="1.0" encoding="UTF-8"?>
+        <issue>
+            <id>5</id>
+            <project id="1" name="Project-Test"/>
+            <tracker id="1" name="Bug"/>
+            <status id="1" name="New" is_closed="true"/>
+            <priority id="2" name="Normal"/>
+            <author id="90" name="Admin User"/>
+            <fixed_version id="2" name="version2"/>
+            <subject>#380</subject>
+            <description></description>
+            <start_date>2025-04-28</start_date>
+            <due_date/>
+            <done_ratio>0</done_ratio>
+            <is_private>false</is_private>
+            <estimated_hours/>
+            <total_estimated_hours/>
+            <spent_hours>0.0</spent_hours>
+            <total_spent_hours>0.0</total_spent_hours>
+            <created_on>2025-04-28T17:58:42Z</created_on>
+            <updated_on>2025-04-28T17:58:42Z</updated_on>
+            <closed_on/>
+            <watchers type="array">
+                <user id="91" name="Normal User"/>
+                <user id="90" name="Admin User"/>
+            </watchers>
+        </issue>
+        """;
+        
+        var output = fixture.Serializer.Deserialize<Redmine.Net.Api.Types.Issue>(input);
+        
+        Assert.NotNull(output);
+        Assert.Equal(5, output.Id);
+        Assert.Equal("Project-Test", output.Project.Name);
+        Assert.Equal(1, output.Project.Id);
+        Assert.Equal("Bug", output.Tracker.Name);
+        Assert.Equal(1, output.Tracker.Id);
+        Assert.Equal("New", output.Status.Name);
+        Assert.Equal(1, output.Status.Id);
+        Assert.True(output.Status.IsClosed);
+        Assert.False(output.Status.IsDefault);
+        Assert.Equal(2, output.FixedVersion.Id);
+        Assert.Equal("version2", output.FixedVersion.Name);
+        Assert.Equal(new DateTime(2025, 4, 28), output.StartDate);
+        Assert.Null(output.DueDate);
+        Assert.Equal(0, output.DoneRatio);
+        Assert.Null(output.EstimatedHours);
+        Assert.Null(output.TotalEstimatedHours);
+
+        var watchers = output.Watchers.ToList();
+        Assert.Equal(2, watchers.Count);
+        
+        Assert.Equal(91, watchers[0].Id);
+        Assert.Equal("Normal User", watchers[0].Name);
+        Assert.Equal(90, watchers[1].Id);
+        Assert.Equal("Admin User", watchers[1].Name);
+    }
 }