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.

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

Improve display name for string and char #3082

Merged
merged 20 commits into from
Jun 10, 2024
Merged

Improve display name for string and char #3082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
81511fb
Improve display name when DataRow contains arrays
MichelZ May 31, 2024
a07dd44
Mark GetObjectString as static
MichelZ May 31, 2024
ec5b115
Handle primitive types with boxing
MichelZ May 31, 2024
5595303
Update tests with newly expected values, Add test for value type
MichelZ May 31, 2024
e6e9fa1
Improve styling of the method
MichelZ Jun 1, 2024
e439821
Fix stackoverflow
MichelZ Jun 3, 2024
b27eb45
Avoid need for breaking change
Evangelink Jun 10, 2024
dbec6ce
Merge branch 'main' into main
Evangelink Jun 10, 2024
689fa0b
Improve display of null and empty string values
MichelZ Jun 10, 2024
cc65770
Merge branch 'microsoft:main' into main
MichelZ Jun 10, 2024
de6a41b
Improve display of null and empty string values
MichelZ Jun 10, 2024
50068a1
Merge branch 'mize/1647_datarow_null_empty' of https://github.com/Mic…
MichelZ Jun 10, 2024
852fe42
Update src/TestFramework/TestFramework/Attributes/DataSource/DataRowA…
MichelZ Jun 10, 2024
880b0f9
Surround strings with " and chars with '
MichelZ Jun 10, 2024
f02f120
Adjust test cases for new string/char rules
MichelZ Jun 10, 2024
c67e473
Satisfy code analyzer
MichelZ Jun 10, 2024
a65887c
Update test/IntegrationTests/MSTest.IntegrationTests/Parameterized te…
MichelZ Jun 10, 2024
1d2bc3e
Improve tests
MichelZ Jun 10, 2024
8ed5759
Fix some more integration tests
MichelZ Jun 10, 2024
7c9ef89
Fix test
MichelZ Jun 10, 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
17 changes: 13 additions & 4 deletions src/TestFramework/TestFramework/Attributes/DataSource/DataRowAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,24 @@ public DataRowAttribute(params object?[]? data)
/// </summary>
private static string? GetObjectString(object? obj)
{
if (TestIdGenerationStrategy != TestIdGenerationStrategy.FullyQualified)
{
return obj?.ToString();
}

if (obj == null)
{
return null;
return "null";
}

if (TestIdGenerationStrategy != TestIdGenerationStrategy.FullyQualified
|| !obj.GetType().IsArray)
if (!obj.GetType().IsArray)
Evangelink marked this conversation as resolved.
Show resolved Hide resolved
MichelZ marked this conversation as resolved.
Show resolved Hide resolved
{
return obj.ToString();
return obj switch
{
string s => $"\"{s}\"",
char c => $"'{c}'",
_ => obj.ToString(),
};
}

// We need to box the object here so that we can support value types
Expand Down
6 changes: 3 additions & 3 deletions test/IntegrationTests/MSTest.IntegrationTests/ClsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ public void TestsAreRun()
testResults,
"TestMethod",
"IntDataRow (10)",
"StringDataRow (some string)",
"StringDataRow2 (some string)",
"StringDataRow2 (some other string)");
"StringDataRow (\"some string\")",
"StringDataRow2 (\"some string\")",
"StringDataRow2 (\"some other string\")");
}
}
18 changes: 9 additions & 9 deletions test/IntegrationTests/MSTest.IntegrationTests/Parameterized tests/DataExtensibilityTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,17 @@ public void ExecuteCustomTestExtensibilityWithTestDataTests()
// Assert
VerifyE2E.TestsPassed(
testResults,
"CustomTestMethod2 (B)",
"CustomTestMethod2 (B)",
"CustomTestMethod2 (B)");
"CustomTestMethod2 (\"B\")",
"CustomTestMethod2 (\"B\")",
"CustomTestMethod2 (\"B\")");

