Chilkat Online Tools

Android / Salesforce Platform APIs / Tooling Run Tests Sync

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // [
    //   {
    //     "className": "YourClassName",
    //     "testMethods": [
    //       "testMethod1",
    //       "testMethod2",
    //       "testMethod3"
    //     ]
    //   },
    //   {
    //     "maxFailedTests": "2"
    //   }
    // ]

    CkJsonArray jarr = new CkJsonArray();

    jarr.AddObjectAt(-1);
    CkJsonObject jsonObj_1 = jarr.ObjectAt(jarr.get_Size() - 1);
    jsonObj_1.UpdateString("className","YourClassName");
    jsonObj_1.UpdateString("testMethods[0]","testMethod1");
    jsonObj_1.UpdateString("testMethods[1]","testMethod2");
    jsonObj_1.UpdateString("testMethods[2]","testMethod3");

    jarr.AddObjectAt(-1);
    jsonObj_1 = jarr.ObjectAt(jarr.get_Size() - 1);
    jsonObj_1.UpdateString("maxFailedTests","2");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");
    http.SetRequestHeader("Content-Type","application/json");

    CkStringBuilder sbRequestBody = new CkStringBuilder();
    jarr.EmitSb(sbRequestBody);

    CkHttpResponse resp = http.PTextSb("POST","https://domain.com/services/data/v{{version}}/tooling/runTestsSynchronous",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "Failed.");

        return;
        }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "apexLogId": "07L4H00000SpGroUAF",
    //   "codeCoverage": [
    //     {
    //       "id": "01q4H000000WjD8QAK",
    //       "locationsNotCovered": [
    //         {},
    //         {}
    //       ],
    //       "name": "StateTrigger",
    //       "namespace": null,
    //       "numLocations": 2,
    //       "numLocationsNotCovered": 2,
    //       "type": "Trigger"
    //     },
    //     {
    //       "id": "01q58000000RLTyAAO",
    //       "locationsNotCovered": [
    //         {},
    //         {},
    //         {}
    //       ],
    //       "name": "RestrictContactByName",
    //       "namespace": null,
    //       "numLocations": 3,
    //       "numLocationsNotCovered": 3,
    //       "type": "Trigger"
    //     },
    //     {
    //       "id": "01q58000000RLBhAAO",
    //       "locationsNotCovered": [
    //         {},
    //         {},
    //         {},
    //         {},
    //         {},
    //         {}
    //       ],
    //       "name": "ClosedOpportunityTrigger",
    //       "namespace": null,
    //       "numLocations": 6,
    //       "numLocationsNotCovered": 6,
    //       "type": "Trigger"
    //     },
    //     {
    //       "id": "01p4H000009PEFIQA4",
    //       "locationsNotCovered": [
    //         {},
    //         {}
    //       ],
    //       "name": "PrepareSandbox",
    //       "namespace": null,
    //       "numLocations": 22,
    //       "numLocationsNotCovered": 2,
    //       "type": "Class"
    //     }
    //   ],
    //   "codeCoverageWarnings": [
    //     {
    //       "id": "01q4H000000WjD8QAK",
    //       "message": "Test coverage of selected Apex Trigger is 0%, at least 1% test coverage is required",
    //       "name": "StateTrigger",
    //       "namespace": null
    //     },
    //     {
    //       "id": "01q58000000RLTyAAO",
    //       "message": "Test coverage of selected Apex Trigger is 0%, at least 1% test coverage is required",
    //       "name": "RestrictContactByName",
    //       "namespace": null
    //     },
    //     {
    //       "id": "01q58000000RLBhAAO",
    //       "message": "Test coverage of selected Apex Trigger is 0%, at least 1% test coverage is required",
    //       "name": "ClosedOpportunityTrigger",
    //       "namespace": null
    //     },
    //     {
    //       "id": "01q4H000000WjD8QAK",
    //       "message": "Average test coverage across all Apex Classes and Triggers is 60%, at least 75% test coverage is required.",
    //       "name": null,
    //       "namespace": ""
    //     }
    //   ],
    //   "failures": [
    //   ],
    //   "flowCoverage": [
    //   ],
    //   "flowCoverageWarnings": [
    //   ],
    //   "numFailures": 0,
    //   "numTestsRun": 1,
    //   "successes": [
    //     {
    //       "id": "01p4H00000A0zYxQAJ",
    //       "methodName": "runApexClass_should_work",
    //       "name": "PrepareSandboxTest",
    //       "namespace": null,
    //       "seeAllData": false,
    //       "time": 1088
    //     }
    //   ],
    //   "totalTime": 1261
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    String id;
    String name;
    String namespace;
    int numLocations;
    int numLocationsNotCovered;
    String v_type;
    int j;
    int count_j;
    String message;
    String methodName;
    boolean seeAllData;
    int time;

    String apexLogId = jResp.stringOf("apexLogId");
    int numFailures = jResp.IntOf("numFailures");
    int numTestsRun = jResp.IntOf("numTestsRun");
    int totalTime = jResp.IntOf("totalTime");
    int i = 0;
    int count_i = jResp.SizeOfArray("codeCoverage");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("codeCoverage[i].id");
        name = jResp.stringOf("codeCoverage[i].name");
        namespace = jResp.stringOf("codeCoverage[i].namespace");
        numLocations = jResp.IntOf("codeCoverage[i].numLocations");
        numLocationsNotCovered = jResp.IntOf("codeCoverage[i].numLocationsNotCovered");
        v_type = jResp.stringOf("codeCoverage[i].type");
        j = 0;
        count_j = jResp.SizeOfArray("codeCoverage[i].locationsNotCovered");
        while (j < count_j) {
            jResp.put_J(j);
            j = j + 1;
            }

        i = i + 1;
        }

    i = 0;
    count_i = jResp.SizeOfArray("codeCoverageWarnings");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("codeCoverageWarnings[i].id");
        message = jResp.stringOf("codeCoverageWarnings[i].message");
        name = jResp.stringOf("codeCoverageWarnings[i].name");
        namespace = jResp.stringOf("codeCoverageWarnings[i].namespace");
        i = i + 1;
        }

    i = 0;
    count_i = jResp.SizeOfArray("failures");
    while (i < count_i) {
        jResp.put_I(i);
        i = i + 1;
        }

    i = 0;
    count_i = jResp.SizeOfArray("flowCoverage");
    while (i < count_i) {
        jResp.put_I(i);
        i = i + 1;
        }

    i = 0;
    count_i = jResp.SizeOfArray("flowCoverageWarnings");
    while (i < count_i) {
        jResp.put_I(i);
        i = i + 1;
        }

    i = 0;
    count_i = jResp.SizeOfArray("successes");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("successes[i].id");
        methodName = jResp.stringOf("successes[i].methodName");
        name = jResp.stringOf("successes[i].name");
        namespace = jResp.stringOf("successes[i].namespace");
        seeAllData = jResp.BoolOf("successes[i].seeAllData");
        time = jResp.IntOf("successes[i].time");
        i = i + 1;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '[
    {
        "className": "YourClassName",
        "testMethods": [
            "testMethod1",
            "testMethod2",
            "testMethod3"
        ]
    },
    {
        "maxFailedTests": "2"
    }
]

