Behaviour-driven development (BDD) extends the Test-Driven Development (TDD) approach by the ‘desired behaviour’ of a software. It is designed to ensure a collaboration between business analysts and developers with explicitly written down scenarios.
- Check out the Tutorial (english) / Tutorial (german)
Seed-Test is a website user interface testing tool, which uses approaches of behaviour-driven development and the notation of Gherkin to enable developers and business users to execute automated tests for their website.
Please contact us via mail [email protected]
Seed-Test can be installed via docker or by hand.
Seed-Test offers a handy demo version that's ready for you to dive into. If you're just looking to test out Seed-Test, you can easily do so by installing this demo.
Before you begin, make sure you have Docker installed.
Follow these simple steps to get up and running:
-
Open your terminal and run this command:
docker run -p 4200:4200 -p 8080:8080 seedtest/seed-test-demo:latest
Try Seed-Test in Your Browser
Now, you can experience Seed-Test in your web browser at http://localhost:4200.
An example user account is ready for you to explore.
- E-Mail:
[email protected] - Password:
seedtest
Have Fun! 🚀🌟
Please note that Seed-Test's demo version is for testing purposes only and should not be used in a production environment. For production use, consider using the full version of Seed-Test. Check out the Installation section bellow.
Seed-Test can be installed via docker or by hand.
Seed-Test can be run by docker which makes the installation very handy. It will download NodeJs and the browsers with their correct driver on it's own.
For this docker needs to be installed.
Once you have Docker installed, the process of setting up Seed is straightforward. Follow these steps:
-
Download the Release:
- Go to the releases page of Seed on GitHub.
- Download the
docker-compose.ymlfile from the assets for the specific release you want.
-
Navigate and Execute:
- Open a terminal.
- Navigate to the directory where you placed the
docker-compose.ymlfile using thecdcommand. For instance:cd C:/seed-test - Execute the following command to start the Seed application in the background:
docker compose up -d
With these steps, you'll have Seed up and running using Docker with the downloaded docker-compose.yml file. This will initiate the necessary services, volumes and configurations for the application (mongoDB, seed-test-frontend, seed-test-backend).
Seed-Test can now be accessed via http://localhost:4200/login
Seed-Test now runs within docker with default values which means the following:
- No emails can be send to reset the password: To get this working you need to create and link an email account.
- GitHub functionalities don't work: To get GitHub functionalities to work you need to create and link a GitHub OAuth App.
- Salt and secrets are defaults:They should be changed for generating secure passwords!
- The mongoDB used has a default username and password: This should be changed for a secure database.
To know how to change this look at the configure section below.
To configure anything when running seed via docker, you can simply adjust the environment variables for each container in the docker-compose.yml file and rerun the command:
| Variable | Description |
|---|---|
| FRONTEND_URL | The frontend URL should be configured to match the server's URL where the frontend container is running. The default value is set to 'http://localhost:4200' (which is the default location of the frontend container). |
| DATABASE_URI* | The mongoDB Connection String URI. This can be replaced with your own mongoDB. If you are using the MongoDB provided by docker compose, this needs to match the values set for the mongoDB in the docker compose. |
| REPORT_DELETION_TIME | Time (in minutes) after which the report is deleted. |
| SESSION_SECRET | Session secret to establish a secure connection and prevent session hijacking (used in /backend/src/server.js). See https://www.npmjs.com/package/express-session |
| JIRA_SECRET | Jira Integration : values used for the encryption of sensible data. Choose a strong Secret like for example generated by RandomKeygen. |
| JIRA_SALT | The salt should be a random string of at least 16 bytes length. |
| EMAIL_AUTH | Mail adress to send password reset mails (used in /backend/src/nodemailer.js) |
| EMAIL_PW | Mail password credentials to send password reset mails (used in /backend/src/nodemailer.js) |
| EMAIL_PORT | Mail server port to send password reset mails (used in /backend/src/nodemailer.js) |
| EMAIL_HOST | Mail server adress to send password reset mails (used in /backend/src/nodemailer.js) |
| GITHUB_CLIENT_SECRET | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| GITHUB_CLIENT_ID | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| PASSPORT_GITHUB_LOCAL_PW_FIELD | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| MAX_SAVED_REPORTS | The amount of maximum saved reports. |
*If you are not using the mongoDB provided by this docker compose you can completely delete the seedmongodb section from the docker-compose.yml and remove the depends on part of the backend service.
| Variable | Meaning |
|---|---|
| GITHUB_CLIENT_ID | GitHub integration. Check out GitHub´s Guide on Autorizing OAuth Apps. |
| VERSION | This controls if the demo warning is shown. Set this to "set" to make it disapear. |
| API_SERVER | The URL for the server or container hosting the backend. The default setting is 'http://localhost:8080/api' (which is the default location of the backend container). |
| Variable | Meaning |
|---|---|
| MONGO_INITDB_ROOT_USERNAME* | The username which should be used for the database. |
| MONGO_INITDB_ROOT_PASSWORD* | The password which should be used for the database. |
| MONGO_INITDB_DATABASE* | The name which should be used for the database. |
*By modifying any of these variables, remember to adjust the corresponding database URI in the backend configuration as well.
Seed-Test can be installed on your machine by hand. This requires some more steps to be done.
To install docker by hand NodeJS needs to be installed.
| Browser | |
|---|---|
| Chrome* | Download and install Google Chrome. Download the version of the chromedriver that matches your version of Google Chrome. Extract the "chromedriver.exe" and set a path to it. |
| Edge | Download and install Microsoft Edge. Download the corresponding edgedriver, unpack it and set a path to the "msedgedriver.exe". |
| Firefox | Download and install Mozilla Firefox. Download the geckodriver in the assets, unpack it and set a path to the "geckodriver.exe". |
*Seed-Test uses Google Chrome by default for executing selenium.
To install and use the application localy, clone or download the repository as a zip.
The required node modules are not installed yet. To do so, open up a console in the frontend and backend folder and install them:
cd backend
npm install
and
cd frontend
npm install
Create a file called .env in the /backend folder.
Now do the steps described in the Database section bellow.
You will need two terminals to run the frontend server and backend server. Switch to the corresponding folder and start it:
cd frontend
npm start
and
cd backend
npm start
Once everything is running, you can access the website by typing this into a browser window:
http://localhost:4200/login
If you would like to use our webdriver updater, open a new terminal switch to the backend folder and start it. Make sure, you assigned the environment variables WEBDRIVER_DIR and WEBDRIVER_EXEC_PERIOD.
cd backend
npm run start:wd_updater
Seed-Test now runs with default values which means the following:
- No emails can be send to reset the password: To get this working you need to create and link an email account.
- GitHub functionalities don't work: To get GitHub functionalities to work you need to create and link a GitHub OAuth App.
- Salt and secrets are defaults:They should be changed for generating secure passwords!
To know how to change this look at the configure section below.
Seed-Test's front- and backend can be configured sepreratly.
To configure the backend create a file with the name ".env" in the /backend directory. Now you can configure the backend by adding parameters shown in the .env.example file.
To configure the frontend create a file with the name ".env" in the /frontend directory. Now you can configure the frontend by adding parameters shown in the .env.example file.
Seed-Test uses a MongoDB. You can either create your own locally or in the cloud. For installation details check out our Database Tutorial
Once you have set up the database, insert the uri into the DATABASE_URI variable inside the .env file of your backend folder. Save it!
Then you can set up the database through this command:
npm run database
This command creates the collections 'Stories' and 'stepTypes' and inserts the current stepTypes into the collection. The Stories collection can stay empty. It will be automatically filled while accessing the web-app.
Copyright (c) 2018 adesso SE Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.