diff --git a/argon2/Argon2/D/index.html b/argon2/Argon2/D/index.html deleted file mode 100644 index 5069a73..0000000 --- a/argon2/Argon2/D/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -D (argon2.Argon2.D)

Module Argon2.D

Bindings to Argon2d.

type hash
type encoded
val hash_raw : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> hash_len:int -> (hashErrorCodes.t) Result.result

Hashes a password with Argon2i, producing a raw hash.

val hash_encoded : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> hash_len:int -> encoded_len:int -> (encodedErrorCodes.t) Result.result

Hashes a password with Argon2i, producing an encoded hash.

val verify : encoded:encoded -> pwd:string -> (bool, ErrorCodes.t) Result.result

Verifies a password against an encoded string.

val hash_to_string : hash -> string

Converts a raw hash value to a string.

val encoded_to_string : encoded -> string

Converts an encoded hash to a string.

\ No newline at end of file diff --git a/argon2/Argon2/ErrorCodes/index.html b/argon2/Argon2/ErrorCodes/index.html deleted file mode 100644 index a60b996..0000000 --- a/argon2/Argon2/ErrorCodes/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -ErrorCodes (argon2.Argon2.ErrorCodes)

Module Argon2.ErrorCodes

type t =
| OK
| OUTPUT_PTR_NULL
| OUTPUT_TOO_SHORT
| OUTPUT_TOO_LONG
| PWD_TOO_SHORT
| PWD_TOO_LONG
| SALT_TOO_SHORT
| SALT_TOO_LONG
| AD_TOO_SHORT
| AD_TOO_LONG
| SECRET_TOO_SHORT
| SECRET_TOO_LONG
| TIME_TOO_SMALL
| TIME_TOO_LARGE
| MEMORY_TOO_LITTLE
| MEMORY_TOO_MUCH
| LANES_TOO_FEW
| LANES_TOO_MANY
| PWD_PTR_MISMATCH
| SALT_PTR_MISMATCH
| SECRET_PTR_MISMATCH
| AD_PTR_MISMATCH
| MEMORY_ALLOCATION_ERROR
| FREE_MEMORY_CBK_NULL
| ALLOCATE_MEMORY_CBK_NULL
| INCORRECT_PARAMETER
| INCORRECT_TYPE
| OUT_PTR_MISMATCH
| THREADS_TOO_FEW
| THREADS_TOO_MANY
| MISSING_ARGS
| ENCODING_FAIL
| DECODING_FAIL
| THREAD_FAIL
| DECODING_LENGTH_FAIL
| VERIFY_MISMATCH
| Other of int
val message : t -> string

Get the associated error message for given error code.

\ No newline at end of file diff --git a/argon2/Argon2/I/index.html b/argon2/Argon2/I/index.html deleted file mode 100644 index 075c8d3..0000000 --- a/argon2/Argon2/I/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -I (argon2.Argon2.I)

Module Argon2.I

Bindings to Argon2i.

type hash
type encoded
val hash_raw : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> hash_len:int -> (hashErrorCodes.t) Result.result

Hashes a password with Argon2i, producing a raw hash.

val hash_encoded : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> hash_len:int -> encoded_len:int -> (encodedErrorCodes.t) Result.result

Hashes a password with Argon2i, producing an encoded hash.

val verify : encoded:encoded -> pwd:string -> (bool, ErrorCodes.t) Result.result

Verifies a password against an encoded string.

val hash_to_string : hash -> string

Converts a raw hash value to a string.

val encoded_to_string : encoded -> string

Converts an encoded hash to a string.

\ No newline at end of file diff --git a/argon2/Argon2/ID/index.html b/argon2/Argon2/ID/index.html deleted file mode 100644 index 39e498e..0000000 --- a/argon2/Argon2/ID/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -ID (argon2.Argon2.ID)

Module Argon2.ID

Bindings to Argon2id.

type hash
type encoded
val hash_raw : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> hash_len:int -> (hashErrorCodes.t) Result.result

Hashes a password with Argon2i, producing a raw hash.

val hash_encoded : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> hash_len:int -> encoded_len:int -> (encodedErrorCodes.t) Result.result

Hashes a password with Argon2i, producing an encoded hash.

val verify : encoded:encoded -> pwd:string -> (bool, ErrorCodes.t) Result.result

