Skip to content

Commit

Permalink
added the grading module. still working on integrating into UI
Browse files Browse the repository at this point in the history
  • Loading branch information
@reevafaisal
reevafaisal committed Aug 21, 2024
1 parent f43be77 commit d52b6db
Show file tree
Hide file tree
Showing 9 changed files with 2,588 additions and 967 deletions.
969 changes: 969 additions & 0 deletions src/haz3lschool/DocumentationEnv.re
View file

Large diffs are not rendered by default.

309 changes: 309 additions & 0 deletions src/haz3lschool/Grading.re
View file
Original file line number Diff line number Diff line change
Expand Up @@ -307,3 +307,312 @@ module F = (ExerciseEnv: Exercise.ExerciseEnv) => {
};
};
};

// NEW FOR TUTORIAL MODE

module D = (DocEnv: DocumentationEnv.DocEnv) => {
open DocumentationEnv.D(DocEnv);

[@deriving (show({with_path: false}), sexp, yojson)]
type percentage = float;
[@deriving (show({with_path: false}), sexp, yojson)]
type points = float;
[@deriving (show({with_path: false}), sexp, yojson)]
type score = (points, points);

let score_of_percent = (percent, max_points) => {
let max_points = float_of_int(max_points);
(percent *. max_points, max_points);
};

module TestValidationReport = {
type t = {
test_results: option(TestResults.t),
required: int,
provided: int,
};

let mk = (test_results: option(TestResults.t)) => {
// {
test_results;
// ,
// required: eds.hidden_tests.tests,
// provided: eds.your_tests.provided,
// };
};

let percentage = (report: t): percentage => {
switch (report.test_results) {
| None => 0.0
| Some(test_results) =>
let num_tests = float_of_int(test_results.total);
let required = float_of_int(report.required);
let provided = float_of_int(report.provided);
let num_passing = float_of_int(test_results.passing);

required -. provided <= 0.0 || num_tests <= 0.0
? 0.0
: num_passing
/. num_tests
*. (
Float.max(
0.,
Float.min(num_tests -. provided, required -. provided),
)
/. (required -. provided)
);
};
};

let test_summary_str = (test_results: TestResults.t) => {
TestResults.result_summary_str(
~n=test_results.total,
~p=test_results.failing,
~q=test_results.unfinished,
~n_str="test",
~ns_str="tests",
~p_str="failing",
~q_str="indeterminate",
~r_str="valid",
);
};
};

module MutationTestingReport = {
type t = {results: list((TestStatus.t, string))};

let hidden_bug_status =
(
test_validation_data: DynamicsItem.t,
hidden_bug_data: DynamicsItem.t,
)
: TestStatus.t => {
switch (
ModelResult.test_results(test_validation_data.result),
ModelResult.test_results(hidden_bug_data.result),
) {
| (None, _)
| (_, None) => Indet
| (Some(test_validation_data), Some(hidden_bug_data)) =>
let validation_test_map = test_validation_data.test_map;
let hidden_bug_test_map = hidden_bug_data.test_map;

let found =
hidden_bug_test_map
|> List.find_opt(((id, instance_reports)) => {
let status = TestMap.joint_status(instance_reports);
switch (status) {
| TestStatus.Pass
| TestStatus.Indet => false
| TestStatus.Fail =>
let validation_test_reports =
validation_test_map |> TestMap.lookup(id);
switch (validation_test_reports) {
| None => false
| Some(reports) =>
let status = TestMap.joint_status(reports);
switch (status) {
| TestStatus.Pass => true
| TestStatus.Fail
| TestStatus.Indet => false
};
};
};
});
switch (found) {
| None => Fail
| Some(_) => Pass
};
};
}; // for each hidden bug
// in the test results data, find a test ID that passes test validation but fails against

let mk =
(
~test_validation: DynamicsItem.t,
~hidden_bugs_state: list(wrong_impl(Editor.t)),
~hidden_bugs: list(DynamicsItem.t),
)
: t => {
let results =
List.map(hidden_bug_status(test_validation), hidden_bugs);
let hints =
List.map(
(wrong_impl: wrong_impl(Editor.t)) => wrong_impl.hint,
hidden_bugs_state,
);
let results = List.combine(results, hints);
{results: results};
};

let percentage = (report: t): percentage => {
let results = report.results;
let num_wrong_impls = List.length(results);
let num_passed =
results
|> List.find_all(((status, _)) => status == TestStatus.Pass)
|> List.length;
switch (num_wrong_impls) {
| 0 => 1.0
| _ => float_of_int(num_passed) /. float_of_int(num_wrong_impls)
};
};

// TODO move to separate module

let summary_str = (~total, ~found): string => {
TestResults.result_summary_str(
~n=total,
~p=found,
~q=0,
~n_str="bug",
~ns_str="bugs",
~p_str="exposed",
~q_str="",
~r_str="unrevealed",
);
};
};

module SyntaxReport = {
type t = {
hinted_results: list((bool, hint)),
percentage,
};

// let mk = (~your_impl: Editor.t, ~tests: syntax_tests): t => {
// let user_impl_term = your_impl.state.meta.view_term;

// let predicates =
// List.map(((_, p)) => SyntaxTest.predicate_fn(p), tests);
// let hints = List.map(((h, _)) => h, tests);
// let syntax_results = SyntaxTest.check(user_impl_term, predicates);

// {
// hinted_results:
// List.map2((r, h) => (r, h), syntax_results.results, hints),
// percentage: syntax_results.percentage,
// };
// };
// };

module ImplGradingReport = {
type t = {
hints: list(string),
test_results: option(TestResults.t),
hinted_results: list((TestStatus.t, string)),
};

let mk =
(~hints: list(string), ~test_results: option(TestResults.t)): t => {
let hinted_results =
switch (test_results) {
| Some(test_results) =>
let statuses = test_results.statuses;
Util.ListUtil.zip_defaults(
statuses,
hints,
Haz3lcore.TestStatus.Indet,
"No hint available.",
);

| None =>
Util.ListUtil.zip_defaults(
[],
hints,
Haz3lcore.TestStatus.Indet,
"Exercise configuration error: Hint without a test.",
)
};
{hints, test_results, hinted_results};
};

let total = (report: t) => List.length(report.hinted_results);
let num_passed = (report: t) => {
report.hinted_results
|> List.find_all(((status, _)) => status == TestStatus.Pass)
|> List.length;
};

// let percentage = (report: t, syntax_report: SyntaxReport.t): percentage => {
// syntax_report.percentage
// *. (float_of_int(num_passed(report)) /. float_of_int(total(report)));
// };

let test_summary_str = (test_results: TestResults.t) => {
TestResults.result_summary_str(
~n=test_results.total,
~p=test_results.failing,
~q=test_results.unfinished,
~n_str="test",
~ns_str="tests",
~p_str="failing",
~q_str="indeterminate",
~r_str="valid",
);
};
};

module GradingReport = {
type t = {
point_distribution,
test_validation_report: TestValidationReport.t,
mutation_testing_report: MutationTestingReport.t,
// syntax_report: SyntaxReport.t,
impl_grading_report: ImplGradingReport.t,
};
// let mk = (eds: eds, ~stitched_dynamics: stitched(DynamicsItem.t)) => {
// point_distribution: eds.point_distribution,
// test_validation_report:
// TestValidationReport.mk(
// eds,
// ModelResult.test_results(stitched_dynamics.test_validation.result),
// ),
// mutation_testing_report:
// MutationTestingReport.mk(
// ~test_validation=stitched_dynamics.test_validation,
// ~hidden_bugs_state=eds.hidden_bugs,
// ~hidden_bugs=stitched_dynamics.hidden_bugs,
// ),
// syntax_report:
// SyntaxReport.mk(~your_impl=eds.your_impl, ~tests=eds.syntax_tests),
// impl_grading_report:
// ImplGradingReport.mk(
// ~hints=eds.hidden_tests.hints,
// ~test_results=
// ModelResult.test_results(stitched_dynamics.hidden_tests.result),
// ),
// };
// let overall_score =
// (
// {
// point_distribution,
// test_validation_report,
// mutation_testing_report,
// // syntax_report,
// impl_grading_report,
// _,
// }: t,
// )
// : score => {
// let (tv_points, tv_max) =
// score_of_percent(
// TestValidationReport.percentage(test_validation_report),
// point_distribution.test_validation,
// );
// let (mt_points, mt_max) =
// score_of_percent(
// MutationTestingReport.percentage(mutation_testing_report),
// point_distribution.mutation_testing,
// );
// let (ig_points, ig_max) =
// score_of_percent(
// // ImplGradingReport.percentage(impl_grading_report, syntax_report),
// // point_distribution.impl_grading,
// );
// let total_points = tv_points +. mt_points +. ig_points;
// let max_points = tv_max +. mt_max +. ig_max;
// (total_points, max_points);
};
};
};
Loading

0 comments on commit d52b6db

Please sign in to comment.