Follow the instructions in the [build from source guide](https://github.com/mostafa/xk6-kafka) to get started.
## Running the k6 test suites
-Simply run the main script. (The script assumes k6 and docker-compose have been installed).
+These tests measure the system capabilities as per requirements.
+There are two test profiles can be run with either: kpi or endurance.
+Simply run the main script. (The script assumes k6 and the relevant docker-compose have been installed).
```shell
-./run-k6-tests.sh
+./run-k6-tests.sh kpi
```
## Running k6 tests manually
*/
import http from 'k6/http';
-export const NCMP_BASE_URL = 'http://localhost:8883';
-export const DMI_PLUGIN_URL = 'http://ncmp-dmi-plugin-demo-and-csit-stub:8092';
+
+const testConfig = JSON.parse(open(`../config/${__ENV.TEST_PROFILE}.json`));
+export const KAFKA_BOOTSTRAP_SERVERS = testConfig.hosts.kafkaBootstrapServer;
+export const LEGACY_BATCH_TOPIC_NAME = testConfig.kafka.legacyBatchTopic;
+export const DURATION = testConfig.timingConfig.testDuration;
+export const LEGACY_BATCH_THROUGHPUT_TEST_START_TIME = testConfig.timingConfig.legacyBatchThroughputTestStartTime;
+export const NCMP_BASE_URL = testConfig.hosts.ncmpBaseUrl;
+export const DMI_PLUGIN_URL = testConfig.hosts.dmiStubUrl;
export const TOTAL_CM_HANDLES = 20000;
export const REGISTRATION_BATCH_SIZE = 100;
export const READ_DATA_FOR_CM_HANDLE_DELAY_MS = 300; // must have same value as in docker-compose.yml
export const CONTENT_TYPE_JSON_PARAM = {'Content-Type': 'application/json'};
export const LEGACY_BATCH_THROUGHPUT_TEST_BATCH_SIZE = 200;
export const LEGACY_BATCH_THROUGHPUT_TEST_NUMBER_OF_REQUESTS = 100;
-export const LEGACY_BATCH_TOPIC_NAME = 'legacy_batch_topic';
-export const KAFKA_BOOTSTRAP_SERVERS = ['localhost:9092'];
export const MODULE_SET_TAGS = ['tagA', 'tagB', 'tagC', 'tagD', 'tagE'];
--- /dev/null
+{
+ "hosts": {
+ "ncmpBaseUrl": "http://localhost:8884",
+ "dmiStubUrl": "http://ncmp-dmi-plugin-demo-and-csit-stub:8092",
+ "kafkaBootstrapServer": "localhost:9093"
+ },
+ "timingConfig": {
+ "testDuration": "2h"
+ },
+ "kafka": {
+ "legacyBatchTopic": "legacy_batch_topic"
+ }
+}
--- /dev/null
+{
+ "hosts": {
+ "ncmpBaseUrl": "http://localhost:8883",
+ "dmiStubUrl": "http://ncmp-dmi-plugin-demo-and-csit-stub:8092",
+ "kafkaBootstrapServer": "localhost:9092"
+ },
+ "timingConfig": {
+ "testDuration": "15m",
+ "legacyBatchThroughputTestStartTime": "15m30s"
+ },
+ "kafka": {
+ "legacyBatchTopic": "legacy_batch_topic"
+ }
+}
\ No newline at end of file
import {
TOTAL_CM_HANDLES, READ_DATA_FOR_CM_HANDLE_DELAY_MS, WRITE_DATA_FOR_CM_HANDLE_DELAY_MS,
makeCustomSummaryReport, makeBatchOfCmHandleIds, LEGACY_BATCH_THROUGHPUT_TEST_BATCH_SIZE,
- LEGACY_BATCH_TOPIC_NAME, KAFKA_BOOTSTRAP_SERVERS, REGISTRATION_BATCH_SIZE,
- LEGACY_BATCH_THROUGHPUT_TEST_NUMBER_OF_REQUESTS
+ REGISTRATION_BATCH_SIZE, LEGACY_BATCH_THROUGHPUT_TEST_NUMBER_OF_REQUESTS, DURATION,
+ LEGACY_BATCH_THROUGHPUT_TEST_START_TIME, KAFKA_BOOTSTRAP_SERVERS, LEGACY_BATCH_TOPIC_NAME
} from './common/utils.js';
import { createCmHandles, deleteCmHandles, waitForAllCmHandlesToBeReady } from './common/cmhandle-crud.js';
import { executeCmHandleSearch, executeCmHandleIdSearch } from './common/search-base.js';
let cmSearchTrustLevelDurationTrend = new Trend('cm_search_trustlevel_duration', true);
let legacyBatchReadCmHandlesPerSecondTrend = new Trend('legacy_batch_read_cmhandles_per_second', false);
-const legacyBatchEventReader = new Reader({
- brokers: KAFKA_BOOTSTRAP_SERVERS,
+export const legacyBatchEventReader = new Reader({
+ brokers: [KAFKA_BOOTSTRAP_SERVERS],
topic: LEGACY_BATCH_TOPIC_NAME,
});
-const DURATION = '15m';
-const LEGACY_BATCH_THROUGHPUT_TEST_START_TIME = '15m30s';
-
export const options = {
setupTimeout: '20m',
teardownTimeout: '20m',
pushd "$(dirname "$0")" >/dev/null || exit 1
number_of_failures=0
-echo "Running K6 performance tests..."
+testProfile=$1
+summaryFile="${testProfile}Summary.csv"
-# Redirecting stderr to /dev/null to prevent large log files
-k6 --quiet run ncmp-kpi.js > summary.csv 2>/dev/null || ((number_of_failures++))
+echo "Running $testProfile performance tests..."
+k6 run ncmp-kpi.js --quiet -e TEST_PROFILE="$testProfile" > "$summaryFile" 2>/dev/null || ((number_of_failures++))
-if [ -f summary.csv ]; then
+if [ -f "$summaryFile" ]; then
# Output raw CSV for plotting job
- echo '-- BEGIN CSV REPORT'
- cat summary.csv
- echo '-- END CSV REPORT'
+ echo "-- BEGIN CSV REPORT"
+ cat "$summaryFile"
+ echo "-- END CSV REPORT"
echo
# Output human-readable report
- echo '####################################################################################################'
- echo '## K 6 P E R F O R M A N C E T E S T R E S U L T S ##'
- echo '####################################################################################################'
- column -t -s, summary.csv
+ echo "####################################################################################################"
+ if [ "$testProfile" = "kpi" ]; then
+ echo "## K 6 K P I P E R F O R M A N C E T E S T R E S U L T S ##"
+ else
+ echo "## K 6 E N D U R A N C E P E R F O R M A N C E T E S T R E S U L T S ##"
+ fi
+ echo "####################################################################################################"
+ column -t -s, "$summaryFile"
echo
# Clean up
- rm -f summary.csv
+ rm -f "$summaryFile"
else
- echo "Error: Failed to generate summary.csv" >&2
+ echo "Error: Failed to generate $summaryFile" >&2
((number_of_failures++))
fi
set -o pipefail # Use last non-zero exit code in a pipeline
#set -o xtrace # Uncomment for debugging
+# default is empty string, which means performance tests
+testProfile=${1:-kpi}
+
on_exit() {
rc=$?
- ./teardown.sh
+ ./teardown.sh "$testProfile"
popd
echo "TEST FAILURES: $rc"
exit $rc
# Install needed dependencies.
source install-deps.sh
+echo "Test profile provided: $testProfile"
+
# Run k6 test suite.
-./setup.sh
-./ncmp/run-all-tests.sh
+./setup.sh "$testProfile"
+./ncmp/run-all-tests.sh "$testProfile"
NCMP_RESULT=$?
# Note that the final steps are done in on_exit function after this exit!
-exit $NCMP_RESULT
+exit $NCMP_RESULT
\ No newline at end of file
# limitations under the License.
#
-docker-compose -f ../docker-compose/docker-compose.yml --profile dmi-stub up --quiet-pull -d
+testProfile=$1
+echo "Spinning off the CPS and NCMP containers for $testProfile testing..."
+
+if [[ "$testProfile" == "endurance" ]]; then
+ docker-compose -f ../docker-compose/docker-compose.yml --profile dmi-stub --project-name "$testProfile" --env-file ../docker-compose/config/endurance.env up --quiet-pull -d
+ CONTAINER_IDS=$(docker ps --filter "name=endurance-cps-and-ncmp" --format "{{.ID}}")
+else
+ docker-compose -f ../docker-compose/docker-compose.yml --profile dmi-stub --project-name "$testProfile" up --quiet-pull -d
+ CONTAINER_IDS=$(docker ps --filter "name=kpi-cps-and-ncmp" --format "{{.ID}}")
+fi
echo "Waiting for CPS to start..."
READY_MESSAGE="Inventory Model updated successfully"
-# Get the container IDs of the cps-and-ncmp replicas
-CONTAINER_IDS=$(docker ps --filter "name=cps-and-ncmp" --format "{{.ID}}")
-
# Check the logs for each container
for CONTAINER_ID in $CONTAINER_IDS; do
echo "Checking logs for container: $CONTAINER_ID"
echo '================================== docker info =========================='
docker ps -a
-echo 'Stopping, Removing containers and volumes...'
-docker_compose_cmd="docker-compose -f ../docker-compose/docker-compose.yml --profile dmi-stub down --volumes"
+testProfile=$1
+docker_compose_shutdown_cmd="docker-compose -f ../docker-compose/docker-compose.yml --profile dmi-stub --project-name $testProfile down --volumes"
+
# Set an environment variable CLEAN_DOCKER_IMAGES=1 to also remove docker images when done (used on jenkins job)
+echo "Stopping, Removing containers and volumes for $testProfile tests..."
if [ "${CLEAN_DOCKER_IMAGES:-0}" -eq 1 ]; then
- $docker_compose_cmd --rmi all
+ $docker_compose_shutdown_cmd --rmi all
else
- $docker_compose_cmd
+ $docker_compose_shutdown_cmd
fi
Code Review / cps.git / commitdiff