This is an archive of the discontinued LLVM Phabricator instance.

Differential D64669

[clang-doc] Fix failing tests on Windows
ClosedPublic

Authored by DiegoAstiazaran on Jul 12 2019, 2:46 PM.

Details

Reviewers
juliehockett
jakehehrlich
lebedev.ri
Commits
rGb131ad0be284: [clang-doc] Fix failing tests on Windows
rCTE365967: [clang-doc] Fix failing tests on Windows
rL365967: [clang-doc] Fix failing tests on Windows
Summary

Tests on Windows were failing due to path separator differences.
'/' was being used as separator in the expected output, paths in expected output are now changed to their native form before comparing them to the actual output.

Diff Detail

Event Timeline

DiegoAstiazaran created this revision.Jul 12 2019, 2:46 PM
juliehockett accepted this revision.Jul 12 2019, 3:04 PM

LGTM

This revision is now accepted and ready to land.Jul 12 2019, 3:04 PM
Closed by commit rL365967: [clang-doc] Fix failing tests on Windows (authored by juliehockett). · Explain WhyJul 12 2019, 3:18 PM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptJul 12 2019, 3:18 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript

Revision Contents

PathSize
clang-tools-extra/
unittests/
clang-doc/
31 lines

Diff 209601

clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp

Show First 20 Lines • Show All 73 Lines • ▼ Show 20 LinesTEST(HTMLGeneratorTest, emitRecordHTML) {
RecordInfo I; RecordInfo I;
I.Name = "r"; I.Name = "r";
I.Path = "X/Y/Z"; I.Path = "X/Y/Z";
I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace); I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"}); I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"});
I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"}); I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"});
SmallString<16> PathTo;
llvm::sys::path::native("path/to", PathTo);
I.Members.emplace_back("int", "X/Y", "X", AccessSpecifier::AS_private); I.Members.emplace_back("int", "X/Y", "X", AccessSpecifier::AS_private);
I.TagType = TagTypeKind::TTK_Class; I.TagType = TagTypeKind::TTK_Class;
I.Parents.emplace_back(EmptySID, "F", InfoType::IT_record, I.Parents.emplace_back(EmptySID, "F", InfoType::IT_record, PathTo);
llvm::SmallString<128>("path/to"));
I.VirtualParents.emplace_back(EmptySID, "G", InfoType::IT_record); I.VirtualParents.emplace_back(EmptySID, "G", InfoType::IT_record);
I.ChildRecords.emplace_back(EmptySID, "ChildStruct", InfoType::IT_record); I.ChildRecords.emplace_back(EmptySID, "ChildStruct", InfoType::IT_record);
I.ChildFunctions.emplace_back(); I.ChildFunctions.emplace_back();
I.ChildFunctions.back().Name = "OneFunction"; I.ChildFunctions.back().Name = "OneFunction";
I.ChildEnums.emplace_back(); I.ChildEnums.emplace_back();
I.ChildEnums.back().Name = "OneEnum"; I.ChildEnums.back().Name = "OneEnum";
auto G = getHTMLGenerator(); auto G = getHTMLGenerator();
assert(G); assert(G);
std::string Buffer; std::string Buffer;
llvm::raw_string_ostream Actual(Buffer); llvm::raw_string_ostream Actual(Buffer);
auto Err = G->generateDocForInfo(&I, Actual); auto Err = G->generateDocForInfo(&I, Actual);
assert(!Err); assert(!Err);
SmallString<16> PathToF;
llvm::sys::path::native("../../../path/to/F.html", PathToF);
SmallString<16> PathToInt;
llvm::sys::path::native("../int.html", PathToInt);
std::string Expected = R"raw(<!DOCTYPE html> std::string Expected = R"raw(<!DOCTYPE html>
<meta charset="utf-8"/> <meta charset="utf-8"/>
<title>class r</title> <title>class r</title>
<div> <div>
<h1>class r</h1> <h1>class r</h1>
<p> <p>
Defined at line 10 of test.cpp Defined at line 10 of test.cpp
</p> </p>
<p> <p>
Inherits from Inherits from
<a href="../../../path/to/F.html">F</a> <a href=")raw" + std::string(PathToF.str()) +
R"raw(">F</a>
, G , G
</p> </p>
<h2>Members</h2> <h2>Members</h2>
<ul> <ul>
<li>private <a href="../int.html">int</a> X</li> <li>private <a href=")raw" +
std::string(PathToInt.str()) + R"raw(">int</a> X</li>
</ul> </ul>
<h2>Records</h2> <h2>Records</h2>
<ul> <ul>
<li>ChildStruct</li> <li>ChildStruct</li>
</ul> </ul>
<h2>Functions</h2> <h2>Functions</h2>
<div> <div>
<h3>OneFunction</h3> <h3>OneFunction</h3>
Show All 14 Lines
TEST(HTMLGeneratorTest, emitFunctionHTML) { TEST(HTMLGeneratorTest, emitFunctionHTML) {
FunctionInfo I; FunctionInfo I;
I.Name = "f"; I.Name = "f";
I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace); I.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"}); I.DefLoc = Location(10, llvm::SmallString<16>{"test.cpp"});
I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"}); I.Loc.emplace_back(12, llvm::SmallString<16>{"test.cpp"});
I.ReturnType = TypeInfo(EmptySID, "float", InfoType::IT_default, "path/to"); SmallString<16> PathTo;
I.Params.emplace_back("int", "path/to", "P"); llvm::sys::path::native("path/to", PathTo);
I.ReturnType = TypeInfo(EmptySID, "float", InfoType::IT_default, PathTo);
I.Params.emplace_back("int", PathTo, "P");
I.IsMethod = true; I.IsMethod = true;
I.Parent = Reference(EmptySID, "Parent", InfoType::IT_record); I.Parent = Reference(EmptySID, "Parent", InfoType::IT_record);
auto G = getHTMLGenerator(); auto G = getHTMLGenerator();
assert(G); assert(G);
std::string Buffer; std::string Buffer;
llvm::raw_string_ostream Actual(Buffer); llvm::raw_string_ostream Actual(Buffer);
auto Err = G->generateDocForInfo(&I, Actual); auto Err = G->generateDocForInfo(&I, Actual);
assert(!Err); assert(!Err);
SmallString<16> PathToFloat;
llvm::sys::path::native("path/to/float.html", PathToFloat);
SmallString<16> PathToInt;
llvm::sys::path::native("path/to/int.html", PathToInt);
std::string Expected = R"raw(<!DOCTYPE html> std::string Expected = R"raw(<!DOCTYPE html>
<meta charset="utf-8"/> <meta charset="utf-8"/>
<title></title> <title></title>
<div> <div>
<h3>f</h3> <h3>f</h3>
<p> <p>
<a href="path/to/float.html">float</a> <a href=")raw" + std::string(PathToFloat.str()) +
R"raw(">float</a>
f( f(
<a href="path/to/int.html">int</a> <a href=")raw" + std::string(PathToInt.str()) +
R"raw(">int</a>
P) P)
</p> </p>
<p> <p>
Defined at line 10 of test.cpp Defined at line 10 of test.cpp
</p> </p>
</div> </div>
)raw"; )raw";
▲ Show 20 Lines • Show All 109 Lines • Show Last 20 Lines