Merge pull request #66 from cake-contrib/feature/gh-44

(GH-44) HtmlDxDataGrid: Add possibility to define additional columns

Author: pascalberger

src/Cake.Issues.Reporting.Generic.Tests/Cake.Issues.Reporting.Generic.Tests.csproj

@@ -85,6 +85,8 @@
   <ItemGroup>
     <Compile Include="ColumnSortOrderExtensionsTests.cs" />
     <Compile Include="DevExtremeThemeExtensionsTests.cs" />
+    <Compile Include="ExceptionAssertExtensions.cs" />
+    <Compile Include="HtmlDxDataGridColumnDescriptionTests.cs" />
     <Compile Include="IIssueExtensionTests.cs" />
     <Compile Include="UriExtensionsTests.cs" />
     <Compile Include="FileLinkSettingsTests.cs" />

src/Cake.Issues.Reporting.Generic.Tests/ExceptionAssertExtensions.cs

@@ -0,0 +1,23 @@
+namespace Cake.Issues.Reporting.Generic.Tests
+{
+    using System;
+    using Microsoft.CSharp.RuntimeBinder;
+    using Xunit;
+
+    /// <summary>
+    /// Extensions for asserting exceptions.
+    /// </summary>
+    internal static class ExceptionAssertExtensions
+    {
+        /// <summary>
+        /// Checks if an execption is of type <see cref="T:Microsoft.CSharp.RuntimeBinder.RuntimeBinderException" />.
+        /// </summary>
+        /// <param name="exception">Exception to check.</param>
+        /// <param name="message">Expected exception message.</param>
+        public static void IsRuntimeBinderException(this Exception exception, string message)
+        {
+            Assert.IsType<RuntimeBinderException>(exception);
+            Assert.Equal(message, exception.Message);
+        }
+    }
+}

src/Cake.Issues.Reporting.Generic.Tests/HtmlDxDataGridColumnDescriptionTests.cs

@@ -0,0 +1,112 @@
+namespace Cake.Issues.Reporting.Generic.Tests
+{
+    using System;
+    using Cake.Issues.Testing;
+    using Shouldly;
+    using Xunit;
+
+    public sealed class HtmlDxDataGridColumnDescriptionTests
+    {
+        public sealed class TheCtor
+        {
+            [Fact]
+            public void Should_Throw_If_Id_Is_Null()
+            {
+                // Given
+                string id = null;
+                object valueRetriever(IIssue issue)
+                {
+                    return true;
+                }
+
+                // When
+                var result = Record.Exception(() => new HtmlDxDataGridColumnDescription(id, valueRetriever));
+
+                // Then
+                result.IsArgumentNullException("id");
+            }
+
+            [Fact]
+            public void Should_Throw_If_Id_Is_Empty()
+            {
+                // Given
+                var id = string.Empty;
+                object valueRetriever(IIssue issue)
+                {
+                    return true;
+                }
+
+                // When
+                var result = Record.Exception(() => new HtmlDxDataGridColumnDescription(id, valueRetriever));
+
+                // Then
+                result.IsArgumentOutOfRangeException("id");
+            }
+
+            [Fact]
+            public void Should_Throw_If_Id_Is_Whitespace()
+            {
+                // Given
+                var id = " ";
+                object valueRetriever(IIssue issue)
+                {
+                    return true;
+                }
+
+                // When
+                var result = Record.Exception(() => new HtmlDxDataGridColumnDescription(id, valueRetriever));
+
+                // Then
+                result.IsArgumentOutOfRangeException("id");
+            }
+
+            [Fact]
+            public void Should_Throw_If_ValueRetriever_Is_Null()
+            {
+                // Given
+                var id = "foo";
+                Func<IIssue, object> valueRetriever = null;
+
+                // When
+                var result = Record.Exception(() => new HtmlDxDataGridColumnDescription(id, valueRetriever));
+
+                // Then
+                result.IsArgumentNullException("valueRetriever");
+            }
+
+            [Fact]
+            public void Should_Assign_Id()
+            {
+                // Given
+                var id = "foo";
+                object valueRetriever(IIssue issue)
+                {
+                    return true;
+                }
+
+                // When
+                var result = new HtmlDxDataGridColumnDescription(id, valueRetriever);
+
+                // Then
+                result.Id.ShouldBe(id);
+            }
+
+            [Fact]
+            public void Should_Assign_ValueRetriever()
+            {
+                // Given
+                var id = "foo";
+                object valueRetriever(IIssue issue)
+                {
+                    return true;
+                }
+
+                // When
+                var result = new HtmlDxDataGridColumnDescription(id, valueRetriever);
+
+                // Then
+                result.ValueRetriever.ShouldBe(valueRetriever);
+            }
+        }
+    }
+}

src/Cake.Issues.Reporting.Generic.Tests/HtmlDxDataGridTemplateTests.cs

@@ -127,5 +127,42 @@ public void Should_Not_Show_Header_If_False()
                 headingElements.ShouldBeEmpty();
             }
         }
+
+        public sealed class TheAdditionalColumnsOption
+        {
+            [Fact]
+            public void Should_Not_Fail_On_Report_Creation()
+            {
+                // Given
+                var fixture = new GenericIssueReportFixture(GenericIssueReportTemplate.HtmlDxDataGrid);
+                fixture.GenericIssueReportFormatSettings
+                    .WithOption(
+                        HtmlDxDataGridOption.AdditionalColumns,
+                        new List<HtmlDxDataGridColumnDescription>
+                        {
+                            new HtmlDxDataGridColumnDescription("MyCustomColumn", x => { return "Foo"; })
+                            {
+                                Caption = "Custom Value",
+                            }
+                        });
+
+                // When
+                var result =
+                    fixture.CreateReport(
+                        new List<IIssue>
+                        {
+                            IssueBuilder
+                                .NewIssue("Message Foo", "ProviderType Foo", "ProviderName Foo")
+                                .InFile(@"src\Cake.Issues.Reporting.Generic.Tests\Foo.cs", 10)
+                                .OfRule("Rule Foo")
+                                .WithPriority(IssuePriority.Warning)
+                                .Create(),
+                        });
+
+                // Then
+                // Currently only checks if genertions failed or not without checking actual output.
+                result.ShouldNotBeNull();
+            }
+        }
     }
 }