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

     1  metadata:
     2    name: mavenExecuteIntegration
     3    aliases:
     4      - name: mavenExecute
     5        deprecated: false
     6    description: "This step will execute backend integration tests via the Jacoco Maven-plugin."
     7    longDescription: |
     8      If the project contains a Maven module named "integration-tests", this step will execute
     9      the integration tests via the Jacoco Maven-plugin.
    10  spec:
    11    inputs:
    12      params:
    13        - name: retry
    14          type: int
    15          description:
    16            "The number of times that integration tests will be retried before failing the step.
    17            Note: This will consume more time for the step execution."
    18          scope:
    19            - PARAMETERS
    20            - STEPS
    21            - STAGES
    22          default: 1
    23        - name: forkCount
    24          type: string
    25          description:
    26            "The number of JVM processes that are spawned to run the tests in parallel in case of
    27            using a maven based project structure.
    28            For more details visit the Surefire documentation at
    29            https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html#forkCount."
    30          scope:
    31            - PARAMETERS
    32            - STEPS
    33            - STAGES
    34          default: "1C"
    35        - name: goal
    36          type: string
    37          description:
    38            "The name of the Maven goal to execute."
    39          scope:
    40            - STEPS
    41            - STAGES
    42            - PARAMETERS
    43          default: "test"
    44        - name: installArtifacts
    45          type: bool
    46          description:
    47            "If enabled, it will install all artifacts to the local maven repository to make them available before running the tests.
    48            This is required if the integration test module has dependencies to other modules in the repository and they were not installed before."
    49          scope:
    50            - GENERAL
    51            - STEPS
    52            - STAGES
    53            - PARAMETERS
    54          default: true
    55        # Global maven settings, should be added to all maven steps
    56        - name: projectSettingsFile
    57          type: string
    58          description: "Path to the mvn settings file that should be used as project settings file."
    59          scope:
    60            - GENERAL
    61            - STEPS
    62            - STAGES
    63            - PARAMETERS
    64          aliases:
    65            - name: maven/projectSettingsFile
    66        - name: globalSettingsFile
    67          type: string
    68          description: "Path to the mvn settings file that should be used as global settings file."
    69          scope:
    70            - GENERAL
    71            - STEPS
    72            - STAGES
    73            - PARAMETERS
    74          aliases:
    75            - name: maven/globalSettingsFile
    76        - name: m2Path
    77          type: string
    78          description: "Path to the location of the local repository that should be used."
    79          scope:
    80            - GENERAL
    81            - STEPS
    82            - STAGES
    83            - PARAMETERS
    84          aliases:
    85            - name: maven/m2Path
    86        - name: logSuccessfulMavenTransfers
    87          type: bool
    88          description: "Configures maven to log successful downloads.
    89            This is set to `false` by default to reduce the noise in build logs."
    90          scope:
    91            - GENERAL
    92            - STEPS
    93            - STAGES
    94            - PARAMETERS
    95          default: false
    96          aliases:
    97            - name: maven/logSuccessfulMavenTransfers
    98    outputs:
    99      resources:
   100        - name: reports
   101          type: reports
   102          params:
   103            - filePattern: "**/requirement.mapping"
   104              type: requirement-mapping
   105            - filePattern: "**/TEST-*.xml"
   106              type: junit
   107            - filePattern: "**/integration-test/*.xml"
   108              type: integration-test
   109            - filePattern: "**/jacoco.xml"
   110              type: jacoco-coverage
   111    containers:
   112      - name: mvn
   113        image: maven:3.6-jdk-8
   114  
   115    # This declaration is necessary in order to return any sidecar configuration in the context config.
   116    sidecars:
   117      - name: ""