BAANGT -> baangt

api/Readme.md

@@ -1,26 +1,26 @@
-BAANGT Execution API
+baangt Execution API
 ====================
-**BAANGT Execution API** provides service endpoints for executing *BAANGT* tests. The main features of the service are:
+**baangt Execution API** provides service endpoints for executing *baangt* tests. The main features of the service are:
 - running the tests
 - storing test results to a database
-- uoloading test run results to [*BAANGT Data Files*](https://gogs.earthsquad.global/athos/baangt-service/src/master/files)
+- uoloading test run results to [*baangt Data Files*](https://gogs.earthsquad.global/athos/baangt-service/src/master/files)
 - retrieving the results of the finished tests
 
 Environmental Variables
 -----------------------
-You may use the following environmental variables to configure the **BAANGT Execution API**:
+You may use the following environmental variables to configure the **baangt Execution API**:
 
 | Variable | Default Value | Description
 |----------|---------------|-------------
 | SECRET_KEY | secret!key | The secret key of the app
-| DATABASE_URL | sqlite:///testrun.db | Database URL for *BAANGT* test results
-| BAANGT_DATAFILE_HOST | 127.0.0.1:5050 | The host that runs [*BAANGT Data Files*](https://gogs.earthsquad.global/athos/baangt-service/src/master/files)
+| DATABASE_URL | sqlite:///testrun.db | Database URL for *baangt* test results
+| BAANGT_DATAFILE_HOST | 127.0.0.1:5050 | The host that runs [*baangt Data Files*](https://gogs.earthsquad.global/athos/baangt-service/src/master/files)
 | REDIS_URL | redis:// | The Redis connection URL
 
 
 Redis Worker
 ------------
-**BAANGT Execution API** implements *BAANGT* test runs as the background tasks via Redis. So, firstly you need a running Redis server. The service uses the Redis Queue (RQ) worker named `baangt-tasks` that based on the same code to run the *BAANGT* tests. At least one `baangt-tasks` RQ worker should be running to support *BAANGT* Execution API service. Be sure to install requirements and setup environmental vars before starting the RQ workers.
+**baangt Execution API** implements *baangt* test runs as the background tasks via Redis. So, firstly you need a running Redis server. The service uses the Redis Queue (RQ) worker named `baangt-tasks` that based on the same code to run the *baangt* tests. At least one `baangt-tasks` RQ worker should be running to support *baangt* Execution API service. Be sure to install requirements and setup environmental vars before starting the RQ workers.
 
 ```bash
 pip install -r requirements.txt
@@ -31,7 +31,7 @@ rq worker baangt-tasks
 
 Set-up
 ------
-Before starting the **BAANGT Execution API** application you need just install the requirements from `requirements.txt`
+Before starting the **baangt Execution API** application you need just install the requirements from `requirements.txt`
 
 ```bash
 pip install -r requirements.txt
@@ -39,22 +39,22 @@ pip install -r requirements.txt
 
 Database
 --------
-**BAANGT Execution API** service interacts with *BAANGT* [Database](https://baangt.readthedocs.io/en/latest/SaveResults2Database.html)
+**baangt Execution API** service interacts with *baangt* [Database](https://baangt.readthedocs.io/en/latest/SaveResults2Database.html)
 
 Subclasses
 ----------
-**BAANGT Execution API** service supports *BAANG* subclasses. You need just go to `plugin` folder (`api/plugin` folder in this repo) and clone (or paste) your subclasses there. For instance:
+**baangt Execution API** service supports *BAANG* subclasses. You need just go to `plugin` folder (`api/plugin` folder in this repo) and clone (or paste) your subclasses there. For instance:
 ```bash
 mkdir plugin
 cd plugin
 git clone https://gogs.earthsquad.global/athos/baangt-subclassingDemo.git
 ``` 
 **IMPORTANT!**  
-Ensure, you add the *subclasses* to [**BAANGT UI Web-Service**](https://gogs.earthsquad.global/athos/baangt-service/src/master/ui)
+Ensure, you add the *subclasses* to [**baangt UI Web-Service**](https://gogs.earthsquad.global/athos/baangt-service/src/master/ui)
 
 Run Service
 -----------
-Please use a Python WSGI Server to run the *BAANGT* Execution API application.  
+Please use a Python WSGI Server to run the *baangt* Execution API application.  
 The **application name** is `app`  
 For example, to run the service with *gunicorn* use:
 

files/Readme.md

@@ -1,12 +1,12 @@
-BAANGT Data Files
+baangt Data Files
 =================
-**BAANGT Data Files** is intended to store, renew, and retrieve *BAANGT* data files. The service could be achieved via HTTP requests. It provides the following end-points:
+**baangt Data Files** is intended to store, renew, and retrieve *baangt* data files. The service could be achieved via HTTP requests. It provides the following end-points:
 - a *home* view with a form for uploading a *DataFile*
 - several [API](#api-reference) end-points  
 
 Environmental Variables
 -----------------------
-You may use the following environmental variables to configure the **BAANGT Data Files**:
+You may use the following environmental variables to configure the **baangt Data Files**:
 
 | Variable | Default Value | Description
 |----------|---------------|-------------
@@ -16,10 +16,10 @@ You may use the following environmental variables to configure the **BAANGT Data
 
 Set-up
 ------
-Before starting the **BAANGT Data Files** application you need to:
+Before starting the **baangt Data Files** application you need to:
 - install the required python packages from `requirements.txt`
 - define *UPLOAD_FOLDER*
-- run `set_uploads.py` to create a directory that will be a file storage for *BAANGT* DataFiles  
+- run `set_uploads.py` to create a directory that will be a file storage for *baangt* DataFiles  
 
 ```bash
 pip install -r requirements.txt
@@ -29,7 +29,7 @@ python set_uploads.py
 
 Run Service
 -----------
-Please use a Python WSGI Server to run the *BAANGT* Data Files application.  
+Please use a Python WSGI Server to run the *baangt* Data Files application.  
 The **application name** is `app`  
 For example, to run the service with *gunicorn* use:
 
@@ -43,7 +43,7 @@ API Reference
 	POST http://[HOST]/save
 
 ##### Requested files
-	dataFile: XLSX file comprising *BAANGT* test data
+	dataFile: XLSX file comprising *baangt* test data
 
 ##### Response
 ```json
@@ -62,7 +62,7 @@ JSON:
 	uuid: UUID of the Data File to be renewed
 
 ##### Requested files
-	dataFile: XLSX file comprising *BAANGT* test data
+	dataFile: XLSX file comprising *baangt* test data
 
 ##### Response
 ```json
@@ -94,8 +94,8 @@ RAW: requested Data File
 	uuid: UUID of the Testrun Execution the files to be assocoated with
 
 ##### Requested files
-	logfile: *BAANGT* Testrun execution logfile
-	outfile: XLSX file comprising *BAANGT* Testrun results 
+	logfile: *baangt* Testrun execution logfile
+	outfile: XLSX file comprising *baangt* Testrun results 
 
 ##### Response
 ```json

files/app/routes.py

@@ -120,4 +120,9 @@ def get_file(uuid):
 	#
 
 	app.logger.info(f'Requested file {uuid}')
-	return send_from_directory(app.config['UPLOAD_FOLDER'], uuid)
+	#return send_from_directory(app.config['UPLOAD_FOLDER'], uuid)
+	return send_file(
+		'/'.join((app.config['UPLOAD_FOLDER'], uuid)),
+		attachment_filename=f'{uuid}.xlsx',
+		as_attachment=True,
+	)

ui/Readme.md

@@ -1,31 +1,31 @@
-BAANGT UI Web-Service
+baangt UI Web-Service
 =====================
-**BAANGT UI Web-Service** provides Web GUI for definition *BAANGT* tests. The main features of the service:
+**baangt UI Web-Service** provides Web GUI for definition *baangt* tests. The main features of the service:
 - creating test definitions using Web GUI
 - importing test definitions from local files (XLSX, JSON formats are supported, see available [examples](https://gogs.earthsquad.global/athos/baangt-service/src/master/ui/examples))
 - exporting test definitions to XLSX or JSON files
 - storing test definitions in a database (see details on the database in [**Database Description**](https://gogs.earthsquad.global/athos/baangt-service/src/master/ui/docs/database.md))
-- running the defined tests via **[BAANGT Execution API](https://gogs.earthsquad.global/athos/baangt-service/src/master/api)**
+- running the defined tests via [**baangt Execution API**](https://gogs.earthsquad.global/athos/baangt-service/src/master/api)
 
 Environmental Variables
 -----------------------
-You may use the following environmental variables to configure the **BAANGT UI Web-Service**:
+You may use the following environmental variables to configure the **baangt UI Web-Service**:
 
 | Variable | Default Value | Description
 |----------|---------------|-------------
 | SECRET_KEY | secret!key | The secret key of the app
 | DATABASE_URL | sqlite:///testrun.db | [*Database*](https://gogs.earthsquad.global/athos/baangt-service/src/master/ui/docs/database.md) URL
-| BAANGT_API_HOST | 127.0.0.1:8000 | The host that runs [*BAANGT Execution API*](https://gogs.earthsquad.global/athos/baangt-service/src/master/api)
-| BAANGT_DATAFILE_HOST | 127.0.0.1:5050 | The host that runs [*BAANGT Data Files*](https://gogs.earthsquad.global/athos/baangt-service/src/master/files)
+| BAANGT_API_HOST | 127.0.0.1:8000 | The host that runs [*baangt Execution API*](https://gogs.earthsquad.global/athos/baangt-service/src/master/api)
+| BAANGT_DATAFILE_HOST | 127.0.0.1:5050 | The host that runs [*baangt Data Files*](https://gogs.earthsquad.global/athos/baangt-service/src/master/files)
 
 Set-up
 ------
-Before starting the **BAANGT UI Web-Service** application you need to define *DATABASE_URL* and run
-Before starting the **BAANGT Data Files** application you need to:
+Before starting the **baangt UI Web-Service** application you need to define *DATABASE_URL* and run
+Before starting the **baangt Data Files** application you need to:
 - install the required python packages from `requirements.txt`
 - define *DATABASE_URL* var
-- run `flask db upgrade` to create required by the *BAANGT UI Web-Service* data tables 
-- run `python db_update.py` to populate *BAANGT UI Web-Service* database with the default supporting instances
+- run `flask db upgrade` to create required by the *baangt UI Web-Service* data tables 
+- run `python db_update.py` to populate *baangt UI Web-Service* database with the default supporting instances
 
 ```bash
 pip install -r requirements.txt
@@ -36,14 +36,14 @@ python db_update.py
 
 Supporting Entities
 -------------------
-It is easily to customize the *BAANGT* supporting entities (namely, `classnames`, `testcases`, `browsers`, `activities`, `locators`). You may just edit file `db_supports.json` and run the update script:
+It is easily to customize the *baangt* supporting entities (namely, `classnames`, `testcases`, `browsers`, `activities`, `locators`). You may just edit file `db_supports.json` and run the update script:
 ```bash
 python db_update.py
 ``` 
 
 Subclasses
 ----------
-To benefit subclasses that was installed in [**BAANGT Execution API**](https://gogs.earthsquad.global/athos/baangt-service/src/master/api) service, add them to `db_supports.json` and update the database. For instance, to introduce subclass `myTestCaseSequence.py` from [https://gogs.earthsquad.global/athos/baangt-subclassingDemo.git](https://gogs.earthsquad.global/athos/baangt-subclassingDemo.git) add it to `db_supports.json` first:
+To benefit subclasses that was installed in [**baangt Execution API**](https://gogs.earthsquad.global/athos/baangt-service/src/master/api) service, add them to `db_supports.json` and update the database. For instance, to introduce subclass `myTestCaseSequence.py` from [https://gogs.earthsquad.global/athos/baangt-subclassingDemo.git](https://gogs.earthsquad.global/athos/baangt-subclassingDemo.git) add it to `db_supports.json` first:
 ```JSON
 {
 	"classnames": {
@@ -58,11 +58,11 @@ then update the database:
 python db_ipdate.py
 ```
 **IMPORTANT!**  
-Ensure, you install the new subclasses in [**BAANGT Execution API**](https://gogs.earthsquad.global/athos/baangt-service/src/master/api). 
+Ensure, you install the new subclasses in [**baangt Execution API**](https://gogs.earthsquad.global/athos/baangt-service/src/master/api). 
 
 Run Service
 -----------
-Please use a Python WSGI Server to run the *BAANGT* UI Web-Service application.  
+Please use a Python WSGI Server to run the *baangt* UI Web-Service application.  
 The **application name** is `app`  
 For example, to run the service with *gunicorn* use:
 

ui/app/templates/auth/base.html

@@ -22,7 +22,7 @@
 
     <body>
         <div class="d-flex flex-column justify-content-center rounded bg-light auth-box border">
-            <img class="auth-logo" src="{{ url_for('static', filename='media/baangt_100.png') }}" alt="BAANGT Logo">
+            <img class="auth-logo" src="{{ url_for('static', filename='media/baangt_100.png') }}" alt="baangt Logo">
             
             {% block content %}
             {% endblock %}

ui/app/templates/auth/login.html

@@ -1,12 +1,12 @@
 {% extends "auth/base.html" %}
 
 {% block title %}
-BAANGT | Login
+baangt | Login
 {% endblock %}
 
 {% block content %}
 
-    <h1 class="text-primary text-center my-2">Login to BAANGT</h1>
+    <h1 class="text-primary text-center my-2">Login to baangt</h1>
         
     <!-- login form -->
     <form method="post" class="text-center mt-3">

ui/app/templates/auth/signup.html

@@ -1,11 +1,11 @@
 {% extends "auth/base.html" %}
 
 {% block title %}
-BAANGT | Sign up
+baangt | Sign up
 {% endblock %}
 
 {% block content %}
-	<h1 class="text-primary text-center my-2">Sign up to BAANGT</h1>
+	<h1 class="text-primary text-center my-2">Sign up to baangt</h1>
 		
 	<!-- login form -->
 	<form method="post" class="text-center mt-3">

ui/app/templates/docs/dashboard.html

@@ -1,6 +1,6 @@
 <!-- Introduction -->
 <div class="section-article">
-	<strong>BAANGT-DB Service</strong> provides a Dashboard that is available by clicking the dashboard icon <i class="fas fa-chart-line fa-lg text-black-50"></i> on the top right. The dashboard shows a list of the test runs grouped by name and stage. The list is ordered <strong>alphabetically</strong>. Clicking a TestRun name transfers you to the chosen <a href="{{ url_for('help', topic='testrun') }}#testrun-details">TestRun details</a>. 
+	<strong>baangtDB Service</strong> provides a Dashboard that is available by clicking the dashboard icon <i class="fas fa-chart-line fa-lg text-black-50"></i> on the top right. The dashboard shows a list of the test runs grouped by name and stage. The list is ordered <strong>alphabetically</strong>. Clicking a TestRun name transfers you to the chosen <a href="{{ url_for('help', topic='testrun') }}#testrun-details">TestRun details</a>. 
 </div>
 <img class="img-article img-100" src="{{ url_for('static', filename='media/docs/dashboard.png') }}" alt="Dashboard" data-toggle="modal" data-target="#modalImage">
 

ui/app/templates/docs/datafile.html

@@ -1,6 +1,6 @@
 <!-- Introduction -->
 <div class="section-article">
-	DataFiles hold the data for <strong>BAANGT</strong> TestCases. DataFile is a separated <code>XLSX</code> file or the <code>data</code> tab in the simple format of a Testrun definition (<a href="https://baangt.readthedocs.io/en/latest/DataFile.html">explore <strong>BAANGT</strong> DataFile</a>).
+	DataFiles hold the data for <strong>baangt</strong> TestCases. DataFile is a separated <code>XLSX</code> file or the <code>data</code> tab in the simple format of a Testrun definition (<a href="https://baangt.readthedocs.io/en/latest/DataFile.html">explore <strong>baangt</strong> DataFile</a>).
 </div>
 
 <!-- Add -->

ui/app/templates/docs/get_started.html

@@ -1,17 +1,17 @@
 <div class="section-article">
-	Welcome to <strong>BAANGT UI-Service</strong> documentation. Here you will find everything that you need to get the most out of the the service.
+	Welcome to <strong>baangt UI-Service</strong> documentation. Here you will find everything that you need to get the most out of the the service.
 </div>
 
-<div class="section-title">Access BAANGT UI-Service</div>
+<div class="section-title">Access baangt UI-Service</div>
 <div class="section-article">
 	<p>
-		To access <strong>BAANGT UI-Service</strong> go to <a class="" href="{{ url_for('login')}}">Login</a> page, enter your user name and password, and click <em>Login</em>
+		To access <strong>baangt UI-Service</strong> go to <a class="" href="{{ url_for('login')}}">Login</a> page, enter your user name and password, and click <em>Login</em>
 	</p>
 	<p>
-		If you still do not have account in <strong>BAANGT UI-Service</strong> then follow to <a class="" href="{{ url_for('register')}}">Sign up</a> page to create a new one.
+		If you still do not have account in <strong>baangt UI-Service</strong> then follow to <a class="" href="{{ url_for('register')}}">Sign up</a> page to create a new one.
 	</p>
 	<p>
-		After a successful login you will see the <em>index</em> page of the <strong>BAANGT UI-Service</strong> with a welcome message and a list of <strong>BAANGT</strong> Testrun layers.
+		After a successful login you will see the <em>index</em> page of the <strong>baangt UI-Service</strong> with a welcome message and a list of <strong>baangt</strong> Testrun layers.
 	</p>
 </div>
 

ui/app/templates/docs/index.html

@@ -5,7 +5,7 @@
 {% endblock %}
 
 {% block title %}
-    BAANGT Documentation|{{ topic|doc_title }}
+    baangt Documentation|{{ topic|doc_title }}
 {% endblock %}
 
 {% block content %}

ui/db_supports.json

@@ -1,8 +1,8 @@
 {
 	"classnames": {
-		"GC.CLASSES_TESTCASESEQUENCE": "Default BAANGT class for TestCaseSequence",
-		"GC.CLASSES_TESTCASE": "Default BAANGT class for TestCase",
-		"GC.CLASSES_TESTSTEPMASTER": "Default class for TestStepSequence"
+		"GC.CLASSES_TESTCASESEQUENCE": "Default baangt class for TestCaseSequence",
+		"GC.CLASSES_TESTCASE": "Default baangt class for TestCase",
+		"GC.CLASSES_TESTSTEPMASTER": "Default baangt class for TestStepSequence"
 	},
 	"testcases": {
 		"Browser": "Browser",

ui/docs/database.md

@@ -1,11 +1,11 @@
 Database Description
 ====================
 
-**BAANGT UI Service** supports the following databases:
+**baangt UI Service** supports the following databases:
 - SQLite
 - PostreSQL
 
-The environmental variable DATABASE_URL shows **BAANGT UI Service** the location of the database.
+The environmental variable DATABASE_URL shows **baangt UI Service** the location of the database.
 
 Authentication
 --------------
@@ -59,7 +59,7 @@ Table holds data on Test Case Sequence Definitions (TCS).
 
 #### Table `datafiles`
 
-Table holds data on BAANGT Data Files. 
+Table holds data on baangt Data Files. 
 
 | Column | Data Type | Description
 |--------|:---------:|-----------------
@@ -120,10 +120,10 @@ Table holds data on Definitions of Test Step Execution (TS).
 | creator_id | INTEGER | The user that created the *TS* <br> FOREIGN KEY to `users` <br> NOT NULL
 | edited | DATETIME | The time when the *TS* was last edited
 | editor_id | INTEGER | The user that last edited the *TS* <br> FOREIGN KEY to `users`
-| locator | VARCHAR(512) | A string representing a *BAANGT* locator
+| locator | VARCHAR(512) | A string representing a *baangt* locator
 | locator_type_id | INTEGER | The *locator type* used by the *TS* <br> FOREIGN KEY to `locator_types`
 | optional | BOOLEAN | | Shows if the execution of the current test case should be continued after *timeout exception* was was thrown <br> NOT NULL
-| timeout | DOUBLE(5,2) | Overrides the default value of the *BAANGT* timeout
+| timeout | DOUBLE(5,2) | Overrides the default value of the *baangt* timeout
 | release | VARCHAR(64) | A release string of the *TS* 
 | value | VARCHAR(1024) | A value associated with the *TS*'s activity
 | value2 | VARCHAR(1024) | The second value if the *TS* activity requires a comparison
@@ -199,7 +199,7 @@ Table holds data on Definitions of Global Test Step Execution (GTS).
 
 #### Table `classnames`
 
-Table holds data on the *BAANGT* Class Names.
+Table holds data on the *baangt* Class Names.
 
 | Column | Data Type | Description
 |--------|:---------:|-----------------
@@ -229,7 +229,7 @@ Table holds data on the Types of Test Cases (TCT).
 
 #### Table `activity_types`
 
-Table holds data on the Activity Types of *BAANGT* tests.
+Table holds data on the Activity Types of *baangt* tests.
 
 | Column | Data Type | Description
 |--------|:---------:|-----------------
@@ -239,7 +239,7 @@ Table holds data on the Activity Types of *BAANGT* tests.
 
 #### Table `locator_types`
 
-Table holds data on the Locator Types of *BAANGT* test activity.
+Table holds data on the Locator Types of *baangt* test activity.
 
 | Column | Data Type | Description
 |--------|:---------:|-----------------

ui/examples/Readme.md

@@ -1,9 +1,9 @@
-BAANGT Testrun Examples
+baangt Testrun Examples
 =======================
-Here you can find examples of *BAANGT* Testrun definitions in XLSX format that could be imported to the *BAANGT* UI Web-Service.
+Here you can find examples of *baangt* Testrun definitions in XLSX format that could be imported to the *baangt* UI Web-Service.
 
 [google_images.xlsx](https://gogs.earthsquad.global/athos/baangt-service/src/master/ui/examples/google_Images.xlsx) — Testrun definition in a simple format (test data included in the definition file)
 [DropsTestRunDefinition.xlsx](https://gogs.earthsquad.global/athos/baangt-service/src/master/ui/examples/DropsTestRunDefinition.xlsx) — Testrun definition in complex format (test data defined in another file [DropsTestExample.xlsx](https://gogs.earthsquad.global/athos/baangt-service/src/master/ui/examples/DropsTestExample.xlsx))
 
 
-More examples could be found in [BAANGT](https://gogs.earthsquad.global/athos/baangt/src/master/examples) repository.
+More examples could be found in [baangt](https://gogs.earthsquad.global/athos/baangt/src/master/examples) repository.