gluk46546546/testgyver repository overview

⁠TestGyver

TestGyver is a multi-environment testing application designed to orchestrate and document functional or technical test campaigns. Inspired by the ingenious spirit of MacGyver, the platform combines flexibility, extensibility (action plugins), and visibility (detailed reports) within a web interface built with Flask and MongoDB.

⁠📚 Documentation

The complete documentation is available in the docs/ folder.

⁠🌍 Choose your language

• English (Source)⁠
• Français⁠
• Español⁠
• Deutsch⁠
• Italiano⁠
• Japanese⁠
• 中文⁠

⁠🚀 Quick Start

⁠Prerequisites

• Python 3.11+
• MongoDB 6.x
• Docker (optional, for containerized deployment)

⁠Installation

1. Clone the repository:

   git clone <repository-url>
   cd app_test
   

   Copy

2. Create a virtual environment:

   python -m venv .venv
   source .venv/bin/activate  # Linux/Mac
   # .venv\Scripts\activate   # Windows
   

   Copy

3. Install dependencies:

   pip install -r requirements.txt
   

   Copy

4. Configure the application: Copy configuration.json.example to configuration.json and adjust the settings (MongoDB connection, etc.).

5. Run the application:

   flask run
   

   Copy

⁠🐳 Docker (official image)

Image: gluk46546546/testgyver:0.0.2

• Pull the image:

  docker pull gluk46546546/testgyver:0.0.2
  

  Copy
• Run exposing port 5000:

  docker run --rm -p 5000:5000 gluk46546546/testgyver:0.0.2
  

  Copy
• Configure MongoDB using environment variables (example):

  docker run --rm -p 5000:5000 \
      -e MONGO_HOST=host.docker.internal \
      -e MONGO_PORT=27017 \
      -e MONGO_DB=testgyver \
      gluk46546546/testgyver:0.0.2
  

  Copy

⁠🧩 Key Features

• Campaign Management: Create, organize, and execute test campaigns.
• Plugin System: Extend functionality with custom action plugins (HTTP, SSH, FTP, etc.).
• Real-time Reporting: Monitor test execution via WebSockets.
• Multi-environment: Manage variables across different environments.

⁠🤝 Contributing

Contributions are welcome! If you want to help, check out the issues tagged with "good first issue":

1. Fork the project.
2. Create your feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

Please see our Developer Guide⁠ for more details.

⁠📄 License

This project is licensed under the MIT License.