Jenkinsfile.rcptt-client-test

pipeline {
    agent none
    options {
        buildDiscarder(logRotator(numToKeepStr: '100'))
        throttleJobProperty categories: ['rcptt-jenkins'], limitOneJobWithMatchingParams: false, maxConcurrentPerNode: 3, maxConcurrentTotal: 3, paramsToUseForLimit: '', throttleEnabled: true, throttleOption: 'category'
    }
    parameters {
        gitParameter branch: '', branchFilter: '.*', defaultValue: 'develop' , quickFilterEnabled: true, selectedValue: 'NONE', sortMode: 'NONE', tagFilter: '*', type: 'PT_BRANCH_TAG',
          description: 'The branch or that that the tests are taken from', name: 'BRANCH_OR_TAG'
        string name: 'job_to_copy_from', defaultValue: 'verinice/develop',
          description: '''The job that the AUT is copied from<br/>
        Please note that slashes in the branch-name must be escaped as %2F, e.g. <code>verinice/feature%2Fvn-0000-make-everything-great</code>.'''
        buildSelector name: 'build_to_copy_from',
          description: 'The build number of the job that the AUT is copied from'
        choice(name: 'LANGUAGE', choices: ['de', 'en'],
          description: 'The language the application will use. The tests need to support this also.')
        choice(name: 'OPERATING_SYSTEM', choices: ['Linux', 'macOS current', 'macOS predecessor', 'Windows 10', 'any'],
          description: 'The operating that the tests should run on.')
        booleanParam defaultValue: false, description: 'Run performance tests', name: 'runPerformanceTests'
        booleanParam defaultValue: false, description: 'Run reporting tests', name: 'runReportingTests'
        string(name: 'TEST_LIST', defaultValue: '*.test',
          description: 'Semicolon separated list of tests, or wildcard expressions. Use *.test for all tests.')
        string(name: 'SERVER_TIMEOUT', defaultValue: '360',
          description: 'The startup timeout of the verinice server.')
        string(name: 'TEST_OPTIONS', defaultValue: 'testExecTimeout=45000;execTimeout=410000;reportingIncludeIgnoredWaitDetails=true;passedTestDetails=true;runtimeEnableActivityLogs=true;q7ImageCapture=true;jobHangTimeout=900000;contextRunnableTimeout=900000',
          description: 'The options of the rcptt testing program.')
    }
    stages {
        stage('Run RCPTT tests') {
            agent {
                node {
                    label(['Linux' : 'linux-gui-tester',
                           'macOS current' : 'mac-current-gui-tester',
                           'macOS predecessor' : 'mac-predecessor-gui-tester',
                           'Windows 10' : 'windows-gui-tester',
                           'any' : 'gui-tester'][params.OPERATING_SYSTEM])
                }
            }
            steps {
                sh 'env'
                buildDescription "branch: ${env.GIT_BRANCH} (${env.GIT_COMMIT[0..8]})<br>node: ${env.NODE_NAME}<br>tests: ${params.TEST_LIST}"
                //remove old stuff
                sh '''
                    rm -f *.zip
                '''

                copyArtifacts filter: "**/verinice-*${VERINICE_CLIENT_SELECTOR_OS_COMPONENT}.zip",
                  fingerprintArtifacts: true, flatten: true,
                  projectName: params.job_to_copy_from,
                  selector: buildParameter(params.build_to_copy_from)

                withAnt(installation: 'Ant 1.9.0') {
                    withEnv(["rcptt_runner_HOME=${tool name: 'rcptt_runner-nightly', type: 'com.cloudbees.jenkins.plugins.customtools.CustomTool'}"]) {
                        script {
                            def skipTags = ['skipExecution', 'serverOnlyTest']
                            if (!params.runPerformanceTests){
                                skipTags << 'performance'
                            }
                            if (!params.runReportingTests){
                                skipTags << 'report'
                            }
                            // work around https://issues.jenkins-ci.org/browse/JENKINS-63850
                            if (env.NODE_LABELS.split(' ').contains('linux-gui-tester')){
                                wrap([$class: 'Xvfb', additionalOptions: '', assignedLabels: '',
                                  autoDisplayName: true, displayNameOffset: 0, installationName: 'default-Xvfb',
                                  screen: '1200x960x24']) {
                                    runRCPTT(rcptt_runner_HOME, "883${env.EXECUTOR_NUMBER}", params.TEST_LIST, params.SERVER_TIMEOUT, skipTags, params.TEST_OPTIONS, params.LANGUAGE)
                                }
                            } else {
                                runRCPTT(rcptt_runner_HOME, "883${env.EXECUTOR_NUMBER}", params.TEST_LIST, params.SERVER_TIMEOUT, skipTags, params.TEST_OPTIONS, params.LANGUAGE)
                            }
                        }
                    }
                }
                dir(tool(name: 'logparser', type: 'com.cloudbees.jenkins.plugins.customtools.CustomTool')){
                    sh "./logParser -i log4j  -d ${WORKSPACE.replace('\\', '/')}/gui-test-runner/result/log -f verinice-client.* -o jenkins -n ${WORKSPACE.replace('\\', '/')}/gui-test-runner/result/log/clientlogparsed.txt"
                }
                junit testDataPublishers: [[$class: 'StabilityTestDataPublisher']], testResults: 'gui-test-runner/result/results.junit.xml'
                perfReport filterRegex: '', sourceDataFiles: 'gui-test-runner/result/results.junit.xml'
                recordIssues(tools: [groovyScript(parserId: 'aut-eclipse-log', pattern: 'gui-test-runner/result/log/verinice-aut/.log*')])
                recordIssues(tools: [groovyScript(id: 'verince-client-log', name: 'verince-client-log', parserId: 'verinice-log-parser', pattern: 'gui-test-runner/result/log/clientlogparsed.txt')])
                publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: true, reportDir: 'gui-test-runner/result', reportFiles: 'results.html', reportName: 'Gui Test Report', reportTitles: "${job_to_copy_from}"])
            }
            post {
                always {
                    archiveArtifacts allowEmptyArchive: true, artifacts: 'gui-test-runner/result/**/*.*', excludes: 'build/result/auth/**'
                    notifyBitbucket stashServerBaseUrl: 'https://git.verinice.org/bb',
                      credentialsId: 'bitbucket',
                      commitSha1: '',
                      considerUnstableAsSuccess: false,
                      disableInprogressNotification: false,
                      ignoreUnverifiedSSLPeer: false,
                      includeBuildNumberInKey: false,
                      prependParentProjectKey: false,
                      buildStatus: currentBuild.result,
                      buildName: currentBuild.fullDisplayName,
                      projectKey: ''

                    cleanWs patterns: [[pattern: '*.zip', type: 'INCLUDE']],
                      notFailBuild: true
                }
            }
        }
    }
}

def runRCPTT(runnerPath, veriniceServerPort, testList, veriniceTimeout, skipTags, testOptions, language){
  sh """
  ant -buildfile gui-test-runner/start-gui-test.xml test-verinice-client-test-custom \
	  -Drunner-path=${runnerPath.replace('\\', '/')} \
	  -Dverinice.server.port=${veriniceServerPort} \
	  -Dtest-list="${testList}" \
	  -Dverinice.timeout="${veriniceTimeout}" \
	  -Dskip-tags="${skipTags.join(';')}" \
	  -Dtest-options="${testOptions}" \
	  -Dverinice.lang=${language}"""
}