Katalon.properties file and JVM System Property katalon.user.home

[kazurayam]

Problems to solve

Let me assume, I have a single Web Application in multiple environments: the development, the staging, the production-blue, the production-green and more. These environments have 99% same contents and features except the following differences:

• Hostname — e.g. demoaut-mimic.kazurayam.com for development, demoaut.katalon.com for production
• Username/Password — e.g. kazurayam/foobar for development, John Doe/ThisIsNotAPassword for production.

Now I want to:

1. I want to use Katalon Studio to test Web UI of all these environments using a single set of Test Suites/Test Cases.
2. I want to store the Katalon project into the GitHub and to expose it public (just as I did here).
3. Still I want to hide my sensitive information: hostname, username and password. I do not like making them visible anywhere in the repository.
4. I want to run the test against multiple targets (hostnames) in Continuous Integration process on Jenkins. In order to do this, I need to be able to switch the test target by command line argument without modifying the source code of the test at all.

**

My solution published**

I believe I have developed a solution to the above problems. I have made a running demo on GitHub. Please have a look at this:
https://github.com/kazurayam/KatalonPropertiesDemo

Related discussions

In the Katalon Discussion Forum I found quite a few discussions on test reuse, passing parameters to automated tests, and hiding credentials.

• Is it possible to use the same test for different sites?
• Automate running a test from maven (as part of build process)
• How to pass user defined parameters from command line
• How to pass the the parameter to the Test listener method…
• Want to overwrite credential info as GlobalVariable with properties file from command line argument
• How to change site based on environmet?
• Inject data with external file?
• Possibility to send property/variable through Katalon console cmd line
• Store variables like username and password
• Variable URL
• How to pass user defined parameters from command line
• Passing variables from jenkins to katalon scripts
• pass global variable value to Katalon in CMD line
• Maintain different environment properties file and run in multiple environment same time

I hope my study suggests something useful to those who may concern.

[Zarashima]

Upvote for this one. Thanks for your study and your implementations, we’ve been very grateful about this

Regards

[Zarashima]

However, this should be in ‘Tips and Tricks’ category, do you mind if I move it to that section?

Regards

[kazurayam]

Please do it.

[kazurayam]

Vinh,

As I wrote in https://github.com/kazurayam/KatalonPropertiesDemo, I have a feature request to Katalon Studio Console Mode Execution so that it accepts argument which give value to JVM System Property.

Should I raise another post in ‘Feature/Improvement Suggestion’?

[Zarashima]

kazurayam said:

Vinh,

As I wrote in GitHub - kazurayam/KatalonPropertiesDemo: katalon.properties file enhances usability of Katalon Studio, I have a feature request to Katalon Studio Console Mode Execution so that it accepts argument which give value to JVM System Property.

Should I raise another post in ‘Feature/Improvement Suggestion’?

Yes this should be raised in ‘Features/Improvement Suggestion’ category instead.

[kazurayam]

Vinh,

I added this:

Command line argument `-Dkatalon.user.home=xxxx`

PLS have a look at this first: https://github.com/kazurayam/KatalonPropertiesDemo ---- I hope I can specify JVM System Property katalon.user.home as command line arguments for the Katalon Studio in Console Mode. For example, I would type like this if I want to test the production Blue environment: >cd %KatalonStudioInstalledDir%>.\katalon.exe -Dkatalon.user.home=C:\Users\myname\tmp\blue -runMode=console -noExit -projectPath="C:\Users\myname\katalon-workspace\KatalonPropertiesDemo\KatalonPro…

[Russ_Thomas]

What an amazing field study. Kudos to Kaz.

[Said_A]

Hi All,

what would be the advantage of using the configurable properties instead of simply using different profiles. The only advantage i see is that you can use the same profile (global variables) with multiple properties. Is there more than that?

Thanks and best regards,
Said

[kazurayam]

Said,

Please find the date of my initial post — 3/27/2018. At that time we had v 5.3.x which did not have Execution Profile yet. Still I wanted a method to specify parameters (username, password) runtime. Therefore I invented the method driven by katalon.properties. Later in April 2018, Execution Profile was introduced to Katalon Studio at v5.4.0.

The advantage of katalon.properties file for me, in comparison to Profiles, is that I can exclude the file out of Git repository. By .gitignoring the katalon.properties I can be 100% sure that my sensitive information(password) is NOT exposed to public even when I put the repository public on GitHub.

[Said_A]

Thanks @kazurayam for the explaination. This sounds plausible.

