Files
sql-utilities/tests/Strata.SqlTools.Markdown.Tests/SqlServer/QueryBreakdownGeneratorTests.cs
T
Thom LambandClaude Opus 4.7 5202d93e8e
SonarQube Analysis / sonarqube (pull_request) Successful in 3m30s
chore(sonar)!: mark public Markdown generator methods static (CA1822)
Three public methods on the SqlServer-namespaced Markdown generators no
longer touch instance state and now carry the `static` keyword:

- `Markdown.SqlServer.QueryBreakdownGenerator.GenerateMermaidDiagram(QueryBreakdown, string?)`
- `Markdown.SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(ISqlBreakdown, string?)`
- `Markdown.SqlServer.SqlStatementGenerator.GenerateEntityRelationshipDiagram(IEnumerable<string>, string?)`

Plus one private bonus the analyzer caught on the same pass:
- `LinqExpressionVisitor.ExtractSelectExpression` → static (non-breaking).

Internal callers in the Snowflake/LinqToSql/PostgreSql wrapper classes
and in the test fixtures are updated to the type-name form
(`SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(...)`).
The wrappers retain their `_baseGenerator` field for now even though it
is no longer used — that S4487 / unused-field cleanup is its own commit.

BREAKING CHANGE: External NuGet consumers calling
`generatorInstance.GenerateMermaidDiagram(...)`,
`generatorInstance.GenerateSequenceDiagram(...)`, or
`generatorInstance.GenerateEntityRelationshipDiagram(...)` on the
SqlServer-namespaced generators must switch to type-name form, e.g.
`Markdown.SqlServer.SqlStatementGenerator.GenerateSequenceDiagram(...)`.
Calls through the Snowflake / LinqToSql / PostgreSql wrapper classes are
unaffected at the call site.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-27 14:22:27 -05:00

155 lines
4.6 KiB
C#

using Strata.SqlTools.Breakdowns.SqlServer;
using Strata.SqlTools.Markdown.SqlServer;
using Interfaces = Strata.SqlTools.SqlBreakdown.Interfaces;
namespace Strata.SqlTools.Markdown.Tests.SqlServer;
[TestFixture]
public class QueryBreakdownGeneratorTests
{
private QueryBreakdownGenerator _generator = null!;
[SetUp]
public void Setup()
{
_generator = new QueryBreakdownGenerator();
}
[Test]
public void GenerateMermaidDiagram_WithSimpleQuery_GeneratesFlowchart()
{
// Arrange
var query = new QueryBreakdown("ID, Name", "Users");
// Act
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Does.Contain("```mermaid"));
Assert.That(result, Does.Contain("flowchart TD"));
Assert.That(result, Does.Contain("SELECT"));
Assert.That(result, Does.Contain("FROM"));
Assert.That(result, Does.Contain("```"));
}
[Test]
public void GenerateMermaidDiagram_WithComplexQuery_IncludesAllClauses()
{
// Arrange
var query = new QueryBreakdown(
"u.ID, u.Name, COUNT(o.OrderID) as OrderCount",
"Users u JOIN Orders o ON u.ID = o.UserID",
"u.Active = 1"
);
query.GroupByClause.Clause = "u.ID, u.Name";
query.HavingClause.Clause = "COUNT(o.OrderID) > 5";
query.OrderByClause.Clause = "OrderCount DESC";
// Act
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query, "User Orders Query");
// Assert
Assert.That(result, Does.Contain("### User Orders Query"));
Assert.That(result, Does.Contain("SELECT"));
Assert.That(result, Does.Contain("FROM"));
Assert.That(result, Does.Contain("WHERE"));
Assert.That(result, Does.Contain("GROUP BY"));
Assert.That(result, Does.Contain("HAVING"));
Assert.That(result, Does.Contain("ORDER BY"));
}
[Test]
public void GenerateMermaidDiagram_WithWhereClause_UsesDecisionShape()
{
// Arrange
var query = new QueryBreakdown("*", "Products", "Price > 100");
// Act
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Does.Contain("WHERE"));
Assert.That(result, Does.Contain("{"));
Assert.That(result, Does.Contain("}"));
}
[Test]
public void GenerateMermaidDiagram_ParsedQuery_GeneratesDiagram()
{
// Arrange
var sql = @"
SELECT u.ID, u.Name, u.Email
FROM Users u
WHERE u.Active = 1
ORDER BY u.Name";
var query = QueryBreakdown.Parse(sql);
// Act
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Is.Not.Null);
Assert.That(result, Does.Contain("mermaid"));
Assert.That(result, Does.Contain("SELECT"));
Assert.That(result.Length, Is.GreaterThan(100));
}
[Test]
public void GenerateMermaidDiagram_WithTitle_IncludesTitle()
{
// Arrange
var query = new QueryBreakdown("*", "Users");
// Act
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query, "Test Query");
// Assert
Assert.That(result, Does.StartWith("### Test Query"));
}
[Test]
public void GenerateMermaidDiagram_WithoutTitle_NoTitle()
{
// Arrange
var query = new QueryBreakdown("*", "Users");
// Act
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Does.Not.StartWith("###"));
Assert.That(result, Does.StartWith("```mermaid"));
}
[Test]
public void GenerateMermaidDiagram_WithLongClause_TruncatesText()
{
// Arrange
var longSelect = string.Join(", ", Enumerable.Range(1, 50).Select(i => $"Column{i}"));
var query = new QueryBreakdown(longSelect, "LargeTable");
// Act
var result = QueryBreakdownGenerator.GenerateMermaidDiagram(query);
// Assert
Assert.That(result, Does.Contain("..."));
}
[Test]
public void GenerateMermaidDiagram_ISqlBreakdown_GeneratesSimpleDiagram()
{
// Arrange
var query = new QueryBreakdown("*", "Users");
query.SetupClauses.Add("CREATE TEMP TABLE #Temp (ID INT)");
// Act
var result = _generator.GenerateMermaidDiagram((Interfaces.ISqlBreakdown)query);
// Assert
Assert.That(result, Does.Contain("mermaid"));
Assert.That(result, Does.Contain("flowchart TD"));
Assert.That(result, Does.Contain("Users"));
}
}