Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create unit tests TextViewVisualization #397

Merged
merged 1 commit into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,241 @@
using System.Collections.Generic;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Reveal.Sdk.Dom.Data;
using Reveal.Sdk.Dom.Visualizations;
using Reveal.Sdk.Dom.Visualizations.VisualizationSpecs;
using Xunit;

namespace Reveal.Sdk.Dom.Tests.Visualizations;

public class TextViewVisualizationFixture
{
[Fact]
public void Constructor_FieldsHaveDefaultValues_WhenInstanceIsCreated()
{
// Act
var visualization = new TextViewVisualization();

// Assert
Assert.Null(visualization.Title);
Assert.Null(visualization.DataDefinition);
Assert.Equal(ChartType.TextView, visualization.ChartType);
Assert.NotNull(visualization.Columns);
Assert.Empty(visualization.Columns);
}

[Fact]
public void Constructor_SetsDataSourceItem_WhenOnlyDataSourceItemProvided()
{
// Arrange
var dataSourceItem = new DataSourceItem();

// Act
var visualization = new TextViewVisualization(dataSourceItem);

// Assert
Assert.Equal(dataSourceItem, visualization.DataDefinition.DataSourceItem);
Assert.Equal(ChartType.TextView, visualization.ChartType);
}

[Fact]
public void Constructor_SetsTitleAndDataSourceItem_WhenBothArgumentsAreProvided()
{
// Arrange
var title = "Text View Visualization";
var dataSourceItem = new DataSourceItem();

// Act
var visualization = new TextViewVisualization(title, dataSourceItem);

// Assert
Assert.Equal(title, visualization.Title);
Assert.Equal(dataSourceItem, visualization.DataDefinition.DataSourceItem);
Assert.Equal(ChartType.TextView, visualization.ChartType);
}

[Fact]
public void Columns_ReturnsCorrectValues_WhenVisualizationDataSpecIsGridVisualizationDataSpec()
{
// Arrange
var expectedColumns = new List<TabularColumn>
{
new TabularColumn { FieldName = "Column1" },
new TabularColumn { FieldName = "Column2" }
};

var visualization = new TextViewVisualization
{
VisualizationDataSpec = new GridVisualizationDataSpec
{
Columns = expectedColumns
}
};

// Act
var actualColumns = visualization.Columns;

// Assert
Assert.Equal(expectedColumns, actualColumns);
}

[Fact]
public void Columns_ReturnsEmptyList_WhenVisualizationDataSpecIsNotGridVisualizationDataSpec()
{
// Arrange
var visualization = new TextViewVisualization
{
VisualizationDataSpec = new VisualizationDataSpec()
};

// Act
var actualColumns = visualization.Columns;

// Assert
Assert.Empty(actualColumns);
}

[Fact]
public void ToJsonString_GeneratesCorrectJson_WhenSerialized()
{
// Arrange
var expectedJson =
"""
[ {
"Id" : "33077d1e-19c5-44fe-b981-6765af3156a8",
"Title" : "TextView",
"IsTitleVisible" : true,
"ColumnSpan" : 0,
"RowSpan" : 0,
"VisualizationSettings" : {
"_type" : "SingleRowVisualizationSettingsType",
"VisualizationType" : "SINGLE_ROW"
},
"DataSpec" : {
"_type" : "TabularDataSpecType",
"IsTransposed" : false,
"Fields" : [ {
"FieldName" : "Date",
"FieldLabel" : "Date",
"UserCaption" : "Date",
"IsCalculated" : false,
"Properties" : { },
"Sorting" : "None",
"FieldType" : "Date"
}, {
"FieldName" : "Territory",
"FieldLabel" : "Territory",
"UserCaption" : "Territory",
"IsCalculated" : false,
"Properties" : { },
"Sorting" : "None",
"FieldType" : "Number"
}, {
"FieldName" : "Spend",
"FieldLabel" : "Spend",
"UserCaption" : "Spend",
"IsCalculated" : false,
"Properties" : { },
"Sorting" : "None",
"FieldType" : "Number"
} ],
"TransposedFields" : [ ],
"QuickFilters" : [ ],
"AdditionalTables" : [ ],
"ServiceAdditionalTables" : [ ],
"DataSourceItem" : {
"_type" : "DataSourceItemType",
"Id" : "080cc17d-4a0a-4837-aa3f-ef2571ea443a",
"Title" : "Marketing Sheet",
"Subtitle" : "Excel Data Source Item",
"DataSourceId" : "__EXCEL",
"HasTabularData" : true,
"HasAsset" : false,
"Properties" : {
"Sheet" : "Marketing"
},
"Parameters" : { },
"ResourceItem" : {
"_type" : "DataSourceItemType",
"Id" : "d593dd79-7161-4929-afc9-c26393f5b650",
"Title" : "Marketing Sheet",
"Subtitle" : "Excel Data Source Item",
"DataSourceId" : "33077d1e-19c5-44fe-b981-6765af3156a6",
"HasTabularData" : true,
"HasAsset" : false,
"Properties" : {
"Url" : "http://dl.infragistics.com/reportplus/reveal/samples/Samples.xlsx"
},
"Parameters" : { }
}
},
"Expiration" : 1440,
"Bindings" : {
"Bindings" : [ ]
}
},
"VisualizationDataSpec" : {
"_type" : "GridVisualizationDataSpecType",
"Columns" : [ {
"_type" : "TabularColumnSpecType",
"FieldName" : "Territory",
"Sorting" : "None"
}, {
"_type" : "TabularColumnSpecType",
"FieldName" : "Conversions",
"Sorting" : "None"
}, {
"_type" : "TabularColumnSpecType",
"FieldName" : "Spend",
"Sorting" : "None"
} ]
}
} ]
""";

var document = new RdashDocument("My Dashboard");

var excelDataSourceItem = new RestDataSourceItem("Marketing Sheet")
{
Id = "080cc17d-4a0a-4837-aa3f-ef2571ea443a",
Subtitle = "Excel Data Source Item",
Url = "http://dl.infragistics.com/reportplus/reveal/samples/Samples.xlsx",
IsAnonymous = true,
ResourceItem = new DataSourceItem
{
Id = "d593dd79-7161-4929-afc9-c26393f5b650",
DataSourceId = "33077d1e-19c5-44fe-b981-6765af3156a6",
Title = "Marketing Sheet",
Subtitle = "Excel Data Source Item",
HasTabularData = true,
HasAsset = false,
Properties = new Dictionary<string, object>
{
{ "Url", "http://dl.infragistics.com/reportplus/reveal/samples/Samples.xlsx" }
}
},
Fields = new List<IField>
{
new DateField("Date"),
new NumberField("Territory"),
new NumberField("Spend"),
}
};
excelDataSourceItem.UseExcel("Marketing");

document.Visualizations.Add(new TextViewVisualization("TextView", excelDataSourceItem)
{
Id = "33077d1e-19c5-44fe-b981-6765af3156a8"
}
.SetColumns("Territory", "Conversions", "Spend"));

// Act
var json = document.ToJsonString();
var actualJson = JObject.Parse(json)["Widgets"];
var actualNormalized = JsonConvert.SerializeObject(actualJson, Formatting.Indented);
var expectedNormalized = JArray.Parse(expectedJson).ToString(Formatting.Indented);

// Assert
Assert.Equal(expectedNormalized.Trim(), actualNormalized.Trim());
}
}
2 changes: 1 addition & 1 deletion src/Reveal.Sdk.Dom/Visualizations/TextViewVisualization.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public TextViewVisualization(DataSourceItem dataSourceItem) : this(null, dataSou
public TextViewVisualization(string title, DataSourceItem dataSourceItem) : base(title, dataSourceItem) { ChartType = ChartType.TextView; }

[JsonProperty(Order = 7)]
VisualizationDataSpec VisualizationDataSpec { get; set; } = new GridVisualizationDataSpec();
internal VisualizationDataSpec VisualizationDataSpec { get; set; } = new GridVisualizationDataSpec();

[JsonIgnore]
public List<TabularColumn> Columns
Expand Down
Loading