Skip to content

APIView server and client unit tests #8889

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.

Sign up for GitHub

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

Merged
praveenkuttappan merged 2 commits into from
Aug 27, 2024
Merged

APIView server and client unit tests #8889

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17fdca0
APIView server and client unit tests
praveenkuttappan Aug 27, 2024
1d2e4b5
Fix SPA tests
praveenkuttappan Aug 27, 2024
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
Prev Previous commit
Fix SPA tests
  • Loading branch information
@praveenkuttappan
praveenkuttappan committed Aug 27, 2024
commit 1d2e4b5a92f19b6ebe922b146363e61f3a0f931d
3 changes: 3 additions & 0 deletions src/dotnet/APIView/APIViewUnitTests/APIViewUnitTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@
</ItemGroup>

<ItemGroup>
<None Update="SampleTestFiles\azure.data.tables.12.9.0_doc_change.json">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
<None Update="SampleTestFiles\azure.data.tables.12.9.0.json">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
Expand Down
120 changes: 47 additions & 73 deletions src/dotnet/APIView/APIViewUnitTests/CodeFileHelpersTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using A;
using ApiView;
using APIView.Model.V2;
using APIView.TreeToken;
Expand All @@ -20,74 +19,9 @@ public class CodeFileHelpersTests

public CodeFileHelpersTests(ITestOutputHelper output)
{

_output = output;
}

[Fact]
public void ComputeAPITreeDiff_Generates_Accurate_TreeDiff()
{
/*var expectedResult = new List<(string id, string diffKind)>
{
("1A", "Unchanged"),
("2A", "Unchanged"),
("2B", "Unchanged"),
("3A", "Removed"),
("3B", "Unchanged"),
("3C", "Unchanged"),
("2C", "Removed"),
("2D", "Unchanged"),
("3A", "Unchanged"),
("3B", "Unchanged"),
("3C", "Added"),
("2E", "Added"),
};
var diffForest = CodeFileHelpers.ComputeAPIForestDiff(apiForestA, apiForestB);
var result = (TraverseForest(diffForest, false))[0];

Assert.Equal(expectedResult.Count, result.Count);
for (int i = 0; i < expectedResult.Count; i++)
{
Assert.Equal(expectedResult[i].id, result[i].id);
Assert.Equal(expectedResult[i].diffKind, result[i].diffKind);
}

diffForest = CodeFileHelpers.ComputeAPIForestDiff(apiForestD, apiForestC);
var result2 = TraverseForest(diffForest, false);

expectedResult = new List<(string id, string diffKind)>
{
("1A", "Unchanged"),
("2A", "Added"),
("2B", "Unchanged"),
("3A", "Added"),
("2C", "Unchanged")
};

Assert.Equal(expectedResult.Count, result2[0].Count);
for (int i = 0; i < expectedResult.Count; i++)
{
Assert.Equal(expectedResult[i].id, result2[0][i].id);
Assert.Equal(expectedResult[i].diffKind, result2[0][i].diffKind);
}

expectedResult = new List<(string id, string diffKind)>
{
("1B", "Unchanged"),
("2A", "Added"),
("2B", "Unchanged"),
("3A", "Removed"),
("2C", "Removed")
};

Assert.Equal(expectedResult.Count, result2[1].Count);
for (int i = 0; i < expectedResult.Count; i++)
{
Assert.Equal(expectedResult[i].id, result2[1][i].id);
Assert.Equal(expectedResult[i].diffKind, result2[1][i].diffKind);
}*/
}

[Fact]
public void ComputeTokenDiff_Verify_API_only_Change_dummy_data()
{
Expand Down Expand Up @@ -244,7 +178,7 @@ public async void VerifyRenderedCodeFile()
//Verify total lines in rendered output
var result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
Assert.Equal(false, result.HasDiff);
Assert.False(result.HasDiff);
Assert.Equal(478, result.NodeMetaData.Count);

//Expected top level nodes 16
Expand All @@ -256,7 +190,7 @@ public async void VerifyRenderedCodeFile()
codePanelRawData.diffRevisionCodeFile = codeFileB;
result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
Assert.Equal(false, result.HasDiff);
Assert.False(result.HasDiff);

//Verify system generated comments
Assert.Equal(15, result.NodeMetaData.Values.Select(v => v.DiagnosticsObj.Count).Sum());
Expand All @@ -274,7 +208,7 @@ public async void VerifyCompareDiffApiSurface()
};
var result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
Assert.Equal(false, result.HasDiff);
Assert.False(result.HasDiff);
Assert.Equal(478, result.NodeMetaData.Count);

