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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
// 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 "src/buildtool/common/artifact_description.hpp"
#include <filesystem>
#include <optional>
#include <string>
#include "catch2/catch_test_macros.hpp"
#include "nlohmann/json.hpp"
#include "src/buildtool/common/artifact.hpp"
#include "src/buildtool/common/artifact_digest.hpp"
#include "src/buildtool/common/artifact_digest_factory.hpp"
#include "src/buildtool/crypto/hash_function.hpp"
#include "src/buildtool/file_system/object_type.hpp"
#include "test/utils/hermeticity/test_hash_function_type.hpp"
static auto NamedDigest(std::string const& str) -> ArtifactDigest {
HashFunction const hash_function{TestHashType::ReadFromEnvironment()};
return ArtifactDigestFactory::HashDataAs<ObjectType::File>(hash_function,
str);
}
[[nodiscard]] auto operator==(Artifact const& lhs,
Artifact const& rhs) -> bool {
return lhs.Id() == rhs.Id() and lhs.FilePath() == rhs.FilePath() and
lhs.Info() == rhs.Info();
}
TEST_CASE("Local artifact", "[artifact_description]") {
auto local_desc = ArtifactDescription::CreateLocal(
std::filesystem::path{"local_path"}, "repo");
auto from_json = ArtifactDescription::FromJson(
TestHashType::ReadFromEnvironment(), local_desc.ToJson());
CHECK(local_desc == *from_json);
}
TEST_CASE("Known artifact", "[artifact_description]") {
SECTION("File object") {
auto known_desc = ArtifactDescription::CreateKnown(
NamedDigest("f_fake_hash"), ObjectType::File);
auto from_json = ArtifactDescription::FromJson(
TestHashType::ReadFromEnvironment(), known_desc.ToJson());
CHECK(known_desc == *from_json);
}
SECTION("Executable object") {
auto known_desc = ArtifactDescription::CreateKnown(
NamedDigest("x_fake_hash"), ObjectType::Executable);
auto from_json = ArtifactDescription::FromJson(
TestHashType::ReadFromEnvironment(), known_desc.ToJson());
CHECK(known_desc == *from_json);
}
SECTION("Symlink object") {
auto known_desc = ArtifactDescription::CreateKnown(
NamedDigest("l_fake_hash"), ObjectType::Symlink);
auto from_json = ArtifactDescription::FromJson(
TestHashType::ReadFromEnvironment(), known_desc.ToJson());
CHECK(known_desc == *from_json);
}
}
TEST_CASE("Action artifact", "[artifact_description]") {
auto action_desc = ArtifactDescription::CreateAction(
"action_id", std::filesystem::path{"out_path"});
auto from_json = ArtifactDescription::FromJson(
TestHashType::ReadFromEnvironment(), action_desc.ToJson());
CHECK(action_desc == *from_json);
}
TEST_CASE("From JSON", "[artifact_description]") {
auto local = ArtifactDescription::CreateLocal("local", "repo").ToJson();
auto known =
ArtifactDescription::CreateKnown(NamedDigest("hash"), ObjectType::File)
.ToJson();
auto action = ArtifactDescription::CreateAction("id", "output").ToJson();
auto const hash_type = TestHashType::ReadFromEnvironment();
SECTION("Parse artifacts") {
CHECK(ArtifactDescription::FromJson(hash_type, local));
CHECK(ArtifactDescription::FromJson(hash_type, known));
CHECK(ArtifactDescription::FromJson(hash_type, action));
}
SECTION("Parse artifact without mandatory type") {
local.erase("type");
known.erase("type");
action.erase("type");
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, local));
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, known));
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, action));
}
SECTION("Parse artifact without mandatory data") {
local.erase("data");
known.erase("data");
action.erase("data");
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, local));
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, known));
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, action));
}
SECTION("Parse local artifact without mandatory path") {
local["data"]["path"] = 0;
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, local));
local["data"].erase("path");
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, local));
}
SECTION("Parse known artifact") {
SECTION("without mandatory id") {
known["data"]["id"] = 0;
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, known));
known["data"].erase("id");
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, known));
}
SECTION("without mandatory size") {
known["data"]["size"] = "0";
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, known));
known["data"].erase("size");
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, known));
}
SECTION("without mandatory file_type") {
known["data"]["file_type"] = "more_than_one_char";
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, known));
known["data"].erase("file_type");
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, known));
}
}
SECTION("Parse action artifact") {
SECTION("without mandatory id") {
action["data"]["id"] = 0;
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, action));
action["data"].erase("id");
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, action));
}
SECTION("without mandatory path") {
action["data"]["path"] = 0;
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, action));
action["data"].erase("path");
CHECK_FALSE(ArtifactDescription::FromJson(hash_type, action));
}
}
}
TEST_CASE("Description missing mandatory key/value pair",
"[artifact_description]") {
nlohmann::json const missing_type = {{"data", {{"path", "some/path"}}}};
CHECK(not ArtifactDescription::FromJson(TestHashType::ReadFromEnvironment(),
missing_type));
nlohmann::json const missing_data = {{"type", "LOCAL"}};
CHECK(not ArtifactDescription::FromJson(TestHashType::ReadFromEnvironment(),
missing_data));
}
TEST_CASE("Local artifact description contains incorrect value for \"data\"",
"[artifact_description]") {
nlohmann::json const local_art_missing_path = {
{"type", "LOCAL"}, {"data", nlohmann::json::object()}};
CHECK(not ArtifactDescription::FromJson(TestHashType::ReadFromEnvironment(),
local_art_missing_path));
}
TEST_CASE("Known artifact description contains incorrect value for \"data\"",
"[artifact_description]") {
std::string file_type{};
file_type += ToChar(ObjectType::File);
SECTION("missing \"id\"") {
nlohmann::json const known_art_missing_id = {
{"type", "KNOWN"},
{"data", {{"size", 15}, {"file_type", file_type}}}};
CHECK(not ArtifactDescription::FromJson(
TestHashType::ReadFromEnvironment(), known_art_missing_id));
}
SECTION("missing \"size\"") {
nlohmann::json const known_art_missing_size = {
{"type", "KNOWN"},
{"data", {{"id", "known_input"}, {"file_type", file_type}}}};
CHECK(not ArtifactDescription::FromJson(
TestHashType::ReadFromEnvironment(), known_art_missing_size));
}
SECTION("missing \"file_type\"") {
nlohmann::json const known_art_missing_file_type = {
{"type", "KNOWN"}, {"data", {{"id", "known_input"}, {"size", 15}}}};
CHECK(not ArtifactDescription::FromJson(
TestHashType::ReadFromEnvironment(), known_art_missing_file_type));
}
}
TEST_CASE("Action artifact description contains incorrect value for \"data\"",
"[artifact_description]") {
nlohmann::json const action_art_missing_id = {
{"type", "ACTION"}, {"data", {{"path", "output/path"}}}};
CHECK(not ArtifactDescription::FromJson(TestHashType::ReadFromEnvironment(),
action_art_missing_id));
nlohmann::json const action_art_missing_path = {
{"type", "ACTION"}, {"data", {{"id", "action_id"}}}};
CHECK(not ArtifactDescription::FromJson(TestHashType::ReadFromEnvironment(),
action_art_missing_path));
}
|
