Add test references for Crystal/Dart/Elixir/OCaml

kazk · kazk · commit f99bc99481ce · 2017-06-03T12:11:51.000-07:00
diff --git a/docs/_test_references/crystal/spec.html b/docs/_test_references/crystal/spec.html
@@ -0,0 +1,28 @@
+---
+title: spec
+language: crystal
+
+basic_setup: |-
+  ```ruby
+  def add(a, b)
+    a + b
+  end
+  ```
+
+  ```ruby
+  describe "simple test" do
+    it "should add" do
+      add(1, 1).should eq 2
+    end
+  end
+  ```
+---
+
+<h1>{{ page.title }}</h1>
+<p>
+<a href="https://crystal-lang.org/api/0.21.1/Spec.html"><code>spec</code></a>
+module can be used to test Crystal code.
+</p>
+
+<h2>Basic Setup</h2>
+{{ page.basic_setup | markdownify }}
diff --git a/docs/_test_references/dart/test.html b/docs/_test_references/dart/test.html
@@ -0,0 +1,50 @@
+---
+title: test
+language: dart
+
+basic_setup: |-
+  ```dart
+  add(a, b) => a + b;
+  ```
+
+  ```dart
+  test('add', () {
+    expect(add(1, 1), equals(2));
+  });
+  ```
+
+  Note that `test()` is *not* inside `main`.
+
+  From above inputs, a file like the following is generated and executed:
+
+  ```dart
+  import 'package:test/test.dart';
+
+  // optional "Preloaded" code
+
+  // solution
+  add(a, b) => a + b;
+
+  void main() {
+    // fixture
+    test('add', () {
+      expect(add(1, 1), equals(2));
+    });
+  }
+  ```
+
+---
+
+<h1>{{ page.title }}</h1>
+
+<a href="https://pub.dartlang.org/packages/test">test</a> package can be used to test Dart code.
+
+<h2>Basic Setup</h2>
+{{ page.basic_setup | markdownify }}
+
+
+{% comment %}
+
+Why does dart-runner do this?
+
+{% endcomment %}
diff --git a/docs/_test_references/elixir/ex_unit.html b/docs/_test_references/elixir/ex_unit.html
@@ -0,0 +1,28 @@
+---
+title: ExUnit
+language: elixir
+
+basic_setup: |-
+  ```elixir
+  defmodule Adder do
+    def add(a, b), do: a + b
+  end
+  ```
+
+  ```elixir
+  defmodule TestAdder do
+    use ExUnit.Case
+    import Adder, only: [add: 2]
+    test "add(1, 1) == 2" do
+      assert add(1, 1) == 2
+    end
+  end
+  ```
+---
+
+<h1>{{ page.title }}</h1>
+
+<p>Elixir code can be tested using <a href="https://hexdocs.pm/ex_unit/ExUnit.html">ExUnit</a>.</p>
+
+<h2>Basic Setup</h2>
+{{ page.basic_setup | markdownify }}
diff --git a/docs/_test_references/ocaml/ounit.html b/docs/_test_references/ocaml/ounit.html
@@ -0,0 +1,152 @@
+---
+title: OUnit
+language: ocaml
+
+basic_setup: |-
+  ```ocaml
+  (* TODO *)
+  ```
+
+assertions:
+  - name: assert_failure
+    id: assert-failure
+    desc: |-
+      ```ocaml
+      val assert_failure : string -> 'a
+      ```
+      Signals a failure.
+      This will raise an exception with the specified string.
+
+  - name: assert_bool
+    id: assert-bool
+    desc: |-
+      ```ocaml
+      val assert_bool : string -> bool -> unit
+      ```
+      Signals a failure when bool is false.
+      The string identifies the failure.
+
+  - name: assert_string
+    id: assert-string
+    desc: |-
+      ```ocaml
+      val assert_string : string -> unit
+      ```
+      Signals a failure when the string is non-empty.
+      The string identifies the failure.
+
+  - name: assert_equal
+    id: assert-equal
+    desc: |-
+      ```ocaml
+      val assert_equal :
+        ?ctxt:test_ctxt ->
+        ?cmp:('a -> 'a -> bool) ->
+        ?printer:('a -> string) ->
+        ?pp_diff:(Format.formatter -> 'a * 'a -> unit) ->
+        ?msg:string ->
+        'a -> 'a -> unit
+      ```
+
+      Compares two values, when they are not equal a failure is signaled.
+
+      `assert_equal expected real`
+
+      `ctxt` : if provided, always print expected and real value
+
+      `cmp` : customize function to compare, default is `=`
+
+      `printer` : value printer, don't print value otherwise
+
+      `pp_diff` : if not equal, ask a custom display of the difference using
+      `diff fmt exp real` where `fmt` is the formatter to use
+
+      `msg` : custom message to identify the failure
+
+  - name: assert_raises
+    desc: |-
+      ```ocaml
+      val assert_raises :
+        ?msg:string ->
+        exn -> (unit -> 'a) -> unit
+      ```
+      Asserts if the expected exception was raised.
+
+      `msg` : identify the failure
+
+compare_functions:
+  - name: cmp_float
+    id: cmp-float
+    desc: |-
+      ```ocaml
+      val cmp_float : ?epsilon:float -> float -> float -> bool
+      ```
+      Compare floats up to a given relative error.
+
+      `epsilon`: if the difference is smaller epsilon values are equal
+
+constructing:
+  - name: '>:'
+    id: label-test
+    desc: |-
+      ```ocaml
+      val (>:) : string -> test -> test
+      ```
+      Create a TestLabel for a test
+  - name: '>::'
+    id: label-test-case
+    desc: |-
+      ```ocaml
+      val (>::) : string -> test_fun -> test
+      ```
+      Create a TestLabel for a TestCase
+  - name: '>:::'
+    id: label-test-list
+    desc: |-
+      ```ocaml
+      val (>:::) : string -> test list -> test
+      ```
+      Create a TestLabel for a TestList
+  - name: test_case
+    id: test-case
+    desc: |-
+      ```ocaml
+      val test_case : ?length:test_length -> test_fun -> test
+      ```
+      Generic function to create a test case.
+  - name: test_list
+    id: test-list
+    desc: |-
+      ```ocaml
+      val test_list : test list -> test
+      ```
+      Generic function to create a test list.
+---
+
+<h1>{{ page.title }}</h1>
+<p><a href="http://ounit.forge.ocamlcore.org/api-ounit/">OUnit</a> can be used to test OCaml code.</p>
+
+<h2>Basic Setup</h2>
+{{ page.basic_setup | markdownify }}
+
+<h2>Assertions</h2>
+<dl>
+{% for a in page.assertions %}
+<dt id="{{ a.id }}" class="f4"><code>{{ a.name }}</code></dt><dd>{{ a.desc | markdownify }}</dd>
+{% endfor %}
+</dl>
+
+<h2>Compare Functions</h2>
+<dl>
+{% for a in page.compare_functions %}
+<dt id="{{ a.id }}" class="f4"><code>{{ a.name }}</code></dt><dd>{{ a.desc | markdownify }}</dd>
+{% endfor %}
+</dl>
+
+
+<h2>Constructing</h2>
+<dl>
+{% for a in page.constructing %}
+<dt id="{{ a.id }}" class="f4"><code>{{ a.name }}</code></dt><dd>{{ a.desc | markdownify }}</dd>
+{% endfor %}
+</dl>
