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

     1  metadata:
     2    name: abapEnvironmentRunATCCheck
     3    description: Runs an ATC Check
     4    longDescription: |
     5      This step is for triggering an [ATC](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/d8cec788fc104ff9ad9c3757b4dd13d4.html) test run on an SAP Cloud Platform ABAP Environment system.
     6      Please provide either of the following options:
     7  
     8      * The host and credentials the Cloud Platform ABAP Environment system itself. The credentials must be configured for the Communication Scenario [SAP_COM_0510](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b04a9ae412894725a2fc539bfb1ca055.html).
     9      * The Cloud Foundry parameters (API endpoint, organization, space), credentials, the service instance for the ABAP service and the service key for the Communication Scenario SAP_COM_0510.
    10      * Only provide one of those options with the respective credentials. If all values are provided, the direct communication (via host) has priority.
    11  
    12      Regardless of the option you chose, please make sure to provide the configuration the object set (e.g. with Software Components and Packages) that you want to be checked analog to the examples listed on this page.
    13  spec:
    14    inputs:
    15      secrets:
    16        - name: abapCredentialsId
    17          aliases:
    18            - name: cfCredentialsId
    19          description: Jenkins credentials ID containing user and password to authenticate to the Cloud Platform ABAP Environment system or the Cloud Foundry API
    20          type: jenkins
    21      params:
    22        - name: atcConfig
    23          type: string
    24          description: Path to a YAML configuration file for the object set to be checked during ATC run
    25          scope:
    26            - PARAMETERS
    27            - STAGES
    28            - STEPS
    29          mandatory: false
    30        - name: repositories
    31          type: string
    32          description: Specifies a YAML file containing the repositories configuration
    33          scope:
    34            - GENERAL
    35            - PARAMETERS
    36            - STAGES
    37            - STEPS
    38        - name: cfApiEndpoint
    39          type: string
    40          description: Cloud Foundry API endpoint
    41          scope:
    42            - PARAMETERS
    43            - STAGES
    44            - STEPS
    45            - GENERAL
    46          mandatory: false
    47          aliases:
    48            - name: cloudFoundry/apiEndpoint
    49        - name: cfOrg
    50          type: string
    51          description: CF org
    52          scope:
    53            - PARAMETERS
    54            - STAGES
    55            - STEPS
    56            - GENERAL
    57          mandatory: false
    58          aliases:
    59            - name: cloudFoundry/org
    60        - name: cfServiceInstance
    61          type: string
    62          description: Parameter of ServiceInstance Name to delete CloudFoundry Service
    63          scope:
    64            - PARAMETERS
    65            - STAGES
    66            - STEPS
    67            - GENERAL
    68          mandatory: false
    69          aliases:
    70            - name: cloudFoundry/serviceInstance
    71        - name: cfServiceKeyName
    72          type: string
    73          description: Parameter of CloudFoundry Service Key to be created
    74          scope:
    75            - PARAMETERS
    76            - STAGES
    77            - STEPS
    78            - GENERAL
    79          mandatory: false
    80          aliases:
    81            - name: cloudFoundry/serviceKey
    82            - name: cloudFoundry/serviceKeyName
    83            - name: cfServiceKey
    84        - name: cfSpace
    85          type: string
    86          description: CF Space
    87          scope:
    88            - PARAMETERS
    89            - STAGES
    90            - STEPS
    91            - GENERAL
    92          mandatory: false
    93          aliases:
    94            - name: cloudFoundry/space
    95        - name: username
    96          type: string
    97          description: User for either the Cloud Foundry API or the Communication Arrangement for SAP_COM_0510
    98          scope:
    99            - PARAMETERS
   100            - STAGES
   101            - STEPS
   102          mandatory: true
   103          secret: true
   104          resourceRef:
   105            - name: abapCredentialsId
   106              type: secret
   107              param: username
   108        - name: password
   109          type: string
   110          description: Password for either the Cloud Foundry API or the Communication Arrangement for SAP_COM_0510
   111          scope:
   112            - PARAMETERS
   113            - STAGES
   114            - STEPS
   115          mandatory: true
   116          secret: true
   117          resourceRef:
   118            - name: abapCredentialsId
   119              type: secret
   120              param: password
   121        - name: host
   122          type: string
   123          description: Specifies the host address of the SAP Cloud Platform ABAP Environment system
   124          scope:
   125            - PARAMETERS
   126            - STAGES
   127            - STEPS
   128            - GENERAL
   129          mandatory: false
   130        - name: atcResultsFileName
   131          type: string
   132          description: Specifies output file name for the results from the ATC run. This file name will also be used for generating the HTML file
   133          scope:
   134            - PARAMETERS
   135            - STAGES
   136            - STEPS
   137          mandatory: false
   138          default: "ATCResults.xml"
   139        - name: generateHTML
   140          type: bool
   141          description: Specifies whether the ATC results should also be generated as an HTML document
   142          scope:
   143            - PARAMETERS
   144            - STAGES
   145            - STEPS
   146            - GENERAL
   147          mandatory: false
   148    containers:
   149      - name: cf
   150        image: ppiper/cf-cli:7