define universal rubric format (#36)

* define universal rubric format

* move to correct directory

Author: Rdeisenroth

model/src/main/protobuf/criterion.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+
+package org.sourcegrade.lab.model.rubric;
+
+import "number_range.proto";
+import "point_range.proto";
+import "test_run.proto";
+import "criterion_accumulator.proto";
+import "showcase_string.proto";
+
+// Represents a criterion in a rubric.
+message Criterion {
+    // The id of the criterion.
+    string id = 1;
+    // The name of the criterion.
+    ShowcaseString name = 2;
+    // The description of the criterion.
+    ShowcaseString description = 3;
+    // The possible amount of points that can be achieved.
+    NumberRange possible_points = 4;
+    // The points that have been achieved.
+    PointRange achieved_points = 5;
+    // The message displayed if the criterion is not fulfilled.
+    ShowcaseString message = 6;
+    // Tests used to determine the achieved points.
+    repeated TestRun tests = 7;
+    // The accumulator used to determine the achieved points.
+    CriterionAccumulator test_accumulator = 8;
+    // The children of the criterion.
+    repeated Criterion children = 9;
+    // The accumulator used to determine the achieved points of the children.
+    CriterionAccumulator children_accumulator = 10;
+}

model/src/main/protobuf/criterion_accumulator.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package org.sourcegrade.lab.model.rubric;
+
+// Enumerates the types of accumulators used to determine achieved points of a criterion.
+enum CriterionAccumulator {
+    // Default accumulator: requires all tests to be successful.
+    AND = 0;
+    // Requires at least one test to be successful.
+    OR = 1;
+    // Requires no test to be successful.
+    NOT = 2;
+    // Adds 1 point for each successful test.
+    SUM = 3;
+}

model/src/main/protobuf/number_range.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package org.sourcegrade.lab.model.rubric;
+
+// Defines a range of numbers. The range is inclusive.
+message NumberRange {
+    // Minimum value of the range (inclusive)
+    int32 min = 1;
+    // Maximum value of the range (inclusive)
+    int32 max = 2;
+}

model/src/main/protobuf/point_range.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package org.sourcegrade.lab.model.rubric;
+
+import "number_range.proto";
+
+// Defines a range of points. The range is inclusive.
+message PointRange {
+    oneof value {
+        // Single point value
+        int32 single = 1;
+        // Range of points
+        NumberRange range = 2;
+    }
+}

model/src/main/protobuf/rubric.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package org.sourcegrade.lab.model.rubric;
+
+import "point_range.proto";
+import "criterion.proto";
+import "showcase_string.proto";
+import "number_range.proto";
+
+// Represents a rubric containing criteria.
+message Rubric {
+    // The id of the rubric.
+    string id = 1;
+    // The name of the rubric.
+    ShowcaseString name = 2;
+    // The description of the rubric.
+    ShowcaseString description = 3;
+    // The possible amount of points that can be achieved.
+    NumberRange possible_points = 4;
+    // The points that have been achieved.
+    PointRange achieved_points = 5;
+    // The criteria of the rubric.
+    repeated Criterion criteria = 6;
+}

model/src/main/protobuf/showcase_string.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package org.sourcegrade.lab.model.rubric;
+
+// Represents a string that can have both text and HTML representations.
+message ShowcaseString {
+    oneof value {
+        // Simple text representation
+        string simple = 1;
+        // Text representation
+        string text = 2;
+        // HTML representation
+        string html = 3;
+    }
+}

model/src/main/protobuf/test_run.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package org.sourcegrade.lab.model.rubric;
+
+import "showcase_string.proto";
+import "test_state.proto";
+
+// Represents the result of a test.
+message TestRun {
+    // The id of the test.
+    string id = 1;
+    // The name of the test.
+    string name = 2;
+    // The state of the test.
+    TestState state = 3;
+    // The message of the test.
+    ShowcaseString message = 4;
+    // The stacktrace of the test.
+    string stacktrace = 5;
+    // The duration of the test in milliseconds.
+    int64 duration = 6;
+    // The children of the test.
+    repeated TestRun children = 7;
+}

model/src/main/protobuf/test_state.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+
+package org.sourcegrade.lab.model.rubric;
+
+// Enumerates the states of a test.
+enum TestState {
+    // The test is pending, i.e., it has not been executed yet.
+    PENDING = 0;
+    // The test is running, i.e., it is currently being executed.
+    RUNNING = 1;
+    // The test is successful.
+    SUCCESS = 2;
+    // The test is not successful, but no exception has been thrown.
+    FAILURE = 3;
+    // The test is not successful, and an exception has been thrown.
+    ERROR = 4;
+    // The test has been skipped.
+    SKIPPED = 5;
+    // The state of the test is unknown.
+    UNKNOWN = 6;
+}