From 10ba241dddff085b684c07dc93f3ce93f370fbb6 Mon Sep 17 00:00:00 2001
From: Ulrich Carmesin <ulrich@carmesin.org>
Date: Mon, 22 Aug 2022 22:45:09 +0200
Subject: [PATCH] main programs commentar

---
 collect_testcase.py   |  8 +++++++-
 compare_testcase.py   |  7 ++++++-
 declare_result.py     |  8 +++++++-
 execute_testcase.py   | 10 ++++++++--
 generate_testcases.py |  1 +
 start_dialog.py       |  7 +++++++
 test_executer.py      |  7 +++++++
 7 files changed, 43 insertions(+), 5 deletions(-)

diff --git a/collect_testcase.py b/collect_testcase.py
index 8052be3..bb2d238 100644
--- a/collect_testcase.py
+++ b/collect_testcase.py
@@ -1,4 +1,10 @@
-# This is a sample Python script.
+#!/usr/bin/python
+# program to collect results from the system
+# PARAM: --environment --application --tcdir [ testcase, tctime ]
+# main functions
+#  + collect_testcase() : system --> data --> archiv.result
+#  + post_testcase()    : comp-config --> system
+# ---------------------------------------------------
 import sys#
 # import jsonpickle # pip install jsonpickle
 import yaml # pip install pyyaml
diff --git a/compare_testcase.py b/compare_testcase.py
index 0bdd43a..270e520 100644
--- a/compare_testcase.py
+++ b/compare_testcase.py
@@ -1,4 +1,9 @@
-# This is a sample Python script.
+#!/usr/bin/python
+# program to compare the results of a testcase
+# PARAM: --environment --application --tcdir [ testcase, tctime ]
+# main functions
+#  + compare_testcase() : archiv.result --> data --> archiv.matchresult
+# ---------------------------------------------------
 import sys#
 import os
 import basic.program as program
diff --git a/declare_result.py b/declare_result.py
index 4d3d006..60c239a 100644
--- a/declare_result.py
+++ b/declare_result.py
@@ -1,4 +1,10 @@
-# This is a sample Python script.
+#!/usr/bin/python
+# program to declare new exceptions from actual results
+# PARAM from INPUT:  --testcase/testsuite
+# main functions
+#  + input_param()  : cache-actjob --> user-input -->  local-param
+#  + start_job()    : local-param --> cache-actjob --> start-param
+# ---------------------------------------------------
 import sys#
 # import jsonpickle # pip install jsonpickle
 import yaml # pip install pyyaml
diff --git a/execute_testcase.py b/execute_testcase.py
index d1869a1..f025eb6 100644
--- a/execute_testcase.py
+++ b/execute_testcase.py
@@ -1,5 +1,11 @@
-# This is a sample Python script.
-import sys#
+#!/usr/bin/python
+# program to execute steps of a testcase
+# PARAM: --environment --application --tcdir [ testcase, tctime ]
+# main functions
+#  + craete_request()   : testspec --> tdata.step --> archiv.request
+#  + send_request()     : archiv.request -- comp-config --> system.interface
+# ---------------------------------------------------
+import sys
 import os
 import basic.step
 import basic.program as program
diff --git a/generate_testcases.py b/generate_testcases.py
index 8b44276..198f0a9 100644
--- a/generate_testcases.py
+++ b/generate_testcases.py
@@ -1,3 +1,4 @@
+# https://ucarmesin.de/index.php/it/testautomatisierung-fuer-daten-test/232-testfallgenerierung
 import random
 #from flask import
 #
diff --git a/start_dialog.py b/start_dialog.py
index b07136e..413ca8b 100644
--- a/start_dialog.py
+++ b/start_dialog.py
@@ -1,3 +1,10 @@
+#!/usr/bin/python
+# program to execute programs for a testcases or for a testsuite
+# PARAM from INPUT:  --granularity --application --environment --testcase/testsuite
+# main functions
+#  + input_param()  : cache-actjob --> user-input -->  local-param
+#  + start_job()    : local-param --> cache-actjob --> start-param
+# ---------------------------------------------------
 
 """
 
diff --git a/test_executer.py b/test_executer.py
index 43b15e5..5617e99 100644
--- a/test_executer.py
+++ b/test_executer.py
@@ -1,3 +1,10 @@
+#!/usr/bin/python
+# program to execute automatically programs for a testsuite
+# PARAM: --environment --application --tsdir [ testsuite, tstime ] --step
+# main functions
+#  + execute_step()  : testspec --> tdata.steps --> call( init_testsuite/testcase(),
+#               execute_testcase/testsuite(), collect_testcase/testsuite(), compare_testcase(), finish_testsuite() )
+# ---------------------------------------------------
 from datetime import datetime
 import traceback
 import basic.program