Test: Add tests for file locking utility class

2 files changed, 84 insertions, 1 deletions

diff --git a/test/utils/cpp/TARGETS b/test/utils/cpp/TARGETS
index 0b9e6518..8e237a65 100644
--- a/test/utils/cpp/TARGETS
+++ b/test/utils/cpp/TARGETS
@@ -42,9 +42,22 @@
     , ["src/utils/cpp", "archive_ops"]
     ]
   }
+, "file_locking":
+  { "type": ["@", "rules", "CC/test", "test"]
+  , "name": ["file_locking"]
+  , "srcs": ["file_locking.test.cpp"]
+  , "private-deps":
+    [ ["@", "catch2", "", "catch2"]
+    , ["test", "catch-main"]
+    , ["src/buildtool/file_system", "file_system_manager"]
+    , ["src/utils/cpp", "file_locking"]
+    , ["src/utils/cpp", "atomic"]
+    ]
+  , "stage": ["test", "utils", "cpp"]
+  }
 , "TESTS":
   { "type": "install"
   , "tainted": ["test"]
-  , "deps": ["path", "curl_usage_test", "archive_usage"]
+  , "deps": ["path", "curl_usage_test", "archive_usage", "file_locking"]
   }
 }
diff --git a/test/utils/cpp/file_locking.test.cpp b/test/utils/cpp/file_locking.test.cpp
new file mode 100644
index 00000000..9e3924e8
--- /dev/null
+++ b/test/utils/cpp/file_locking.test.cpp
@@ -0,0 +1,70 @@
+// Copyright 2022 Huawei Cloud Computing Technology Co., Ltd.
+//
+// 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.
+
+#include <thread>
+
+#include "catch2/catch.hpp"
+#include "src/buildtool/file_system/file_system_manager.hpp"
+#include "src/utils/cpp/atomic.hpp"
+#include "src/utils/cpp/file_locking.hpp"
+
+namespace {
+[[nodiscard]] auto GetTestDir() noexcept -> std::filesystem::path {
+    auto* tmp_dir = std::getenv("TEST_TMPDIR");
+    if (tmp_dir != nullptr) {
+        return tmp_dir;
+    }
+    return FileSystemManager::GetCurrentDirectory() / "test/other_tools";
+}
+
+[[nodiscard]] auto GetLockDirPath(int id) noexcept -> std::filesystem::path {
+    auto lock_file = std::to_string(id) + std::string{".lock"};
+    return GetTestDir() / lock_file;
+}
+}  // namespace
+
+TEST_CASE("Multi-file locking", "[file_locking]") {
+    // Test locking and unlocking. Each thread will have one lock.
+    // setup threading
+    constexpr auto kNumThreads = 50;  // increasing it too much will fail
+    constexpr auto kNumLocks = 5;
+
+    atomic<bool> starting_signal{false};
+    std::vector<std::thread> threads{};
+    threads.reserve(kNumThreads);
+
+    for (int id{}; id < kNumThreads; ++id) {
+        threads.emplace_back(
+            [&starting_signal](int tid) {
+                starting_signal.wait(false);
+                // cases based on id
+                auto flockpath = GetLockDirPath(tid % kNumLocks);
+                // Get lock
+                auto lock = LockFile::Acquire(flockpath, /*is_shared=*/false);
+                REQUIRE(lock);
+                // Do some "work"
+                std::this_thread::sleep_for(std::chrono::milliseconds(1));
+                // lock released automatically when out of scope
+            },
+            id);
+    }
+
+    starting_signal = true;
+    starting_signal.notify_all();
+
+    // wait for threads to finish
+    for (auto& thread : threads) {
+        thread.join();
+    }
+}