Add perf test job with cpu/ram usage report (#1234)

Job runs build & performance test with cpu/ram usage reporting
collected by python script. It measure max and avg values for
CPU and RAM during execution of
MemoryTest.ReadNPartitionsFromVersionedLayer/15m_test.

Job is proposed to run weekly or on-demand for release.
Report with collected data feom csv to be showed as
index.html on Gitlab Pages.

Relates-To: OLPEDGE-2459

Signed-off-by: Yaroslav Stefinko <[email protected]>

Author: ystefinko

.gitignore

@@ -7,6 +7,9 @@ CMakeLists.txt.user
 build*/
 *.doap
 .repo
+.cache
+.local
+.bash_history
 
 # Compiled Object files
 *.slo

.gitlab-ci.yml

@@ -23,6 +23,33 @@ stages:
   - translate_report
   - deploy
 
+# Job for running perf test with reports of mem/cpu usage
+weekly_perf_reports:
+  stage: build
+  image: ${DOCKER_REGISTRY}/${DOCKER_IMAGE_USER}:${DOCKER_IMAGE_USER_VERSION}
+  only:
+    refs:
+      - branches
+      - master
+      - schedules
+    variables:
+      - $PERFORMANCE
+  script:
+    - mkdir -p reports .public
+    - $CI_PROJECT_DIR/scripts/linux/weekly/gitlab_build_perf_tests.sh
+    - python3 $CI_PROJECT_DIR/scripts/linux/weekly/run_performance_test_metrics.py
+    - cat $CI_PROJECT_DIR/scripts/linux/weekly/reports/index.html >> .public/index.html && cat $CI_PROJECT_DIR/scripts/linux/weekly/performance_tests.json >> .public/performance_tests.json
+    - if $(ls $CI_PROJECT_DIR/reports/*.xml &>/dev/null); then tar -czvf ${CI_JOB_NAME}_test_reports.tar.gz $CI_PROJECT_DIR/reports ; fi;
+    - $CI_PROJECT_DIR/scripts/misc/artifactory_upload.sh edge-sdks/sdk-for-cpp/releases/test-reports/$CI_JOB_NAME/$CI_JOB_ID/${CI_JOB_NAME}_test_reports.tar.gz $CI_PROJECT_DIR/${CI_JOB_NAME}_test_reports.tar.gz
+  artifacts:
+    when: always
+    paths:
+      - performance_results_*.csv
+      - test_detail_perf.json
+      - .public
+      - reports/*.xml
+    expire_in: 1 year
+
 wv_security_job:
   stage: test
   tags:
@@ -231,6 +258,7 @@ pages:
     variables:
       - $FV
       - $NV
+      - $PERFORMANCE
 
 # TO DO: add Android network test into script $CI_PROJECT_DIR/scripts/android/build-test-emulator.sh
 # Currently job below just build HERE Data SDK for Android and start AVD by Android SDK emulator.

scripts/linux/weekly/gitlab_build_perf_tests.sh

@@ -0,0 +1,26 @@
+#!/bin/bash -ex
+#
+# Copyright (C) 2021 HERE Europe B.V.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# License-Filename: LICENSE
+
+# Script will build olp-cpp-sdk-performance-tests for further execution with CPU/RAM metrics
+
+mkdir -p build && cd build
+
+cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DOLP_SDK_NO_EXCEPTION=ON -DBUILD_SHARED_LIBS=ON -DOLP_SDK_ENABLE_TESTING=ON ..
+
+cmake --build . --target olp-cpp-sdk-performance-tests

scripts/linux/weekly/performance_tests.json

@@ -0,0 +1,41 @@
+[
+  {
+    "name": "MemoryUsage/MemoryTest.ReadNPartitionsFromVersionedLayer/15m_test",
+    "repeat": 1,
+    "metric_infos": [
+      {
+        "name": "Performance",
+        "metrics": [
+          "max_mem",
+          "avg_mem",
+          "max_cpu",
+          "avg_cpu"
+        ]
+      }
+    ],
+    "charts" : [
+      {
+        "name": "ReadNPartitionsFromVersionedLayer/15m_test",
+        "source": "Performance",
+        "charts": [
+          {
+            "name": "CPU usage",
+            "units": "Percentage ( CPU model: sed_cpu_model sed_mhz. Core: sed_n_core. )",
+            "values": [
+              {"Maximum": "max_cpu"},
+              {"Average": "avg_cpu"}
+            ]
+          },
+          {
+            "name": "RAM usage",
+            "units": "MB ( Total: sed_memory_total )",
+            "values": [
+              {"Maximum": "max_mem"},
+              {"Average": "avg_mem"}
+            ]
+          }
+        ]
+      }
+    ]
+  }
+]