Verifies a password against an encoded string.

val hash_to_string : hash -> string

Converts a raw hash value to a string.

val encoded_to_string : encoded -> string

Converts an encoded hash to a string.

\ No newline at end of file diff --git a/argon2/Argon2/index.html b/argon2/Argon2/index.html deleted file mode 100644 index 48145f0..0000000 --- a/argon2/Argon2/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Argon2 (argon2.Argon2)

Module Argon2

Ocaml bindings to Argon2.

module ErrorCodes : sig ... end
module type HashFunctions = sig ... end
module I : HashFunctions

Bindings to Argon2i.

module D : HashFunctions

Bindings to Argon2d.

module ID : HashFunctions

Bindings to Argon2id.

type hash = string
type encoded = string
type kind =
| D
| I
| ID
val show_kind : [ `Upper | `Lower ] -> kind -> string
type version =
| VERSION_10
| VERSION_13
| VERSION_NUMBER

Currently an alias for VERSION_13

val hash : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> kind:kind -> hash_len:int -> encoded_len:int -> version:version -> (hash * encodedErrorCodes.t) Result.result

Generic function underlying the above ones.

val verify : encoded:encoded -> pwd:string -> kind:kind -> (bool, ErrorCodes.t) Result.result

Verifies a password against an encoded string.

val encoded_len : t_cost:int -> m_cost:int -> parallelism:int -> salt_len:int -> hash_len:int -> kind:kind -> int

Returns the encoded hash length for the given input parameters.

\ No newline at end of file diff --git a/argon2/Argon2/module-type-HashFunctions/index.html b/argon2/Argon2/module-type-HashFunctions/index.html deleted file mode 100644 index 375a709..0000000 --- a/argon2/Argon2/module-type-HashFunctions/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -HashFunctions (argon2.Argon2.HashFunctions)

Module type Argon2.HashFunctions

type hash
type encoded
val hash_raw : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> hash_len:int -> (hashErrorCodes.t) Result.result

Hashes a password with Argon2i, producing a raw hash.

val hash_encoded : t_cost:int -> m_cost:int -> parallelism:int -> pwd:string -> salt:string -> hash_len:int -> encoded_len:int -> (encodedErrorCodes.t) Result.result

Hashes a password with Argon2i, producing an encoded hash.

val verify : encoded:encoded -> pwd:string -> (bool, ErrorCodes.t) Result.result

Verifies a password against an encoded string.

val hash_to_string : hash -> string

Converts a raw hash value to a string.

val encoded_to_string : encoded -> string

Converts an encoded hash to a string.

\ No newline at end of file diff --git a/argon2/index.html b/argon2/index.html deleted file mode 100644 index 5aab6d8..0000000 --- a/argon2/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -index (argon2.index)

argon2 index

Library argon2

The entry point of this library is the module: Argon2.

\ No newline at end of file diff --git a/index.html b/index.html index a629831..13c58d5 100644 --- a/index.html +++ b/index.html @@ -11,7 +11,9 @@

OCaml package documentation

    -
  1. argon2 73bd37b
  2. +
  3. junit 2.0.2
  4. +
  5. junit_alcotest 2.0.2
  6. +
  7. junit_ounit 2.0.2
diff --git a/argon2/Argon2/.dune-keep b/junit/Junit/.dune-keep similarity index 100% rename from argon2/Argon2/.dune-keep rename to junit/Junit/.dune-keep diff --git a/junit/Junit/Property/index.html b/junit/Junit/Property/index.html new file mode 100644 index 0000000..110de74 --- /dev/null +++ b/junit/Junit/Property/index.html @@ -0,0 +1,2 @@ + +Property (junit.Junit.Property)

Module Junit.Property

type t
val make : name:string -> value:string -> t
\ No newline at end of file diff --git a/junit/Junit/Testcase/index.html b/junit/Junit/Testcase/index.html new file mode 100644 index 0000000..7bac301 --- /dev/null +++ b/junit/Junit/Testcase/index.html @@ -0,0 +1,2 @@ + +Testcase (junit.Junit.Testcase)

Module Junit.Testcase

type t
val error : ?⁠message:string -> typ:string -> name:string -> classname:string -> time:float -> string -> t

error ?message ~typ ~name ~classname ~time description creates an error element.

