Merge pull request #991 from exadel-inc/k6_load_tests

Added k6 load tests

Author: VolodymyrBushko

load-tests/README.md

@@ -0,0 +1,46 @@
+# K6 load tests for CompreFace services  
+Each folder inside `tests` folder contains a separate loading test.
+To run tests, first you need to build an image:
+```
+cd ./docker
+docker build -t k6tests .
+```
+
+Then you can run all tests or define a list of tests (as TESTS env variable):
+```
+# run only face_verify and recognize tests
+docker run \
+    -e TESTS="face_verify;recognize" \ 
+    -e HOSTNAME="http://myhost:8082" \
+    -e INFLUXDB_HOSTNAME="http://myinfluxdbhost:8086"
+    -e DB_CONNECTION_STRING="user=postgres password=postgres port=5432 dbname=frs host=mydbhost sslmode=disable" \
+    k6tests
+```
+```
+# run all tests
+docker run \ 
+    -e HOSTNAME="http://myhost:8082" \
+    -e INFLUXDB_HOSTNAME="http://myinfluxdbhost:8086"
+    -e DB_CONNECTION_STRING="user=postgres password=postgres port=5432 dbname=frs host=mydbhost sslmode=disable" \
+    k6tests
+```
+
+Any test from `tests` folder follows those steps:
+1. Apply db_init.sql to database
+2. Run recognition test according to `scenarios` defined in the script
+3. Apply db_truncate.sql to database
+
+
+### Run command details
+```
+docker run 
+    --env IMAGES="./faces/FACE_512KB.jpg;./faces/FACE_1024KB.jpg"
+    --env HOSTNAME="<host>"
+    --env INFLUXDB_HOSTNAME="<influxdb_host>"
+    --env DB_CONNECTION_STRING="user=postgres password=<password> port=5432 dbname=frs host=<db_host> sslmode=disable" 
+    <image_id>
+``` 
+`IMAGES` list of images fot test (if images are needed for the test)   
+`HOSTNAME` hostname of test server  
+`INFLUXDB_HOSTNAME` hostname of influxdb  
+`DB_CONNECTION_STRING` DB connection string, template is *"user=mydbuser password=mydbpass port=5432 dbname=mydbname host=mydbhost sslmode=disable"*

load-tests/docker/Dockerfile

@@ -0,0 +1,19 @@
+FROM alpine:3.13.4
+
+ENV K6_HOME="/data/k6" \
+#   run all tests by default
+    TESTS="" \
+    VUS="1" \
+    ITERATIONS="1" \
+    DURATION="2m" \
+    HOSTNAME="http://localhost:8000" \
+    INFLUXDB_HOSTNAME="http://localhost:8086" \
+    DB_CONNECTION_STRING="user=postgres password=postgres port=5432 dbname=frs host=localhost sslmode=disable"
+
+RUN mkdir -p ${K6_HOME}
+WORKDIR	${K6_HOME}
+ADD . .
+RUN chmod +x ./entrypoint.sh \
+    && chmod +x ./k6
+
+ENTRYPOINT ["./entrypoint.sh"]

load-tests/docker/entrypoint.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+FOLDERS=""
+
+if [ -z "$TESTS" ]
+then
+  echo "TESTS is empty, run all tests"
+  FOLDERS=$(ls -F tests | tr "/ " "\n")
+else
+  echo "TESTS to run: $TESTS"
+  FOLDERS=$(echo $TESTS | tr ";" "\n")
+fi
+
+for test_folder in $FOLDERS
+do
+  echo "************************************************************************"
+  echo "********************************** $test_folder"
+  echo "************************************************************************"
+
+  chmod +x ./tests/${test_folder}/loadtest.k6.js
+  ./k6 run \
+    --insecure-skip-tls-verify \
+    --vus ${VUS} \
+    --iterations ${ITERATIONS} \
+    --duration ${DURATION} \
+    -e HOSTNAME="$HOSTNAME" \
+    -e DB_CONNECTION_STRING="$DB_CONNECTION_STRING" \
+    --out influxdb=${INFLUXDB_HOSTNAME}/${test_folder} \
+    ./tests/${test_folder}/loadtest.k6.js
+done

