1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
// 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.
#ifndef INCLUDED_SRC_OTHER_TOOLS_GIT_OPERATIONS_GIT_OPERATIONS_HPP
#define INCLUDED_SRC_OTHER_TOOLS_GIT_OPERATIONS_GIT_OPERATIONS_HPP
#include "src/buildtool/multithreading/async_map_consumer.hpp"
#include "src/other_tools/git_operations/git_ops_types.hpp"
/// \brief Class defining the critical Git operations, i.e., those which write
/// to the underlying Git ODB.
/// The target_path is a mandatory argument, as it is used in a file locking
/// mechanism, ensuring only one process at a time works on a particular
/// repository on the file system.
class CriticalGitOps {
public:
// This operations needs the params: target_path, message
// Will perform: "git init && git add . && git commit -m <message>".
// Called to setup first commit in new repository. Assumes folder exists.
// It guarantees the logger is called exactly once with fatal if failure.
[[nodiscard]] static auto GitInitialCommit(
GitOpParams const& crit_op_params,
AsyncMapConsumerLoggerPtr const& logger) -> GitOpValue;
// This operation needs the params: target_path
// Called to initialize a repository. Creates folder if not there.
// It guarantees the logger is called exactly once with fatal if failure.
[[nodiscard]] static auto GitEnsureInit(
GitOpParams const& crit_op_params,
AsyncMapConsumerLoggerPtr const& logger) -> GitOpValue;
// This operation needs the params: target_path, git_hash (commit), message
// Called after a git fetch to retain the commit. Assumes folder exists.
// It guarantees the logger is called exactly once with fatal if failure.
[[nodiscard]] static auto GitKeepTag(
GitOpParams const& crit_op_params,
AsyncMapConsumerLoggerPtr const& logger) -> GitOpValue;
// This operations needs the params: target_path
// Called to retrieve the HEAD commit hash. Assumes folder exists.
// It guarantees the logger is called exactly once with fatal if failure.
[[nodiscard]] static auto GitGetHeadId(
GitOpParams const& crit_op_params,
AsyncMapConsumerLoggerPtr const& logger) -> GitOpValue;
// This operation needs the params: target_path, git_hash (tree), message
// Called after resolving symlinks in a tree to retain the resolved tree
// by tagging it. Assumes folder exists.
// It guarantees the logger is called exactly once with fatal if failure.
[[nodiscard]] static auto GitKeepTree(
GitOpParams const& crit_op_params,
AsyncMapConsumerLoggerPtr const& logger) -> GitOpValue;
};
#endif // INCLUDED_SRC_OTHER_TOOLS_GIT_OPERATIONS_GIT_OPERATIONS_HPP
|