VerifyE2E.TestsFailed(
testResults,
"CustomTestMethod2 (A)",
"CustomTestMethod2 (A)",
"CustomTestMethod2 (A)",
"CustomTestMethod2 (C)",
"CustomTestMethod2 (C)",
"CustomTestMethod2 (C)");
"CustomTestMethod2 (\"A\")",
"CustomTestMethod2 (\"A\")",
"CustomTestMethod2 (\"A\")",
"CustomTestMethod2 (\"C\")",
"CustomTestMethod2 (\"C\")",
"CustomTestMethod2 (\"C\")");
}
}
78 changes: 39 additions & 39 deletions test/IntegrationTests/MSTest.IntegrationTests/Parameterized tests/DataRowTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ public void ExecuteOnlyDerivedClassDataRowsWhenBothBaseAndDerivedClassHasDataRow
// Assert
VerifyE2E.TestsPassed(
testResults,
"DataRowTestMethod (BaseString1)",
"DataRowTestMethod (BaseString2)",
"DataRowTestMethod (BaseString3)",
"DataRowTestMethod (DerivedString1)",
"DataRowTestMethod (DerivedString2)");
"DataRowTestMethod (\"BaseString1\")",
"DataRowTestMethod (\"BaseString2\")",
"DataRowTestMethod (\"BaseString3\")",
"DataRowTestMethod (\"DerivedString1\")",
"DataRowTestMethod (\"DerivedString2\")");
}

public void ExecuteOnlyDerivedClassDataRowsWhenItOverridesBaseClassDataRows_SimpleDataRows()
Expand All @@ -40,8 +40,8 @@ public void ExecuteOnlyDerivedClassDataRowsWhenItOverridesBaseClassDataRows_Simp
// Assert
VerifyE2E.TestsPassed(
testResults,
"DataRowTestMethod (DerivedString1)",
"DataRowTestMethod (DerivedString2)");
"DataRowTestMethod (\"DerivedString1\")",
"DataRowTestMethod (\"DerivedString2\")");
}

public void DataRowsExecuteWithRequiredAndOptionalParameters()
Expand All @@ -57,8 +57,8 @@ public void DataRowsExecuteWithRequiredAndOptionalParameters()
VerifyE2E.TestsPassed(
testResults,
"DataRowTestMethodWithSomeOptionalParameters (123)",
"DataRowTestMethodWithSomeOptionalParameters (123,DerivedOptionalString1)",
"DataRowTestMethodWithSomeOptionalParameters (123,DerivedOptionalString2,DerivedOptionalString3)");
"DataRowTestMethodWithSomeOptionalParameters (123,\"DerivedOptionalString1\")",
"DataRowTestMethodWithSomeOptionalParameters (123,\"DerivedOptionalString2\",\"DerivedOptionalString3\")");
}

public void DataRowsExecuteWithParamsArrayParameter()
Expand All @@ -74,9 +74,9 @@ public void DataRowsExecuteWithParamsArrayParameter()
VerifyE2E.TestsPassed(
testResults,
"DataRowTestMethodWithParamsParameters (2)",
"DataRowTestMethodWithParamsParameters (2,DerivedSingleParamsArg)",
"DataRowTestMethodWithParamsParameters (2,DerivedParamsArg1,DerivedParamsArg2)",
"DataRowTestMethodWithParamsParameters (2,DerivedParamsArg1,DerivedParamsArg2,DerivedParamsArg3)");
"DataRowTestMethodWithParamsParameters (2,\"DerivedSingleParamsArg\")",
"DataRowTestMethodWithParamsParameters (2,\"DerivedParamsArg1\",\"DerivedParamsArg2\")",
"DataRowTestMethodWithParamsParameters (2,\"DerivedParamsArg1\",\"DerivedParamsArg2\",\"DerivedParamsArg3\")");
}

public void DataRowsFailWhenInvalidArgumentsProvided()
Expand All @@ -93,7 +93,7 @@ public void DataRowsFailWhenInvalidArgumentsProvided()
testResults,
"DataRowTestMethodFailsWithInvalidArguments ()",
"DataRowTestMethodFailsWithInvalidArguments (2)",
"DataRowTestMethodFailsWithInvalidArguments (2,DerivedRequiredArgument,DerivedOptionalArgument,DerivedExtraArgument)");
"DataRowTestMethodFailsWithInvalidArguments (2,\"DerivedRequiredArgument\",\"DerivedOptionalArgument\",\"DerivedExtraArgument\")");
}

public void DataRowsShouldSerializeDoublesProperly()
Expand Down Expand Up @@ -124,7 +124,7 @@ public void DataRowsShouldSerializeMixedTypesProperly()
// Assert
VerifyE2E.TestsPassed(
testResults,
"DataRowTestMixed (10,10,10,10,10,10,10,10)");
"DataRowTestMixed (10,10,10,10,10,10,10,\"10\")");
}

