Merge branch 'codeocean-tuil' into origin-swp

Author: Benedikt Artelt

Gemfile.lock

@@ -242,8 +242,8 @@ GEM
       activerecord
       kaminari-core (= 1.2.2)
     kaminari-core (1.2.2)
-    kramdown (2.4.0)
-      rexml
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
@@ -338,7 +338,7 @@ GEM
     psych (5.2.0)
       stringio
     public_suffix (6.0.1)
-    puma (6.4.3)
+    puma (6.5.0)
       nio4r (~> 2.0)
     pundit (2.4.0)
       activesupport (>= 3.0.0)
@@ -484,7 +484,7 @@ GEM
       sprockets-rails
       tilt
     securerandom (0.3.2)
-    selenium-webdriver (4.26.0)
+    selenium-webdriver (4.27.0)
       base64 (~> 0.2)
       logger (~> 1.4)
       rexml (~> 3.2, >= 3.2.5)

app/controllers/submissions_controller.rb

@@ -100,7 +100,7 @@ def render_file
       url = render_protected_upload_url(id: @file.id, filename: @file.filepath)
       redirect_to AuthenticatedUrlHelper.sign(url, @file)
     else
-      response.set_header('Content-Length', @file.size)
+      #response.set_header('Content-Length', @file.size)
       send_data(@file.content, filename: @file.name_with_extension, disposition: 'inline')
     end
   end

app/policies/exercise_policy.rb

@@ -14,7 +14,7 @@ def study_group_dashboard?
   end
 
   def detailed_statistics?
-    admin?
+    admin? || teacher_in_study_group?
   end
 
   %i[clone? destroy? edit? update?].each do |action|

config/environments/production.rb

@@ -44,8 +44,8 @@
   # config.asset_host = "http://assets.example.com"
 
   # Specifies the header that your server uses for sending files.
-  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache
-  config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
   # Store uploaded files on the local file system (see config/storage.yml for options).
   config.active_storage.service = :local
@@ -60,11 +60,10 @@
   config.assume_ssl = true
 
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
-  config.force_ssl = true
-
+  # config.force_ssl = true
   # Skip http-to-https redirect for the default health check endpoint.
   # config.ssl_options = { redirect: { exclude: ->(request) { request.path == "/up" } } }
-  config.ssl_options = {hsts: {preload: true}}
+  # config.ssl_options = {hsts: {preload: true}}
 
   if ENV['RAILS_LOG_TO_STDOUT'].present?
     # Log to STDOUT by default

docs/add_new_programming_language.md

