Merge branch 'develop'

Author: hoshildharmendra

.gitignore

@@ -2,6 +2,8 @@
 /build/
 !gradle/wrapper/gradle-wrapper.jar
 /bin/
+server/gitruler.jar
+server/mark/
 
 ### STS ###
 .apt_generated

.travis.yml

@@ -9,4 +9,5 @@ before_script:
   - cat src/main/resources/application.yml
 
 script:
-  - if [[ $TRAVIS_BRANCH =~ ^(feature|bug).*$ ]]; then gradle checkWithoutJacoco -i; else gradle check -i; fi
+  - if [[ $TRAVIS_BRANCH =~ ^(feature|bug).*$ ]]; then gradle checkWithoutJacoco -i; else gradle check -i; fi
+  - shellcheck server/*.sh

_docs/deployment-instructions.md

@@ -3,22 +3,14 @@
 ## Requirements
 
 You will need the following to run this application:
-1. Server running MySQL version 14.14
-1. Server running Java version 1.8
-
-## Installation
-
-Setup the MySQL database.
-
-```bash
-mysql -u USERNAME -h HOSTNAME -P PORT -p -e "create database groupthree" 
-```
+1. Server running MySQL version 14.14 (database)
+1. Server running Java version 1.8 (web application)
+1. Server running Ubuntu, Java version 1.8 and MySQL version 14.14 (marking server)
 
 ## Configure GitLab OAuth2
 
 Follow the instructions provided on this [website](https://docs.gitlab.com/ee/integration/oauth_provider.html). Set the callback URL to `http://{DOMAIN_NAME}/login/oauth2/code/gitlab`, replacing {DOMAIN_NAME} with the appropriate domain name. Tick the `api` scope box.
 
-
 ## Configure application.yml
 
 This file contains the properties of the deployment of the application.
@@ -77,8 +69,47 @@ jasypt:
     password: {ENCRYPTION_PASSWORD}
 ```
 
-## Run the application
+## Installation
+
+1. Setup the MySQL database on the database server.
+
+    ```bash
+    mysql -u USERNAME -h HOSTNAME -P PORT -p -e "create database groupthree" 
+    ```
+
+1. Download the `co2015-1819-group-03-0.0.2-SNAPSHOT.war` from [Releases](https://github.com/UOL-CS/co2015-1819-group-03/releases) and place in web server.
+1. Download the `server` folder from the repository and place in marking server. 
+1. Download the `gitruler.jar` from [Releases](https://github.com/UOL-CS/co2015-1819-group-03/releases) and place in the `server` folder.
+
+## Configure mysql.cnf
+
+This file contains the properties for the MySQL database connection.
+
+Replace the following with the MySQL configuration details used when setting up the MySQL database above:
+
+`USERNAME` = Username for the sql server  
+`PASSWORD` = Password for the sql server 
+`DATABASE` = Name of the database ("groupthree" used above)
+`HOSTNAME` = Hostname of the sql server e.g. mysql.mcscw3.le.ac.uk  
+`PORT` = Port of the sql server e.g. 3306
+
+```cnf
+[client]
+user=USERNAME
+password=PASSWORD
+database=DATABASE_NAME
+host=HOSTNAME
+port=PORT
+```
+
+## Running the web application
 
 ```bash
 java -jar /path/to/co2015-1819-group-03-0.0.2-SNAPSHOT.war --spring.config.location=file:relative/path/to/application.yml
 ```
+
+## Running the marking server
+
+```bash
+./gitruler-server.sh /path/to/mysql.cnf
+```

_docs/sprint-3/start-exercise.md _docs/sprint-3/manual-testing/start-exercise.md

@@ -0,0 +1,19 @@
+# Display submission feedback
+
+| Test                                                           | Expected Result | Actual Result |
+|----------------------------------------------------------------|--------------------------------------------------------------------------|---------------|
+| Manually add job to job queue and run server | Server marks exercise with score being 0 and all crosses on feedback  | Pass          |
+| Complete exercise and click submit button | Server marks exercise with expected feedback output  | Pass          |
+| (With no exercises attempted) click on submit button and view attempts tab after marking successful | One exercise should be displayed with feedback card shown | Pass | 
+| (With 5 exercises attempted) click on submit button and view attempts tab after marking successful | 6 exercises should be displayed with latest attempt also showing feedback card. All other attempts' feedback card is collapsed | Pass |
+| Manually add attempt with all span colours in feedback e.g. `<span style="color:#8be9fd;">Cyan</span>` etc | Colours are displayed correctly and output is legible | Pass | 
+| Click on an attempt multiple times | Drop down icon toggles between up and down state (up when feedback expanded, down when feedback collapsed) | Pass |
+| Click on another attempt | Feedback card for current open attempt collapses and feedback card, for the attempt clicked on, opens | Pass |
+| Check icons displayed correctly | Cross, tick, up arrow and down arrow display as intended | Pass |
+| Manually add attempt with feedback containing escape characters | Escape characters are printed out | Pass |
+| Manually add attempt with feedback of size 65kb | Successfully adds row to attempt table | Pass |
+| Manually add attempt with feedback of size 70kb | Fails to add row to attempt table | Pass |
+| Manually add attempt with feedback that is empty | Successfully adds row to attempt table (shows empty feedback card in attempts tab) | Pass |
+| Manually add attempt with feedback containing UTF-8 3 byte characters (e.g. ä) | Successfully adds row to attempt table | Pass |
+| Manually add attempt with feedback containing UTF-8 4 byte characters (e.g. ☃) | Successfully adds row to attempt table | Fail - Does not add row to attempt table (mySQL ERROR 1366) |
+| Check padding around the feedback card | Padding around feedback card is as intended | Pass |

_docs/sprint-4/manual-testing/disp-submission-feedback.md

@@ -0,0 +1,18 @@
+# Display submission mark 
+
+| Test                                                           | Expected Result | Actual Result |
+|----------------------------------------------------------------|--------------------------------------------------------------------------|---------------|
+| Click on attempts tab when attempts list is empty | Message "No attempts available." is displayed  | Pass          |
+| Click on attempts tab when attempts list is not empty | All attempts of the exercise for the user are displayed    | Pass          |
+| Click on attempts tab | Switches view to new tab     | Pass          |
+| Click on attempts tab, after job has been marked | Attempt number and score are displayed with the correct values   | Fail - Attempt number is the id of the row instead of the actual attempt number for the exercise          |
+| When submit button is clicked check if server marks submission | Server adds new row to attempt table and removes marked job from job queue     | Pass          |
+| When submit button is clicked without completing the exercise | Score 0 is displayed for that attempt   | Pass          |
+| When multiple exercises are submitted, the appropriate number of jobs are added to the server job queue | Same number of jobs are marked (rows added to attempt table and removed from job queue)    | Pass          |
+| When exercise is completed and submit button is clicked, the correct values are displayed | Server adds new row to attempt table and removes marked job from job queue    | Pass          |
+| Manually add a job to the job queue when the server is in sleep state | Server wakes up after around a minute and marks the new job in the queue    | Pass          |
+| Manually add a job to the job queue when the server is in wake state and another job is in the queue | Server marks the manually added job after it finishes marking the previous one  | Pass          |
+| Manually add 25 jobs to the job queue | Server marks all 25 jobs consecutively and goes into sleep state    | Pass          |
+| Manually add job with incorrect repository link | Server fails to mark repository and removes row from job queue    | Pass          |
+| Manually add job to the job queue, but delete the forked repository before starting the server | Server fails to mark repository and removes row from job queue    | Pass          |
+| Multiple users using the service click on submit button for different exercises at different times | Server successfully marks the given exercise for the correct user    | Pass          |

_docs/sprint-4/manual-testing/display-submission-mark.md

@@ -0,0 +1,12 @@
+# Submit Exercise
+
+| Test                                                           | Expected Result                                                          | Actual Result |
+|----------------------------------------------------------------|--------------------------------------------------------------------------|---------------|
+| Click on Submit button and alert box shows success  | When Submit button is selected an alert box showing success is displayed      | Pass          |
+| Click on Submit button and view job queue | Job queue has been updated and contains expected values  | Pass          |     
+| Click on Submit button and remove hidden link input tag via chrome inspector  | When Submit button is selected an error page is shown   | Pass          |     
+| Click on Submit button and remove hidden csrf input tag via chrome inspector  | When Submit button is selected an error page is shown   | Pass          |     
+| Click on Submit button in two different tabs  | Success message shown and job queue updated  | Pass          |  
+| Check if Submit button alignment is as intended  | Alignment of the submit button is correct  | Pass          |    
+| On different browsers such as Chrome, Firefox and Safari, check CSS is correct | CSS is correct on all browsers tested  | Pass          | 
+ | Delete repo from gitlab then click submit button | Adds job to job queue and returns success message | Pass          |    

_docs/sprint-4/manual-testing/submit-exercise.md

@@ -0,0 +1,7 @@
+# Sprint Planning
+
+At university we held our sprint planning meeting which was timeboxed to 2 hours where Product Owner, Scrum master and the rest of Scrum team were present. This meeting began with the Product Owner briefing the rest of the scrum team the current stories in the product backlog and what stories will be aimed to be achieved by the end of sprint. In addition, we also discussed our estimates for our stories, using the poker planning technique, and ensuring we think of the technical challenges of our stories. We discussed this as we really underestimated the level of difficulty in terms of the technical aspects of the story completed in the previous sprint. 
+
+## Spring Goal 
+
+The sprint goal we have set for this sprint is to complete the key aspect of the system, that being marking the solution to an exercise, resulting in a mark and feedback that will be shown to the user.

_docs/sprint-4/sprint-planning.md

@@ -0,0 +1,3 @@
+# Sprint Restrospective
+
+The sprint retrospective was timeboxed to 45 minutes and all the members of the scrum team were present. In this sprint the real focus was on the core functionality of our application that being the submission, marking and feedback of the exercises completed by users.  Completing these stories was a real challenge for the scrum team as we had to find a way to submit the solution of an exercise as an attempt to be marked by the system and eventually provide user with the proper feedback. After many obstacles, we overcame our challenges and completed 3 user stories (and many bug fixes) in this sprint and now our application has its main functionality implemented. During the time of the sprint, we learned that our user story estimations still were not as accurate as we had anticipated. We believe that this will improve as we grow and get more experience. We also learnt that we should ask the client more valuable and precise questions that will allow us to visualise what the client wants.

_docs/sprint-4/sprint-retrospective.md

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+if [ "$#" -ne 1  ]; then
+    echo "Usage: ./gitruler-server.sh /path/to/mysql.cnf"
+    exit 1
+fi
+
+if [ ! -f "$1" ]; then
+    echo "Usage: ./gitruler-server.sh /path/to/mysql.cnf"
+    exit 1
+fi
+
+cloneDir=mark
+mysqlcommand="mysql --defaults-file=$1 -e"
+
+echo "[Server starting]"
+
+while true; do
+    while [[ $($mysqlcommand "SELECT COUNT(*) FROM queue;" -sN) -gt 0 ]]; do
+        eval "$mysqlcommand 'SELECT * FROM queue;' -sN" | while read -r id exId link userId; do
+            echo "[Starting Job $id]"
+            rm -rf "$cloneDir"
+            if git clone --quiet "$link" "$cloneDir"; then
+                echo "[Clone successful]"
+
+                output=$(java -jar gitruler.jar -w -r $cloneDir)
+
+                feedback=$(echo "$output" | head -n -1 | sed -e "s/'/\\\\'/g" | tr -d '\n')
+                score=$(echo "$output" | tail -1)
+
+                if $mysqlcommand "INSERT INTO attempt VALUES (0, '$feedback', $score, $exId, $userId);"; then
+                    echo "[Row insertion successful]"
+                else 
+                    echo "[Row insertion failed]"
+                fi
+
+            else 
+                echo "[Clone failed]"
+            fi
+
+            if eval "$mysqlcommand 'DELETE FROM queue WHERE id=$id;' -sN"; then
+                echo "[Row deletion successful]"
+            else
+                echo "[Row deletion failed]"
+            fi
+
+        done
+    done
+    echo "[Server sleeping]"
+    sleep 60
+    echo "[Server wake]"
+done
+
+
+
+

server/gitruler-server.sh

@@ -0,0 +1,6 @@
+[client]
+user=USERNAME
+password=PASSWORD
+database=DATABASE_NAME
+host=HOSTNAME
+port=PORT

server/mysql.cnf

@@ -31,32 +31,57 @@ public static void main(String[] args) {
    */
   @EventListener
   public void appReady(ApplicationReadyEvent event) {
-
-    String[] themes = { "sugarsweets", "heatwave", "daisygarden", "seascape", "summerwarmth", 
-        "bythepool", "duskfalling", "frogideas", "berrypie" };
 
-    String[] repositories = {
-        "https://gitlab.com/gitlab-org/gitlab-ce",
-        "https://gitlab.com/gitlab-org/gitlab-runner",
-        "https://gitlab.com/inkscape/inkscape",
-        "https://gitlab.com/gnachman/iterm2",
-        "https://gitlab.com/gitlab-org/omnibus-gitlab",
-        "https://gitlab.com/tortoisegit/tortoisegit"
-    };
-   
-    Exercise ex;
-
-    for (int i = 1; i <= 6; i++) {
-      ex = new Exercise();
-      ex.setName("Exercise " + i);
-      ex.setDescription("Lorem ipsum dolor sit amet, consectetur adipiscing elit. " 
-          + "Aenean mattis vel purus et sagittis nullam.");
-      ex.setTheme(themes[new Random().nextInt(9)]);
-      ex.setPoint((new Random().nextInt(41) + 10) * 10);
-      ex.setRepository(repositories[i - 1]);
-      
-      exRepo.save(ex);
-    }
+    Exercise ex = new Exercise();
+    ex.setName("Section A");
+    ex.setDescription("Configuring git, committing updates to tracked "
+        + "files and pushing changes to origin.");
+    ex.setTheme("bythepool");
+    ex.setPoint(30);
+    ex.setRepository("https://gitlab.com/BrandonRNeath/gitruler-a-1");
+    exRepo.save(ex);
+    
+    ex = new Exercise();
+    ex.setName("Section B");
+    ex.setDescription("Tracking a new file, staging specific files for a commit "
+        + "and checking the repository status.");
+    ex.setTheme("heatwave");
+    ex.setPoint(100);
+    ex.setRepository("https://gitlab.com/BrandonRNeath/gitruler-b-1");
+    exRepo.save(ex);
+    
+    ex = new Exercise();
+    ex.setName("Section C");
+    ex.setDescription("Ignoring moving and removing files in git.");
+    ex.setTheme("sugarsweets");
+    ex.setPoint(100);
+    ex.setRepository("https://gitlab.com/BrandonRNeath/gitruler-section-c");
+    exRepo.save(ex);
+    
+    ex = new Exercise();
+    ex.setName("Section D");
+    ex.setDescription("Tagging and using git to view a log of commits "
+        + "and differences between versions.");
+    ex.setTheme("duskfalling");
+    ex.setPoint(100);
+    ex.setRepository("https://gitlab.com/BrandonRNeath/gitruler-d-1");
+    exRepo.save(ex);
+    
+    ex = new Exercise();
+    ex.setName("Section E");
+    ex.setDescription("Branching and merging and resolving merge conflicts.");
+    ex.setTheme("bythepool");
+    ex.setPoint(100);
+    ex.setRepository("https://gitlab.com/BrandonRNeath/gitruler-e-1");
+    exRepo.save(ex);
+    
+    ex = new Exercise();
+    ex.setName("Practice A-E");
+    ex.setDescription("Practice all the skills that you learned from previous exercises.");
+    ex.setTheme("sugarsweets");
+    ex.setPoint(100);
+    ex.setRepository("https://gitlab.com/BrandonRNeath/gitruler-practice-a-e");
+    exRepo.save(ex);
 
   }