I am using profiles and by now I am quite happy. However would love to have a possibility to overwrite global properties in the execution command. e.g. i want to run the test with almost the same profile, only the baseURL in the profile is different. For that i want to specify the baseURL in the execution command. e.g.

>.\katalon.exe -DbaseURL=http://www.example1.com -runMode=console ...

Do you know if there is a smart way for doing that? May I use your functionality for that?

Thanks!
Said

[kazurayam]

-DbaseURL=http://www.example1.com

No, specifying Java System Property by -D option on the command line is not supported.

[kazurayam]

Using OS-level environment variable would be an option for you.

In the command line or windows bat script you would do:

>set baseURL=http://www.example1.com>...>.\katalon -runMode=console ...

and in TestListener or Test Case you do

if (System.getenv("baseURL") != null) {    GlobalVariable.baseURL = System.getenv("baseURL")}

[Said_A]

That looks like a good option. I will try it out and check if that would solve my problem smart and easy.

Thanks for your help! Much appreciated

[Alex_Jack]

kazurayam said:

Using OS-level environment variable would be an option for you.

In the command line or windows bat script you would do:

>set baseURL=http://www.example1.com>...>.\katalon -runMode=console ...

and in TestListener or Test Case you do

if (System.getenv("baseURL") != null) {    GlobalVariable.baseURL = System.getenv("baseURL")}

I have tried to make something like that for hit the result to test railt but it doesn’t work

this my code on Testlistener/hook’s

if (System.getenv("runMode") == "console") {			
GlobalVariable.UpdateTestRail = System.getenv("updateTestRail")
GlobalVariable.TestRailRunId = System.getenv("testRailRunID")	
}

./Katalon\ Studio.app/Contents/MacOS/katalon --args -noSplash  -runMode=console -updateTestRail=true -testRailRunID=5193 -consoleLog -projectPath="/Users/automation-web/Automation-Web.prj" -retry=0 -testSuiteCollectionPath="Test Suites/TestSuiteCollection/Run Smoke Test 1(Chrome)"

I have tried also as you explain, by typing and set parameters but not working

>set updateTestRail=true>set testRailRunID=5193>./Katalon\ Studio.app/Contents/MacOS/katalon --args -noSplash  -runMode=console -consoleLog -projectPath="/Users/automation-web/Automation-Web.prj" -retry=0 -testSuiteCollectionPath="Test Suites/TestSuiteCollection/Run Smoke Test 1(Chrome)"

[kazurayam]

but it doesn’t work

Any messages in the log?

Did you defined _UpdateTestRail and _TestRailRunId in the defaul Profile before running the script?

You need to defind variables in the defaul Profile.PNG

[Alex_Jack]

yes I have:

It’s looks like I missed something, did I need to use jar file which is you provided and create katalon properties?

if I uses katalon properties it means I still need to open file and edit the properties before execute the command right? is there any way to make it put the variable like usually uses for executing katalon via command line, by typing -updateTestRail=true -testRailRunId=5191

Screen Shot 2018-10-09 at 13.06.09.png

[kazurayam]

Yes, you need to import MultiSourcedProperties-1.0.jar file into Katalon Studio in order to load the contents of katalon.properties file.

You can download the jar from

1. https://github.com/kazurayam/MultiSourcedProperties/releases

[kazurayam]

is there any way to make it put the variable like usually uses for executing katalon via command line, by typing -updateTestRail=true -testRailRunId=5191

No, there isn’t. It is the very reason why you are now working on using OS-level environment variable, isn’t it? Using environment variables, you are going to overwrite the values of GlobalVariables.

[Alex_Jack]

I have installed your jar.

And for properties I just need to uses properties which is generated from Build CMD > Generate Property File and replaces it with my variable, right?

this is my content of console.properties

this my code on Testlistener/hook’s

if (System.getenv("runMode") == "console") {			
GlobalVariable.UpdateTestRail = System.getenv("updateTestRail")
GlobalVariable.TestRailRunId = System.getenv("testRailRunID")	
}

I tried to uses my properties but it’s gives result like this:

Then I did,

$cd /Applications/$set updateTestRail=true$set testRailRunID=5193$./Katalon\ Studio.app/Contents/MacOS/katalon --args -noSplash  -runMode=console -consoleLog -projectPath="/Users/automation-web/Automation-Web.prj" -retry=0 -testSuiteCollectionPath="Test Suites/TestSuiteCollection/Run Smoke Test 1(Chrome)"

but still my test rail not updated

Screen Shot 2018-10-09 at 14.21.49.png

Screen Shot 2018-10-09 at 15.02.21.png