Skip to content

Latest commit

 

History

History
378 lines (235 loc) · 9.88 KB

running-abap-test-cockpit-atc-check-runs-d8cec78.md

File metadata and controls

378 lines (235 loc) · 9.88 KB

Running ABAP Test Cockpit (ATC) Check Runs

Prerequisites

  • You have an SAP BTP ABAP environment system.

  • You’ve created a Communication User as described in How to Create Communication Users.

  • You’ve created a Communication System as described in How to Create Communication Systems.

  • You’ve created a Communication Arrangement as described in How to Create a Communication Arrangement.

  • You've selected the communication scenario SAP_COM_0901 for your communication arrangement and have mapped it to your communication system.

    Restriction:

    The communication scenario SAP_COM_0510 is deprecated and should no longer be used.

  • You've defined a business user in the additional properties in the communication arrangement. To do so, choose the Additional Properties link for ATC Check Run in the Inbound Services section. Specify a business user (CB) or select a user from the value help. ATC runs started via the service will be scheduled and run with the specified business user.

    Note:

    The assigned business user needs development authorization for ADT, which is contained in the business catalog SAP_A4C_BC_DEV_ATC_RUN_PC. In case the ATC is used to run ABAP Unit Tests, further specific authorizations might be required.

    When you assign the catalog to a dedicated role, do not forget to remove the restriction to read-only access before saving the role.

Context

The ABAP Test Cockpit (ATC) is the standard tool for checking the quality of ABAP development objects using static checks and ABAP unit tests. In this help topic, you'll learn how to start an ATC Check Run via REST Service.

For more information about the ABAP Test Cockpit, see Checking Quality of ABAP Code with ATC.

Procedure

  1. (Get CSRF token) The first step serves for the authentication on the server. The response header contains an CSRF token, which is used as authentication for the POST request following in step 2.

    Request

    Authentication Type: Basic Authentication

    GET https://<host.com>:<port>/sap/bc/adt/api/atc/runs/00000000000000000000000000000000

    Headers

    KEY

    VALUE

    accept

    application/vnd.sap.atc.run.v1+xml

    x-csrf-token

    fetch

    Response

    Body

    <?xml version="1.0" encoding="utf-8"?>
<atc:run status="Not Created" xmlns:atc="http://www.sap.com/adt/atc">
    <atc:progress description="No run was created, no objects had to be checked"/>
    <atc:phases/>
</atc:run>

    Headers

    KEY

    VALUE

    x-csrf-token

    <token>

    location

    /sap/bc/adt/atc/runs/00000000000000000000000000000000

  2. (Start an ATC Check Run) To start an ATC check run, insert the CSRF token that was retrieved in the first request in the header parameters.

    Request

    POST https://<host.com>:<port>/sap/bc/adt/api/atc/runs?clientWait=false

    Headers

    KEY

    VALUE

    x-csrf-token

    <token>

    content type

    application/vnd.sap.atc.run.parameters.v1+xml

    Body

    You can specify components, packages or both. If you specify both components and packages, only those objects will be checked that are assigned to packages that belong to the specified software components.

    For the package value, enter the name of the package you want to have checked.

    You can provide an ATC configuration as additional parameter that is used instead of the default configuration of your system.

    You can also provide an ATC check variant as additional parameter. This is used instead of the default check variant of your ATC configuration, regardless of whether an ATC configuration was explicitly provided via parameter or not.

    You can specify arbitrary object sets. See also Object Sets and XML Representations of Object Sets for more details.

    <?xml version="1.0" encoding="UTF-8"?>
<atc:runparameters xmlns:atc="http://www.sap.com/adt/atc"
         xmlns:obj="http://www.sap.com/adt/objectset"
         checkVariant="CHECKVARIANT_NAME"
         objectProvider="OBJECTPROVIDER_NAME"
         configuration="CONFIGURATION_NAME">
    <osl:objectSet xsi:type="unionSet" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:osl="http://www.sap.com/api/osl">
      <osl:set xsi:type="osl:multiPropertySet">
        <osl:property key="softwareComponent" value="Z_MY_COMPONENT"/>
      </osl:set>
      <osl:set xsi:type="osl:packageSet">
        <osl:package includeSubpackages="false" name="Z_MY_PACKAGE"/>
      </osl:set>
    </osl:objectSet>
</atc:runparameters>

    Response

    Headers

    KEY

    VALUE

    location

    /sap/bc/adt/api/atc/runs/<UUID>

  3. **(Tracking the Status of the Check Run)**To track the status of the check run, you can make a GET request using the URI contained in the location header.

    Request

    GET https://<host.com>:<port>/sap/bc/adt/api/atc/runs/<UUID>

    Headers

    KEY

    VALUE

    accept

    application/vnd.sap.atc.run.v1+xml

    Response

    While the check is still running, the ATC phases will show the status ”In Process” or “Undefined” in the body.

    The check run is finished when all ATC phases show the status “Completed”. You'll find the link /sap/bc/adt/api/atc/results/<UUID> at the bottom of the body. Use this link to retrieve the ATC check run results in the next step.

    Body

    <?xml version="1.0" encoding="utf-8"?>
<atc:run status="Completed" xmlns:atc="http://www.sap.com/adt/atc">
    <atc:progress description="Run Completed"/>
    <atc:phases>
        <atc:phase title="Determine Object Keys" status="Completed" number="1"/>
        ...
    </atc:phases>
    <atom:link href="/sap/bc/adt/api/atc/results/<UUID>" rel="http://www.sap.com/abap/checks/atc/relations/results/displayid" type="application/xml" title="Result" xmlns:atom="http://www.w3.org/2005/Atom"/>
</atc:run>

  4. (Retrieve Results) To get the ATC results, use the following request.

    Request

    GET /sap/bc/adt/api/atc/results/<UUID>

    Headers

    KEY

    VALUE

    Accept

    application/vnd.sap.atc.checkstyle.v1+xml

    Response

    The results are submitted in the checkstyle format. You can find the checkstyle XSD here: https://github.com/linkedin/pygradle/blob/master/pygradle-plugin/src/test/resources/checkstyle/checkstyle.xsd.

    Body

    As an example, the result may look like this:

    <?xml version="1.0" encoding="utf-8"?>
<checkstyle version="1.0">
    <file name="PACKAGE/OBJECT_NAME.OBJECT_TYPE">
    <error message="Hard-coded user name (@User's formatted name)" source="CL_CI_TEST_EXTENDED_CHECK_SEC#0821" line="2" severity="error"/>
</checkstyle>

    In this example, the error message shows a hard-coded username. Ideally, the formatted user name corresponds to the developer that edited the object for the last time. In case "last changed by" shouldn't be available for the object, the author is used instead. In case the formatted user name can't be determined, the business user id is displayed as fallback.

    Note:

    In the output, the namespace slashes will be replaced by dashes. That means /NAMESPACE/OBJECT_NAME will be output as -NAMESPACE-OBJECT_NAME.