@@ -0,0 +1,76 @@
+# How to add a new programming language to Codeocean
+## Overview
+Adding a new programming language to Codeocean is done in three steps:
+1. Create a Docker image that contains the necessary tools to compile, run, etc.
+2. Create a Ruby file under lib/ that specifies the name of the testing framework, parses the output of the testing tools, and returns the number of tests, number of failed tests, and associated error messages. 
+3. Create a new execution environment for the programming language in Codeoceans graphical interface.
+
+### 1. Create the Docker image
+The following Dockerfile is used as a starting point:
+```dockerfile
+FROM openhpi/docker_exec_phusion
+LABEL description=''
+LABEL run_command=''
+LABEL test_command=''
+
+# insert installation routines, environment variable adjustment, etc. here
+
+# switch user
+USER user
+```
+
+Each execution environment must be derived from `openhpi/docker_exec_phusion`. This image is based on `phusion/baseimage:master`, a Docker-optimized version of Ubuntu that provides, among other things, the [install_clean](https://github.com/phusion/baseimage-docker#overview) command for installing Ubuntu packages.  
+At the end, the user needs to be switched so that he does not get elevated privileges in his container.
+
+Specify the run and test command to be used for the programming language. You can use the parameter `%{filename}` inside the command string. When a user clicks on *run* or *test* for a certain file in Codeoceans graphical interface, `%{filename}` will be replaced with the name of this file. Note that the run and test command are not automatically imported into Codeocean when you add a new Execution Environment.
+
+Add the installation routines and customizations needed for the programming language.
+
+Build with the following command:  
+`docker build --no-cache -t openhpi/co_execenv_<language> .`  
+where `<language>` is the corresponding programming language.
+
+Select the image in Codeoceans graphical interface when creating a new Execution Environment. 
+
+### 2. Create the Adapter
+Create a file named my_adapter.rb and add the following content: 
+```ruby
+# frozen_string_literal: true
+
+class MyAdapter < TestingFrameworkAdapter
+    def self.framework_name
+        # insert here what you want to call your test framework
+    end
+
+    def parse_output(output)
+        # insert code here that parses the output generated by the testing tools
+    end
+end
+```
+
+Change the name of the file and class to match your programming language and testing tools.  
+This class is a subclass of *`TestingFrameworkAdapter`*. Implement the methods *`self.framework_name`* and *`parse_output(output)`*:   
+*`self.framework_name`* shall return the name of the testing framework as a string.  
+*`parse_output`* gets a [hash object](https://ruby-doc.org/core-3.1.2/Hash.html) *`output`* with the following keys and data types of values:
+- `file_role`: String
+- `waiting_for_container_time`: Float
+- `stdout`: String
+- `stderr`: String
+- `messages`: Array of hash objects with the keys `:cmd, :stream, :log, :timestamp`.
+- `exit_code`: Integer
+- `container_execution_time`: Float
+- `status`: Symbol
+
+*`parse_output`* shall return a [hash object](https://ruby-doc.org/core-3.1.2/Hash.html) with the following keys:
+- `count`: Integer ( the number of executed tests)
+- `failed`: Integer ( the number of failed tests)
+- `error_messages`: Array of strings (the error messages of the failed tests.)
+
+### 3. Create a new Execution Environment
+1. In Codeoceans graphical interface select `Administration` > `Execution Environments` and click on `Add Execution Environment`.
+2. Give it a name and default file type.
+3. Select the Docker image you built above.
+4. Copy and paste the run and test command from the Dockerfile into the corresponding fields.
+5. Select the testing framework you defined above in *`self.framework_name`*.
+6. It might be necessary to set the `Prewarming Pool Size` to > 0.
+7. Make further adjustments if necessary and then click on `Create Execution Environment`.  

docs/cargo_test_adapter.md

@@ -0,0 +1,66 @@
+# The Cargo Test Adapter
+This documentation focusses on the file `lib/cargo_test_adapter.rb`. It only explains the functions `parse_json_objects_per_line(string)` and `extract_test_result_parameters(parsed_json_objects)`. For more details on `self.framework_name` and `parse_output(output)` see [add_new_programming_language.md](add_new_programming_language.md).
+
+The code assumes that the JSON output was generated by Cargo version 1.59.0 with the command `cargo test --no-fail-fast -q --color never --message-format json-diagnostic-short -- --color never -Z unstable-options --format json`. Note that the [json output format for tests is unstable](https://doc.rust-lang.org/rustc/tests/index.html#--format-format) and might change with newer Rust and Cargo versions. If that happens the code must be updated.
+
+## Example project
+Let us look at a Rust project consisting of three files:
+
+`Cargo.toml`:
+```
+[package]
+name = "add"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+```
+
+`src/main.rs`:
+```rust
+fn main() { println!("Hello, world!"); }
+
+fn add(a: i32, b: i32) -> i32 { a }
+
+fn mult(a: i32, b: i32) -> i32 { a }
+
+#[cfg(test)]
+mod tests;
+```
+
+`src/tests.rs`:
+```rust
+use super::*;
+
+#[test]
+fn test_add() {
+    assert_eq!(add(1,1), 2);
+}
+
+#[test]
+fn test_mutl() {
+    assert_eq!(mult(1,0), 0);
+    assert_eq!(mult(1,1), 1);
+    assert_eq!(mult(-1,1), -1);
+    assert_eq!(mult(1,-1), -1);
+    assert_eq!(mult(-1,-1), 1);
+}
+```
+
+The output generated by our test command inside Codeocean will look like this (the compiler messages are left out because they are not needed):
+
+```json
+[...]
+{"reason":"build-finished","success":true}
+{ "type": "suite", "event": "started", "test_count": 2 }
+{ "type": "test", "event": "started", "name": "tests::test_add" }
+{ "type": "test", "event": "started", "name": "tests::test_mutl" }
+{ "type": "test", "name": "tests::test_mutl", "event": "failed", "stdout": "thread 'tests::test_mutl' panicked at 'assertion failed: `(left == right)`\n  left: `1`,\n right: `0`', src/tests.rs:10:5\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace\n" }
+{ "type": "test", "name": "tests::test_add", "event": "failed", "stdout": "thread 'tests::test_add' panicked at 'assertion failed: `(left == right)`\n  left: `1`,\n right: `2`', src/tests.rs:5:5\n" }
+{ "type": "suite", "event": "failed", "passed": 0, "failed": 2, "allowed_fail": 0, "ignored": 0, "measured": 0, "filtered_out": 0, "exec_time": 0.000608784 }
+error: test failed, to rerun pass '--bin add'
+```
+
+We see that each line contains either a valid JSON object or some text. In `parse_json_objects_per_line(string)` we therefore iterate over each line, parse it and if it is valid JSON push it into an array. If it is not a JSON object, we skip the line. 
+
+The array is then passed to `extract_test_result_parameters`. In here we first find out if the compilation was successful by finding the JSON object with the key-value pair `"reason" : "build-finished"` and accessing the value of the `"success"` key. If compilation was successful, we count the number of tests performed, the number of tests that failed and collect all error messages. The `count` and `failed` variables are updated with `+=` because there may be multiple JSON objects that match the `"type" : "suite"` key-value pairs and have either the `"test_count"` or `"failed"` keys. This happens, for example, when there are unit tests and integration tests in the same project.

lib/cargo_test_adapter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'json'
+
+class CargoTestAdapter < TestingFrameworkAdapter
+    def self.framework_name
+        'CargoTest'
+    end
+
+    def parse_output(output)
+        extract_test_result_parameters(parse_json_objects_per_line(output[:stdout]))
+    end
+
+    def pretty_format(test_result_obj)
+        test_result_obj["stdout"]
+    end
+
+    # Assumption: One JSON object per row. If a row is not a JSON object, it will not be included in parsed_json_objects.
+    def parse_json_objects_per_line(string)
+        parsed_json_objects = []
+        string.each_line(chomp: true) { |line|
+            begin
+                obj = JSON.parse(line)
+                parsed_json_objects.push(obj)
+            rescue JSON::ParserError
+            end
+        }
+        parsed_json_objects
+    end
+
+    def extract_test_result_parameters(parsed_json_objects)
+        compile_success = false
+        count = 0
+        failed = 0
+        error_messages = []
+
+        parsed_json_objects.each { |obj|
+            if obj["reason"] == "build-finished" && obj.has_key?("success")
+                compile_success = obj["success"]
+            end
+        }
+
+        if compile_success
+            parsed_json_objects.each { |obj|
+                if obj["type"] == "suite"
+                    if obj.has_key?("test_count")
+                        count += obj["test_count"]
+                    elsif obj.has_key?("failed")
+                        failed += obj["failed"]
+                    end
+                end
+                if obj["type"] == "test" && obj["event"] == "failed"
+                    error_messages.push(pretty_format(obj))
+                end
+            }
+        else
+            error_messages.push("Could not compile. See below for more details.")
+        end
+
+        {count: count, failed: failed, error_messages: error_messages}
+    end
+end
+

package.json

@@ -7,9 +7,9 @@
     "@babel/preset-env": "^7.26.0",
     "@babel/runtime": "^7.26.0",
     "@egjs/hammerjs": "^2.0.17",
-    "@fortawesome/fontawesome-free": "^6.6.0",
+    "@fortawesome/fontawesome-free": "^6.7.1",
     "@popperjs/core": "^2.11.8",
-    "@sentry/browser": "^8.38.0",
+    "@sentry/browser": "^8.40.0",
     "@toast-ui/editor": "^3.2.2",
     "@webpack-cli/serve": "^2.0.5",
     "ace-builds": "^1.36.5",
@@ -42,7 +42,7 @@
     "sass-loader": "^16.0.3",
     "shakapacker": "8.0.2",
     "showdown": "^2.1.0",
-    "sortablejs": "^1.15.3",
+    "sortablejs": "^1.15.4",
     "sorttable": "^1.0.2",
     "style-loader": "^4.0.0",
     "terser-webpack-plugin": "^5.3.10",

start_codeocean_dockercontainerpool.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+# A small script to start codeocean and dockercontainerpool on two tmux panes in the same window.
+# Must be called from within the vagrant VM.
+sessionname='codeocean-session'
+windowname='codeocean'
+tmux new-session -d -s $sessionname
+tmux new-window -n $windowname -t 0 -k 'cd /home/vagrant/dockercontainerpool && rails s -p 7100'
+tmux split-window -h -b -t 0 'cd /home/vagrant/codeocean && rails s -b 0.0.0.0 -p 7000'
+tmux set-option -t 0 remain-on-exit on
+tmux attach -t $sessionname
+