Copy in (#270)

* added in validation for input files and permissions while creating directory

* removed unnecessary files

* added thread pool for scp commands

* added more in-depth print statements

* reverted threading and added logging

* reverted thread pool

* remove dump

* Small fixces

* reverted threading

* small fixes

* stressTest.py working

* Incorporated PDL correctness changes

* Added some stabilization time

* Changed stabilization

* Added timeout using aws waiter

* Syntax issues

* Syntax issues and logging

* readme updated

* Fixed client region

* Revert stop before

* Revert sleep

* Revert aws waiter

* Update .gitignore

* Clean dump

* Quality improvements

* Fix gitignore

* Update .gitignore

* fixed stressTest termination

* updated .gitignore for security key

* copy boto.cfg

* docker installation and install ping

* copy boto if exist

* Removed detachVM argument

* chnaged request obj

* removed vmms in request obj

* Added error handling if not found

---------

Co-authored-by: evanyeyeye <[email protected]>
Co-authored-by: Soma Narita <[email protected]>

Author: 3 people

.gitignore

@@ -6,8 +6,10 @@
 scripts/*.sh
 # exclude
 vmms/id_rsa*
+vmms/id_ed25519*
 courselabs/*
 dockerTmp/*
+
 # config
 config.py
 
@@ -27,3 +29,10 @@ pip-selfcheck.json
 
 # Backup files
 *.bak
+
+# Redis
+*.rdb
+
+# Tests
+tests/*
+!tests/*.py

Dockerfile

@@ -32,13 +32,25 @@ RUN apt-get update && apt-get install -y \
 	ca-certificates \
 	lxc \
 	iptables \
+	iputils-ping \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/*
 
 WORKDIR /opt/TangoService/Tango/
 
-# Install Docker from Docker Inc. repositories.
-RUN curl -sSL https://get.docker.com/ -o get_docker.sh && sh get_docker.sh
+# Install Docker
+RUN set -eux; \
+    apt-get update; \
+    DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends ca-certificates curl gnupg; \
+    install -m 0755 -d /etc/apt/keyrings; \
+    curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc; \
+    chmod a+r /etc/apt/keyrings/docker.asc; \
+    . /etc/os-release; \
+    echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu ${VERSION_CODENAME} stable" > /etc/apt/sources.list.d/docker.list; \
+    apt-get update; \
+    DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+      docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin; \
+    apt-get clean; rm -rf /var/lib/apt/lists/*
 
 # Install the magic wrapper.
 ADD ./wrapdocker /usr/local/bin/wrapdocker
@@ -69,6 +81,7 @@ RUN mkdir -p /var/log/docker /var/log/supervisor
 # Move custom config file to proper location
 RUN cp /opt/TangoService/Tango/deployment/config/nginx.conf /etc/nginx/nginx.conf
 RUN cp /opt/TangoService/Tango/deployment/config/supervisord.conf /etc/supervisor/supervisord.conf
+RUN if [ -f /opt/TangoService/Tango/boto.cfg ]; then cp /opt/TangoService/Tango/boto.cfg ~/.boto; fi
 
 # Reload new config scripts
 CMD ["/usr/bin/supervisord", "-c", "/etc/supervisor/supervisord.conf"]

README.md

@@ -2,8 +2,7 @@
   <img src="images/autolab_banner.svg" width="380px" height="100px">
 </a>
 
-Tango
-======
+# Tango
 
 Tango is a standalone RESTful Web service that runs and manages jobs. A job is a set of files that must satisfy the following constraints:
 
@@ -16,13 +15,13 @@ Upon receiving a job, Tango will copy all of the job's input files into a VM, ru
 
 A brief overview of the Tango respository:
 
-* `tango.py` - Main tango server
-* `jobQueue.py` - Manages the job queue
-* `jobManager.py` - Assigns jobs to free VMs
-* `worker.py` - Shepherds a job through its execution
-* `preallocator.py` - Manages pools of VMs
-* `vmms/` - VMMS library implementations
-* `restful_tango/` - HTTP server layer on the main Tango
+- `tango.py` - Main tango server
+- `jobQueue.py` - Manages the job queue
+- `jobManager.py` - Assigns jobs to free VMs
+- `worker.py` - Shepherds a job through its execution
+- `preallocator.py` - Manages pools of VMs
+- `vmms/` - VMMS library implementations
+- `restful_tango/` - HTTP server layer on the main Tango
 
 Tango was developed as a distributed grading system for [Autolab](https://github.com/autolab/Autolab) at Carnegie Mellon University and has been extensively used for autograding programming assignments in CMU courses.
 
@@ -35,7 +34,63 @@ Please feel free to use Tango at your school/organization. If you run into any p
 3. [Read the documentation for the VMMS API](https://docs.autolabproject.com/tango-vmms/).
 4. [Test whether Tango is set up properly and can process jobs](https://docs.autolabproject.com/tango-cli/).
 
+## Stress Testing Tango
+
+To stress test Tango by running a large number of submissions, use `stressTest.py`. Currently, this is not a feature on the master branch. To use this feature, go on the `copy-in`.
+
+### Setting up the testing directory
+
+Create your testing directory by copying the 　`sample_test` directory into the `my_tests` directory.
+
+```
+cp -r sample_tests my_tests/<Test Name>
+```
+
+A brief overview of the testing directory
+
+- `input` - Directory to put your input files
+- `output` - Directory for the autograder output for each of the test submissions
+- `<Test Name>.yaml` - Yaml file to configure the stress test
+- `expected_output.txt` - Expected JSON output of the autograder
+- `summary.txt` - Summary of the autograder outputs
+- `log.txt` - Log of the submissions
+
+First, rename the `sample_test.yaml` to be `<Test Name>.yaml`
+
+```
+mv sample_test.yaml <Test Name>.yaml
+```
+
+Next, update the Yaml file.
+
+```yaml
+num_submissions: 5
+submission_delay: 0.1
+autograder_image: <Autograding Image>
+output_file: log.txt
+tango_port: 3001
+cli_path: <Path to Tango>/clients/tango-cli.py
+instance_type: <Instance Type>
+timeout: 180
+ec2: True
+expected_output: expected_output.txt
+stop_before:
+```
+
+After creating the Yaml file, copy the `autograde-Makefile`, `autograde.tar` and the file to submit in the `input` directory.
+
+### Running the stress test
+
+```
+virtualenv env
+source env/bin/activate
+pip install -r requirements.txt
+cd <Path to Tango>/tests
+python3 stressTest.py --test_dir my_tests/<Test Name>
+```
+
 ## Python 2 Support
+
 Tango now runs on Python 3. However, there is a legacy branch [master-python2](https://github.com/autolab/Tango/tree/master-python2) which is a snapshot of the last Python 2 Tango commit for legacy reasons. You are strongly encouraged to upgrade to the current Python 3 version of Tango if you are still on the Python 2 version, as future enhancements and bug fixes will be focused on the current master.
 
 We will not be backporting new features from `master` to `master-python2`.