automated-software-testing

Automated software testing

Automated software testing
Explore the docs »

Table of Contents

1. About The Project
   • Key Features
   • Built with
2. Getting Started
   • Prerequisites
   • Installation
   • Usage
3. Contributing
4. Security
5. Code of Conduct
6. License
7. Contact

About the Project

This project focuses on implementing automated software testing for two types of applications: a simple CLI app and a RESTful API built with Flask. The goal is to ensure robust and reliable functionality through comprehensive test coverage, utilizing both unit and integration tests.

Key Features

• CLI App Testing: Automates the testing of command-line interface applications, verifying correct input handling, output generation, and error management.
• RESTful API Testing: Implements automated tests for the Flask-based API, covering various endpoints, HTTP methods, and expected responses.
• Test Frameworks: Leverages popular Python testing frameworks such as pytest and unittest to structure and execute tests efficiently.
• Continuous Integration: Integrates with CI tools to run tests automatically on code changes, ensuring consistent code quality and functionality.
• Mocking and Patching: Uses mocking and patching techniques to simulate external dependencies and isolate test environments.

By automating the testing process, this project aims to enhance development efficiency, reduce bugs, and maintain high code quality.

Built with

(back to top)

Getting started

Prerequisites

• Python 3.12

Installation

1. Clone the repository

    git clone https://github.com/jpcadena/automated-software-testing.git

2. Change the directory to root project

   cd automated-software-testing

3. Install Poetry package manager

   pip install poetry

4. Install the project's dependencies

   poetry install

5. Activate the environment

   poetry shell

Usage

1. If found sample.env, copy it and rename it to .env.

2. Replace your credentials into the .env file.

3. Execute with console

    python main.py

(back to top)

Contributing

Please read our contributing guide for details on our code of conduct, and the process for submitting pull requests to us.

(back to top)

Security

For security considerations and best practices, please refer to our Security Guide for a detailed guide.

(back to top)

Code of Conduct

We enforce a code of conduct for all maintainers and contributors. Please read our Code of Conduct to understand the expectations before making any contributions.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

• 

• 

(back to top)