package learn-ocaml

You can search for identifiers within the package.

in-package search v0.2.0

package learn-ocaml

learn-ocaml.mutation_testing
- Mutation_test
  - M
  - Make
    
    _
    
    Ast_checker
    
    Make
    
    _
    
    Mutation
    
    Open_me
    
    Introspection
    
    S
    
    Sampler
    
    Sampler_reg
    
    Test_functions_function
    
    Test_functions_generic
    
    Make
    
    _
    
    S
    
    Test_functions_ref_var
    
    Test_functions_types
    
    Tester

Legend:
Library
Module
Module type
Parameter
Class
Class type

type 'a mutant_info = string * int * 'a

The information about a mutant is made up of:

A name describing the bug in the mutant function
The number of points to be awarded for exposing the bug
The mutant function itself.

module M : sig ... end

Running mutation tests on a student's test suite. For testing a function called foo, the student's tests should be in a variable called foo_tests.

include module type of M

Running mutation tests on a student's test suite. For testing a function called foo, the student's tests should be in a variable called foo_tests.

A grading function is defined for each arity function from one to four:

test_unit_tests_<args_nb> ty name mutants grades unit tests for the args_nb-arity function named name, which are stored in the variable called name_tests, against the broken implementations in the list mutants.

The optional argument ~points specifies how many points should be given for each mutant exposed by the test suite. If test_student_soln is true (as it is by default), also runs the student's test suite against the student's own implementation and reports the results. The test parameter specifies a comparison function for the expected and actual outputs, and defaults to structural equality ((=)).

val run_test_against_mutant : 
  ?compare:('b -> 'b -> bool) ->
  ('a -> 'b) ->
  ('a * 'b) ->
  bool

Run a test (a pair of input and expected output) on a mutant function. Returns true if the mutant *fails* the test, either by deviating from the expected output or by raising an error. Returns false if the mutant *passes* the test. The compare parameter specifies a comparison function for comparing the expected and actual outputs, and defaults to structural equality ((=)).

val test_unit_tests_1 : 
  ?test_student_soln:bool ->
  ?test:('b -> 'b -> bool) ->
  ('a -> 'b) Ty.ty ->
  string ->
  ('a -> 'b) mutant_info list ->
  Learnocaml_report.t

val test_unit_tests_2 : 
  ?test_student_soln:bool ->
  ?test:('c -> 'c -> bool) ->
  ('a -> 'b -> 'c) Ty.ty ->
  string ->
  ('a -> 'b -> 'c) mutant_info list ->
  Learnocaml_report.t

val test_unit_tests_3 : 
  ?test_student_soln:bool ->
  ?test:('d -> 'd -> bool) ->
  ('a -> 'b -> 'c -> 'd) Ty.ty ->
  string ->
  ('a -> 'b -> 'c -> 'd) mutant_info list ->
  Learnocaml_report.t

val test_unit_tests_4 : 
  ?test_student_soln:bool ->
  ?test:('e -> 'e -> bool) ->
  ('a -> 'b -> 'c -> 'd -> 'e) Ty.ty ->
  string ->
  ('a -> 'b -> 'c -> 'd -> 'e) mutant_info list ->
  Learnocaml_report.t

val passed_mutation_testing : Learnocaml_report.t -> bool

To be called on a report returned by one of the test_unit_tests_<args_nb> functions, for checking whether the student passed or failed mutation testing. The Learnocaml_report.result function is not sufficient for checking this since a report will register as a failure if the student's implementation does not pass all of their own tests, even if the student did pass mutation testing. If this function is called on a report that did not result from one of the above 4 functions, the result is undefined.

module Make (_ : module type of Test_lib) : module type of M

For backwards compatibility