From 75ac1af3b5f065e1c093310a90c38ccaf4864619 Mon Sep 17 00:00:00 2001
From: Davide Aprea <davide@suma-ev.de>
Date: Thu, 3 Dec 2020 11:36:53 +0100
Subject: [PATCH] add doc

---
 app/Http/Controllers/Stresstest.php | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/app/Http/Controllers/Stresstest.php b/app/Http/Controllers/Stresstest.php
index 45bfc2dac..a4114a8c6 100644
--- a/app/Http/Controllers/Stresstest.php
+++ b/app/Http/Controllers/Stresstest.php
@@ -10,13 +10,22 @@ use LaravelLocalization;
 use Log;
 use View;
 
+/* The controller uses the MetaGers dummy engine ( documentation: https:\/\/gitlab.metager.de\/open-source\/dummy-engine )
+*  to generate a list of test results for stress testing purposes at "/admin/stress".
+*  For local testing go to config/stress.json and change sumas->dummy->host to "dummy-nginx".
+*  To activate browser and human verfication use the following route: "/admin/stress/verify".
+*/ 
 class Stresstest extends MetaGerSearch
 {
     public function index(Request $request, MetaGer $metager, $timing = false)
     {
+        # adds / replaces query input with a random string to avoid cached results
         $request->merge(["eingabe" => "test" . rand()]);
+
+        # deactivates adgoal
         $metager->setDummy(true);
         $metager->setAdgoalHash(true);
+
         parent::search($request, $metager, $timing);
     }
 }
\ No newline at end of file
-- 
GitLab