github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/gctsExecuteABAPUnitTests.yaml (about)

     1  metadata:
     2    name: gctsExecuteABAPUnitTests
     3    description: Runs ABAP unit tests and ATC (ABAP Test Cockpit) checks for a specified object scope.
     4    longDescription: |
     5      This step executes ABAP unit test and ATC checks for a specified scope of objects that exist in a local Git repository on an ABAP system.
     6  
     7  spec:
     8    inputs:
     9      secrets:
    10        - name: abapCredentialsId
    11          description: ID taken from the Jenkins credentials store containing user name and password of the user that authenticates to the ABAP system on which you want to execute the checks.
    12          type: jenkins
    13      params:
    14        - name: username
    15          type: string
    16          description: User that authenticates to the ABAP system. Note - Don´t provide this parameter directly. Either set it in the environment, or in the Jenkins credentials store, and provide the ID as value of the `abapCredentialsId` parameter.
    17          scope:
    18            - PARAMETERS
    19            - STAGES
    20            - STEPS
    21          mandatory: true
    22          secret: true
    23          resourceRef:
    24            - name: abapCredentialsId
    25              type: secret
    26              param: username
    27        - name: password
    28          type: string
    29          description: Password of the ABAP user that authenticates to the ABAP system. Note - Don´t provide this parameter directly. Either set it in the environment, or in the Jenkins credentials store, and provide the ID as value of the `abapCredentialsId` parameter.
    30          scope:
    31            - PARAMETERS
    32            - STAGES
    33            - STEPS
    34          mandatory: true
    35          secret: true
    36          resourceRef:
    37            - name: abapCredentialsId
    38              type: secret
    39              param: password
    40        - name: host
    41          type: string
    42          description: Protocol and host of the ABAP system, including the port. Please provide it in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.
    43          scope:
    44            - PARAMETERS
    45            - STAGES
    46            - STEPS
    47          mandatory: true
    48        - name: repository
    49          type: string
    50          description: Name (ID) of the local repository on the ABAP system
    51          scope:
    52            - PARAMETERS
    53            - STAGES
    54            - STEPS
    55          mandatory: true
    56        - name: client
    57          type: string
    58          description: Client of the ABAP system in which you want to execute the checks
    59          scope:
    60            - PARAMETERS
    61            - STAGES
    62            - STEPS
    63          mandatory: true
    64        - name: aUnitTest
    65          type: bool
    66          default: true
    67          description: |
    68           Indication whether you want to execute the ABAP Unit tests. If the ABAP Unit tests fail, the results are mapped as follows to the statuses available in the Jenkins plugin. (Successful ABAP unit test results are not displayed.)
    69           <br/>
    70           - Failed with severity `fatal` is displayed as an `Error`.
    71           <br/>
    72           - Failed with severity `critical` is displayed as an `Error`.
    73           <br/>
    74           - Failed with severity `warning` is displayed as a `Warning`.
    75          scope:
    76            - PARAMETERS
    77            - STAGES
    78            - STEPS
    79        - name: atcCheck
    80          type: bool
    81          default: true
    82          description: |
    83            Indication whether you want to execute the ATC checks. If the ATC checks result in errors with priorities 1 and 2, they are considered as failed. The results are mapped as follows to the statuses available in the Jenkins plugin. (Successful ATC check results are not displayed.)
    84            <br/>
    85            - Priorities 1 and 2 are displayed as an `Error`.
    86            <br/>
    87            - Priority 3 is displayed as a `Warning`.
    88          scope:
    89            - PARAMETERS
    90            - STAGES
    91            - STEPS
    92        - name: atcVariant
    93          type: string
    94          default: "DEFAULT"
    95          description: Variant for ATC checks
    96          scope:
    97            - PARAMETERS
    98            - STAGES
    99            - STEPS
   100        - name: scope
   101          type: string
   102          default: repository
   103          enum:
   104            - localChangedObjects
   105            - remoteChangedObjects
   106            - localChangedPackages
   107            - remoteChangedPackages
   108            - repository
   109            - packages
   110          description: |
   111            Scope of objects for which you want to execute the checks:
   112            <br/>
   113            - `localChangedObjects`: The object scope is derived from the last activity in the local repository. The checks are executed for the individual objects.
   114            <br/>
   115            - `remoteChangedObjects`: The object scope is the delta between the commit that triggered the pipeline and the current commit in the remote repository. The checks are executed for the individual objects.
   116            <br/>
   117            - `localChangedPackages`: The object scope is derived from the last activity in the local repository. All objects are resolved into packages. The checks are executed for the packages.
   118            <br/>
   119            - `remoteChangedPackages`: The object scope is the delta between the commit that triggered the pipeline and the current commit in the remote repository. All objects are resolved into packages. The checks are executed for the packages.
   120            <br/>
   121            - `repository`: The object scope comprises all objects that are part of the local repository. The checks are executed for the individual objects. Packages (DEVC) are excluded. This is the default scope.
   122            <br/>
   123            - `packages`: The object scope comprises all packages that are part of the local repository. The checks are executed for the packages.
   124          scope:
   125            - PARAMETERS
   126            - STAGES
   127            - STEPS
   128        - name: commit
   129          type: string
   130          description: ID of the commit that triggered the pipeline or any other commit used to calculate the object scope. Specifying a commit is mandatory for the `remoteChangedObjects` and `remoteChangedPackages` scopes.
   131          scope:
   132            - PARAMETERS
   133            - STAGES
   134            - STEPS
   135          mandatory: false
   136        - name: workspace
   137          type: string
   138          description: Absolute path to the directory that contains the source code that your CI/CD tool checks out. For example, in Jenkins, the workspace parameter is `/var/jenkins_home/workspace/<jobName>/`. As an alternative, you can use Jenkins's predefined environmental variable `WORKSPACE`.
   139          scope:
   140            - PARAMETERS
   141            - STAGES
   142            - STEPS
   143          mandatory: true
   144        - name: atcResultsFileName
   145          type: string
   146          description: Specifies an output file name for the results of the ATC checks.
   147          scope:
   148            - PARAMETERS
   149            - STAGES
   150            - STEPS
   151          mandatory: false
   152          default: "ATCResults.xml"
   153        - name: aUnitResultsFileName
   154          type: string
   155          description: Specifies an output file name for the results of the ABAP Unit tests.
   156          scope:
   157            - PARAMETERS
   158            - STAGES
   159            - STEPS
   160          mandatory: false
   161          default: "AUnitResults.xml"