load-tests/docker/k6

@@ -0,0 +1,2 @@
+INSERT INTO app(id, name, guid, api_key) VALUES (1, 'TEST_K6_1', 'a1111a11-ae6d-4636-8b47-49754ca2f54b', '6f348698-6985-4296-914e-a5e3270cfad1');
+INSERT INTO model(id, name, guid, api_key, app_id, type) VALUES (1, 'D_SERVICE', 'm1111a11-ae6d-4636-8b47-49754ca2f54b', '1f348698-6985-4296-914e-a5e3270cfad7', 1, 'D');

load-tests/docker/tests/detect/db_init.sql

@@ -0,0 +1,2 @@
+DELETE FROM app WHERE id IN ('1', '2', '3');
+DELETE FROM model WHERE id IN ('1');

load-tests/docker/tests/detect/db_truncate.sql

@@ -0,0 +1,93 @@
+/*
+ * FormData polyfill for k6
+ * Copyright (C) 2021 Load Impact
+ * License: MIT
+ *
+ * This simplifies the creation of multipart/form-data requests from k6 scripts.
+ * It was adapted from the original version by Rob Wu[1] to remove references of
+ * XMLHttpRequest and File related code which isn't supported in k6.
+ *
+ * [1]: https://gist.github.com/Rob--W/8b5adedd84c0d36aba64
+ **/
+
+if (exports.FormData) {
+  // Don't replace FormData if it already exists
+  return;
+}
+
+// Export variable to the global scope
+exports.FormData = FormData;
+
+function FormData() {
+  // Force a Constructor
+  if (!(this instanceof FormData)) return new FormData();
+  // Generate a random boundary - This must be unique with respect to the
+  // form's contents.
+  this.boundary = '------RWWorkerFormDataBoundary' + Math.random().toString(36);
+  this.parts = [];
+
+  /**
+   * Internal method. Convert input to a byte array.
+   * @param inp String | ArrayBuffer | Uint8Array  Input
+   */
+  this.__toByteArray = function(inp) {
+    var arr = [];
+    var i = 0, len;
+    if (typeof inp === 'string') {
+      for (len = inp.length; i < len; ++i)
+        arr.push(inp.charCodeAt(i) & 0xff);
+    } else if (inp && inp.byteLength) {/*If ArrayBuffer or typed array */
+      if (!('byteOffset' in inp))   /* If ArrayBuffer, wrap in view */
+        inp = new Uint8Array(inp);
+      for (len = inp.byteLength; i < len; ++i)
+        arr.push(inp[i] & 0xff);
+    }
+    return arr;
+  };
+}
+
+/**
+ * @param fieldName          String                    Form field name
+ * @param data               object|string             An object or string field value.
+ *
+ * If data is an object, it should match the structure of k6's http.FileData
+ * object (returned by http.file()) and consist of:
+ * @param data.data          String|Array|ArrayBuffer  File data
+ * @param data.filename      String                    Optional file name
+ * @param data.content_type  String                    Optional content type, default is application/octet-stream
+ **/
+FormData.prototype.append = function(fieldName, data) {
+  if (arguments.length < 2) {
+    throw new SyntaxError('Not enough arguments');
+  }
+  var file = data;
+  if (typeof data === 'string') {
+    file = {data: data, content_type: 'text/plain'};
+  }
+  this.parts.push({field: fieldName, file: file});
+};
+
+/**
+ * Return the assembled request body as an ArrayBuffer.
+ **/
+FormData.prototype.body = function() {
+  var body = [];
+  var barr = this.__toByteArray('--' + this.boundary + '\r\n');
+  for (var i=0; i < this.parts.length; i++) {
+    Array.prototype.push.apply(body, barr);
+    var p = this.parts[i];
+    var cd = 'Content-Disposition: form-data; name="' + p.field + '"';
+    if (p.file.filename) {
+      cd += '; filename="' + p.file.filename.replace(/"/g,'%22') + '"';
+    }
+    cd += '\r\nContent-Type: '
+      + (p.file.content_type || 'application/octet-stream')
+      + '\r\n\r\n';
+    Array.prototype.push.apply(body, this.__toByteArray(cd));
+    var data = Array.isArray(p.file.data) ? p.file.data : this.__toByteArray(p.file.data);
+    Array.prototype.push.apply(body, data);
+    Array.prototype.push.apply(body, this.__toByteArray('\r\n'));
+  }
+  Array.prototype.push.apply(body, this.__toByteArray('--' + this.boundary + '--\r\n'));
+  return new Uint8Array(body).buffer;
+};

load-tests/docker/tests/detect/faces/FACE_1.jpg

@@ -0,0 +1,84 @@
+import sql from "k6/x/sql"
+import http from "k6/http"
+import { check } from 'k6'
+import { FormData } from './formdata.js'
+
+
+const PREDEFINED_IMAGES = [
+    "./faces/FACE_1.jpg"
+]
+
+const XAPIKEY = '1f348698-6985-4296-914e-a5e3270cfad7'
+const IMAGE_PATHS = __ENV.IMAGES ? __ENV.IMAGES.split(';') : PREDEFINED_IMAGES
+const IMAGES = getImageFiles(IMAGE_PATHS)
+const REQUEST_TIMEOUT = 360000
+const db_init_sql = open("./db_init.sql")
+const db_truncate_sql = open("./db_truncate.sql")
+const db = sql.open("postgres", __ENV.DB_CONNECTION_STRING)
+
+
+export let options = {
+    scenarios: {
+        my_awesome_api_test: {
+            executor: 'constant-vus',
+            vus: 8,
+            duration: '1m', // possible opts "Xs" (X seconds), "Xm" (X minutes), "Xh" (X hours), "Xd" (X days)
+        },
+    },
+    thresholds: {
+        http_req_duration: ['p(99)<3000'], // 99% of requests must complete below 3s
+    },
+};
+
+export function setup() {
+    console.log("DB: " + __ENV.DB_CONNECTION_STRING)
+    console.log("Host: " + __ENV.HOSTNAME)
+
+    execute_sql(db_init_sql)
+    return {}
+}
+
+export function teardown(data) {
+    execute_sql(db_truncate_sql)
+    db.close()
+}
+
+export default function(data) {
+    let response = verify(IMAGES[IMAGE_PATHS[0]], IMAGES[IMAGE_PATHS[1]])
+    check(response, {
+        'status 200': (r) => r.status === 200,
+        'probability': (r) => r.body.indexOf('probability') !== -1,
+    })
+}
+
+function verify(image_file) {
+    let url = __ENV.HOSTNAME + '/api/v1/detection/detect'
+
+    const fd = new FormData()
+    fd.append('file', http.file(image_file, 'file.jpg', 'image/jpeg'))
+    fd.append('limit', '0')
+    fd.append('prediction_count', '1')
+
+    let headers = {
+        'Content-Type': 'multipart/form-data; boundary=' + fd.boundary,
+        'x-api-key': XAPIKEY,
+    }
+
+    let params = {headers: headers, timeout: REQUEST_TIMEOUT}
+
+    return http.post(url, fd.body(), params)
+}
+
+function getImageFiles(image_paths) {
+    let image_files = {}
+
+    for (let index = 0; index < image_paths.length; ++index) {
+        image_files[IMAGE_PATHS[index]] = open(image_paths[index], 'b')
+    }
+
+    return image_files
+}
+
+export function execute_sql(sql_string) {
+    db.exec(sql_string)
+}