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.

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

Add clang-tidy checks on CI #555

Merged
merged 13 commits into from
Feb 23, 2025
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
1 change: 1 addition & 0 deletions .clang-tidy
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Checks: "clang-diagnostic-*,clang-analyzer-*"
49 changes: 49 additions & 0 deletions .github/workflows/clang-tidy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Clang Tidy

on:
schedule:
- cron: "0 1 * * *"
push:
branches: [main]
paths-ignore:
- CODEOWNERS
- requirements.txt
- LICENSE.txt
- .pre-commit-config.yaml
- '**/*.md'
pull_request:
branches: [main]
paths-ignore:
- CODEOWNERS
- requirements.txt
- LICENSE.txt
- .pre-commit-config.yaml
- '**/*.md'

env:
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
BUILD_TYPE: Debug

jobs:
clang-tidy:
# The CMake configure and build commands are platform agnostic and should work equally
# well on Windows or Mac. You can convert this to a matrix build if you need
# cross-platform coverage.
# See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: seanmiddleditch/gha-setup-ninja@master

- name: Configure CMake # We need `compile_commands.json` to be generated.
run: cmake --preset Release

- name: clang-tidy
run: |
python scripts/reduce_compile_commands.py build/compile_commands.json > compile_commands.json
PROJECT_SOURCE_FILES="$(python scripts/reduce_compile_commands.py build/compile_commands.json \
--names-only \
--exclude_dirs build exploration compile_checks benchmarks)"
echo $PROJECT_SOURCE_FILES \
| xargs clang-tidy -warnings-as-errors="*" -p compile_commands.json
5 changes: 0 additions & 5 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ xyz_add_library(
target_sources(indirect_cxx14
INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/indirect_cxx14.h>
PRIVATE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/indirect_cxx14.cc>
)

Expand All @@ -68,7 +67,6 @@ xyz_add_library(
target_sources(indirect_cxx17
INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/indirect_cxx14.h>
PRIVATE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/indirect_cxx14.cc>
)

Expand All @@ -79,7 +77,6 @@ xyz_add_library(
target_sources(polymorphic
INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/polymorphic.h>
PRIVATE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/polymorphic.cc>
)

Expand All @@ -92,7 +89,6 @@ xyz_add_library(
target_sources(polymorphic_cxx14
INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/polymorphic_cxx14.h>
PRIVATE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/polymorphic_cxx14.cc>
)

Expand All @@ -105,7 +101,6 @@ xyz_add_library(
target_sources(polymorphic_cxx17
INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/polymorphic_cxx14.h>
PRIVATE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/polymorphic_cxx14.cc>
)

Expand Down
2 changes: 1 addition & 1 deletion CMakePresets.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
},
{
"name": "default",
"binaryDir": "${sourceDir}/build/${presetName}",
"binaryDir": "${sourceDir}/build",
"cacheVariables": {
"CMAKE_INSTALL_PREFIX": "${sourceDir}/install/${presetName}",
"CMAKE_INTERPROCEDURAL_OPTIMIZATION": true
Expand Down
80 changes: 53 additions & 27 deletions indirect_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,8 @@ TEST(IndirectTest, MovePreservesIndirectObjectAddress) {
auto address = &*a;
auto aa = std::move(a);

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
EXPECT_EQ(address, &*aa);
}

Expand All @@ -204,7 +205,8 @@ TEST(IndirectTest, AllocatorExtendedMove) {
auto address = &*a;
xyz::indirect<int> aa(std::allocator_arg, a.get_allocator(), std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
EXPECT_EQ(address, &*aa);
}

Expand All @@ -231,7 +233,8 @@ TEST(IndirectTest, MoveAssignment) {
EXPECT_EQ(*a, 42);
a = std::move(b);

EXPECT_TRUE(b.valueless_after_move());
EXPECT_TRUE(
b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
EXPECT_EQ(*a, 101);
}

Expand All @@ -252,7 +255,8 @@ TEST(IndirectTest, ConvertingAssignmentValueless) {
xyz::indirect<int> a;
xyz::indirect<int> aa(std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
a = 42;
EXPECT_EQ(*a, 42);
}
Expand Down Expand Up @@ -286,70 +290,86 @@ TEST(IndirectTest, CopyFromValueless) {
xyz::indirect<int> a;
xyz::indirect<int> aa(std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
xyz::indirect<int> b(a);
EXPECT_TRUE(b.valueless_after_move());
EXPECT_TRUE(
b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, MoveFromValueless) {
xyz::indirect<int> a;
xyz::indirect<int> aa(std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
xyz::indirect<int> b(std::move(a));
EXPECT_TRUE(b.valueless_after_move());
EXPECT_TRUE(
b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, AllocatorExtendedCopyFromValueless) {
xyz::indirect<int> a;
xyz::indirect<int> aa(std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
xyz::indirect<int> b(std::allocator_arg, a.get_allocator(), a);
EXPECT_TRUE(b.valueless_after_move());
EXPECT_TRUE(
b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, AllocatorExtendedMoveFromValueless) {
xyz::indirect<int> a;
xyz::indirect<int> aa(std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
xyz::indirect<int> b(std::allocator_arg, a.get_allocator(), std::move(a));
EXPECT_TRUE(b.valueless_after_move());
EXPECT_TRUE(
b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, AssignFromValueless) {
xyz::indirect<int> a;
xyz::indirect<int> aa(std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
xyz::indirect<int> b;
b = a;
EXPECT_TRUE(b.valueless_after_move());
EXPECT_TRUE(
b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, MoveAssignFromValueless) {
xyz::indirect<int> a;
xyz::indirect<int> aa(std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
xyz::indirect<int> b;
b = std::move(a);
EXPECT_TRUE(b.valueless_after_move());
EXPECT_TRUE(
b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, SwapFromValueless) {
xyz::indirect<int> a;
xyz::indirect<int> aa(std::move(a));

EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
xyz::indirect<int> b;
EXPECT_TRUE(!b.valueless_after_move());
EXPECT_TRUE(
!b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)

using std::swap;
swap(a, b);
EXPECT_TRUE(!a.valueless_after_move());
EXPECT_TRUE(b.valueless_after_move());
EXPECT_TRUE(
!a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
EXPECT_TRUE(
b.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, ConstPropagation) {
Expand Down Expand Up @@ -390,7 +410,7 @@ TEST(IndirectTest, Hash) {
auto make_valueless_indirect() {
xyz::indirect<int> a;
auto aa = std::move(a);
return a;
return a; // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, HashValueless) {
Expand Down Expand Up @@ -732,7 +752,8 @@ TEST(IndirectTest, CountAllocationsForAssignmentToMovedFromObject) {
std::allocator_arg,
xyz::TrackingAllocator<int>(&alloc_counter, &dealloc_counter),
xyz::in_place_t{}, 404);
EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
a = c; // This will cause an allocation as a is valueless.
EXPECT_EQ(alloc_counter, 4);
EXPECT_EQ(dealloc_counter, 1);
Expand Down Expand Up @@ -961,7 +982,8 @@ TEST(IndirectTest, TaggedAllocatorsEqualMoveConstruct) {
xyz::indirect<int, xyz::TaggedAllocator<int>> ii(std::allocator_arg, aa,
std::move(i));

EXPECT_TRUE(i.valueless_after_move());
EXPECT_TRUE(
i.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
EXPECT_EQ(*ii, -1);
}

Expand All @@ -985,7 +1007,8 @@ TEST(IndirectTest, TaggedAllocatorsNotEqualMoveConstruct) {
xyz::indirect<int, xyz::TaggedAllocator<int>> ii(std::allocator_arg, aa,
std::move(i));

EXPECT_FALSE(i.valueless_after_move());
EXPECT_FALSE(
i.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
EXPECT_EQ(*ii, -1);
}

Expand All @@ -1001,18 +1024,21 @@ TEST(IndirectTest, TaggedAllocatorsNotEqualMoveConstructFromValueless) {
xyz::in_place_t{}, -1);

xyz::indirect<int, xyz::TaggedAllocator<int>> ii(std::move(i));
EXPECT_TRUE(i.valueless_after_move());
EXPECT_TRUE(
i.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)

// Move construct from the now valueless i.
xyz::indirect<int, xyz::TaggedAllocator<int>> iii(std::allocator_arg, aa,
std::move(i));
EXPECT_TRUE(iii.valueless_after_move());
EXPECT_TRUE(
iii.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

TEST(IndirectTest, SupportNonCopyableType) {
xyz::indirect<xyz::NonCopyable> a;
auto aa = std::move(a);
EXPECT_TRUE(a.valueless_after_move());
EXPECT_TRUE(
a.valueless_after_move()); // NOLINT(clang-analyzer-cplusplus.Move)
}

} // namespace
Expand Down
Loading