You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 8
Next »
Introduction
A smart debugger greatly enhances the effectiveness of test case development by simulating test execution in debug mode. Users can strategically place breakpoints within test steps, allowing Jenkins to pause execution at these designated points. The test steps which has breakpoint won't be executed until the user resumes the test execution.
Configurations in Orchestration
Add Configs in System Configuration Page
- Launch Automatics Orchestration tool. From menu select Settings → System Configuration as shown in the image below.
2. Click on 'Add configuration' shown on the top right corner of the System Configuration page and add the following 3 configurations and click on save changes button.
Parameter Name | Description |
---|
DEBUGGER_SERVICE | Smart Debugger Service Base URL |
SMART_DEBUGGER_JENKINS_CONFIG | This is the configuration of the jenkins job which will be used for the debugger feature test execution. It is done in json format. Two jenkins job details has to be mentioned which are the scripted and scriptless jenkins job. scriptlessDebuggerJobName - provide the name of the scriptless debugger job scriptedDebuggerJobName - provide the name of the scripted debugger job name scriptlessJenkinsServerBaseUrl - provide the base URL of the jenkins application in which the scriptless debugger job is present scriptedJenkinsServerBaseUrl - provide the base URL of the jenkins application in which the scripted debugger job is present scriptlessJenkinsServerUserName - provide the user name of the jenkins application in which the scriptless debugger job is present scriptedJenkinsServerUserName - provide the user name of the jenkins application in which the scripted debugger job is present scriptlessJenkinsServerPassword - provide the password of the jenkins application in which the scriptless debugger job is present scriptedJenkinsServerPassword - provide the password of the jenkins application in which the scripted debugger job is present
eg: {"scriptlessDebuggerJobName":"SCRIPTLESS_JOB_SMART_DEBUGGER","scriptedDebuggerJobName":"SCRIPTED_JOB_SMART_DEBUGGER","scriptlessJenkinsServerBaseUrl":"http://localhost:8081/jenkins","scriptedJenkinsServerBaseUrl":"http://localhost:8082/jenkins","scriptlessJenkinsServerUserName":"username","scriptlessJenkinsServerPassword":"xyz","scriptedJenkinsServerUserName":"username","scriptedJenkinsServerPassword":"pqr"} |
AUTOMATICS_DNS_BASE_URL | Provide the DNS (Domain Name System) base URL of the Automatics application.
eg: https://rdkm/Automatics |
Configurations in Automatics Properties
Launch Automatics Properties application and add the below configuration.
Property Name | Description |
---|
debuggerService.base.url | Smart Debugger Service Base URL |
Setup Jenkins Job For Smart Debugger
Jenkins job is getting used in the Automatics to execute the test case in debug mode. Partner can refer Smart Debugger Jenkins Setup for detailed steps on how to setup jenkins job for smart debugger.
Smart-Debugger Service Setup
Software Requirement
JDK 17 Setup Details
Follow Steps below to install Java 17 on CentOS/linux.
Install Java 17
yum install java-17-openjdk |
---|
Verify Java is Installed
Building debugger Service Source Code
- Clone Debugger Service source code from Debugger Service
- Open debuggerservice/src/main/resources/application.properties in source code and update automaticsBaseUrl with automatics base url and save the changes.
- Build the source code using maven to generate the jar file
"mvn clean install"
Deployment
- Copy the jar file to the VM where Debugger Service to be deployed.
- Create 2 directories debugger-service and logs in VM.
- Copy the jar file to debugger-service directory.
Run the below command from debugger-service directory to bring the Debugger Service up in the VM.
nohup java -XX:+UseSerialGC -Dlog4j2.formatMsgNoLookups=true -jar debuggerservice-0.0.1-SNAPSHOT.jar > logfile.log 2>&1 & |
---|
- debuggerservice.log file will be created in the logs directory and we can check the real time logs of the Debugger Service using this file.