ci: add clang-tidy check (#5)

BewareMyPower · web-flow · commit 084b45d76c83 · 2025-05-20T19:26:30.000+08:00
diff --git a/.clang-tidy b/.clang-tidy
@@ -0,0 +1,67 @@
+---
+Checks: >
+  # It follows https://github.com/googleapis/google-cloud-cpp/blob/main/.clang-tidy
+  -*,
+  abseil-*,
+  bugprone-*,
+  google-*,
+  misc-*,
+  modernize-*,
+  performance-*,
+  portability-*,
+  readability-*,
+  -google-readability-braces-around-statements,
+  -google-readability-namespace-comments,
+  -google-runtime-references,
+  -misc-non-private-member-variables-in-classes,
+  -misc-const-correctness,
+  -misc-include-cleaner,
+  -modernize-return-braced-init-list,
+  -modernize-use-trailing-return-type,
+  -modernize-concat-nested-namespaces,
+  -modernize-use-nodiscard,
+  -modernize-avoid-c-arrays,
+  -modernize-type-traits,
+  -modernize-unary-static-assert,
+  -performance-move-const-arg,
+  -performance-avoid-endl,
+  -performance-enum-size,
+  -readability-braces-around-statements,
+  -readability-identifier-length,
+  -readability-magic-numbers,
+  -readability-named-parameter,
+  -readability-redundant-declaration,
+  -readability-avoid-return-with-void-value,
+  -readability-function-cognitive-complexity,
+  -bugprone-narrowing-conversions,
+  -bugprone-easily-swappable-parameters,
+  -bugprone-inc-dec-in-conditions,
+  -bugprone-implicit-widening-of-multiplication-result,
+  -bugprone-unchecked-optional-access,
+  -bugprone-unused-local-non-trivial-variable,
+  -bugprone-unused-return-value
+WarningsAsErrors: '*'
+HeaderFileExtensions:
+  - ''
+  - h
+ImplementationFileExtensions:
+  - cc
+HeaderFilterRegex: '.*'
+FormatStyle:     none
+User:            xuyunze
+CheckOptions:
+  cert-err33-c.CheckedFunctions: '^::aligned_alloc;^::asctime_s;^::at_quick_exit;^::atexit;^::bsearch;^::bsearch_s;^::btowc;^::c16rtomb;^::c32rtomb;^::calloc;^::clock;^::cnd_broadcast;^::cnd_init;^::cnd_signal;^::cnd_timedwait;^::cnd_wait;^::ctime_s;^::fclose;^::fflush;^::fgetc;^::fgetpos;^::fgets;^::fgetwc;^::fopen;^::fopen_s;^::fprintf;^::fprintf_s;^::fputc;^::fputs;^::fputwc;^::fputws;^::fread;^::freopen;^::freopen_s;^::fscanf;^::fscanf_s;^::fseek;^::fsetpos;^::ftell;^::fwprintf;^::fwprintf_s;^::fwrite;^::fwscanf;^::fwscanf_s;^::getc;^::getchar;^::getenv;^::getenv_s;^::gets_s;^::getwc;^::getwchar;^::gmtime;^::gmtime_s;^::localtime;^::localtime_s;^::malloc;^::mbrtoc16;^::mbrtoc32;^::mbsrtowcs;^::mbsrtowcs_s;^::mbstowcs;^::mbstowcs_s;^::memchr;^::mktime;^::mtx_init;^::mtx_lock;^::mtx_timedlock;^::mtx_trylock;^::mtx_unlock;^::printf_s;^::putc;^::putwc;^::raise;^::realloc;^::remove;^::rename;^::scanf;^::scanf_s;^::setlocale;^::setvbuf;^::signal;^::snprintf;^::snprintf_s;^::sprintf;^::sprintf_s;^::sscanf;^::sscanf_s;^::strchr;^::strerror_s;^::strftime;^::strpbrk;^::strrchr;^::strstr;^::strtod;^::strtof;^::strtoimax;^::strtok;^::strtok_s;^::strtol;^::strtold;^::strtoll;^::strtoul;^::strtoull;^::strtoumax;^::strxfrm;^::swprintf;^::swprintf_s;^::swscanf;^::swscanf_s;^::thrd_create;^::thrd_detach;^::thrd_join;^::thrd_sleep;^::time;^::timespec_get;^::tmpfile;^::tmpfile_s;^::tmpnam;^::tmpnam_s;^::tss_create;^::tss_get;^::tss_set;^::ungetc;^::ungetwc;^::vfprintf;^::vfprintf_s;^::vfscanf;^::vfscanf_s;^::vfwprintf;^::vfwprintf_s;^::vfwscanf;^::vfwscanf_s;^::vprintf_s;^::vscanf;^::vscanf_s;^::vsnprintf;^::vsnprintf_s;^::vsprintf;^::vsprintf_s;^::vsscanf;^::vsscanf_s;^::vswprintf;^::vswprintf_s;^::vswscanf;^::vswscanf_s;^::vwprintf_s;^::vwscanf;^::vwscanf_s;^::wcrtomb;^::wcschr;^::wcsftime;^::wcspbrk;^::wcsrchr;^::wcsrtombs;^::wcsrtombs_s;^::wcsstr;^::wcstod;^::wcstof;^::wcstoimax;^::wcstok;^::wcstok_s;^::wcstol;^::wcstold;^::wcstoll;^::wcstombs;^::wcstombs_s;^::wcstoul;^::wcstoull;^::wcstoumax;^::wcsxfrm;^::wctob;^::wctrans;^::wctype;^::wmemchr;^::wprintf_s;^::wscanf;^::wscanf_s;'
+  cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor: 'true'
+  cppcoreguidelines-special-member-functions.AllowMissingMoveFunctionsWhenCopyIsDeleted: 'true'
+  performance-move-const-arg.CheckTriviallyCopyableMove: 'false'
+  readability-identifier-naming.LocalVariableCase: 'lower_case'
+  readability-identifier-naming.LocalConstantCase: 'lower_case'
+  readability-identifier-naming.StructCase: 'CamelCase'
+  readability-identifier-naming.ClassCase: 'CamelCase'
+  readability-identifier-naming.ParameterCase: 'lower_case'
+  readability-identifier-naming.MethodCase: 'lower_case'
+  readability-identifier-naming.FunctionCase: 'lower_case'
+  readability-identifier-naming.MemberCase: 'lower_case'
+  readability-identifier-naming.PrivateMemberSuffix: '_'
+  readability-identifier-naming.PublicMemberSuffix: ''
+SystemHeaders: false
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -0,0 +1,57 @@
+# Copyright 2025 Yunze Xu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  lint:
+    name: Lint check
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Install necessary tools
+        run: |
+          sudo apt-get install -y clang-tidy
+
+      - name: Build
+        run: |
+          cmake -B build
+          cmake --build build -j4
+
+      - name: Tidy
+        run: |
+          run-clang-tidy -p build
+          if [[ $? -ne 0 ]]; then
+            echo "clang-tidy failed"
+            exit 1
+          fi
diff --git a/include/snctl-cpp/configs.h b/include/snctl-cpp/configs.h
@@ -26,7 +26,7 @@
 
 struct KafkaConfigs {
   std::string bootstrap_servers = "localhost:9092";
-  std::string token = "";
+  std::string token;
 };
 
 struct LogConfigs {
@@ -39,7 +39,7 @@ struct LogConfigs {
 
 class Configs : public SubCommand {
 public:
-  Configs(argparse::ArgumentParser &parent) : SubCommand("configs") {
+  explicit Configs(argparse::ArgumentParser &parent) : SubCommand("configs") {
     update_command_.add_description("Update key-value from the INI section");
     update_command_.add_argument("--kafka-url")
         .help("The Kafka bootstrap.servers");
@@ -55,15 +55,15 @@ class Configs : public SubCommand {
       if (!std::filesystem::exists(file)) {
         continue;
       }
-      if (loadFile(file)) {
+      if (load_file(file)) {
         break;
       }
     }
     if (config_file_.empty()) {
       config_file_ = std::filesystem::current_path() / "sncloud.ini";
       std::cout << "No config file found. Creating " << config_file_
                 << " with the default configs" << std::endl;
-      saveFile();
+      save_file();
     }
   }
 
@@ -98,7 +98,7 @@ class Configs : public SubCommand {
         }
       }
       if (updated) {
-        saveFile();
+        save_file();
         std::cout << "Updated config file " << config_file_ << std::endl;
       } else {
         std::cout << "No config updated" << std::endl;
@@ -122,16 +122,16 @@ class Configs : public SubCommand {
   KafkaConfigs kafka_configs_;
   LogConfigs log_configs_;
 
-  std::optional<std::string> getValue(const std::string &section,
-                                      const std::string &key) {
-    auto value = ini_.GetValue(section.c_str(), key.c_str());
+  std::optional<std::string> get_value(const std::string &section,
+                                       const std::string &key) {
+    const auto *value = ini_.GetValue(section.c_str(), key.c_str());
     if (value == nullptr) {
       return std::nullopt;
     }
     return std::optional(value);
   }
 
-  bool loadFile(const std::string &file) {
+  bool load_file(const std::string &file) {
     if (auto rc = ini_.LoadFile(file.c_str()); rc != SI_OK) {
       std::cerr << "Failed to load existing file " << file << ": " << rc
                 << std::endl;
@@ -143,20 +143,20 @@ class Configs : public SubCommand {
     log_configs_ = {};
 
     // load configs from the INI file
-    if (auto value = getValue("kafka", "bootstrap.servers"); value) {
+    if (auto value = get_value("kafka", "bootstrap.servers"); value) {
       kafka_configs_.bootstrap_servers = *value;
     } else {
       std::cerr << "No bootstrap.servers found in the kafka section. Use the "
                    "default value: "
                 << kafka_configs_.bootstrap_servers << std::endl;
     }
-    if (auto value = getValue("kafka", "token"); value) {
+    if (auto value = get_value("kafka", "token"); value) {
       kafka_configs_.token = *value;
     }
-    if (auto value = getValue("log", "enabled"); value) {
+    if (auto value = get_value("log", "enabled"); value) {
       log_configs_.enabled = std::string(*value) != "false";
       if (log_configs_.enabled) {
-        if (auto value = getValue("log", "path"); value) {
+        if (auto value = get_value("log", "path"); value) {
           log_configs_.path = *value;
         }
       }
@@ -166,7 +166,7 @@ class Configs : public SubCommand {
     return true;
   }
 
-  void saveFile() {
+  void save_file() {
     ini_.SetValue("kafka", "bootstrap.servers",
                   kafka_configs_.bootstrap_servers.c_str());
     ini_.SetValue("kafka", "token", kafka_configs_.token.c_str());
diff --git a/include/snctl-cpp/rk_event_wrapper.h b/include/snctl-cpp/rk_event_wrapper.h
@@ -20,9 +20,9 @@
 
 class RdKafkaEvent final {
 public:
-  static RdKafkaEvent poll(rd_kafka_t *rk, rd_kafka_queue_t *rkqu) {
-    auto event = rd_kafka_queue_poll(rkqu, -1 /* infinite timeout */);
-    if (rd_kafka_event_error(event)) {
+  static RdKafkaEvent poll(rd_kafka_queue_t *rkqu) {
+    auto *event = rd_kafka_queue_poll(rkqu, -1 /* infinite timeout */);
+    if (rd_kafka_event_error(event) != RD_KAFKA_RESP_ERR_NO_ERROR) {
       throw std::runtime_error(rd_kafka_event_error_string(event));
     }
     return RdKafkaEvent(event);
@@ -45,5 +45,5 @@ class RdKafkaEvent final {
 private:
   rd_kafka_event_t *event_;
 
-  RdKafkaEvent(rd_kafka_event_t *event) : event_(event) {}
+  explicit RdKafkaEvent(rd_kafka_event_t *event) : event_(event) {}
 };
diff --git a/include/snctl-cpp/subcommand.h b/include/snctl-cpp/subcommand.h
@@ -22,9 +22,9 @@
 
 class SubCommand {
 public:
-  SubCommand(const std::string &name) : name_(name), handle_(name) {}
+  explicit SubCommand(const std::string &name) : name_(name), handle_(name) {}
 
-  bool used_by_parent(argparse::ArgumentParser &parent) const noexcept {
+  bool used_by_parent(argparse::ArgumentParser &parent) const {
     return parent.is_subcommand_used(handle_);
   }
 
diff --git a/include/snctl-cpp/topics.h b/include/snctl-cpp/topics.h
@@ -26,7 +26,7 @@
 
 class Topics : public SubCommand {
 public:
-  Topics(argparse::ArgumentParser &parent) : SubCommand("topics") {
+  explicit Topics(argparse::ArgumentParser &parent) : SubCommand("topics") {
     create_command_.add_description("Create a topic");
     create_command_.add_argument("topic").help("Topic to create").required();
     create_command_.add_argument("-p")
diff --git a/include/snctl-cpp/topics/create_topic.h b/include/snctl-cpp/topics/create_topic.h
@@ -28,8 +28,8 @@
 inline void create_topic(rd_kafka_t *rk, rd_kafka_queue_t *rkqu,
                          const std::string &topic, int num_partitions) {
   std::array<char, 512> errstr;
-  auto rk_topic = rd_kafka_NewTopic_new(topic.c_str(), num_partitions, 1,
-                                        errstr.data(), errstr.size());
+  auto *rk_topic = rd_kafka_NewTopic_new(topic.c_str(), num_partitions, 1,
+                                         errstr.data(), errstr.size());
   if (rk_topic == nullptr) {
     throw std::runtime_error("Failed to create topic: " +
                              std::string(errstr.data()));
@@ -39,7 +39,7 @@ inline void create_topic(rd_kafka_t *rk, rd_kafka_queue_t *rkqu,
   rd_kafka_CreateTopics(rk, &rk_topic, 1, nullptr, rkqu);
 
   try {
-    RdKafkaEvent::poll(rk, rkqu);
+    RdKafkaEvent::poll(rkqu);
     std::cout << R"(Created topic ")" << topic << R"(" with )" << num_partitions
               << " partition" << (num_partitions == 1 ? "" : "s") << std::endl;
   } catch (const std::runtime_error &e) {
diff --git a/include/snctl-cpp/topics/delete_topic.h b/include/snctl-cpp/topics/delete_topic.h
@@ -26,21 +26,21 @@
 
 inline void delete_topic(rd_kafka_t *rk, rd_kafka_queue_t *rkqu,
                          const std::string &topic) {
-  auto rk_topic = rd_kafka_DeleteTopic_new(topic.c_str());
+  auto *rk_topic = rd_kafka_DeleteTopic_new(topic.c_str());
   GUARD(rk_topic, rd_kafka_DeleteTopic_destroy);
 
   rd_kafka_DeleteTopics(rk, &rk_topic, 1, nullptr, rkqu);
 
   try {
-    auto event = RdKafkaEvent::poll(rk, rkqu);
-    auto result = rd_kafka_event_DeleteTopics_result(event.handle());
+    auto event = RdKafkaEvent::poll(rkqu);
+    const auto *result = rd_kafka_event_DeleteTopics_result(event.handle());
     size_t cntp;
-    auto topics = rd_kafka_DeleteTopics_result_topics(result, &cntp);
+    const auto *topics = rd_kafka_DeleteTopics_result_topics(result, &cntp);
     if (cntp != 1) {
       throw std::runtime_error("DeleteTopics response has " +
                                std::to_string(cntp) + " topics");
     }
-    if (auto error = rd_kafka_topic_result_error_string(topics[0]);
+    if (const char *error = rd_kafka_topic_result_error_string(topics[0]);
         error == nullptr) {
       std::cout << R"(Deleted topic ")" << topic << R"(")" << std::endl;
     } else {
diff --git a/include/snctl-cpp/topics/describe_topic.h b/include/snctl-cpp/topics/describe_topic.h
@@ -25,36 +25,37 @@
 inline void describe_topic(rd_kafka_t *rk, rd_kafka_queue_t *rkqu,
                            const std::string &topic) {
   const char *topics[] = {topic.c_str()};
-  auto topic_names = rd_kafka_TopicCollection_of_topic_names(topics, 1);
+  auto *topic_names = rd_kafka_TopicCollection_of_topic_names(topics, 1);
   GUARD(topic_names, rd_kafka_TopicCollection_destroy);
 
   rd_kafka_DescribeTopics(rk, topic_names, nullptr, rkqu);
 
   try {
-    auto event = RdKafkaEvent::poll(rk, rkqu);
-    auto result = rd_kafka_event_DescribeTopics_result(event.handle());
+    auto event = RdKafkaEvent::poll(rkqu);
+    const auto *result = rd_kafka_event_DescribeTopics_result(event.handle());
     size_t result_topics_cnt;
-    auto result_topics =
+    auto *result_topics =
         rd_kafka_DescribeTopics_result_topics(result, &result_topics_cnt);
     for (size_t i = 0; i < result_topics_cnt; i++) {
-      auto result_topic = result_topics[i];
-      auto topic_name = rd_kafka_TopicDescription_name(result_topic);
-      auto error = rd_kafka_TopicDescription_error(result_topic);
-      if (rd_kafka_error_code(error)) {
+      const auto *result_topic = result_topics[i];
+      const char *topic_name = rd_kafka_TopicDescription_name(result_topic);
+      const auto *error = rd_kafka_TopicDescription_error(result_topic);
+      if (rd_kafka_error_code(error) != RD_KAFKA_RESP_ERR_NO_ERROR) {
         std::cout << "Topic: " << topic_name
                   << " has error: " << rd_kafka_error_string(error) << "\n";
         continue;
       }
 
       size_t partition_cnt;
-      auto partitions =
+      auto *partitions =
           rd_kafka_TopicDescription_partitions(result_topic, &partition_cnt);
       for (size_t i = 0; i < partition_cnt; i++) {
-        auto result_partition = partitions[i];
+        const auto *result_partition = partitions[i];
         auto id = rd_kafka_TopicPartitionInfo_partition(result_partition);
-        auto leader = rd_kafka_TopicPartitionInfo_leader(result_partition);
-        if (leader) {
-          std::cout << "Partition[" << i << "] "
+        const auto *leader =
+            rd_kafka_TopicPartitionInfo_leader(result_partition);
+        if (leader != nullptr) {
+          std::cout << "Partition[" << id << "] "
                     << R"(leader: {"id": )" << rd_kafka_Node_id(leader)
                     << R"(, url: ")" << rd_kafka_Node_host(leader) << ':'
                     << rd_kafka_Node_port(leader) << R"("})" << std::endl;
diff --git a/src/main.cc b/src/main.cc

Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,9 @@`
`22`	`22`
`23`	`23`	`class SubCommand {`
`24`	`24`	`public:`
`25`		`- SubCommand(const std::string &name) : name_(name), handle_(name) {}`
	`25`	`+ explicit SubCommand(const std::string &name) : name_(name), handle_(name) {}`
`26`	`26`
`27`		`- bool used_by_parent(argparse::ArgumentParser &parent) const noexcept {`
	`27`	`+ bool used_by_parent(argparse::ArgumentParser &parent) const {`
`28`	`28`	`return parent.is_subcommand_used(handle_);`
`29`	`29`	`}`
`30`	`30`