Decoupling symlinks map and CAS utilities from just-mr

This is required in order to make them available to 'just serve'
in a minimal just installation.

1 files changed, 77 insertions, 0 deletions

diff --git a/src/buildtool/storage/fs_utils.hpp b/src/buildtool/storage/fs_utils.hpp
new file mode 100644
index 00000000..ba66dac5
--- /dev/null
+++ b/src/buildtool/storage/fs_utils.hpp
@@ -0,0 +1,77 @@
+// Copyright 2023 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.
+
+#ifndef INCLUDED_SRC_BUILDTOOL_STORAGE_FS_UTILS_HPP
+#define INCLUDED_SRC_BUILDTOOL_STORAGE_FS_UTILS_HPP
+
+#include <filesystem>
+#include <optional>
+#include <string>
+
+#include "src/buildtool/common/user_structs.hpp"
+#include "src/buildtool/file_system/symlinks_map/pragma_special.hpp"
+#include "src/utils/cpp/tmp_dir.hpp"
+
+/* Utilities related to CAS and paths therein */
+
+namespace StorageUtils {
+
+/// \brief Get location of Git repository. Defaults to the Git cache root when
+/// no better location is found.
+[[nodiscard]] auto GetGitRoot(LocalPathsPtr const& just_mr_paths,
+                              std::string const& repo_url) noexcept
+    -> std::filesystem::path;
+
+/// \brief Create a tmp directory with controlled lifetime for specific
+/// operations (archive, zip, file, distdir checkouts; fetch; update).
+[[nodiscard]] auto CreateTypedTmpDir(std::string const& type) noexcept
+    -> TmpDirPtr;
+
+/// \brief Get the path to the file storing the tree id associated with
+/// a given commit.
+[[nodiscard]] auto GetCommitTreeIDFile(std::string const& commit) noexcept
+    -> std::filesystem::path;
+
+/// \brief Get the path to the file storing the tree id of an archive
+/// content.
+[[nodiscard]] auto GetArchiveTreeIDFile(std::string const& repo_type,
+                                        std::string const& content) noexcept
+    -> std::filesystem::path;
+
+/// \brief Get the path to the file storing the tree id of a distdir list
+/// content.
+[[nodiscard]] auto GetDistdirTreeIDFile(std::string const& content) noexcept
+    -> std::filesystem::path;
+
+/// \brief Get the path to the file storing a resolved tree hash.
+[[nodiscard]] auto GetResolvedTreeIDFile(
+    std::string const& tree_hash,
+    PragmaSpecial const& pragma_special) noexcept -> std::filesystem::path;
+
+/// \brief Write a tree id to file. The parent folder of the file must exist!
+[[nodiscard]] auto WriteTreeIDFile(std::filesystem::path const& tree_id_file,
+                                   std::string const& tree_id) noexcept -> bool;
+
+/// \brief Add data to file CAS.
+/// Returns the path to the file added to CAS, or nullopt if not added.
+[[nodiscard]] auto AddToCAS(std::string const& data) noexcept
+    -> std::optional<std::filesystem::path>;
+
+/// \brief Try to add distfile to CAS.
+void AddDistfileToCAS(std::filesystem::path const& distfile,
+                      LocalPathsPtr const& just_mr_paths) noexcept;
+
+}  // namespace StorageUtils
+
+#endif  // INCLUDED_SRC_BUILDTOOL_STORAGE_FS_UTILS_HPP