or

{
    "tests": [
        {
            "className": "YourClassName",
            "testMethods": [
                "testMethod1",
                "testMethod2",
                "testMethod3"
            ]
        }
    ],
    "maxFailedTests": "integer value",
    "testLevel": "TestLevel enum value",
    "skipCodeCoverage": "boolean value"
}'
https://domain.com/services/data/v{{version}}/tooling/runTestsSynchronous

Postman Collection Item JSON

{
  "name": "Tooling Run Tests Sync",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "[\n    {\n        \"className\": \"YourClassName\",\n        \"testMethods\": [\n            \"testMethod1\",\n            \"testMethod2\",\n            \"testMethod3\"\n        ]\n    },\n    {\n        \"maxFailedTests\": \"2\"\n    }\n]\n\nor\n\n{\n    \"tests\": [\n        {\n            \"className\": \"YourClassName\",\n            \"testMethods\": [\n                \"testMethod1\",\n                \"testMethod2\",\n                \"testMethod3\"\n            ]\n        }\n    ],\n    \"maxFailedTests\": \"integer value\",\n    \"testLevel\": \"TestLevel enum value\",\n    \"skipCodeCoverage\": \"boolean value\"\n}\n",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/runTestsSynchronous",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "runTestsSynchronous"
      ]
    },
    "description": "Runs one or more methods within one or more Apex classes, using the asynchronous test execution mechanism. In the request body, you can specify test class names and IDs, suite names and IDs, the maximum number of failed tests to allow, and the test level, as comma-separated lists or as an array. You can also indicate whether to opt out of collecting code coverage information during the test run (available in API version 43.0 and later)."
  },
  "response": [
    {
      "name": "Tooling Run Tests Sync",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"tests\": [\n        {\n            \"className\": \"PrepareSandboxTest\",\n            \"testMethods\": [\n                \"runApexClass_should_work\"\n            ]\n        }\n    ],\n    \"maxFailedTests\": \"1\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/runTestsSynchronous",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "runTestsSynchronous"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 11 Dec 2023 09:59:37 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=246/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"apexLogId\": \"07L4H00000SpGroUAF\",\n    \"codeCoverage\": [\n        {\n            \"id\": \"01q4H000000WjD8QAK\",\n            \"locationsNotCovered\": [\n                {},\n                {}\n            ],\n            \"name\": \"StateTrigger\",\n            \"namespace\": null,\n            \"numLocations\": 2,\n            \"numLocationsNotCovered\": 2,\n            \"type\": \"Trigger\"\n        },\n        {\n            \"id\": \"01q58000000RLTyAAO\",\n            \"locationsNotCovered\": [\n                {},\n                {},\n                {}\n            ],\n            \"name\": \"RestrictContactByName\",\n            \"namespace\": null,\n            \"numLocations\": 3,\n            \"numLocationsNotCovered\": 3,\n            \"type\": \"Trigger\"\n        },\n        {\n            \"id\": \"01q58000000RLBhAAO\",\n            \"locationsNotCovered\": [\n                {},\n                {},\n                {},\n                {},\n                {},\n                {}\n            ],\n            \"name\": \"ClosedOpportunityTrigger\",\n            \"namespace\": null,\n            \"numLocations\": 6,\n            \"numLocationsNotCovered\": 6,\n            \"type\": \"Trigger\"\n        },\n        {\n            \"id\": \"01p4H000009PEFIQA4\",\n            \"locationsNotCovered\": [\n                {},\n                {}\n            ],\n            \"name\": \"PrepareSandbox\",\n            \"namespace\": null,\n            \"numLocations\": 22,\n            \"numLocationsNotCovered\": 2,\n            \"type\": \"Class\"\n        }\n    ],\n    \"codeCoverageWarnings\": [\n        {\n            \"id\": \"01q4H000000WjD8QAK\",\n            \"message\": \"Test coverage of selected Apex Trigger is 0%, at least 1% test coverage is required\",\n            \"name\": \"StateTrigger\",\n            \"namespace\": null\n        },\n        {\n            \"id\": \"01q58000000RLTyAAO\",\n            \"message\": \"Test coverage of selected Apex Trigger is 0%, at least 1% test coverage is required\",\n            \"name\": \"RestrictContactByName\",\n            \"namespace\": null\n        },\n        {\n            \"id\": \"01q58000000RLBhAAO\",\n            \"message\": \"Test coverage of selected Apex Trigger is 0%, at least 1% test coverage is required\",\n            \"name\": \"ClosedOpportunityTrigger\",\n            \"namespace\": null\n        },\n        {\n            \"id\": \"01q4H000000WjD8QAK\",\n            \"message\": \"Average test coverage across all Apex Classes and Triggers is 60%, at least 75% test coverage is required.\",\n            \"name\": null,\n            \"namespace\": \"\"\n        }\n    ],\n    \"failures\": [],\n    \"flowCoverage\": [],\n    \"flowCoverageWarnings\": [],\n    \"numFailures\": 0,\n    \"numTestsRun\": 1,\n    \"successes\": [\n        {\n            \"id\": \"01p4H00000A0zYxQAJ\",\n            \"methodName\": \"runApexClass_should_work\",\n            \"name\": \"PrepareSandboxTest\",\n            \"namespace\": null,\n            \"seeAllData\": false,\n            \"time\": 1088\n        }\n    ],\n    \"totalTime\": 1261\n}"
    }
  ]
}