Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyborq/auto-testing
Utility library for testing Python scripts written in Rust
https://github.com/kyborq/auto-testing
Last synced: 15 days ago
JSON representation
Utility library for testing Python scripts written in Rust
- Host: GitHub
- URL: https://github.com/kyborq/auto-testing
- Owner: kyborq
- License: mit
- Created: 2024-03-29T14:15:35.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-29T15:57:20.000Z (11 months ago)
- Last Synced: 2024-03-29T16:50:54.160Z (11 months ago)
- Language: Rust
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# AutoTest: A Python Script Testing Utility
## Introduction
AutoTest is a lightweight utility designed for automated testing of Python scripts. It offers a straightforward way to validate the functionality of simple scripts, potentially providing a valuable tool for programming courses or individual practice. While it is currently optimized for Python, plans for future updates include support for additional programming languages.
## Features
- **Simple Test Creation:** Easily create test cases within a structured directory.
- **Automated Grading:** Ideal for programming assignments, allowing for automatic evaluation based on the number of passed tests.
- **Open Source:** Freely available for use, modification, and distribution
## Installation
To get started with AutoTest, clone the repository or download the latest release:
```bash
$ git clone https://github.com/kyborq/auto-testing.git
```
No additional installation steps are required. Ensure you have Python installed on your system to test Python scripts.
**Example File Structure:**
```
tests/
| test1.txt
| test1.expect.txt
| ...
| testN.txt
| testN.expect.txt
auto-test.exe
main.py
```
## Usage
1. **Prepare Test Cases:**
- Within the same directory as your Python script, create a `tests` folder.
- Add test files following the format: `test.txt` for input and `test.expect.txt` for the expected output.
2. **Run Tests:**
- Place the `auto-test.exe` executable in the root directory alongside your script.
- Execute the utility via the command line:
```
./auto-test.exe
```
## Limitations and Known Issues
1. **End-of-Line Marker Bug:** Ensure a newline character at the end of each test file to avoid issues with test execution.
2. **Language Support:** Currently limited to Python scripts. Future updates are planned to extend support to more programming languages.
## Contributing
We welcome contributions from the community! Whether it's adding new features, fixing bugs, or improving documentation, your help is appreciated.