Skip to content

[clang-include-cleaner] Fix incorrect directory issue for writing files #111375

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
merged 9 commits into from
Oct 17, 2024
Merged

[clang-include-cleaner] Fix incorrect directory issue for writing files #111375

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
23b90bb
[clang-include-cleaner] Fix incorrect directory issue for writing files
bc-lee Oct 7, 2024
eef397c
Fix path issue identified by @kadircet
bc-lee Oct 9, 2024
2409d6f
Apply code review feedback
bc-lee Oct 10, 2024
0c9477d
Add test cases where the cwd and the compilation database's directory…
bc-lee Oct 10, 2024
dec9be8
Fix the previous commit that removed existing test cases
bc-lee Oct 10, 2024
b39f36e
Make clang-format happy
bc-lee Oct 10, 2024
3a0f02e
Fix unittest failures in Windows
bc-lee Oct 10, 2024
c65d828
Apply review comments.
bc-lee Oct 13, 2024
11f78a3
Apply review comments
bc-lee Oct 14, 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
15 changes: 9 additions & 6 deletions clang-tools-extra/include-cleaner/test/tool.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,15 @@ int x = foo();
// RUN: FileCheck --match-full-lines --check-prefix=EDIT2 %s < %t.cpp
// EDIT2-NOT: {{^}}#include "foo.h"{{$}}

// This test has commands that rely on shell capabilities that won't execute
// correctly on Windows e.g. subshell execution
// REQUIRES: shell
Copy link
Member

@kadircet kadircet Oct 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doesn't just affect that particular run, affects the whole, can you move the test into its own file ?

Copy link
Contributor Author

@bc-lee bc-lee Oct 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was explained in the previous comment. It now works on Windows as well.

// RUN: mkdir -p $(dirname %t)/out
Copy link
Member

@kadircet kadircet Oct 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use %T instead of dirname %t, you can find full list in https://llvm.org/docs/CommandGuide/lit.html#substitutions, same below.

also it's safer to run a rm -rf %T beforehand to make sure we're starting clean

Copy link
Contributor Author

@bc-lee bc-lee Oct 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It turns out %T is also deprecated. I replaced my shell invocation with %t.dir, as this is the recommended method, as described in https://reviews.llvm.org/D69572. I also slightly modified the test invocation so that it works on Windows as well. (Tested on a local Windows machine.)

// RUN: cp %s %t.cpp
// RUN: echo "[{\"directory\":\"$(dirname %t)/out\",\"file\":\"../$(basename %t).cpp\",\"command\":\":clang++ -I%S/Inputs/ ../$(basename %t).cpp\"}]" > $(dirname %t)/out/compile_commands.json
// RUN: pushd $(dirname %t)
// RUN: clang-include-cleaner -p out -edit $(basename %t).cpp
// RUN: popd
// RUN: FileCheck --match-full-lines --check-prefix=EDIT3 %s < %t.cpp
// EDIT3: #include "foo.h"
// EDIT3-NOT: {{^}}#include "foobar.h"{{$}}
// RUN: pushd $(dirname %t)
// RUN: clang-include-cleaner -p out -edit $(basename %t).cpp
// RUN: popd
// RUN: FileCheck --match-full-lines --check-prefix=EDIT3 %s < %t.cpp
// EDIT3: #include "foo.h"
// EDIT3-NOT: {{^}}#include "foobar.h"{{$}}
Loading