This repository has been archived by the owner on Mar 28, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tests: metrics: Add script to save results into csv
Add the send_results.sh.in script that saves the metrics results into csv files under the tests/metrics/results dir. Also add it to the generated files list so it can be pre-processed into a runnable script. Signed-off-by: Graham Whaley <[email protected]>
- Loading branch information
Graham Whaley
committed
Jun 16, 2017
1 parent
827347d
commit 9a4daf9
Showing
2 changed files
with
341 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,340 @@ | ||
| #!/bin/bash | ||
|
|
||
| # This file is part of cc-oci-runtime. | ||
| # | ||
| # Copyright (C) 2017 Intel Corporation | ||
| # | ||
| # This program is free software; you can redistribute it and/or | ||
| # modify it under the terms of the GNU General Public License | ||
| # as published by the Free Software Foundation; either version 2 | ||
| # of the License, or (at your option) any later version. | ||
| # | ||
| # This program is distributed in the hope that it will be useful, | ||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| # GNU General Public License for more details. | ||
| # | ||
| # You should have received a copy of the GNU General Public License | ||
| # along with this program; if not, write to the Free Software | ||
| # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||
| # | ||
| # This script will store the results into csv files in the | ||
| # metrics 'results' directory. | ||
| # The csv file names are derived from the reported 'test name', and all | ||
| # results for a single 'test name' are collated (appended) into a single csv. | ||
|
|
||
| # General env | ||
| MYSELF="${0##*/}" | ||
| SCRIPT_PATH=$(dirname $(readlink -f $0)) | ||
| source "${SCRIPT_PATH}/test-common.bash" | ||
|
|
||
| # Override the RESULT_DIR from the test-common.bash for the moment. | ||
| # Once all all tests are migrated to use this script, remove the | ||
| # RESULT_DIR definition from test-common.bash, as all results should | ||
| # be then stored via this script | ||
| RESULT_DIR="${SCRIPT_PATH}/../metrics/results" | ||
|
|
||
| GROUP="PNP" | ||
| CC_DEFAULT_IMG_PATH="/usr/share/clear-containers" | ||
| CONTAINERS_IMG_SYSTEM="@CONTAINERS_IMG@" | ||
| CONTAINERS_IMG_GUESS="${CC_DEFAULT_IMG_PATH}/clear-containers.img" | ||
| CONTAINER_KERNEL_SYSTEM="@CONTAINER_KERNEL@" | ||
| CONTAINER_KERNEL_GUESS="${CC_DEFAULT_IMG_PATH}/vmlinux.container" | ||
| SYSTEM_CLEAR_RELEASE_FILE="/usr/lib/os-release" | ||
| SYSTEM_CENTOS_RELEASE_FILE="/etc/os-release" | ||
|
|
||
| declare TEST_NAME | ||
| declare RESULT | ||
| declare ARGS | ||
| declare UNITS | ||
| declare SYS_VERSION | ||
| declare SYSTEM | ||
| declare TAG | ||
| declare HW | ||
| declare SEND | ||
| declare KERNEL | ||
| declare IMG | ||
|
|
||
| # Parse the platform name | ||
| function get_platform_name() | ||
| { | ||
| com="core" | ||
|
|
||
| model="$(cat /proc/cpuinfo | grep "model name" | uniq | \ | ||
| awk -F ": " '{print $2}' | sed s/\(R\)//g | \ | ||
| sed s/\(TM\)//g | sed s/[[:space:]]*CPU[[:space:]]*/" "/g | \ | ||
| cut -d"@" -f1 | sed s/[[:space:]]*$//g)" | ||
|
|
||
| num_cores=$(nproc) | ||
|
|
||
| if (( $num_cores > 1 ));then | ||
| com="cores" | ||
| fi | ||
|
|
||
| echo "$model ($num_cores $com)" | ||
| } | ||
|
|
||
| # Locate the cor runtime binary. If unknown or unfound, return nothing | ||
| function locate_runtime() | ||
| { | ||
| # For now use the build installed path for the runtime | ||
| # Ultimately, it would be good if we could ask/extract from | ||
| # docker itself where the runtime it is using lives | ||
| if [ -f "${bindir}/cc-oci-runtime" ];then | ||
| echo "${bindir}/cc-oci-runtime" | ||
| else | ||
| # And if we cannot find it at the default, can we find it | ||
| # in the path | ||
| runtime="$(which cc-oci-runtime)" | ||
| if [ ! -z "$runtime" ]; then | ||
| echo "$runtime" | ||
| fi | ||
| fi | ||
|
|
||
| } | ||
|
|
||
| function find_system_name() | ||
| { | ||
| os="$(cat "$SYSTEM_RELEASE_FILE" | grep -w "ID" | cut -d "=" -f2)" | ||
|
|
||
| if [ -z "$os" ];then | ||
| os="Unknown" | ||
| fi | ||
|
|
||
| echo "$os" | ||
| } | ||
|
|
||
| function find_system_version() | ||
| { | ||
| version="$(cat "$SYSTEM_RELEASE_FILE" | grep "VERSION_ID"| cut -d "=" -f2 | sed s/\"//g)" | ||
|
|
||
| if [ -z "$version" ];then | ||
| version="Unknown" | ||
| fi | ||
|
|
||
| echo "$version" | ||
| } | ||
|
|
||
| # Try to find the img file we are running with. | ||
| function locate_containers_img() | ||
| { | ||
| # This is the location the build/install is configured for | ||
| res="$CONTAINERS_IMG_SYSTEM" | ||
|
|
||
| if [ ! -f "$res" ];then | ||
| # but, sometimes we are running the tests on an already installed | ||
| # system - try a 'backup' path | ||
| # This is far far from perfect. | ||
| # Ideally we'd ask the test runner or test or docker which runtime | ||
| # and kernel and img (if appropriate for the runtime) were used | ||
| res="$CONTAINERS_IMG_GUESS" | ||
|
|
||
| if [ ! -f "$res" ];then | ||
| res="" | ||
| fi | ||
| fi | ||
|
|
||
| echo "$res" | ||
| } | ||
|
|
||
| # Try to find the VM container kernel that was used | ||
| function locate_container_kernel() | ||
| { | ||
| # This is the location the build/install is configured for | ||
| res="$CONTAINER_KERNEL_SYSTEM" | ||
|
|
||
| if [ ! -f "$res" ];then | ||
| # but, sometimes we are running the tests on an already installed | ||
| # system - try a 'backup' path | ||
| # This is far far from perfect. | ||
| # Ideally we'd ask the test runner or test or docker which runtime | ||
| # and kernel and img (if appropriate for the runtime) were used | ||
| res="$CONTAINER_KERNEL_GUESS" | ||
|
|
||
| if [ ! -f "$res" ];then | ||
| res="" | ||
| fi | ||
| fi | ||
|
|
||
| echo "$res" | ||
| } | ||
|
|
||
| function save_to_csv() | ||
| { | ||
|
|
||
| if [ -z "$TEST_NAME" ];then | ||
| die "test name argument not supplied" | ||
| fi | ||
|
|
||
| if [ -z "$RESULT" ];then | ||
| die "result argument not supplied" | ||
| fi | ||
|
|
||
| if [ -z "$UNITS" ];then | ||
| die "units argument not supplied" | ||
| fi | ||
|
|
||
| if [ -z "$HW" ];then | ||
| platform="$(get_platform_name)" | ||
| HW="$platform" | ||
| fi | ||
|
|
||
| if [ -z "$IMG" ];then | ||
| CONTAINERS_IMG="$(locate_containers_img)" | ||
| IMG="$(readlink "$CONTAINERS_IMG")" | ||
| fi | ||
|
|
||
| if [ -z "$KERNEL" ];then | ||
| CONTAINER_KERNEL="$(locate_container_kernel)" | ||
| KERNEL="$(readlink "$CONTAINER_KERNEL")" | ||
| fi | ||
|
|
||
| if [ -z "$TAG" ];then | ||
| # This is somewhat imperfect. Ideally we'd have knowledge passed | ||
| # in from the test itself about which runtime it used so we could | ||
| # be certain to have the correct runtime and extract the correct | ||
| # commit id | ||
| runtime="$(locate_runtime)" | ||
| if [ -f "$runtime" ];then | ||
| commit="$($runtime -v | tail -n1 | sed s/"commit: "//g)" | ||
| TAG="$commit" | ||
| else | ||
| TAG="unknown" | ||
| fi | ||
| fi | ||
|
|
||
| if [ -z "$SYSTEM" ];then | ||
| SYSTEM="$(find_system_name)" | ||
| fi | ||
|
|
||
| if [ -z "$SYS_VERSION" ];then | ||
| SYS_VERSION="$(find_system_version)" | ||
| fi | ||
|
|
||
| if [ -z "$ARGS" ];then | ||
| ARGS="none" | ||
| fi | ||
|
|
||
| # Generate the file name from the test name - replace spaces and path chars | ||
| # to hyphens | ||
| CSV_FILE=${RESULT_DIR}/$(echo ${TEST_NAME} | sed 's/[ \/]/-/g').csv | ||
|
|
||
| if [ ! -d ${RESULT_DIR} ];then | ||
| mkdir -p ${RESULT_DIR} | ||
| fi | ||
|
|
||
| timestamp="$(date +%s)" | ||
|
|
||
| # If this is the first write to the file, start with the column header | ||
| if [ ! -f ${CSV_FILE} ];then | ||
| s0=$(echo "Timestamp,Group,Name,Args,Result,Units,System,SystemVersion,Platform,Image,Kernel,Commit") | ||
| if [ -z "$SEND" ];then | ||
| echo "${s0}" > "${CSV_FILE}" | ||
| else | ||
| echo "Would have done: echo ${s0} > ${CSV_FILE}" | ||
| fi | ||
| fi | ||
|
|
||
| # A bit horrid - but quote the values in the CSV just in case one has an embedded comma | ||
| s1=$(echo "\"$timestamp\",\"$GROUP\",\"$TEST_NAME\",\"$ARGS\",\"$RESULT\",\"$UNITS\",\"$SYSTEM\",\"$SYS_VERSION\",\"$platform\",\"$IMG\",\"$KERNEL\",\"$commit\"") | ||
|
|
||
| if [ -z "$SEND" ];then | ||
| echo "${s1}" >> "${CSV_FILE}" | ||
| else | ||
| echo "Would have done: echo ${s1} > ${CSV_FILE}" | ||
| fi | ||
| } | ||
|
|
||
| function help() | ||
| { | ||
| usage=$(cat << EOF | ||
| Usage: $MYSELF [-h] [--help] [-v] [--version] | ||
| Description: | ||
| This tool will save results to csv files. | ||
| Options: | ||
| -a Test arguments | ||
| -d Dry-run | ||
| -g Group (by default PNP) | ||
| -h Help page | ||
| -i Clear containers image | ||
| -k Clear containers kernel image | ||
| -n Test name (Mandatory) | ||
| -o OS version | ||
| -r Test Results (Mandatory) | ||
| -s Name of OS | ||
| -t Git commit | ||
| -u Test units, example: secs, ms, KB (Mandatory) | ||
| -v Show version | ||
| -w (Hardware | platform) name | ||
| EOF | ||
| ) | ||
| echo "$usage" | ||
| } | ||
|
|
||
| function main() | ||
| { | ||
| local OPTIND | ||
| while getopts ":a:dg:hi:k:n:o:r:s:t:u:vw: " opt;do | ||
| case ${opt} in | ||
| a) | ||
| ARGS="${OPTARG}" | ||
| ;; | ||
| d) SEND="No" | ||
| ;; | ||
| g) | ||
| GROUP="${OPTARG}" | ||
| ;; | ||
| h) | ||
| help | ||
| exit 0; | ||
| ;; | ||
| i) IMG="${OPTARG}" | ||
| ;; | ||
| k) KERNEL="${OPTARG}" | ||
| ;; | ||
| n) | ||
| TEST_NAME="${OPTARG}" | ||
| ;; | ||
| o) | ||
| SYS_VERSION="${OPTARG}" | ||
| ;; | ||
| r) | ||
| RESULT="${OPTARG}" | ||
| ;; | ||
| s) | ||
| SYSTEM="${OPTARG}" | ||
| ;; | ||
| t) TAG="${OPTARG}" | ||
| ;; | ||
| u) | ||
| UNITS="${OPTARG}" | ||
| ;; | ||
| v) | ||
| echo "$MYSELF version 0.1" | ||
| exit 0; | ||
| ;; | ||
| w) HW="${OPTARG}" | ||
| ;; | ||
| esac | ||
| done | ||
| shift $((OPTIND-1)) | ||
|
|
||
| # do some prep work to locate files | ||
| # Try to figure out where the system release file is | ||
| if [ -f $SYSTEM_CLEAR_RELEASE_FILE ];then | ||
| SYSTEM_RELEASE_FILE="$SYSTEM_CLEAR_RELEASE_FILE" | ||
| fi | ||
|
|
||
| if [ -f $SYSTEM_CENTOS_RELEASE_FILE ];then | ||
| SYSTEM_RELEASE_FILE="$SYSTEM_CENTOS_RELEASE_FILE" | ||
| fi | ||
|
|
||
| if [ -z "$SYSTEM_RELEASE_FILE" ];then | ||
| die "Cannot locate system release file" | ||
| fi | ||
|
|
||
| save_to_csv | ||
| } | ||
|
|
||
| # call main | ||
| main "$@" |