aboutsummaryrefslogtreecommitdiff
path: root/doc/COVERAGE.md
diff options
context:
space:
mode:
authorRuben Beltran del Rio <ruben@unlimited.pizza>2020-09-20 16:55:36 +0200
committerRuben Beltran del Rio <ruben@unlimited.pizza>2020-09-20 16:55:36 +0200
commite4c7bafd276049c805039b240e0a83346c31f41b (patch)
tree4c8788909ed67710a1628b9e4ae51c1a45b3b3ce /doc/COVERAGE.md
Initial release
Diffstat (limited to 'doc/COVERAGE.md')
-rw-r--r--doc/COVERAGE.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/COVERAGE.md b/doc/COVERAGE.md
new file mode 100644
index 0000000..43cf0e4
--- /dev/null
+++ b/doc/COVERAGE.md
@@ -0,0 +1,52 @@
+# TOC
+ - [test/graph.js](#testgraphjs)
+ - [It colorizes the graph based on execution results](#it-colorizes-the-graph-based-on-execution-results)
+
+
+<a name="testgraphjs"></a>
+# test/graph.js
+It throws an error if you try to run a non-existing vertex.
+
+
+It runs a vertex if no dependencies are defined.
+
+
+It does not run a vertex if it has unfulfilled dependencies.
+
+
+It runs dependent vertices on completion of a vertex's action.
+
+
+It ensures dependencies state is available before running dependents.
+
+
+It gives dependent vertices a state including their dependencies' results.
+
+
+It throws an error if a vertex throws an error.
+
+
+It runs a vertex only once.
+
+
+It can convert to a string representing the graph in graphviz format.
+
+
+<a name="it-colorizes-the-graph-based-on-execution-results"></a>
+## It colorizes the graph based on execution results
+It throws an error if a sub-step fails.
+
+
+It adds the right colors according to execution.
+
+
+
+ok - It colorizes the graph based on execution results
+
+ok - test/graph.js
+----------|----------|----------|----------|----------|-------------------|
+File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s |
+----------|----------|----------|----------|----------|-------------------|
+All files | 100 | 100 | 100 | 100 | |
+ graph.js | 100 | 100 | 100 | 100 | |
+----------|----------|----------|----------|----------|-------------------|