using ClosedXML.Excel; using JdeScoping.ExcelIO.Options; using JdeScoping.ExcelIO.Generators; using JdeScoping.ExcelIO.Helpers; using JdeScoping.ExcelIO.Models.Reporting; using Microsoft.Extensions.Options; using Shouldly; using Xunit; namespace JdeScoping.ExcelIO.Tests; public class CriteriaSheetGeneratorTests { private readonly CriteriaSheetGenerator _generator; private readonly IOptions _options; public CriteriaSheetGeneratorTests() { _options = Microsoft.Extensions.Options.Options.Create(new ExcelExportOptions { CriteriaSheetPassword = "TestPassword" }); var cache = new OutputColumnCache(); var tableWriter = new AttributeTableWriter(cache); _generator = new CriteriaSheetGenerator(_options, tableWriter); } [Fact] public void Generate_CreatesSearchCriteriaSheet() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); _generator.Generate(workbook, search); workbook.Worksheets.TryGetWorksheet("Search Criteria", out var worksheet).ShouldBeTrue(); worksheet.ShouldNotBeNull(); } [Fact] public void Generate_ContainsSearchName() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.Name = "Test Search Name"; _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); worksheet.Cell(1, 1).Value.GetText().ShouldBe("Search Name"); worksheet.Cell(1, 2).Value.GetText().ShouldBe("Test Search Name"); } [Fact] public void Generate_ContainsUserName() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.UserName = "testuser"; _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); worksheet.Cell(2, 1).Value.GetText().ShouldBe("User Name"); worksheet.Cell(2, 2).Value.GetText().ShouldBe("testuser"); } [Fact] public void Generate_ContainsTimestamps() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); var submitDt = new DateTime(2024, 1, 15, 10, 30, 0); var startDt = new DateTime(2024, 1, 15, 10, 31, 0); var endDt = new DateTime(2024, 1, 15, 10, 35, 0); search.SubmitDt = submitDt; search.StartDt = startDt; search.EndDt = endDt; _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); worksheet.Cell(4, 1).Value.GetText().ShouldBe("Submit timestamp"); worksheet.Cell(4, 2).Value.GetText().ShouldContain("Jan 15, 2024"); worksheet.Cell(5, 1).Value.GetText().ShouldBe("Start timestamp"); worksheet.Cell(5, 2).Value.GetText().ShouldContain("Jan 15, 2024"); worksheet.Cell(6, 1).Value.GetText().ShouldBe("Completed timestamp"); worksheet.Cell(6, 2).Value.GetText().ShouldContain("Jan 15, 2024"); } [Fact] public void Generate_ContainsTimespanFilterTable() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.MinimumDt = new DateTime(2024, 1, 1); search.MaximumDt = new DateTime(2024, 12, 31); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; tables.Any(t => t.Name == "Timespan_Filter").ShouldBeTrue(); } [Fact] public void Generate_ContainsWorkOrderFilterTable() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.WorkOrderFilter.Add(new WorkOrderFilterEntry { WorkOrderNumber = 12345, ItemNumber = "ITEM-001" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; tables.Any(t => t.Name == "Work_Order_Filter").ShouldBeTrue(); } [Fact] public void Generate_ContainsItemNumberFilterTable() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.ItemNumberFilter.Add(new ItemNumberFilterEntry { ItemNumber = "ITEM-001" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; tables.Any(t => t.Name == "Item_Number_Filter").ShouldBeTrue(); } [Fact] public void Generate_ContainsProfitCenterFilterTable() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.ProfitCenterFilter.Add(new ProfitCenterFilterEntry { Code = "PC01", Description = "Profit Center 1" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; tables.Any(t => t.Name == "Profit_Center_Filter").ShouldBeTrue(); } [Fact] public void Generate_ContainsWorkCenterFilterTable() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.WorkCenterFilter.Add(new WorkCenterFilterEntry { Code = "WC01", Description = "Work Center 1" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; tables.Any(t => t.Name == "Work_Center_Filter").ShouldBeTrue(); } [Fact] public void Generate_ContainsOperatorFilterTable() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.OperatorFilter.Add(new OperatorFilterEntry { UserId = "OP01", FullName = "Operator 1" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; tables.Any(t => t.Name == "Operator_Filter").ShouldBeTrue(); } [Fact] public void Generate_ContainsComponentLotFilterTable() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.ComponentLotFilter.Add(new ComponentLotFilterEntry { LotNumber = "LOT001" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; tables.Any(t => t.Name == "Component_Lot_Filter").ShouldBeTrue(); } [Fact] public void Generate_ContainsItemOperationMisFilterTable() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.ItemOperationMisFilter.Add(new ItemOperationMisFilterEntry { ItemNumber = "ITEM-001", OperationNumber = "10", MisNumber = "MIS-001" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; tables.Any(t => t.Name == "Item_Operation_MIS_Filter").ShouldBeTrue(); } [Fact] public void Generate_ContainsExtractMisDataIndicator_WhenTrue() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.ExtractMisData = true; _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); // Find the "Extract MIS data?" header and check for YES var cells = worksheet.CellsUsed(); var extractMisCell = cells.FirstOrDefault(c => c.Value.ToString() == "YES" || c.Value.ToString() == "NO"); extractMisCell.ShouldNotBeNull(); extractMisCell.Value.GetText().ShouldBe("YES"); } [Fact] public void Generate_ContainsExtractMisDataIndicator_WhenFalse() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.ExtractMisData = false; _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); // Find the "Extract MIS data?" header and check for NO var cells = worksheet.CellsUsed(); var extractMisCell = cells.FirstOrDefault(c => c.Value.ToString() == "YES" || c.Value.ToString() == "NO"); extractMisCell.ShouldNotBeNull(); extractMisCell.Value.GetText().ShouldBe("NO"); } [Fact] public void Generate_AppliesHeaderFormatting() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); // Search Name header should be bold with Gainsboro background var headerCell = worksheet.Cell(1, 1); headerCell.Style.Font.Bold.ShouldBeTrue(); headerCell.Style.Fill.BackgroundColor.ShouldBe(XLColor.Gainsboro); } [Fact] public void Generate_AppliesProtection() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); worksheet.Protection.IsProtected.ShouldBeTrue(); } [Fact] public void Generate_TablesHaveLight18Style() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.WorkOrderFilter.Add(new WorkOrderFilterEntry { WorkOrderNumber = 12345, ItemNumber = "ITEM-001" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var table = worksheet.Tables.First(t => t.Name == "Work_Order_Filter"); table.Theme.ShouldBe(XLTableTheme.TableStyleLight18); } [Fact] public void Generate_FilterTables_Have2BlankRowSpacing() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.WorkOrderFilter.Add(new WorkOrderFilterEntry { WorkOrderNumber = 12345, ItemNumber = "ITEM-001" }); search.ItemNumberFilter.Add(new ItemNumberFilterEntry { ItemNumber = "ITEM-001" }); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var woTable = worksheet.Tables.First(t => t.Name == "Work_Order_Filter"); var itemTable = worksheet.Tables.First(t => t.Name == "Item_Number_Filter"); // There should be 2 blank rows between tables. With the header row of the next table, that's a gap of 3 // Looking at CriteriaSheetGenerator: row = table.RangeAddress.LastAddress.RowNumber + 3 // This means the next table starts 3 rows after the last row, leaving 2 blank rows in between var gap = itemTable.RangeAddress.FirstAddress.RowNumber - woTable.RangeAddress.LastAddress.RowNumber; // Gap includes header row of next table, so: 2 blank rows + 1 header = gap of 3 // But with table header (Timespan_Filter has ShowHeader=true), add 1 more gap.ShouldBeGreaterThanOrEqualTo(3); } [Fact] public void Generate_NullTimestamps_ShowEmptyValue() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.SubmitDt = null; search.StartDt = null; search.EndDt = null; _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); worksheet.Cell(4, 2).Value.ToString().ShouldBe(string.Empty); worksheet.Cell(5, 2).Value.ToString().ShouldBe(string.Empty); worksheet.Cell(6, 2).Value.ToString().ShouldBe(string.Empty); } [Fact] public void Generate_ColumnsAreAutoFitWithPadding() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.Name = "A Very Long Search Name That Needs Extra Width"; _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); // Columns should have been adjusted - verify they have non-default width worksheet.Column(1).Width.ShouldBeGreaterThan(0); worksheet.Column(2).Width.ShouldBeGreaterThan(0); } [Fact] public void Generate_MultipleFiltersWithData_CreatesAllTables() { using var workbook = new XLWorkbook(); var search = CreateFullSearchModel(); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var tables = worksheet.Tables; // Should have 8 filter tables tables.Count().ShouldBe(8); tables.Any(t => t.Name == "Timespan_Filter").ShouldBeTrue(); tables.Any(t => t.Name == "Work_Order_Filter").ShouldBeTrue(); tables.Any(t => t.Name == "Item_Number_Filter").ShouldBeTrue(); tables.Any(t => t.Name == "Profit_Center_Filter").ShouldBeTrue(); tables.Any(t => t.Name == "Work_Center_Filter").ShouldBeTrue(); tables.Any(t => t.Name == "Component_Lot_Filter").ShouldBeTrue(); tables.Any(t => t.Name == "Operator_Filter").ShouldBeTrue(); tables.Any(t => t.Name == "Item_Operation_MIS_Filter").ShouldBeTrue(); } [Fact] public void Generate_TimestampFormat_IncludesESTSuffix() { using var workbook = new XLWorkbook(); var search = CreateMinimalSearchModel(); search.SubmitDt = new DateTime(2024, 1, 15, 10, 30, 45); _generator.Generate(workbook, search); var worksheet = workbook.Worksheet("Search Criteria"); var timestampValue = worksheet.Cell(4, 2).Value.GetText(); timestampValue.ShouldContain("EST"); timestampValue.ShouldContain("10:30:45"); } private static SearchModel CreateMinimalSearchModel() { return new SearchModel { Id = 1, Name = "Test Search", UserName = "testuser", SubmitDt = DateTime.Now.AddHours(-1), StartDt = DateTime.Now.AddMinutes(-30), EndDt = DateTime.Now, ExtractMisData = false }; } private static SearchModel CreateFullSearchModel() { return new SearchModel { Id = 1, Name = "Full Search", UserName = "testuser", SubmitDt = DateTime.Now.AddHours(-1), StartDt = DateTime.Now.AddMinutes(-30), EndDt = DateTime.Now, MinimumDt = new DateTime(2024, 1, 1), MaximumDt = new DateTime(2024, 12, 31), ExtractMisData = true, WorkOrderFilter = [new WorkOrderFilterEntry { WorkOrderNumber = 12345, ItemNumber = "ITEM-001" }], ItemNumberFilter = [new ItemNumberFilterEntry { ItemNumber = "ITEM-001" }], ProfitCenterFilter = [new ProfitCenterFilterEntry { Code = "PC01", Description = "Profit Center 1" }], WorkCenterFilter = [new WorkCenterFilterEntry { Code = "WC01", Description = "Work Center 1" }], OperatorFilter = [new OperatorFilterEntry { UserId = "OP01", FullName = "Operator 1" }], ComponentLotFilter = [new ComponentLotFilterEntry { LotNumber = "LOT001" }], ItemOperationMisFilter = [new ItemOperationMisFilterEntry { ItemNumber = "ITEM-001", OperationNumber = "10", MisNumber = "MIS-001" }] }; } }