benchmark-test-endpoint.jenkinsfile

/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

lib = library(identifier: 'jenkins@6.8.0', retriever: modernSCM([

    $class: 'GitSCMSource',
    remote: 'https://github.com/opensearch-project/opensearch-build-libraries.git',
]))

pipeline {
    agent none
    options {
        timeout(time: 24, unit: 'HOURS')
        buildDiscarder(logRotator(daysToKeepStr: '30'))
    }
    environment {
        AGENT_LABEL = 'Jenkins-Agent-AL2023-X64-M52xlarge-Benchmark-Test'
        JOB_NAME = 'benchmark-test'
    }
parameters {
        password(
            name: 'CLUSTER_ENDPOINT',
            description: 'Provide an endpoint to a cluster for running benchmark tests against it.',
        )
        booleanParam(
            name: 'SECURITY_ENABLED',
            description: 'Mention if the cluster is secured or insecured.',
            defaultValue: false,
        )
        password(
            name: 'USERNAME',
            description: 'Enter username for the cluster endpoint',
            defaultValue: ''
        )
        password(
            name: 'PASSWORD',
            description: 'Enter password for the cluster endpoint',
            defaultValue: ''
        )
        string(
            name: 'TEST_WORKLOAD',
            description: 'The workload name from OpenSearch Benchmark Workloads.',
            defaultValue: 'nyc_taxis',
            trim: true
        )
        string(
            name: 'USER_TAGS',
            description: 'Attach arbitrary text to the meta-data of each benchmark metric record, without any spaces. e.g., `run-type:adhoc,segrep:enabled,arch:x64`. ',
            trim: true
        )
        string(
            name: 'WORKLOAD_PARAMS',
            description: 'With this parameter you can inject variables into workloads. Use json type. e.g., `{"number_of_replicas":"1","number_of_shards":"5"}`',
            trim: true
        )
        string(
            name: 'TEST_PROCEDURE',
            description: 'Defines a test procedure to use. e.g., `append-no-conflicts,significant-text`',
            trim: true
        )
        string(
            name: 'EXCLUDE_TASKS',
            description: 'Defines a comma-separated list of test procedure tasks not to run. Default runs all. e.g., `type:search,delete-index`',
            trim: true
        )
        string(
            name: 'INCLUDE_TASKS',
            description: 'Defines a comma-separated list of test procedure tasks to run. Default runs all. e.g., `type:search,delete-index`',
            trim: true
        )
        booleanParam(
            name: 'CAPTURE_NODE_STAT',
            description: 'Enable opensearch-benchmark node-stats telemetry to capture system level metrics.',
            defaultValue: false
        )
        booleanParam(
            name: 'CAPTURE_SEGMENT_REPLICATION_STAT',
            description: 'Enable opensearch-benchmark segment-replication-stats telemetry to capture metrics such as replication lag.',
            defaultValue: false
        )
        string(
            name: 'TELEMETRY_PARAMS',
            description: 'Allows to set parameters for telemetry devices. Use json type. e.g.,{"node-stats-include-indices":"true","node-stats-include-indices-metrics":"segments"}',
            trim: true
        )
    }

    stages {
        stage('validate-and-set-parameters') {
            agent { label AGENT_LABEL }
            steps {
                script {
                    if (CLUSTER_ENDPOINT == '') {
                        currentBuild.result = 'ABORTED'
                        error("Benchmark Tests failed to start. Provide CLUSTER_ENDPOINT to run tests")
                    }
                }
            }
            post {
                always {
                    postCleanup()
                }
            }
        }
        stage('benchmark-test-with-cluster') {
            agent { label AGENT_LABEL }
            steps {
                script {
                    echo "security-enabled: ${SECURITY_ENABLED}"

                    runBenchmarkTestScript(
                        command: 'execute-test',
                        endpoint: CLUSTER_ENDPOINT,
                        insecure: !(params.SECURITY_ENABLED),
                        username: USERNAME,
                        password: PASSWORD,
                        workload: TEST_WORKLOAD,
                        userTag: USER_TAGS.isEmpty() ? "security-enabled:${SECURITY_ENABLED}" : "${USER_TAGS},security-enabled:${SECURITY_ENABLED}",
                        suffix: "${BUILD_NUMBER}",
                        workloadParams: WORKLOAD_PARAMS,
                        testProcedure: TEST_PROCEDURE,
                        excludeTasks: EXCLUDE_TASKS,
                        includeTasks: INCLUDE_TASKS,
                        captureNodeStat: CAPTURE_NODE_STAT,
                        captureSegmentReplicationStat: CAPTURE_SEGMENT_REPLICATION_STAT,
                        telemetryParams: TELEMETRY_PARAMS
                    )
                    stash includes: 'test_execution*.csv', name: "benchmark"

                }
            }
            post {
                always {
                    unstash "benchmark"
                    archiveArtifacts artifacts: 'test_execution*.csv'
                    postCleanup()
                }
            }
        }
    }
}