//Expected top level nodes 16
Expand All @@ -287,7 +221,7 @@ public async void VerifyCompareDiffApiSurface()
codePanelRawData.diffRevisionCodeFile = codeFileB;
result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
Assert.Equal(true, result.HasDiff);
Assert.True(result.HasDiff);
// Thre is only one API line change difference between 12.9.1 and 12.9.0
Assert.Equal(1, result.NodeMetaData.Values.Count(m => m.IsNodeWithDiff));
}
Expand All @@ -304,7 +238,7 @@ public async void VerifyAttributeLineChangeOnly()
};
var result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
Assert.Equal(false, result.HasDiff);
Assert.False(result.HasDiff);
Assert.Equal(478, result.NodeMetaData.Count);

//Expected top level nodes 16
Expand All @@ -317,7 +251,7 @@ public async void VerifyAttributeLineChangeOnly()
codePanelRawData.diffRevisionCodeFile = codeFileB;
result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
Assert.Equal(true, result.HasDiff);
Assert.True(result.HasDiff);
// Thre is only one API line change difference between 12.9.1 and 12.9.0
Assert.Equal(2, result.NodeMetaData.Values.Count(m => m.IsNodeWithDiff));
var modifiedLines = result.NodeMetaData.Values.Where(m => m.IsNodeWithDiff);
Expand Down Expand Up @@ -345,8 +279,48 @@ public async void VerifySameApiwithDependencyVersionChange()
var result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
//Dependency version change(marked as skip from diff )should not be considered as diff
Assert.Equal(false, result.HasDiff);
Assert.False(result.HasDiff);
Assert.Equal(478, result.NodeMetaData.Count);
}

[Fact]
public async void VerifySameApiwithOnlyDocChange()
{
var testCodeFilePath = Path.Combine("SampleTestFiles", "azure.data.tables.12.9.0.json");
FileInfo fileInfo = new FileInfo(testCodeFilePath);
var codeFile = await CodeFile.DeserializeAsync(fileInfo.Open(FileMode.Open, FileAccess.Read, FileShare.Read));
CodePanelRawData codePanelRawData = new CodePanelRawData()
{
activeRevisionCodeFile = codeFile
};

//Verify rendered result has no diff when comparing different API code files
testCodeFilePath = Path.Combine("SampleTestFiles", "azure.data.tables.12.9.0_doc_change.json");
FileInfo fileInfoB = new FileInfo(testCodeFilePath);
var codeFileB = await CodeFile.DeserializeAsync(fileInfoB.Open(FileMode.Open, FileAccess.Read, FileShare.Read));
codePanelRawData.diffRevisionCodeFile = codeFileB;
var result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
//Doc only change should not flag a revision as different
Assert.False(result.HasDiff);
Assert.Equal(478, result.NodeMetaData.Count);
}

[Fact]
public async void VerifyNavigationNodeCount()
{
var testCodeFilePath = Path.Combine("SampleTestFiles", "azure.data.tables.12.9.0.json");
FileInfo fileInfo = new FileInfo(testCodeFilePath);
var codeFile = await CodeFile.DeserializeAsync(fileInfo.Open(FileMode.Open, FileAccess.Read, FileShare.Read));
CodePanelRawData codePanelRawData = new CodePanelRawData()
{
activeRevisionCodeFile = codeFile
};

var result = await CodeFileHelpers.GenerateCodePanelDataAsync(codePanelRawData);
Assert.NotNull(result);
var navTreeNodeCount = result.NodeMetaData.Values.Count(n => n.NavigationTreeNode != null);
Assert.Equal(42, navTreeNodeCount);
}
}
}
Loading