https://github.com/floriangolling/epitech_tester
Launch any command in epitech docker environnement
https://github.com/floriangolling/epitech_tester
docker env epitech test
Last synced: 3 months ago
JSON representation
Launch any command in epitech docker environnement
- Host: GitHub
- URL: https://github.com/floriangolling/epitech_tester
- Owner: floriangolling
- Created: 2025-02-18T09:34:07.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-20T15:50:28.000Z (3 months ago)
- Last Synced: 2025-03-20T16:41:17.143Z (3 months ago)
- Topics: docker, env, epitech, test
- Language: Shell
- Homepage:
- Size: 10.7 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Epitest Setup and Usage Guide
## Prerequisites
Before installing `epitest`, ensure that Docker is installed on your system. You can verify this by running:
```bash
docker --version
```
If Docker is not installed, follow the [official Docker installation guide](https://docs.docker.com/get-docker/) for your operating system.
## Installation
To install `epitest`, follow these steps:
1. **Clone the Repository** (if not already cloned):
```bash
git clone
cd
```
2. **Run the Setup Script**: Execute the setup script with root privileges:
**MacOS**
```bash
chmod +x macOS.sh && ./macOS.sh
```
> Note: This will also launch **setup.sh**
**Other**
```bash
sudo ./setup.sh
```
**What **``setup.sh``** Does:**
- Ensures the script is run with root permissions.
- Verifies the presence of the `epitest` script in the current directory.
- Copies `epitest` to `/usr/local/bin/` for global access.
- Grants execute permissions to `epitest`.
3. **Verify Installation**: Check if `epitest` is installed correctly:
```bash
epitest -h
```
You should see the usage information displayed.
## Usage
To execute a command within the `epitest` Docker environment, use:
```bash
epitest
```
### Examples:
- Run an executable:
```bash
epitest ./a.out
```
- Run multiple commands (use quotes to group them):
```bash
epitest "make re && ./a.out"
```
- Enable graphical mode (e.g., for CSFML projects):
```bash
epitest -g "make re && ./my_hunter"
```
## Uninstallation
To remove `epitest`, delete the script from `/usr/local/bin/`:
```bash
sudo rm /usr/local/bin/epitest
```
## Troubleshooting
If you encounter any issues:
- Ensure Docker is running properly.
- Verify that `epitest` is in `/usr/local/bin/` by running:
```bash
which epitest
```
- Check for permission issues and rerun `setup.sh` with `sudo`.
For further assistance, consult the project repository or open an issue.