Skip to content

Commit e1cfa1e

Browse files
AdamCetnerowskiCompute-Runtime-Automation
AdamCetnerowski
authored and
Compute-Runtime-Automation
committed
ULT renaming: File Logger tests
Related-To: NEO-2236 Change-Id: Id0d26d65cb024f7e192915fbd6e3bc62a446caa4 Signed-off-by: Adam Cetnerowski <adam.cetnerowski@intel.com>
1 parent 2fb1dd4 commit e1cfa1e

File tree

1 file changed

+34
-45
lines changed

1 file changed

+34
-45
lines changed

‎opencl/test/unit_test/utilities/file_logger_tests.cpp‎

Lines changed: 34 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
using namespace NEO;
2828

29-
TEST(FileLogger, WithDebugFunctionality) {
29+
TEST(FileLogger, WhenFileLoggerIsCreatedThenItIsEnabled) {
3030
DebugVariables flags;
3131
FullyEnabledFileLogger fileLogger(std::string(""), flags);
3232

@@ -40,7 +40,7 @@ TEST(FileLogger, GivenFileLoggerWhenSettingFileNameThenCorrectFilenameIsSet) {
4040
EXPECT_STREQ("new_filename", fileLogger.getLogFileName());
4141
}
4242

43-
TEST(FileLogger, WithDebugFunctionalityCreatesAndDumpsToLogFile) {
43+
TEST(FileLogger, GivenEnabledDebugFunctinalityWhenLoggingApiCallsThenDumpToFile) {
4444
DebugVariables flags;
4545
flags.LogApiCalls.set(true);
4646
FullyEnabledFileLogger fileLogger(std::string("test.log"), flags);
@@ -70,7 +70,7 @@ TEST(FileLogger, WithDebugFunctionalityCreatesAndDumpsToLogFile) {
7070
}
7171
}
7272

73-
TEST(FileLogger, WithoutDebugFunctionalityDoesNotCreateLogFile) {
73+
TEST(FileLogger, GivenDisabledDebugFunctinalityWhenLoggingApiCallsThenFileIsNotCreated) {
7474
DebugVariables flags;
7575
flags.LogApiCalls.set(true);
7676

@@ -89,7 +89,7 @@ TEST(FileLogger, WithoutDebugFunctionalityDoesNotCreateLogFile) {
8989
EXPECT_FALSE(fileLogger.wasFileCreated(fileLogger.getLogFileName()));
9090
}
9191

92-
TEST(FileLogger, WithIncorrectFilenameFileNotCreated) {
92+
TEST(FileLogger, GivenIncorrectFilenameFileWhenLoggingApiCallsThenFileIsNotCreated) {
9393
DebugVariables flags;
9494
flags.LogApiCalls.set(true);
9595
FullyEnabledFileLogger fileLogger(std::string("test.log"), flags);
@@ -99,7 +99,7 @@ TEST(FileLogger, WithIncorrectFilenameFileNotCreated) {
9999
EXPECT_FALSE(fileLogger.wasFileCreated(fileLogger.getLogFileName()));
100100
}
101101

102-
TEST(FileLogger, WithCorrectFilenameFileCreated) {
102+
TEST(FileLogger, GivenCorrectFilenameFileWhenLoggingApiCallsThenFileIsCreated) {
103103
std::string testFile = "testfile";
104104
DebugVariables flags;
105105
FullyEnabledFileLogger fileLogger(testFile, flags);
@@ -112,7 +112,7 @@ TEST(FileLogger, WithCorrectFilenameFileCreated) {
112112
}
113113
}
114114

115-
TEST(FileLogger, CreatingNewInstanceRemovesOldFile) {
115+
TEST(FileLogger, GivenSameFileNameWhenCreatingNewInstanceThenOldFileIsRemoved) {
116116
std::string testFile = "testfile";
117117
DebugVariables flags;
118118
flags.LogApiCalls.set(true);
@@ -125,7 +125,7 @@ TEST(FileLogger, CreatingNewInstanceRemovesOldFile) {
125125
EXPECT_FALSE(fileExists(fileLogger.getLogFileName()));
126126
}
127127

128-
TEST(FileLogger, WithDebugFunctionalityDoesNotDumpApiCallLogWhenFlagIsFalseButDumpsCustomLogs) {
128+
TEST(FileLogger, GivenFlagIsFalseWhenLoggingThenOnlyCustomLogsAreDumped) {
129129
std::string testFile = "testfile";
130130
DebugVariables flags;
131131
flags.LogApiCalls.set(false);
@@ -159,7 +159,7 @@ TEST(FileLogger, WithDebugFunctionalityDoesNotDumpApiCallLogWhenFlagIsFalseButDu
159159
}
160160
}
161161

162-
TEST(FileLogger, WithDebugFunctionalityGetInputReturnsCorectValue) {
162+
TEST(FileLogger, WhenGettingInputThenCorrectValueIsReturned) {
163163
std::string testFile = "testfile";
164164
DebugVariables flags;
165165

@@ -171,7 +171,7 @@ TEST(FileLogger, WithDebugFunctionalityGetInputReturnsCorectValue) {
171171
EXPECT_EQ(input, output);
172172
}
173173

174-
TEST(FileLogger, WithDebugFunctionalityGetInputNegative) {
174+
TEST(FileLogger, GivenNullInputWhenGettingInputThenZeroIsReturned) {
175175
std::string testFile = "testfile";
176176
DebugVariables flags;
177177

@@ -181,7 +181,7 @@ TEST(FileLogger, WithDebugFunctionalityGetInputNegative) {
181181
EXPECT_EQ(0u, output);
182182
}
183183

184-
TEST(FileLogger, WithDebugFunctionalityGetSizesReturnsCorectString) {
184+
TEST(FileLogger, WhenGettingSizesThenCorrectValueIsReturned) {
185185
std::string testFile = "testfile";
186186
DebugVariables flags;
187187
flags.LogApiCalls.set(true);
@@ -197,7 +197,7 @@ TEST(FileLogger, WithDebugFunctionalityGetSizesReturnsCorectString) {
197197
EXPECT_EQ(gwsExpected, gwsSizes);
198198
}
199199

200-
TEST(FileLogger, WithDebugFunctionalityGetSizesNegative) {
200+
TEST(FileLogger, GivenNullInputWhenGettingSizesThenZeroIsReturned) {
201201
std::string testFile = "testfile";
202202
DebugVariables flags;
203203
flags.LogApiCalls.set(true);
@@ -211,7 +211,7 @@ TEST(FileLogger, WithDebugFunctionalityGetSizesNegative) {
211211
EXPECT_EQ(0u, gwsSizes.size());
212212
}
213213

214-
TEST(FileLogger, WithoutDebugFunctionalityGetSizesDoesNotReturnString) {
214+
TEST(FileLogger, GivenDisabledDebugFunctionalityWhenGettingSizesThenEmptyStringIsReturned) {
215215
std::string testFile = "testfile";
216216
DebugVariables flags;
217217
flags.LogApiCalls.set(true);
@@ -224,7 +224,7 @@ TEST(FileLogger, WithoutDebugFunctionalityGetSizesDoesNotReturnString) {
224224
EXPECT_EQ(0u, gwsSizes.size());
225225
}
226226

227-
TEST(FileLogger, WithDebugFunctionalityGetEventsReturnsCorectString) {
227+
TEST(FileLogger, WhenGettingEventsThenCorrectValueIsReturned) {
228228
std::string testFile = "testfile";
229229
DebugVariables flags;
230230
flags.LogApiCalls.set(true);
@@ -237,7 +237,7 @@ TEST(FileLogger, WithDebugFunctionalityGetEventsReturnsCorectString) {
237237
EXPECT_NE(0u, eventsString.size());
238238
}
239239

240-
TEST(FileLogger, WithDebugFunctionalityGetEventsNegative) {
240+
TEST(FileLogger, GivenNullInputWhenGettingEventsThenZeroIsReturned) {
241241
std::string testFile = "testfile";
242242
DebugVariables flags;
243243

@@ -282,7 +282,7 @@ TEST(FileLogger, GiveDisabledDebugFunctionalityWhenGetMemObjectsIsCalledThenCall
282282
EXPECT_EQ(0u, memObjectString.size());
283283
}
284284

285-
TEST(FileLogger, WithDebugFunctionalityDumpKernel) {
285+
TEST(FileLogger, WhenDumpingKernelThenFileIsCreated) {
286286
std::string testFile = "testfile";
287287
DebugVariables flags;
288288
flags.DumpKernels.set(true);
@@ -294,7 +294,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernel) {
294294
EXPECT_TRUE(fileLogger.wasFileCreated(kernelDumpFile.append(".txt")));
295295
}
296296

297-
TEST(FileLogger, WithoutDebugFunctionalityDumpKernel) {
297+
TEST(FileLogger, GivenDisabledDebugFunctionalityWhenDumpingKernelThenFileIsNotCreated) {
298298
std::string testFile = "testfile";
299299
DebugVariables flags;
300300
flags.DumpKernels.set(false);
@@ -306,7 +306,7 @@ TEST(FileLogger, WithoutDebugFunctionalityDumpKernel) {
306306
EXPECT_FALSE(fileLogger.wasFileCreated(kernelDumpFile.append(".txt")));
307307
}
308308

309-
TEST(FileLogger, WithDebugFunctionalityDumpBinary) {
309+
TEST(FileLogger, WhenDumpingBinaryFileThenFileIsCreated) {
310310
std::string testFile = "testfile";
311311
DebugVariables flags;
312312
flags.DumpKernels.set(true);
@@ -320,7 +320,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpBinary) {
320320
EXPECT_TRUE(fileLogger.wasFileCreated(programDumpFile));
321321
}
322322

323-
TEST(FileLogger, WithDebugFunctionalityDumpNullBinary) {
323+
TEST(FileLogger, GivenNullPointerWhenDumpingBinaryFileThenFileIsNotCreated) {
324324
std::string testFile = "testfile";
325325
DebugVariables flags;
326326
flags.DumpKernels.set(true);
@@ -333,18 +333,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpNullBinary) {
333333
EXPECT_FALSE(fileLogger.wasFileCreated(programDumpFile));
334334
}
335335

336-
TEST(FileLogger, WithDebugFunctionalityDontDumpKernelsForNullMdi) {
337-
std::string testFile = "testfile";
338-
DebugVariables flags;
339-
flags.DumpKernelArgs.set(true);
340-
FullyEnabledFileLogger fileLogger(testFile, flags);
341-
342-
fileLogger.dumpKernelArgs((const MultiDispatchInfo *)nullptr);
343-
344-
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
345-
}
346-
347-
TEST(FileLogger, WithDebugFunctionalityDontDumpKernelArgsForNullMdi) {
336+
TEST(FileLogger, GivenNullMdiWhenDumpingKernelsThenFileIsNotCreated) {
348337
std::string testFile = "testfile";
349338
DebugVariables flags;
350339
flags.DumpKernelArgs.set(true);
@@ -390,7 +379,7 @@ TEST(FileLogger, GivenDebugFunctionalityWhenDebugFlagIsDisabledThenDoNotDumpKern
390379
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
391380
}
392381

393-
TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsForMdi) {
382+
TEST(FileLogger, GivenMdiWhenDumpingKernelArgsThenFileIsCreated) {
394383
auto kernelInfo = std::make_unique<KernelInfo>();
395384
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
396385
MockProgram program(*device->getExecutionEnvironment());
@@ -425,7 +414,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsForMdi) {
425414
EXPECT_EQ(fileLogger.createdFilesCount(), 1);
426415
}
427416

428-
TEST(FileLogger, WithDebugFunctionalityDumpKernelNullKernel) {
417+
TEST(FileLogger, GivenNullWhenDumpingKernelArgsThenFileIsNotCreated) {
429418
std::string testFile = "testfile";
430419
DebugVariables flags;
431420
flags.DumpKernelArgs.set(true);
@@ -435,7 +424,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelNullKernel) {
435424
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
436425
}
437426

438-
TEST(FileLogger, WithDebugFunctionalityAndEmptyKernelDontDumpKernelArgs) {
427+
TEST(FileLogger, GivenEmptyKernelWhenDumpingKernelArgsThenFileIsNotCreated) {
439428
auto kernelInfo = std::make_unique<KernelInfo>();
440429
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
441430
MockProgram program(*device->getExecutionEnvironment());
@@ -451,7 +440,7 @@ TEST(FileLogger, WithDebugFunctionalityAndEmptyKernelDontDumpKernelArgs) {
451440
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
452441
}
453442

454-
TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsImmediate) {
443+
TEST(FileLogger, GivenImmediateWhenDumpingKernelArgsThenFileIsCreated) {
455444
auto kernelInfo = std::make_unique<KernelInfo>();
456445
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
457446
MockProgram program(*device->getExecutionEnvironment());
@@ -484,7 +473,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsImmediate) {
484473
EXPECT_EQ(fileLogger.createdFilesCount(), 1);
485474
}
486475

487-
TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsImmediateZeroSize) {
476+
TEST(FileLogger, GivenImmediateZeroSizeWhenDumpingKernelArgsThenFileIsNotCreated) {
488477

489478
auto kernelInfo = std::make_unique<KernelInfo>();
490479
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
@@ -514,7 +503,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsImmediateZeroSize) {
514503
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
515504
}
516505

517-
TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsLocalBuffer) {
506+
TEST(FileLogger, GivenLocalBufferWhenDumpingKernelArgsThenFileIsNotCreated) {
518507

519508
auto kernelInfo = std::make_unique<KernelInfo>();
520509
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
@@ -537,7 +526,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsLocalBuffer) {
537526
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
538527
}
539528

540-
TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsBufferNotSet) {
529+
TEST(FileLogger, GivenBufferNotSetWhenDumpingKernelArgsThenFileIsNotCreated) {
541530
auto kernelInfo = std::make_unique<KernelInfo>();
542531
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
543532
auto context = clUniquePtr(new MockContext(device.get()));
@@ -568,7 +557,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsBufferNotSet) {
568557
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
569558
}
570559

571-
TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsBuffer) {
560+
TEST(FileLogger, GivenBufferWhenDumpingKernelArgsThenFileIsCreated) {
572561
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
573562
auto context = clUniquePtr(new MockContext(device.get()));
574563
auto buffer = BufferHelper<>::create(context.get());
@@ -610,7 +599,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsBuffer) {
610599
EXPECT_EQ(fileLogger.createdFilesCount(), 1);
611600
}
612601

613-
TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsSampler) {
602+
TEST(FileLogger, GivenSamplerWhenDumpingKernelArgsThenFileIsNotCreated) {
614603
auto kernelInfo = std::make_unique<KernelInfo>();
615604
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
616605
auto context = clUniquePtr(new MockContext(device.get()));
@@ -637,7 +626,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsSampler) {
637626
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
638627
}
639628

640-
TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsImageNotSet) {
629+
TEST(FileLogger, GivenImageNotSetWhenDumpingKernelArgsThenFileIsNotCreated) {
641630

642631
auto kernelInfo = std::make_unique<KernelInfo>();
643632
auto device = std::make_unique<MockClDevice>(MockDevice::createWithNewExecutionEnvironment<MockDevice>(nullptr));
@@ -676,7 +665,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpKernelArgsImageNotSet) {
676665
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
677666
}
678667

679-
TEST(FileLogger, WithDebugFunctionalityDumpBinaryNegativeCases) {
668+
TEST(FileLogger, GivenNullsWhenDumpingKernelArgsThenFileIsNotCreated) {
680669
std::string testFile = "testfile";
681670
DebugVariables flags;
682671
flags.DumpKernels.set(true);
@@ -694,7 +683,7 @@ TEST(FileLogger, WithDebugFunctionalityDumpBinaryNegativeCases) {
694683
EXPECT_EQ(fileLogger.createdFilesCount(), 0);
695684
}
696685

697-
TEST(FileLogger, WithoutDebugFunctionality) {
686+
TEST(FileLogger, GivenDisabledDebugFunctionalityWhenLoggingThenDumpingDoesNotOccur) {
698687
std::string path = ".";
699688
std::vector<std::string> files = Directory::getFiles(path);
700689
size_t initialNumberOfFiles = files.size();
@@ -768,7 +757,7 @@ TEST(FileLogger, WithoutDebugFunctionality) {
768757
EXPECT_EQ(initialNumberOfFiles, finalNumberOfFiles);
769758
}
770759

771-
TEST(LoggerApiEnterWrapper, WithDebugFunctionality) {
760+
TEST(LoggerApiEnterWrapper, GivenDebugFunctionalityEnabledWhenApiWrapperIsCreatedThenEntryIsLogged) {
772761

773762
const char *name = "function";
774763
int error = 0;
@@ -783,7 +772,7 @@ TEST(LoggerApiEnterWrapper, WithDebugFunctionality) {
783772
}
784773
}
785774

786-
TEST(LoggerApiEnterWrapper, WithoutDebugFunctionality) {
775+
TEST(LoggerApiEnterWrapper, GivenDebugFunctionalityDisabledWhenApiWrapperIsCreatedThenEntryIsNotLogged) {
787776

788777
const char *name = "function";
789778
int error = 0;
@@ -798,7 +787,7 @@ TEST(LoggerApiEnterWrapper, WithoutDebugFunctionality) {
798787
}
799788
}
800789

801-
TEST(FileLogger, infoPointerToStringReturnsCorrectString) {
790+
TEST(FileLogger, WhenConvertingInfoPointerToStringThenCorrectStringIsReturned) {
802791
std::string testFile = "testfile";
803792
DebugVariables flags;
804793
FullyEnabledFileLogger fileLogger(testFile, flags);

0 commit comments

Comments
 (0)