From 666882575233736b745a0345ab910f43d581b810 Mon Sep 17 00:00:00 2001
From: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
Date: Thu, 31 Aug 2023 16:17:29 +0000
Subject: [PATCH] metrics: Add grabdata script for metrics report

This PR adds the grabdata script so it can be used for the metrics report
for kata metrics.

Fixes #7812

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
---
 tests/metrics/report/grabdata.sh | 168 +++++++++++++++++++++++++++++++
 1 file changed, 168 insertions(+)
 create mode 100755 tests/metrics/report/grabdata.sh

diff --git a/tests/metrics/report/grabdata.sh b/tests/metrics/report/grabdata.sh
new file mode 100755
index 0000000000..3544339f8a
--- /dev/null
+++ b/tests/metrics/report/grabdata.sh
@@ -0,0 +1,168 @@
+#!/bin/bash
+# Copyright (c) 2018-2023 Intel Corporation
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# Run a set of the metrics tests to gather data to be used with the report
+# generator. The general ideal is to have the tests configured to generate
+# useful, meaninful and repeatable (stable, with minimised variance) results.
+# If the tests have to be run more or longer to achieve that, then generally
+# that is fine - this test is not intended to be quick, it is intended to
+# be repeatable.
+
+# Note - no 'set -e' in this file - if one of the metrics tests fails
+# then we wish to continue to try the rest.
+# Finally at the end, in some situations, we explicitly exit with a
+# failure code if necessary.
+
+SCRIPT_DIR=$(dirname "$(readlink -f "$0")")
+source "${SCRIPT_DIR}/../lib/common.bash"
+RESULTS_DIR=${SCRIPT_DIR}/../results
+
+# By default we run all the tests
+RUN_ALL=1
+
+help() {
+	usage=$(cat << EOF
+Usage: $0 [-h] [options]
+   Description:
+        This script gathers a number of metrics for use in the
+        report generation script. Which tests are run can be
+        configured on the commandline. Specifically enabling
+        individual tests will disable the 'all' option, unless
+        'all' is also specified last.
+   Options:
+        -a,         Run all tests (default).
+        -d,         Run the density tests.
+        -h,         Print this help.
+        -s,         Run the storage tests.
+        -t,         Run the time tests.
+EOF
+)
+	echo "$usage"
+}
+
+# Set up the initial state
+init() {
+	metrics_onetime_init
+
+	local OPTIND
+	while getopts "adhst" opt;do
+		case ${opt} in
+		a)
+		    RUN_ALL=1
+		    ;;
+		d)
+		    RUN_DENSITY=1
+		    RUN_ALL=
+		    ;;
+		h)
+		    help
+		    exit 0;
+		    ;;
+		s)
+		    RUN_STORAGE=1
+		    RUN_ALL=
+		    ;;
+		t)
+		    RUN_TIME=1
+		    RUN_ALL=
+		    ;;
+		?)
+		    # parse failure
+		    help
+		    die "Failed to parse arguments"
+		    ;;
+		esac
+	done
+	shift $((OPTIND-1))
+}
+
+run_density_ksm() {
+	echo "Running KSM density tests"
+
+	# Run the memory footprint test - the main test that
+	# KSM affects. Run for a sufficient number of containers
+	# (that gives us a fair view of how memory gets shared across
+	# containers), and a large enough timeout  for KSM to settle.
+	# If KSM has not settled down by then, just take the measurement.
+	# 'auto' mode should detect when KSM has settled automatically.
+	bash density/memory_usage.sh 20 300 auto
+
+	# Get a measure for the overhead we take from the container memory
+	bash density/memory_usage_inside_container.sh
+}
+
+run_density() {
+	echo "Running non-KSM density tests"
+
+	# Run the density tests - no KSM, so no need to wait for settle
+	# Set a token short timeout, and use enough containers to get a
+	# good average measurement.
+	bash density/memory_usage.sh 20 5
+}
+
+run_time() {
+	echo "Running time tests"
+	# Run the time tests - take time measures for an ubuntu image, over
+	# 100 'first and only container' launches.
+	# NOTE - whichever container you test here must support a full 'date'
+	# command - busybox based containers (including Alpine) will not work.
+	bash time/launch_times.sh -i public.ecr.aws/ubuntu/ubuntu:latest -n 100
+}
+
+run_storage() {
+	echo "Running storage tests"
+
+	bash storage/blogbench.sh
+}
+
+
+# Execute metrics scripts
+run() {
+	pushd "$SCRIPT_DIR/.."
+
+	# If KSM is available on this platform, let's run any tests that are
+	# affected by having KSM on/off first, and then turn it off for the
+	# rest of the tests, as KSM may introduce some extra noise in the
+	# results by stealing CPU time for instance.
+	if [[ -f ${KSM_ENABLE_FILE} ]]; then
+		# No point enabling and disabling KSM if we have nothing to test.
+		if [ -n "$RUN_ALL" ] || [ -n "$RUN_DENSITY" ]; then
+			save_ksm_settings
+			trap restore_ksm_settings EXIT QUIT KILL
+			set_ksm_aggressive
+
+			run_density_ksm
+
+			# And now ensure KSM is turned off for the rest of the tests
+			disable_ksm
+		fi
+	else
+		echo "No KSM control file, skipping KSM tests"
+	fi
+
+	if [ -n "$RUN_ALL" ] || [ -n "$RUN_TIME" ]; then
+		run_time
+	fi
+
+	if [ -n "$RUN_ALL" ] || [ -n "$RUN_DENSITY" ]; then
+		run_density
+	fi
+
+	if [ -n "$RUN_ALL" ] || [ -n "$RUN_STORAGE" ]; then
+		run_storage
+	fi
+
+	popd
+}
+
+finish() {
+	echo "Now please create a suitably descriptively named subdirectory in"
+	echo "$RESULTS_DIR and copy the .json results files into it before running"
+	echo "this script again."
+}
+
+init "$@"
+run
+finish