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
67
68
69
70
71
72
|
// 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_BUILDTOOL_EXECUTION_API_COMMON_REMOTE_EXECUTION_ACTION_HPP
#define INCLUDED_SRC_BUILDTOOL_EXECUTION_API_COMMON_REMOTE_EXECUTION_ACTION_HPP
#include <chrono>
#include <memory>
#include "gsl-lite/gsl-lite.hpp"
#include "src/buildtool/execution_api/common/execution_response.hpp"
class Logger;
class ExecutionArtifactContainer;
/// \brief Abstract action.
/// Can execute multiple commands. Commands are executed in arbitrary order and
/// cannot depend on each other.
class IExecutionAction {
public:
using Ptr = std::unique_ptr<IExecutionAction>;
enum class CacheFlag {
CacheOutput, ///< run and cache, or serve from cache
DoNotCacheOutput, ///< run and do not cache, never served from cached
FromCacheOnly, ///< do not run, only serve from cache
PretendCached ///< always run, respond same action id as if cached
};
static constexpr std::chrono::milliseconds kDefaultTimeout{1000};
[[nodiscard]] static constexpr auto CacheEnabled(CacheFlag f) -> bool {
return f == CacheFlag::CacheOutput or f == CacheFlag::FromCacheOnly;
}
[[nodiscard]] static constexpr auto ExecutionEnabled(CacheFlag f) -> bool {
return f == CacheFlag::CacheOutput or
f == CacheFlag::DoNotCacheOutput or
f == CacheFlag::PretendCached;
}
IExecutionAction() = default;
IExecutionAction(IExecutionAction const&) = delete;
IExecutionAction(IExecutionAction&&) = delete;
auto operator=(IExecutionAction const&) -> IExecutionAction& = delete;
auto operator=(IExecutionAction&&) -> IExecutionAction& = delete;
virtual ~IExecutionAction() = default;
/// \brief Execute the action.
/// \returns Execution response, with commands' outputs and artifacts.
/// \returns nullptr if execution failed.
// NOLINTNEXTLINE(google-default-arguments)
[[nodiscard]] virtual auto Execute(Logger const* logger = nullptr) noexcept
-> IExecutionResponse::Ptr = 0;
virtual void SetCacheFlag(CacheFlag flag) noexcept = 0;
virtual void SetTimeout(std::chrono::milliseconds timeout) noexcept = 0;
};
#endif // INCLUDED_SRC_BUILDTOOL_EXECUTION_API_COMMON_REMOTE_EXECUTION_ACTION_HPP
|