Indicates that the test errored. An errored test is one that had an unanticipated problem. e.g., an unchecked throwable; or a problem with the implementation of the test. Contains as a text node relevant data for the error, e.g., a stack trace.

parameter message

The error message. e.g., if a java exception is thrown, the return value of getMessage().

parameter typ

The type of error that occured. e.g., if a java execption is thrown the full class name of the exception.

parameter description

Description of the error.

parameter name

Name of the test method.

parameter classname

Full class name for the class the test method is in.

parameter time

Time taken (in seconds) to execute the test.

val failure : ?⁠message:string -> typ:string -> name:string -> classname:string -> time:float -> string -> t

failure ?message ~typ ~name ~classname ~time description creates a failure element.

Indicates that the test failed. A failure is a test which the code has explicitly failed by using the mechanisms for that purpose. e.g., via an assertEquals. Contains as a text node relevant data for the failure, e.g., a stack trace.

parameter message

The message specified in the assert.

parameter typ

The type of the assert.

parameter description

Description of the failure.

parameter name

Name of the test method.

parameter classname

Full class name for the class the test method is in.

parameter time

Time taken (in seconds) to execute the test.

val skipped : name:string -> classname:string -> time:float -> t

skipped ~name ~classname ~time creates a skipped element.

Indicates that the test has not been launched.

parameter name

Name of the test method.

parameter classname

Full class name for the class the test method is in.

parameter time

Time taken (in seconds) to execute the test.

val pass : name:string -> classname:string -> time:float -> t

pass ~name ~classname ~time creates a pass element.

Indicates that the test is a success.

parameter name

Name of the test method.

parameter classname

Full class name for the class the test method is in.

parameter time

Time taken (in seconds) to execute the test.

\ No newline at end of file diff --git a/junit/Junit/Testsuite/index.html b/junit/Junit/Testsuite/index.html new file mode 100644 index 0000000..9de8857 --- /dev/null +++ b/junit/Junit/Testsuite/index.html @@ -0,0 +1,3 @@ + +Testsuite (junit.Junit.Testsuite)

Module Junit.Testsuite

type t
val make : ?⁠package:string -> ?⁠timestamp:Ptime.t -> ?⁠hostname:string -> ?⁠system_out:string -> ?⁠system_err:string -> name:string -> unit -> t

make ?package ?timestamp ?hostname ?system_out ?system_err + ~name () creates a testsuite.

Attributes

parameter package

Derived from the testsuite name in the non-aggregated documents.

parameter timestamp

When the test was executed. Timezone may not be specified. Uses the current time by default.

parameter hostname

Host on which the tests were executed. Uses localhost by default.

parameter system_out

Data that was written to standard out while the test was executed.

parameter system_err

Data that was written to standard error while the test was executed.

parameter name

Full class name of the test for non-aggregated testsuite documents. Class name without the package for aggregated testsuites documents.

val add_testcases : Testcase.t list -> t -> t
val add_properties : Property.t list -> t -> t
\ No newline at end of file diff --git a/junit/Junit/index.html b/junit/Junit/index.html new file mode 100644 index 0000000..339b6f6 --- /dev/null +++ b/junit/Junit/index.html @@ -0,0 +1,2 @@ + +Junit (junit.Junit)

Module Junit

High level interface to produce JUnit reports.

module Property : sig ... end
module Testcase : sig ... end
module Testsuite : sig ... end
type t

Contains an aggregation of testsuite results.

val make : Testsuite.t list -> t
val add_testsuite : Testsuite.t -> t -> t
val to_xml : t -> Tyxml.Xml.elt
val to_file : t -> string -> unit
\ No newline at end of file diff --git a/junit/Junit_xml/.dune-keep b/junit/Junit_xml/.dune-keep new file mode 100644 index 0000000..e69de29 diff --git a/junit/Junit_xml/index.html b/junit/Junit_xml/index.html new file mode 100644 index 0000000..cf59815 --- /dev/null +++ b/junit/Junit_xml/index.html @@ -0,0 +1,2 @@ + +Junit_xml (junit.Junit_xml)

Module Junit_xml

Low level interface to build XML elements.

Categories of elements and attributes

Attributes

type token = string

https://www.w3.org/TR/xmlschema-2/#token

