Testlink Facade Api

Testlink facade API that provides some features to Testlink integration

Summary

• Requirements
• Installation
• Test
• Techs
• References

Testlink

TestLink is a web based test management and test execution system. It enables quality assurance teams to create and manage their test cases as well as to organize them into test plans. These test plans allow team members to execute test cases and track test results dynamically.

Requirements

To create a mysqldump for this project database run: docker exec -it mariadb-testlink mysqldump -u root bitnami_testlink > ./config/mariadb/dump.sql

To recover the dump run: docker exec mariadb-testlink mysql -u root bitnami_testlink < ./config/mariadb/dump.sql

Installation

To install this project, run the following commands: git clone https://github.com/lucsimao/testlink-facade-api

• For npm users npm install npm start

• For yarn users: yarn install yarn start

Test

To execute this project tests, you must run the following commands:

• Unit Tests npm run test:unit or yarn test:unit

• Functional Tests npm run test:functional or yarn test:functional

• Lint npm run lint or yarn lint

• Style Check npm run style:check npm run style:fix or yarn style:check yarn style:fix

• All Tests npm test or yarn test

Documentation

For view this Swagger Api, start the local server with the following commands:

yarn install yarn start:local

then access then /docs route

http://localhost:3000/docs

Techs

In this project, we used the following technologies:

• Node.js
• Visual Studio Code- Text editor with following plugins installed: DotENV, ESLint, GitLens e vscode-icons.
• Overnight - TypeScript decorators for Express.
• Jest - Javascript Test Framework.
• ESLint - ESLint to padronize the project code.
• Prettier - To format code automatically.
• Docker Compose - Virtualization Tool container based.
• Testlink (Docker) - Docker image for Testlink
• MariaDB (Docker) - Mariadb oficial image for Mariadb Database
• XMLRPC-testlink - Testlink XMLRPC module
• Swagger - for Api Documentation.
• Husky - To force tests and lint when committing and pushing.
• Joi - to validate models schemas.
• Codecov - to generate Jest badge report.
• Stryker - To run mutation tests in project and use mutation badges.

References

• Testlink
• Waldemar Neto - DO ZERO A PRODUÇÃO: APRENDA A CONSTRUIR UMA API NODE.JS COM TYPESCRIPT
• Glaucia Lemos - Curso Typescript Zero To Hero
• Alura - Formação Node JS
• NodeJS Integration Test Best Practices
• NodeJS Best Practices
• Javascript Testing Best Practices