## Demo
I have made a demo project at GitHub - kazurayam/TestSuiteContext_getTimestamp_is_wanted
Please clone the project onto you PC and try running the test suite TS1.
## how to run the demo
- clone the project onto your PC
- open the project with Katalon studio
- load the test suite ‘TS1’
- execute the test suite with any browser you like
- in the project directory, you will find the `Results` directory is newly created.
- in the `Results` directory you find a PNG file.
then I got the Results directory and screenshot file as follows:
## What I wanted to achieve
With Katalon Studio I can easily start Web UI automated testing with WebDriver. With WebUI.takeScreenshot(path) I can easily take screenshots of target Web pages. But here I find an itchy problem: how to resolve the path of image files?
To tell conclusion first, I want to save screenshot files in the following location:
<project dir>/Results/<TestSuite name>/<TestSuite timestamp>/ <TestCase name>/<encoded URL string>.png
for example:
./Results/TS1/20180611_140156/TC1/http%3A%2F%2Fdemoaut.katalon.com%2F.png
In the demo project, I have implemented this approach with custom Groovy programming in TestListener, TestCase, and with GlobalVariables.
## How I implemented my idea
In the above screenshot, you would find a directory named `Results/TS1/20180611_140159`. This is made my custom Groovy scripts. Have a look at the TestListener. I wrote as follows:
// resolve the test suite timestamp. e.g, '20180611_130937'
GlobalVariable.CURRENT_TESTSUITE_TIMESTAMP =
DateTimeFormatter.ofPattern(DATE_TIME_PATTERN).
format(LocalDateTime.now())
Here I got the timestamp from the current machine clock, and formatted the time value into a string of ‘20180611_140159’.
I felt comfortable enough with the screenshot file path:
./Results/TS1/20180611_140159/TC1/http%3A%2F%2Fdemoaut.katalon.com%2F.png
If I repeatedly execute the Test Suite `TS1`, each TS1 execution will create an indivisual directory. Directories are differentiated by the timestamp value. Hence I can preserve multiple versions of screenshot images. This means, I can compare the current screenshot with other versions in an automated way. This idea makes me excited. The following article describes how to implement it with Image Magick.
## What this means
Provided that the screenshots files are stored in a well organized way, I can integrate Image Magick with Katalon Studio. Then Katalon Studio would newly equip a feature of local Visual Testing.
## A Problem found
You will find in the above screenshot a diretory named **./Reports/**TS1/20180611_140156. The Reports directory was created by Katalon Studio. Let’s compare the 2 timestamps:
- ./Reports/TS1/20180611_140156
- ./Results/TS1/20180611_140159
Ah, this is disappointing. No reason why these two should have different timestamp. I want to refer to the test suite timestamp managed by Katalon Studio runtime so that I make my directory with the same time stamp value.
## How to solve it
I want the `com.kms.katalon.core.context.TestSuiteContext` class to be added with a new method `getTimestamp()` or `getTimestampAsString()`. I would propose the following code snippet become possible:
class MyTestListener {
@BeforeTestSuite
def beforeTestSuite(TestSuiteContext testSuiteContext) {
GlobalVariable.CURRENT_TESTSUITE_TIMESTAMP =
testSuiteContext.getTestSuiteTimestamp() // I WANT THIS!
