Skip to content

Latest commit

 

History

History
218 lines (187 loc) · 5.45 KB

atc.md

File metadata and controls

218 lines (187 loc) · 5.45 KB

ATC

  1. customizing
  2. run
  3. profile list
  4. profile dump

customizing

Fetches and prints out ATC configuration.

sapcli atc customizing

To be able to use Code Inspector variants, you must set the user parameter SATC_CI_MODE to X; otherwise the default value '' means Checkman mode.

User parameters are configured in the transaction SU01 or in the table USR05.

run

Executes ATC Checks on the given object and exits with non-zero code, if ATC findings of Prio higher then the configured level are found.

sapcli atc run {package,class,program} OBJECT_NAME [-r VARIANT] [-e ERROR_LEVEL] [-m MAX_VERDICITS] [-o {human,html,checkstyle}] [-s SEVERITY_MAPPING] [-f PRIORITY_FILTER]
  • OBJECT_NAME package, class or program name
  • VARIANT if not provided, the system variant from customizing is used
  • ERROR_LEVEL All ATC Prio numbers higher than this mumber are not considered erros (default: 2)
  • MAX_VERDICTS Total number of verdicts returned (default: 100)
  • -o OUTPUT Output format in which checks will be printed (default: human)
  • SEVERITY_MAPPING Severity mapping between ATC PRIO levels and Checkstyle severities (default: None). Could be passed as SEVERITY_MAPPING env variable. Should be passes as JSON string, example: {"1":"error", "2":"warning", "3":"info"}
  • PRIORITY_FILTER Consider priorities lower than the set value.

Output format

Human

FAKE/TEST/MADE_UP_OBJECT
* 1 :: UNIT_TEST :: Unit tests for ATC module of sapcli
* 2 :: PRIO_2 :: Prio 2
* 3 :: PRIO_3 :: Prio 3
* 4 :: PRIO_4 :: Prio 4

HTML

<table>
<tr><th>Object type ID</th>
<th>Name</th></tr>
<tr><td>FAKE/TEST</td>
<td>MADE_UP_OBJECT</td></tr>
<tr><th>Priority</th>
<th>Check title</th>
<th>Message title</th></tr>
<tr><td>1</td>
<td>UNIT_TEST</td>
<td>Unit tests for ATC module of sapcli</td></tr>
<tr><td>2</td>
<td>PRIO_2</td>
<td>Prio 2</td></tr>
<tr><td>3</td>
<td>PRIO_3</td>
<td>Prio 3</td></tr>
<tr><td>4</td>
<td>PRIO_4</td>
<td>Prio 4</td></tr>
</table>

Checkstyle

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="8.36">
<file name="FAKE/TEST&#8725;FOO&#8725;MADE_UP_OBJECT">
<error line="24" column="0" severity="error" message="Unit tests for ATC module of sapcli" source="UNIT_TEST"/>
<error line="32" column="0" severity="error" message="Prio 2" source="PRIO_2"/>
<error line="45" column="0" severity="warning" message="Prio 3" source="PRIO_3"/>
<error line="67" column="0" severity="warning" message="Prio 4" source="PRIO_4"/>
</file>
</checkstyle>
Severity mapping

By default, sapcli mapps ATC checks to severity the following way:

  • PRIO 1 = Error
  • PRIO 2 = Error
  • PRIO 3 = Warning
  • PRIO 4 = Warning
  • PRIO 5 = Info

The mapping can be changed via the command line option -s/--severity-mapping or via the environment variable SEVERITY_MAPPING. Both options accepts JSON string encoding an object with 5 properties where names are used for ATC PRIO numbers (1-5) and values hold Checkstyle severity values - error, warning, info.

The default configuration in JSON is the following:

{"1": "error", "2": "error", "3": "warning", "4": "warning", "5": "info"}

References:

profile list

Fetches and prints all ATC profiles.

sapcli atc profile list

Default output - list of profile names:

profile_id
PROFILE1
PROFILE2

Long output:

sapcli atc profile list -l
profile_id | created | created_by | changed | changed_by
PROFILE1 | 20010309180000 | ALICE | 20080415161735 | BOB 
PROFILE2 | 20210309180000 | BOB| 20080415161735 | BOB

Json output:

sapcli atc profile list --output json
{
  "PROFILE1": {
    "created": "20010309180000",
    "created_by": "ALICE",
    "changed": "20080415161735",
    "changed_by": "BOB"
  },
  "PROFILE2": {
    "created": "20210309180000",
    "created_by": "BOB",
    "changed": "20080415161735",
    "changed_by": "BOB"
  }
}

profile dump

Fetches and dumps complete content of ATC profiles, including checkman priorities. The output is always in json format with following structure:

{
  "profiles": {
    "profile-name": {
      "created": "timestamp",
      "created_by": "userid",
      "changed": "timestamp",
      "changed_by": "userid",
      "trans": {
        "D": "Profile description in German",
        "?": "..."
      },
      "checks": {
        "first check name": {
          "sequence_number": "number",
          "since": "timestamp",
          "note": ""
        },
        "next check": {"..."}
      }
    }
  }
}

It is possible to limit dump to specific profiles. The output is same, but content is stripped. Only data relevant to selected profiles are printed out.

sapcli atc profile dump -p PROFILE1 PROFILE2

Use flag --checkman to include checkman priorities:

sapcli atc profile dump --checkman

The output json will contain additional key on root level called checkman_messages_local and it's content will have following structure:

{
  "profiles": "see above",
  "checkman_messages_local": [
    {
      "check_id": "CHECK1",
      "check_view": "",
      "check_message_id": "EHPW",
      "local_prio": "3",
      "deactivated": "",
      "valid_to": "timestamp",
      "valid_id": "some comment"
    },
    {"..."}
   ]
}