public void DataRowsShouldSerializeEnumsProperly()
Expand All @@ -139,7 +139,7 @@ public void DataRowsShouldSerializeEnumsProperly()
// Assert
VerifyE2E.TestsPassed(
testResults,
"DataRowEnums ()",
"DataRowEnums (null)",
"DataRowEnums (Alfa)",
"DataRowEnums (Beta)",
"DataRowEnums (Gamma)");
Expand Down Expand Up @@ -202,35 +202,35 @@ public void ExecuteDataRowTests_Enums()
"DataRowEnum_ULong (Alfa)",
"DataRowEnum_ULong (Beta)",
"DataRowEnum_ULong (Gamma)",
"DataRowEnums_Nullable_SByte ()",
"DataRowEnums_Nullable_SByte (null)",
"DataRowEnums_Nullable_SByte (Alfa)",
"DataRowEnums_Nullable_SByte (Beta)",
"DataRowEnums_Nullable_SByte (Gamma)",
"DataRowEnums_Nullable_Byte ()",
"DataRowEnums_Nullable_Byte (null)",
"DataRowEnums_Nullable_Byte (Alfa)",
"DataRowEnums_Nullable_Byte (Beta)",
"DataRowEnums_Nullable_Byte (Gamma)",
"DataRowEnums_Nullable_Short ()",
"DataRowEnums_Nullable_Short (null)",
"DataRowEnums_Nullable_Short (Alfa)",
"DataRowEnums_Nullable_Short (Beta)",
"DataRowEnums_Nullable_Short (Gamma)",
"DataRowEnums_Nullable_UShort ()",
"DataRowEnums_Nullable_UShort (null)",
"DataRowEnums_Nullable_UShort (Alfa)",
"DataRowEnums_Nullable_UShort (Beta)",
"DataRowEnums_Nullable_UShort (Gamma)",
"DataRowEnums_Nullable_Int ()",
"DataRowEnums_Nullable_Int (null)",
"DataRowEnums_Nullable_Int (Alfa)",
"DataRowEnums_Nullable_Int (Beta)",
"DataRowEnums_Nullable_Int (Gamma)",
"DataRowEnums_Nullable_UInt ()",
"DataRowEnums_Nullable_UInt (null)",
"DataRowEnums_Nullable_UInt (Alfa)",
"DataRowEnums_Nullable_UInt (Beta)",
"DataRowEnums_Nullable_UInt (Gamma)",
"DataRowEnums_Nullable_Long ()",
"DataRowEnums_Nullable_Long (null)",
"DataRowEnums_Nullable_Long (Alfa)",
"DataRowEnums_Nullable_Long (Beta)",
"DataRowEnums_Nullable_Long (Gamma)",
"DataRowEnums_Nullable_ULong ()",
"DataRowEnums_Nullable_ULong (null)",
"DataRowEnums_Nullable_ULong (Alfa)",
"DataRowEnums_Nullable_ULong (Beta)",
"DataRowEnums_Nullable_ULong (Gamma)",
Expand Down Expand Up @@ -275,23 +275,23 @@ public void ExecuteDataRowTests_Regular()
"DataRow1 (20)",
"DataRow1 (30)",
"DataRow1 (40)",
"DataRow2 (10,String parameter,True,False)",
"DataRow2 (20,String parameter,True,False)",
"DataRow2 (30,String parameter,True,False)",
"DataRow2 (40,String parameter,True,False)",
"DataRow2 (10,\"String parameter\",True,False)",
"DataRow2 (20,\"String parameter\",True,False)",
"DataRow2 (30,\"String parameter\",True,False)",
"DataRow2 (40,\"String parameter\",True,False)",
"DataRowTestDouble (10.01,20.01)",
"DataRowTestDouble (10.02,20.02)",
"DataRowTestMixed (1,10,10,10,10,10,10,10,10)",
"DataRowTestMixed (2,10,10,10,10,10,10,10,10)",
"DataRowTestMixed (3,10,10,10,10,10,10,10,10)",
"DataRowTestMixed (4,10,10,10,10,10,10,10,10)",
"NullValueInData (john.doe@example.com,abc123,)",
"NullValueInData (john.doe@example.com,abc123,/unit/test)",
"NullValue ()",
"OneStringArray ([])",
"TwoStringArrays ([],[1.4,message])",
"OneObjectArray ([,1])",
"TwoObjectArrays ([,1],[3])",
"DataRowTestMixed (1,10,10,10,10,10,10,10,\"10\")",
"DataRowTestMixed (2,10,10,10,10,10,10,10,\"10\")",
"DataRowTestMixed (3,10,10,10,10,10,10,10,\"10\")",
"DataRowTestMixed (4,10,10,10,10,10,10,10,\"10\")",
"NullValueInData (\"john.doe@example.com\",\"abc123\",null)",
"NullValueInData (\"john.doe@example.com\",\"abc123\",\"/unit/test\")",
"NullValue (null)",
"OneStringArray ([\"\"])",
"TwoStringArrays ([\"\"],[\"1.4\",\"message\"])",
"OneObjectArray ([\"\",1])",
"TwoObjectArrays ([\"\",1],[3])",
"ThreeObjectArrays ([1],[2],[3])",
"FourObjectArrays ([1],[2],[3],[4])",
"FiveObjectArrays ([1],[2],[3],[4],[5])",
Expand All @@ -312,6 +312,6 @@ public void ExecuteDataRowTests_Regular()
testResults,
"DataRowTestMethodFailsWithInvalidArguments ()",
"DataRowTestMethodFailsWithInvalidArguments (2)",
"DataRowTestMethodFailsWithInvalidArguments (2,DerivedRequiredArgument,DerivedOptionalArgument,DerivedExtraArgument)");
"DataRowTestMethodFailsWithInvalidArguments (2,\"DerivedRequiredArgument\",\"DerivedOptionalArgument\",\"DerivedExtraArgument\")");
}
}
8 changes: 4 additions & 4 deletions test/IntegrationTests/MSTest.IntegrationTests/TestId.DefaultStrategy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ public void TestIdUniqueness_DataRowString_DefaultStrategy()
VerifyE2E.FailedTestCount(testResults, 0);
VerifyE2E.TestsPassed(
testResults,
"DataRowStringTests ()",
"DataRowStringTests ()",
"DataRowStringTests ( )",
"DataRowStringTests ( )");
"DataRowStringTests (null)",
"DataRowStringTests (\"\")",
"DataRowStringTests (\" \")",
"DataRowStringTests (\" \")");

