Introduction

Automatics supports CI integration and validation of RDK builds. To integrate Automatics in any CI system, the CI portal has to follow REST communication with Automatics.

CI portal should provide details like image name and other request parameters along with REST request. Automatics has pre-configured filters for CI requests. If request parameters from CI portal matches with filter, then the request is ACCEPTED. For ACCEPTED requests, Automatics will trigger test execution based on test data configured against filter.

The status of requests ACCEPTED and REJECTED are available in Automatics Orchestration.

Filter parameters supported are shown below. These parameters except 'images' are configurable from DB. So partner can configure their custom parameters in CI request.

CI Portal - Automatics Communication Diagram

eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlJhZGhpa2EgU3VkaGFrYXJhbiIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJaLVJlc2htaSBLIFIiLCJsYW5ndWFnZSI6ImVuIiwidWlDb25maWciOiJ7fSIsImRpYWdyYW1EaXNwbGF5TmFtZSI6IiIsInNGaWxlSWQiOiIiLCJhdHRJZCI6IjE2OTQ1MDgzMSIsImRpYWdyYW1OYW1lIjoiQ0lfRmxvdyIsImFzcGVjdCI6IiIsImxpbmtzIjoiYXV0byIsImNlb05hbWUiOiJDSSBQb3J0YWwgLSBBdXRvbWF0aWNzIEludGVncmF0aW9uIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjoxNjk0NTA3NTcsImVkaXRhYmxlIjpmYWxzZSwiY2VvSWQiOjE4Mjc1Mjc5MSwicGFnZUlkIjoiIiwibGJveCI6dHJ1ZSwic2VydmVyQ29uZmlnIjp7ImVtYWlscHJldmlldyI6IjEifSwib2RyaXZlSWQiOiIiLCJyZXZpc2lvbiI6MSwibWFjcm9JZCI6ImQ0MWE3ZTI3LWM2YTktNDc3ZS1hOWRhLTcwZDJmYWU5MzkyZSIsInByZXZpZXdOYW1lIjoiQ0lfRmxvdy5wbmciLCJsaWNlbnNlU3RhdHVzIjoiT0siLCJzZXJ2aWNlIjoiIiwiaXNUZW1wbGF0ZSI6IiIsIndpZHRoIjoiNDQ5Iiwic2ltcGxlVmlld2VyIjpmYWxzZSwibGFzdE1vZGlmaWVkIjoxNjQ3MzI4NTY2MDAwLCJleGNlZWRQYWdlV2lkdGgiOmZhbHNlLCJvQ2xpZW50SWQiOiIifQ==

CI Portal - Automatics Communication

• Rest based communication
• Automatics End Point: /Automatics/handleRdkTrigger.htm
• Description: Automatics accepts request from CI portal in this end point. Upon receiving the request from CI portal, Automatics immediately returns the response code 200 with response text 'Request received and taken for processing.'  On receiving the request, Automatics will start processing it. Based on the filters configured in Automatics Orchestration, the request from CI portal will be accepted or rejected. 
• Response Code: 200
• Response Body: Request received and taken for processing.

Automatics - CI Portal Communication

• Rest based communication
• CI Portal End Point: /json/test
• Description:  When a request from CI portal is accepted, Automatics Orchestration will send execution request to Jenkins. The test cases to be executed for CI validation will pre-configured  in Orchestration. Set of scripts to be executed for a CI request with image name and other parameter values is configured in Automatics. Upon completion of test execution, the results will be updated back to CI portal.
• Request Content-Type: application/json
• Request Body Format:

{
   "service":"CI_VERIFICATION",
   "status":"SUCCESS",
   "started_at":1623818325471,
   "started_by":"CI PORTAL",
   "duration":3618,
   "result":{
      "build_name":"image_name",
      "type":"test_type",
      "tests":[
         {
            "test_id":"Test case id",
            "step":"Step No",
            "description":"Test step description",
            "status":"Test step status",
            "reason":"Reason for failure",
            "jira_id":"Jira Id"
         }
      ]
   },
   "finished_at":1623818329089,
   "test_jenkins_url":"http://{jenkins}/job/JOB1/612",
   "boxes":[
      {
         "eSTB_mac":"estb_mac",
         "eCM_mac":"ecm_mac",
         "eSTB_ip":"estb_ip,
         "eCM_ip":"ecm_ip"
      }
   ]
}

• Response Code: 200