1 files changed, 136 insertions, 0 deletions
diff --git a/src/qdoc/qdoc/tests/qdoc/boundaries/filesystem/catch_filepath.cpp b/src/qdoc/qdoc/tests/qdoc/boundaries/filesystem/catch_filepath.cpp
new file mode 100644
index 000000000..44d59017b
--- /dev/null
+++ b/src/qdoc/qdoc/tests/qdoc/boundaries/filesystem/catch_filepath.cpp
@@ -0,0 +1,136 @@
+// Copyright (C) 2022 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
+
+#include <catch_conversions/qdoc_catch_conversions.h>
+
+#include <catch/catch.hpp>
+
+#include <qdoc/boundaries/filesystem/filepath.h>
+
+#include <catch_generators/generators/path_generator.h>
+
+#include <QFileInfo>
+#include <QTemporaryDir>
+#include <QDir>
+#include <QIODeviceBase>
+
+SCENARIO("Obtaining a FilePath", "[FilePath][Boundaries][Validation][Canonicalization][Path]") {
+
+    GIVEN("Any string representing a path that does not represent an existing element on the filesystem") {
+        QString path = GENERATE(take(100, filter([](auto path){ return !QFileInfo{path}.exists(); }, qdoc::catch_generators::native_path())));
+        CAPTURE(path);
+
+        WHEN("A FilePath instance is requested from that string") {
+            auto maybe_filepath{FilePath::refine(path)};
+
+            THEN("A FilePath instance is not obtained") {
+                REQUIRE(!maybe_filepath);
+            }
+        }
+    }
+
+    GIVEN("Any string representing a path to a directory") {
+        QString relative_path = GENERATE(take(100, qdoc::catch_generators::native_relative_directory_path()));
+        CAPTURE(relative_path);
+
+        QTemporaryDir working_directory{};
+        REQUIRE(working_directory.isValid());
+
+        QString path_to_directory = working_directory.path() + "/" + relative_path;
+
+        AND_GIVEN("That the path represents an existing directory on the filesystem") {
+            REQUIRE(QDir{working_directory.path()}.mkpath(relative_path));
+
+            WHEN("A FilePath instance is requested from that string") {
+                auto maybe_filepath{FilePath::refine(path_to_directory)};
+
+                THEN("A FilePath instance is not obtained") {
+                    REQUIRE(!maybe_filepath);
+                }
+            }
+        }
+    }
+
+#if defined(Q_OS_LINUX) || defined(Q_OS_MACOS)
+
+    GIVEN("Any string representing a path to a file") {
+        QString relative_path = GENERATE(take(100, qdoc::catch_generators::native_relative_file_path()));
+        CAPTURE(relative_path);
+
+        QTemporaryDir working_directory{};
+        REQUIRE(working_directory.isValid());
+
+        QString path_to_file = working_directory.path() + "/" + relative_path;
+
+        AND_GIVEN("That the path represents an existing file on the filesystem") {
+            REQUIRE(QDir{working_directory.path()}.mkpath(QFileInfo{relative_path}.path()));
+            REQUIRE(QFile{path_to_file}.open(QIODeviceBase::ReadWrite | QIODeviceBase::NewOnly));
+
+            AND_GIVEN("That the file represented by the path is not readable") {
+                REQUIRE(QFile::setPermissions(path_to_file, QFileDevice::WriteOwner  |
+                                                           QFileDevice::ExeOwner    |
+                                                           QFileDevice::WriteGroup  |
+                                                           QFileDevice::ExeGroup    |
+                                                           QFileDevice::WriteOther  |
+                                                           QFileDevice::ExeOther));
+
+                WHEN("A FilePath instance is requested from that string") {
+                    auto maybe_filepath{FilePath::refine(path_to_file)};
+
+                    THEN("A FilePath instance is not obtained") {
+                        // REMARK: [temporary_directory_cleanup]
+                        CHECK(!maybe_filepath);
+                        REQUIRE(QFile::setPermissions(path_to_file, QFileDevice::WriteUser | QFileDevice::ReadUser | QFileDevice::ExeUser));
+                    }
+                }
+            }
+
+            AND_GIVEN("That the file represented by the path is readable") {
+                REQUIRE(QFile::setPermissions(path_to_file, QFileDevice::ReadOwner | QFileDevice::ReadGroup | QFileDevice::ReadOther));
+
+                WHEN("A FilePath instance is requested from that string") {
+                    auto maybe_filepath{FilePath::refine(path_to_file)};
+
+                    THEN("A FilePath instance is obtained") {
+                        // REMARK: [temporary_directory_cleanup]
+                        CHECK(maybe_filepath);
+                        REQUIRE(QFile::setPermissions(path_to_file, QFileDevice::WriteUser | QFileDevice::ReadUser | QFileDevice::ExeUser));
+                    }
+                }
+            }
+        }
+    }
+
+#endif
+
+}
+
+SCENARIO("Inspecting the contents of a FilePath", "[FilePath][Boundaries][Canonicalization][Path][Contents]") {
+    GIVEN("Any string representing a path from which a FilePath instance can be obtained") {
+        QString relative_path = GENERATE(take(100, qdoc::catch_generators::native_relative_file_path()));
+        CAPTURE(relative_path);
+
+        QTemporaryDir working_directory{};
+        REQUIRE(working_directory.isValid());
+
+        QString path_to_file = QFileInfo{working_directory.path() + "/" + relative_path}.filePath();
+
+        REQUIRE(QDir{working_directory.path()}.mkpath(QFileInfo{relative_path}.path()));
+        REQUIRE(QFile{path_to_file}.open(QIODeviceBase::ReadWrite | QIODeviceBase::NewOnly));
+
+        AND_GIVEN("A FilePath instance obtained from that path") {
+            auto maybe_filepath{FilePath::refine(path_to_file)};
+            REQUIRE(maybe_filepath);
+
+            auto filepath{*maybe_filepath};
+
+            WHEN("The path that the FilePath contains is inspected") {
+                auto path{filepath.value()};
+
+                THEN("That path is the same as the canonicazlied version of the path that the FilePath was built from") {
+                    REQUIRE(path == QFileInfo(path_to_file).canonicalFilePath());
+                }
+            }
+        }
+    }
+}