// We cannot assert the expected ID as it is path dependent
testResults.Select(x => x.TestCase.Id.ToString()).Should().OnlyHaveUniqueItems();
Expand Down
8 changes: 4 additions & 4 deletions test/IntegrationTests/MSTest.IntegrationTests/TestId.FullyQualifiedStrategy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ public void TestIdUniqueness_DataRowString_FullyQualifiedStrategy()
VerifyE2E.FailedTestCount(testResults, 0);
VerifyE2E.TestsPassed(
testResults,
"DataRowStringTests ()",
"DataRowStringTests ()",
"DataRowStringTests ( )",
"DataRowStringTests ( )");
"DataRowStringTests (null)",
"DataRowStringTests (\"\")",
"DataRowStringTests (\" \")",
"DataRowStringTests (\" \")");

// We cannot assert the expected ID as it is path dependent
testResults.Select(x => x.TestCase.Id.ToString()).Should().OnlyHaveUniqueItems();
Expand Down
18 changes: 9 additions & 9 deletions ...STest.VstestConsoleWrapper.IntegrationTests/Parameterized tests/DataExtensibilityTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,17 @@ public void ExecuteCustomTestExtensibilityWithTestDataTests()
InvokeVsTestForExecution([TestAssetName], testCaseFilter: "FullyQualifiedName~CustomTestExTests.CustomTestMethod2");

ValidatePassedTests(
"CustomTestMethod2 (B)",
"CustomTestMethod2 (B)",
"CustomTestMethod2 (B)");
"CustomTestMethod2 (\"B\")",
"CustomTestMethod2 (\"B\")",
"CustomTestMethod2 (\"B\")");
ValidateFailedTestsCount(6);
ValidateFailedTestsContain(
true,
"CustomTestMethod2 (A)",
"CustomTestMethod2 (A)",
"CustomTestMethod2 (A)",
"CustomTestMethod2 (C)",
"CustomTestMethod2 (C)",
"CustomTestMethod2 (C)");
"CustomTestMethod2 (\"A\")",
"CustomTestMethod2 (\"A\")",
"CustomTestMethod2 (\"A\")",
"CustomTestMethod2 (\"C\")",
"CustomTestMethod2 (\"C\")",
"CustomTestMethod2 (\"C\")");
}
}
Loading