Introduction

Automatics 3.0 Custom API can be added by the partner by following the below steps

Steps to develop custom API 

• Api Development 

Refer Automatics 3.0 - API Development to get more details on how to define Automatics API

• Deploy the latest code to articraft

Jenkins Job can be triggered to deploy the latest code changes of project where new API is developed

Refer Jenkins Deployment Jobs for deployment jobs configurations.

• Parse the project to update newly added API to data base

Utility parser need to be triggered for latest code changes to parse the new API and update the API details to micro service for test executions.

Refer Automatics 3.0 Utility Parser Jobs for Parser job configurations.

Automate the Deployment and Parsing jobs

For automating the deployment and parser jobs for Automatics, a new Pipeline job is introduced. What this pipeline job will do is it will invoke the existing jenkins freestyle jobs which does the deployment and API scanning in the correct order. The overview of jenkins pipeline job as well as the steps to create the Automatics pipeline job below.

Deployment and Parser Job creation

URL:<<Jenkins url>>

Go to the Dashboard of after logging in to Jenkins UI.

• • Click on New Item in the Jenkins dashboard.

Image Added

• • Click on the New Item and Create a job name.

Image Added

• • Select Pipeline option from the List of options
  • Navigate to the Pipeline section of the job setup page.
  • The below is a sample groovy script for creating the pipeline job. What the below script does is invoke the existing jobs in sequential order. It should invoke the job deploy Automatics Core, RDB/RDKV Utils, and the jobs needs for Automatics 3.0 which are API Scan job for Automatics Core, Scriptless Automation, RDKB/ RDKV Utils projects.

node {
   
    stage('Deployment DEPLOY_AUTOMATICS_CORE') {
       echo "Calling Deployment-Automatics-Core Job"
       build job: '<<Name_of_Deployment_Job_for_automatics_core>>', wait: true, propagate: true
    }
    
    stage('Deployment RDKM_DEPLOY_RDKB_TEST_UTILS') {
       echo "Calling Deployment-RDKB-Utils Job"
       build job: '<<Name_of_Deployment_Job_for_rdkb_utils>>', wait: true, propagate: true
    }
    
    stage('Deployment RDKM_DEPLOY_RDKV_TEST_UTILS') {
       echo "Calling Deployment-RDKV-Utils Job"
       build job: '<<Name_of_Deployment_Job_for_rdkv_utils>>', wait: true, propagate: true
    }
    
     stage('Run utility parser for Automatics Core') {
       echo "Calling RDKM_AUTOMATICS_API_SCAN_FOR_AUTOMATICS_CORE Job"
       build job: '<<Name_of_Utility_Parser_for_Automatics_Core>>', wait: true, propagate: true
    }
    
    stage('Run utility parser for Scriptless Automation') {
       echo "Calling RDKM_AUTOMATICS_API_SCAN_FOR_SCRIPTLESS_AUTOMATION Job"
       build job: '<<Name_of_Utility_Parser_for_scriptless_automation>>', wait: true, propagate: true
    }
    
      stage('Run utility parser for RDKB Test Utils') {
       echo "Calling RDKM_AUTOMATICS_API_SCAN_FOR_RDKB_UTILS Job"
       build job: '<<Name_of_Utility_Parser_for_rdkb_utils>>', wait: true, propagate: true
    }
    
    stage('Run utility parser for RDKV Test Utils') {
       echo "Calling RDKM_AUTOMATICS_API_SCAN_FOR_RDKV_UTILS Job"
       build job: '<<Name_of_Utility_Parser_for_rdkv_utils>>', wait: true, propagate: true
    }
}

• • The documentation for creating the individual Deployment  jobs can be found here Jenkins Deployment Jobs.

  • The documentation for creating the individual Parser jobs for API san can be found here  Utility Parser Jobs