README
¶
SystemTestPortal - http://www.systemtestportal.org
SystemTestPortal is a web application that allows to create, run and analyze manual system tests. It aims to be useful for developers, testers and end-users.
Features
- Dashboard that provides an overview of the latest execution results for test cases and test sequences
- Step-by-step execution of tests
- Organizing test cases with the help of test sequences
- Inspect protocols of test executions
- Export execution protocols to PDF
- Print tests to execute them offline
- Social features to manage test creation and test execution within a project
Discover more on our Homepage.
Quick start
Binaries
Once you have downloaded the binary or compiled it yourself. The server can be started using:
stp --host=<the hostname (e.g. localhost or 0.0.0.0)> --port=<the port to listen to>
If no port is provided the server will listen to all interfaces on port 8080 by default.
Docker image
The easiest way to get an STP up and running is by using our Docker Image.
We offer a docker image via dockerhub or our registry on gitlab
You can simple pull the latest image using:
docker pull systemtestportal/systemtestportal
To pull a specific tag you can run for example:
docker pull systemtestportal/systemtestportal:v1-4-0
Just run the following command to start the container:
docker run -p 8080:8080 systemtestportal/systemtestportal:latest
You can pull the most current image of our master branch from our registry on gitlab
docker pull registry.gitlab.com/stp-team/systemtestportal-webapp/signed:master
Documentation
Click here to checkout our full user documentation.
Configuration
STP can be configured using a ini configuration file. The default path for the configuration file on
linux is /etc/stp/config.ini. On windows STP looks for the config.ini inside the working directory
(the directory STP is started in).
You can define a different path to the configuration file via the commandline flag
--config-path=<your custom path to the configuration>.
A configuration file with all defaults can be found here.
Flags
The available flags you can pass to STP are as follows:
--basepath=<the base path>: This is directory STP searches for its resource folders (templates, static, migrations, data).--port=<port number>: The port that STP should listen on.--host=<host>: The host that STP should interface with.--debug: If present the log output will be a bit more verbose.--config-path=<path/to/the/configuration>: Sets the path where STP searches for its configuration file.--data-dir=<path/where/stp/stores/date>: The directory that STP should stores its data in. E.g. when build with sqlite STP will store the database file there.
Installation guide
The installation guide can be found on our website.
Do you want to contribute?
Check out our workflow.
About the developers
The SystemTestPortal is developed by students of the Institute of Software Technology at the Universität Stuttgart in a student project.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd contains functionality correlating to the command line.
|
Package cmd contains functionality correlating to the command line. |
|
Package config is responsible for managing the configuration of this application.
|
Package config is responsible for managing the configuration of this application. |
|
Package domain contains the entities of the system(project/group/...) and their properties (e.g.
|
Package domain contains the entities of the system(project/group/...) and their properties (e.g. |
|
Package email handles the configuration of a mail-server, the authentication to this mail-server and creating and sending of emails.
|
Package email handles the configuration of a mail-server, the authentication to this mail-server and creating and sending of emails. |
|
Package store holds everything that has to do with persistence and manages stored data.
|
Package store holds everything that has to do with persistence and manages stored data. |
|
Package web contains all the logic that makes this software a web-service.
|
Package web contains all the logic that makes this software a web-service. |
|
context
Package context is used to create a context that can be passed to the execution of templates.
|
Package context is used to create a context that can be passed to the execution of templates. |
|
errors
Package errors contains helpful types and structures simplifying error handling.
|
Package errors contains helpful types and structures simplifying error handling. |
|
handler
Package handler contains the logic of the server.
|
Package handler contains the logic of the server. |
|
handler/assignment
Package assignment handles the assigning of tests to users.
|
Package assignment handles the assigning of tests to users. |
|
handler/creation
Package creation contains the logic to create or add elements.
|
Package creation contains the logic to create or add elements. |
|
handler/deletion
Package deletion contains the logic for deleting or removing elements.
|
Package deletion contains the logic for deleting or removing elements. |
|
handler/display
This file is part of SystemTestPortal.
|
This file is part of SystemTestPortal. |
|
handler/duplication
Package duplication handles duplicating elements (e.g.
|
Package duplication handles duplicating elements (e.g. |
|
handler/execution
Package execution handles the execution of cases and sequences.
|
Package execution handles the execution of cases and sequences. |
|
handler/integration/ci_cd
Package ci_cd provides an integration into the CI/CD to analyze test results.
|
Package ci_cd provides an integration into the CI/CD to analyze test results. |
|
handler/integration/gitlab
Package gitlab contains everything for the integration into gitlab.
|
Package gitlab contains everything for the integration into gitlab. |
|
handler/json
Package json contains functions to serve and receive data as json.
|
Package json contains functions to serve and receive data as json. |
|
handler/list
Package list contains the logic for listing elements and everything that comes with listing, like filtering, sorting, etc.
|
Package list contains the logic for listing elements and everything that comes with listing, like filtering, sorting, etc. |
|
handler/printing
Package printing contains the logic for printing elements of the system.
|
Package printing contains the logic for printing elements of the system. |
|
handler/update
Package update contains the logic for updating elements in the system (cases/sequences/projects...).
|
Package update contains the logic for updating elements in the system (cases/sequences/projects...). |
|
handler/usersession
Package usersession contains the logic for usersession handling.
|
Package usersession contains the logic for usersession handling. |
|
routing
This file is part of SystemTestPortal.
|
This file is part of SystemTestPortal. |
|
templates
Package templates is used to easily retrieve parsed templates without hassle.
|
Package templates is used to easily retrieve parsed templates without hassle. |