diff --git a/README.md b/README.md index ccd66c690438aa2fb2da22ad5988d4320814a8f9..99368ab21a6ef1c8084fbe4f4f648473b26910c5 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,96 @@ -# cota-infra +# Moodle DTA Plugin CI/CD Automation Pipeline +[![pipeline status](https://gitlab.com/your-username/your-project/badges/master/pipeline.svg)](https://gitlab.com/your-username/your-project/-/commits/master) +This repository contains the complete infrastructure and automation scripts for a Continuous Integration (CI) pipeline designed to test a custom Moodle assignment submission plugin, the "Dockerized Testing Agent" (DTA). -## Getting started +The primary goal of this project is to create a fully automated, ephemeral Moodle environment where the DTA plugin can be installed, configured, and tested from a clean slate on every code change, ensuring high-quality and reliable development. -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +--- -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +## 🏛️ Architecture Overview -## Add your files +This project uses a combination of modern DevOps tools to achieve a fully automated, transparent, and controllable testing environment: -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +* **Containerization:** **Docker** and **Docker Compose** are used to define and run the multi-container application stack (Moodle, MariaDB, and the custom DTA Backend). +* **Custom Moodle Image:** A custom `Dockerfile` builds a Moodle image from a standard **Debian 'Bookworm'** base. This provides a clean, non-opinionated foundation and allows for precise control over PHP versions and system dependencies, which proved critical after initial attempts with pre-packaged images failed. +* **Orchestration Scripting:** A master `bash` script (`automate_moodle.sh`) orchestrates the entire lifecycle, from Moodle's command-line installation to the final student submission. +* **Deep Moodle Integration:** Custom **PHP CLI scripts** are generated on the fly to interact directly with Moodle's core internal libraries. This robust method was developed to bypass limitations and bugs in the standard Moodle Web Service API for complex tasks like assignment creation and submission. +* **CI/CD Pipeline:** The entire process is designed to be executed within a **GitLab CI/CD** pipeline, using a `.gitlab-ci.yml` file to define the stages, manage secrets, and automate the workflow. -``` -cd existing_repo -git remote add origin https://transfer.hft-stuttgart.de/gitlab/cota/cota-infra.git -git branch -M master -git push -uf origin master -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://transfer.hft-stuttgart.de/gitlab/cota/cota-infra/-/settings/integrations) - -## Collaborate with your team +--- -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +## 📁 File Structure -## Test and Deploy +Here is a description of the key files in this repository: -Use the built-in continuous integration in GitLab. +| File Name | Purpose | +| :----------------------------- | :----------------------------------------------------------------------------------------------------- | +| **`docker-compose.yml`** | Defines all the services (Moodle, DB, DTA Backend), networks, and volumes for the application stack. | +| **`Dockerfile`** | The blueprint for building our custom, transparent Moodle web server image based on Debian. | +| **`automate_moodle.sh`** | The master orchestration script that runs the entire end-to-end process after the containers are started. | +| **`docker-entrypoint.sh`** | A helper script used inside the `Dockerfile` to ensure Apache starts correctly. | +| **`dta.zip`** | The Moodle assignment submission plugin to be tested. | +| **`dta_teacher_config.zip`** | A sample configuration file used by the script to set up the DTA assignment. | +| **`dta_student_submission.zip`** | A sample submission file used by the script to simulate a student submission. | +| **`moodle.ini`** | A custom PHP configuration file to meet Moodle's specific requirements (e.g., `max_input_vars`). | +| **`.gitlab-ci.yml`** | (To be created) The definition for the automated GitLab CI/CD pipeline. | -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) +--- -*** +## 🚀 Getting Started (Local Development) -# Editing this README +Follow these steps to build and run the entire automation pipeline on your local machine. -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. +### **Prerequisites** -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +* [Docker](https://www.docker.com/products/docker-desktop/) installed and running. +* [Docker Compose](https://docs.docker.com/compose/install/) installed. +* A `bash`-compatible terminal (like Git Bash on Windows, or any standard Linux/macOS terminal). +* The required zip files (`dta.zip`, `dta_teacher_config.zip`, `dta_student_submission.zip`) must be present in the root directory. -## Name -Choose a self-explaining name for your project. +### **Execution Steps** -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +1. **Clone the Repository:** + ```bash + git clone [your-repository-url] + cd [your-repository-directory] + ``` -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +2. **Build and Start the Containers:** + This command will build your custom Moodle image from the `Dockerfile` and start all services in the background. + ```bash + docker-compose up -d --build + ``` + Please wait **3-4 minutes** after this command finishes. Moodle will be performing its first-time installation inside the container. You can check the status with `docker-compose ps`. -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +3. **Make the Script Executable:** + ```bash + chmod +x automate_moodle.sh + ``` -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +4. **Configure and Run the Automation Script:** + Before running, open `automate_moodle.sh` in a text editor and ensure the credentials at the top (e.g., `MOODLE_ADMIN_PASS`) match what you intend to use. Then, execute the script: + ```bash + ./automate_moodle.sh + ``` + The script will now run through all the automated steps: installing the plugin, creating users and roles, configuring the web service, creating the course and assignment, and finally simulating a student submission and checking the results. -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +### **Cleanup** -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +To stop and completely remove all containers, networks, and data volumes, run: +```bash +docker-compose down -v +``` -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +--- -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +## 🔬 CI/CD Pipeline Workflow -## License -For open source projects, say how it is licensed. +This project is designed to be run in a CI/CD environment like GitLab. The `.gitlab-ci.yml` file will orchestrate the following process: -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +1. **Setup:** A GitLab Runner with Docker capabilities will check out the code. +2. **Environment Launch:** The runner will execute `docker-compose up -d --build` to create a fresh Moodle environment for the test run. +3. **Automation:** The runner will then execute the `automate_moodle.sh` script. Secret credentials (like `MOODLE_ADMIN_PASS`) will be injected securely from GitLab's CI/CD variables, not stored in the script itself. +4. **Testing:** After the automation script successfully sets up the test scenario, the pipeline would proceed to run tests against the DTA plugin and its backend. +5. **Teardown:** The `after_script` stage in GitLab will automatically run `docker-compose down -v` to ensure the environment is completely destroyed, leaving the runner clean for the next job.