Definition: token represents tokenized strings. The ·value space· of token is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The ·lexical space· of token is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The ·base type· of token is normalizedString.

type timestamp
val timestamp : Ptime.t -> timestamp

Elements

Properties
type property
type properties = property list

Properties (e.g., environment settings) set during test execution.

val property : name:token -> value:string -> property
val property_to_xml : property -> Tyxml.Xml.elt

Builds an XML element from a property.

Testcases
type error = {
message : string option;
typ : string;
description : string;
}

Indicates that the test errored. An errored test is one that had an unanticipated problem. e.g., an unchecked throwable; or a problem with the implementation of the test. Contains as a text node relevant data for the error, e.g., a stack trace.

val error : ?⁠message:string -> typ:string -> string -> error

error ?message ~typ description creates an error element.

parameter message

The error message. e.g., if a java exception is thrown, the return value of getMessage().

parameter typ

The type of error that occured. e.g., if a java execption is thrown the full class name of the exception.

parameter description

Description of the error.

val error_to_xml : error -> Tyxml.Xml.elt

Builds an XML element from a error.

type failure = {
message : string option;
typ : string;
description : string;
}

Indicates that the test failed. A failure is a test which the code has explicitly failed by using the mechanisms for that purpose. e.g., via an assertEquals. Contains as a text node relevant data for the failure, e.g., a stack trace.

val failure : ?⁠message:string -> typ:string -> string -> failure

failure ?message ~typ description creates a failure element.

parameter message

The message specified in the assert.

parameter typ

The type of the assert.

parameter description

Description of the failure.

val failure_to_xml : failure -> Tyxml.Xml.elt

Builds an XML element from a failure.

type result =
| Error of error
| Failure of failure
| Pass
| Skipped

Not part of the spec, but available in jenkins.

val result_to_xml : result -> Tyxml.Xml.elt

Builds an XML element from a result.

type testcase
type testcases = testcase list
val testcase : name:token -> classname:token -> time:float -> result -> testcase

Creates a testcase.

parameter name

Name of the test method.

parameter classname

Full class name for the class the test method is in.

parameter time

Time taken (in seconds) to execute the test.

parameter result

Result of the test.

val testcase_to_xml : testcase -> Tyxml.Xml.elt

Builds an XML element from a testcase.

Testsuites
type testsuite

Contains the results of executing a testsuite.

type testsuites = testsuite list

Contains an aggregation of testsuite results.

val testsuite : ?⁠system_out:string -> ?⁠system_err:string -> package:token -> id:int -> name:token -> timestamp:timestamp -> hostname:token -> tests:int -> failures:int -> errors:int -> time:float -> properties -> testcases -> testsuite

Creates a testsuite.

Attributes

parameter package

Derived from the testsuite name in the non-aggregated documents.

parameter id

Starts at 0 for the first testsuite and is incremented by 1 for each following testsuite.

parameter name

Full class name of the test for non-aggregated testsuite documents. Class name without the package for aggregated testsuites documents.

parameter timestamp

When the test was executed. Timezone may not be specified.

parameter hostname

Host on which the tests were executed. 'localhost' should be used if the hostname cannot be determined.

parameter tests

The total number of tests in the suite.The total number of tests in the suite.

parameter failures

The total number of tests in the suite that failed. A failure is a test which the code has explicitly failed by using the mechanisms for that purpose. e.g., via an assertEquals.

parameter errors

The total number of tests in the suite that errored. An errored test is one that had an unanticipated problem. e.g., an unchecked throwable; or a problem with the implementation of the test.

parameter time

Time taken (in seconds) to execute the tests in the suite.

Elements

parameter properties

Properties (e.g., environment settings) set during test execution.

parameter testcases

List of test executed.

parameter system_out

Data that was written to standard out while the test was executed.

parameter system_err

Data that was written to standard error while the test was executed.

val testsuite_to_xml : testsuite -> Tyxml.Xml.elt

Builds an XML element from a testsuite.

val to_xml : testsuites -> Tyxml.Xml.elt

Builds an XML element from a list of testsuites.

\ No newline at end of file diff --git a/junit/index.html b/junit/index.html new file mode 100644 index 0000000..282e079 --- /dev/null +++ b/junit/index.html @@ -0,0 +1,2 @@ + +index (junit.index)

junit index

Library junit

