Skip to content

Commit b69b13b

Browse files
committed
refactor task tests: improve naming consistency for test cases to enhance clarity and readability
1 parent 085f6de commit b69b13b

1 file changed

Lines changed: 27 additions & 23 deletions

File tree

modules/task/tests/task_tests.cpp

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ class FakeSlowTask : public TestTask<InType, OutType> {
6969

7070
} // namespace ppc::test
7171

72-
TEST(task_tests, check_int32_t) {
72+
TEST(TaskTest, TestTask_WithInt32Vector_CompletesSuccessfully) {
7373
std::vector<int32_t> in(20, 1);
7474
ppc::test::TestTask<std::vector<int32_t>, int32_t> test_task(in);
7575
ASSERT_EQ(test_task.Validation(), true);
@@ -79,7 +79,7 @@ TEST(task_tests, check_int32_t) {
7979
ASSERT_EQ(static_cast<size_t>(test_task.GetOutput()), in.size());
8080
}
8181

82-
TEST(task_tests, check_int32_t_slow) {
82+
TEST(TaskTest, SlowTask_WithInt32Vector_ThrowsOnTimeout) {
8383
{
8484
std::vector<int32_t> in(20, 1);
8585
ppc::test::FakeSlowTask<std::vector<int32_t>, int32_t> test_task(in);
@@ -91,7 +91,7 @@ TEST(task_tests, check_int32_t_slow) {
9191
ppc::util::DestructorFailureFlag::Unset();
9292
}
9393

94-
TEST(task_tests, check_validate_func) {
94+
TEST(TaskTest, TestTask_WithEmptyInput_ValidationFails) {
9595
{
9696
std::vector<int32_t> in;
9797
ppc::test::TestTask<std::vector<int32_t>, int32_t> test_task(in);
@@ -100,7 +100,7 @@ TEST(task_tests, check_validate_func) {
100100
ppc::util::DestructorFailureFlag::Unset();
101101
}
102102

103-
TEST(task_tests, check_double) {
103+
TEST(TaskTest, TestTask_WithDoubleVector_CompletesSuccessfully) {
104104
std::vector<double> in(20, 1);
105105
ppc::test::TestTask<std::vector<double>, double> test_task(in);
106106
ASSERT_EQ(test_task.Validation(), true);
@@ -110,7 +110,7 @@ TEST(task_tests, check_double) {
110110
EXPECT_NEAR(test_task.GetOutput(), static_cast<double>(in.size()), 1e-6);
111111
}
112112

113-
TEST(task_tests, check_float) {
113+
TEST(TaskTest, TestTask_WithFloatVector_CompletesSuccessfully) {
114114
std::vector<float> in(20, 1);
115115
ppc::test::TestTask<std::vector<float>, float> test_task(in);
116116
ASSERT_EQ(test_task.Validation(), true);
@@ -120,7 +120,7 @@ TEST(task_tests, check_float) {
120120
EXPECT_NEAR(test_task.GetOutput(), in.size(), 1e-3);
121121
}
122122

123-
TEST(task_tests, check_wrong_order_disabled_valgrind) {
123+
TEST(TaskTest, TestTask_WithWrongExecutionOrder_ThrowsRuntimeError) {
124124
{
125125
std::vector<float> in(20, 1);
126126
ppc::test::TestTask<std::vector<float>, float> test_task(in);
@@ -131,7 +131,7 @@ TEST(task_tests, check_wrong_order_disabled_valgrind) {
131131
ppc::util::DestructorFailureFlag::Unset();
132132
}
133133

134-
TEST(task_tests, premature_postprocessing_no_steps) {
134+
TEST(TaskTest, TestTask_WithPrematurePostProcessingNoSteps_ThrowsRuntimeError) {
135135
{
136136
std::vector<float> in(20, 1);
137137
ppc::test::TestTask<std::vector<float>, float> test_task(in);
@@ -140,7 +140,7 @@ TEST(task_tests, premature_postprocessing_no_steps) {
140140
ppc::util::DestructorFailureFlag::Unset();
141141
}
142142

143-
TEST(task_tests, premature_postprocessing_after_preprocessing) {
143+
TEST(TaskTest, TestTask_WithPrematurePostProcessingAfterPreProcessing_ThrowsRuntimeError) {
144144
{
145145
std::vector<float> in(20, 1);
146146
ppc::test::TestTask<std::vector<float>, float> test_task(in);
@@ -150,15 +150,19 @@ TEST(task_tests, premature_postprocessing_after_preprocessing) {
150150
ppc::util::DestructorFailureFlag::Unset();
151151
}
152152

153-
TEST(TaskTest, GetStringTaskStatus_Disabled) { EXPECT_EQ(GetStringTaskStatus(StatusOfTask::kDisabled), "disabled"); }
153+
TEST(TaskTest, GetStringTaskStatus_WithDisabledStatus_ReturnsDisabled) {
154+
EXPECT_EQ(GetStringTaskStatus(StatusOfTask::kDisabled), "disabled");
155+
}
154156

155-
TEST(TaskTest, GetStringTaskStatus_Enabled) { EXPECT_EQ(GetStringTaskStatus(StatusOfTask::kEnabled), "enabled"); }
157+
TEST(TaskTest, GetStringTaskStatus_WithEnabledStatus_ReturnsEnabled) {
158+
EXPECT_EQ(GetStringTaskStatus(StatusOfTask::kEnabled), "enabled");
159+
}
156160

157-
TEST(TaskTest, GetStringTaskType_InvalidFileThrows) {
161+
TEST(TaskTest, GetStringTaskType_WithInvalidFile_ThrowsRuntimeError) {
158162
EXPECT_THROW({ GetStringTaskType(TypeOfTask::kALL, "non_existing_file.json"); }, std::runtime_error);
159163
}
160164

161-
TEST(TaskTest, GetStringTaskType_UnknownType_WithValidFile) {
165+
TEST(TaskTest, GetStringTaskType_WithUnknownTypeAndValidFile_DoesNotThrow) {
162166
std::string path = "settings_valid.json";
163167
ScopedFile cleaner(path);
164168
std::ofstream file(path);
@@ -168,7 +172,7 @@ TEST(TaskTest, GetStringTaskType_UnknownType_WithValidFile) {
168172
EXPECT_NO_THROW({ GetStringTaskType(TypeOfTask::kUnknown, path); });
169173
}
170174

171-
TEST(TaskTest, GetStringTaskType_ThrowsOnBadJSON) {
175+
TEST(TaskTest, GetStringTaskType_WithBadJSON_ThrowsException) {
172176
std::string path = "bad_settings.json";
173177
ScopedFile cleaner(path);
174178
std::ofstream file(path);
@@ -177,7 +181,7 @@ TEST(TaskTest, GetStringTaskType_ThrowsOnBadJSON) {
177181
EXPECT_THROW({ GetStringTaskType(TypeOfTask::kALL, path); }, std::exception);
178182
}
179183

180-
TEST(TaskTest, GetStringTaskType_EachType_WithValidFile) {
184+
TEST(TaskTest, GetStringTaskType_WithEachTypeAndValidFile_DoesNotThrow) {
181185
std::string path = "settings_valid_all.json";
182186
ScopedFile cleaner(path);
183187
std::ofstream file(path);
@@ -193,7 +197,7 @@ TEST(TaskTest, GetStringTaskType_EachType_WithValidFile) {
193197
EXPECT_NO_THROW(GetStringTaskType(TypeOfTask::kSEQ, path));
194198
}
195199

196-
TEST(TaskTest, GetStringTaskType_ReturnsUnknown_OnDefault) {
200+
TEST(TaskTest, GetStringTaskType_WithUnknownType_ReturnsUnknown) {
197201
std::string path = "settings_valid_unknown.json";
198202
ScopedFile cleaner(path);
199203
std::ofstream file(path);
@@ -204,7 +208,7 @@ TEST(TaskTest, GetStringTaskType_ReturnsUnknown_OnDefault) {
204208
EXPECT_EQ(result, "unknown");
205209
}
206210

207-
TEST(TaskTest, GetStringTaskType_ThrowsIfKeyMissing) {
211+
TEST(TaskTest, GetStringTaskType_WithMissingKey_ThrowsException) {
208212
std::string path = "settings_partial.json";
209213
ScopedFile cleaner(path);
210214
std::ofstream file(path);
@@ -214,7 +218,7 @@ TEST(TaskTest, GetStringTaskType_ThrowsIfKeyMissing) {
214218
EXPECT_ANY_THROW(GetStringTaskType(TypeOfTask::kSTL, path));
215219
}
216220

217-
TEST(TaskTest, TaskDestructor_ThrowsIfStageIncomplete) {
221+
TEST(TaskTest, TaskDestructor_WithIncompleteStage_SetsDestructorFailureFlag) {
218222
{
219223
std::vector<int32_t> in(20, 1);
220224
struct LocalTask : Task<std::vector<int32_t>, int32_t> {
@@ -230,7 +234,7 @@ TEST(TaskTest, TaskDestructor_ThrowsIfStageIncomplete) {
230234
ppc::util::DestructorFailureFlag::Unset();
231235
}
232236

233-
TEST(TaskTest, TaskDestructor_ThrowsIfEmpty) {
237+
TEST(TaskTest, TaskDestructor_WithEmptyTask_SetsDestructorFailureFlag) {
234238
{
235239
std::vector<int32_t> in(20, 1);
236240
struct LocalTask : Task<std::vector<int32_t>, int32_t> {
@@ -245,7 +249,7 @@ TEST(TaskTest, TaskDestructor_ThrowsIfEmpty) {
245249
ppc::util::DestructorFailureFlag::Unset();
246250
}
247251

248-
TEST(TaskTest, InternalTimeTest_ThrowsIfTimeoutExceeded) {
252+
TEST(TaskTest, InternalTimeTest_WithTimeoutExceeded_ThrowsRuntimeError) {
249253
struct SlowTask : Task<std::vector<int32_t>, int32_t> {
250254
explicit SlowTask(const std::vector<int32_t>& in) { this->GetInput() = in; }
251255
bool ValidationImpl() override { return true; }
@@ -278,7 +282,7 @@ class DummyTask : public Task<int, int> {
278282
bool PostProcessingImpl() override { return true; }
279283
};
280284

281-
TEST(TaskTest, ValidationThrowsIfCalledTwice) {
285+
TEST(TaskTest, Validation_WhenCalledTwice_ThrowsRuntimeError) {
282286
{
283287
auto task = std::make_shared<DummyTask>();
284288
task->Validation();
@@ -287,23 +291,23 @@ TEST(TaskTest, ValidationThrowsIfCalledTwice) {
287291
ppc::util::DestructorFailureFlag::Unset();
288292
}
289293

290-
TEST(TaskTest, PreProcessingThrowsIfCalledBeforeValidation) {
294+
TEST(TaskTest, PreProcessing_WhenCalledBeforeValidation_ThrowsRuntimeError) {
291295
{
292296
auto task = std::make_shared<DummyTask>();
293297
EXPECT_THROW(task->PreProcessing(), std::runtime_error);
294298
}
295299
ppc::util::DestructorFailureFlag::Unset();
296300
}
297301

298-
TEST(TaskTest, RunThrowsIfCalledBeforePreProcessing) {
302+
TEST(TaskTest, Run_WhenCalledBeforePreProcessing_ThrowsRuntimeError) {
299303
{
300304
auto task = std::make_shared<DummyTask>();
301305
EXPECT_THROW(task->Run(), std::runtime_error);
302306
}
303307
ppc::util::DestructorFailureFlag::Unset();
304308
}
305309

306-
TEST(TaskTest, PostProcessingThrowsIfCalledBeforeRun) {
310+
TEST(TaskTest, PostProcessing_WhenCalledBeforeRun_ThrowsRuntimeError) {
307311
{
308312
auto task = std::make_shared<DummyTask>();
309313
task->Validation();

0 commit comments

Comments
 (0)