This library exposes the following toplevel modules:

\ No newline at end of file diff --git a/junit_alcotest/Junit_alcotest/.dune-keep b/junit_alcotest/Junit_alcotest/.dune-keep new file mode 100644 index 0000000..e69de29 diff --git a/junit_alcotest/Junit_alcotest/index.html b/junit_alcotest/Junit_alcotest/index.html new file mode 100644 index 0000000..bb7c049 --- /dev/null +++ b/junit_alcotest/Junit_alcotest/index.html @@ -0,0 +1,2 @@ + +Junit_alcotest (junit_alcotest.Junit_alcotest)

Module Junit_alcotest

Interface to product JUnit reports for Alcotest

It tries to provide a layer as thin as possible on top of Alcotest to allow to port existing test without writing a lot a boilerplate.

val wrap_test : ?⁠classname:string -> (Junit.Testcase.t -> unit) -> unit Alcotest.test_case -> unit Alcotest.test_case

wrap_test handle_result test_cases wraps test cases to create Junit testcases and pass them to handle_result.

Can be used with run to create customized Junit testsuites if the output of run_and_report is not as expected.

parameter classname

will populate the 'classname' attribute for the test case. For best hierarchic rendering in Jenkins, it should contain a period. For example, "foo.bar.baz" will be rendered a package "foo.bar" that contains a class "baz", which contains the current test case and others. Defaults to the name of the test case.

val run : ?⁠argv:string array -> string -> unit Alcotest.test list -> unit

run ?argv n t is a wrapper around Alcotest.run, only setting and_exit to false. It is mandatory to be able to process results after the end of the run.

Low level function. It is easier to use run_and_report.

type exit = unit -> unit

exit () exists with appropriate code if run_and_report's and_exit was true or raise Alcotest.Test_error in case of error.

val run_and_report : ?⁠and_exit:bool -> ?⁠package:string -> ?⁠timestamp:Ptime.t -> ?⁠argv:string array -> string -> (string * unit Alcotest.test_case list) list -> Junit.Testsuite.t * exit

run name tests is a wrapper around run and wrap_test. It runs the tests and creates a Junit testsuite from the results.

As Alcotest.run is always called with and_exit = false to be able to produce a report, the behavior is emulated by the returned exit function.

The optional argument and_exit controls what happens when the exit function is called. By default, and_exit is set, which makes the function exit with 0 if everything is fine or 1 if there is an issue. If and_exit is false, then the function raises Test_error on error.

?argv is forwarded to run. ?package and ?timestamp are forwarded to Junit.Testsuite.make.

\ No newline at end of file diff --git a/junit_alcotest/index.html b/junit_alcotest/index.html new file mode 100644 index 0000000..99ee98a --- /dev/null +++ b/junit_alcotest/index.html @@ -0,0 +1,2 @@ + +index (junit_alcotest.index)

junit_alcotest index

Library junit_alcotest

The entry point of this library is the module: Junit_alcotest.

\ No newline at end of file diff --git a/junit_ounit/Junit_ounit/.dune-keep b/junit_ounit/Junit_ounit/.dune-keep new file mode 100644 index 0000000..e69de29 diff --git a/junit_ounit/Junit_ounit/index.html b/junit_ounit/Junit_ounit/index.html new file mode 100644 index 0000000..6579334 --- /dev/null +++ b/junit_ounit/Junit_ounit/index.html @@ -0,0 +1,2 @@ + +Junit_ounit (junit_ounit.Junit_ounit)

Module Junit_ounit

Interface from OUnit result to JUnit reports

val of_result : OUnit.test_result -> Junit.Testcase.t
val of_results : name:string -> OUnit.test_results -> Junit.Testsuite.t

of_results ~name l converts the list of results l into a Junit testsuite named name.

val to_file : name:string -> string -> OUnit.test_results -> unit

Shortcut: converts the test results to a Junit testsuite, and dump it into the given file as XML.

\ No newline at end of file diff --git a/junit_ounit/index.html b/junit_ounit/index.html new file mode 100644 index 0000000..1c54c88 --- /dev/null +++ b/junit_ounit/index.html @@ -0,0 +1,2 @@ + +index (junit_ounit.index)

junit_ounit index

Library junit_ounit

The entry point of this library is the module: Junit_ounit.

\ No newline at end of file