kinx | Looks like JavaScript, feels like Ruby, and it is a script language fitting in C programmers.

Language Independent Testing Framework for Behavior-Driven Development
Writing a specification means writing a test, and examples will become test codes as is.

Overview

Do you write a test code? You know it is very important to make a test code, but it is one of tough work these days. SpecTest will help you a little smaller work of that.

What is SpecTest?

SpecTest is a testing system based on Specification By Example. That is one of thought in Behavior Driven Development. You only write a document, it will be tested automatically.

If you want to see a kind of examples soon, see here.

How to Use

Write Specification

First, write a specification with the markdown style below. Here is the simple template of a specification document. SpecTest will work with markdown by default.

# TestSuite name

The top level header is an important mark to show a test suite name.

For any other places, you can write any text document for your specification with nothing to care about tests.
Everything is okay.

## Subject...
### Subject 2...

Also don't have to care about test here.
...

## Examples

This subject of `## Examples` is important.
This means starting test area.

### Example 1. TestCase Name.

This subject of `### Example N. ...` is also important.
This means starting a test case and it shows a test case's name.

#### Code

`#### Code` is an important mark to start a test code.
In this section, you can write a test case as an example in code block.

```language
Test code here
```

Note that `language` comment is ignored for testing because interpreter is specified in the rule file.
And you can write anything except inside code block.

#### Result

`#### Result` is also an important mark to start an expected result in code block.
This section will show the result corresponding to the test shown in `Code` section.

```
Expected result
```

Any other lines are the places you can write anything.

For your more understanding, you can see the actual specification file of Kinx below. It will help you.

declaration.md … Testing for declaration.
benchmark/README.md … Example for using multiple interpreters.

`.spectest` File

Setup The File

Write .spectest file in Json format. SpecTest will expect there is a .spectest file to load in the current directory by default.

Markdown Template

SpecTest will work the rule from .spectest. That rule is based on Markdown by default and you can write some differences.

Note that currently there is no template but for Markdown. In future some templates will be added for other document styles.

The Sample of `.spectest` File

See the example below. This is the actual .spectest file of Kinx itself.

{
    "root": "docs/spec",

    "testfile": "test.kx",
    "resultfile": "result.txt",
    "interpreter": "kinx",

    "ignoreFiles": [
        "docs/spec/../benchmark/README.md",
        "docs/spec/spectest/README.md"
    ]
}

Rules

The items of .spectest file is below.

Key	Default	Meaning
topLevelFilePattern	`"(README\|CONTENTS\|index)\\\\.md"`	Root document for SpecTest.
linkPattern	`"\\[([^\\]]+)\\]\\s*\\(([^\\)]+\\.md)\\)"`	Link pattern to traverse document tree.
targetNamePattern	`"^#\\s+(.+)"`	The line of TestSuite name.
startTestPattern	`"^##+\\s+Examples"`	The line to recognize to start a test code area.
endTestPattern	`""`	The line to recognize to end a test code area.
testNamePattern	`"^##+\\s+Example\\s+[0-9]+[\\.\\)]?\\s+(.+)"`	The line of TestCase name.
startCodePattern	`"^##+\\s+Code(?:\\s+\\(([^\\)]+)\\))?.*"`	The line to recognize to start a test code section.
startResultPattern	`"^##+\\s+Result.*"`	The line to recognize to start a test result section.
codeBlockStart	"^```"	The line to recognize to start a test code.
codeBlockEnd	"^```"	The line to recognize to end a test code.
testfile	`"test.kx"`	Temporary test code file name.
resultfile	`"result.txt"`	Temporary test result file name.
compiler	`""`	Currently Not supported. This will be supported when supporting to use compiler.
interpreter	`"kinx"`	Interpreter command name. It is necessary to set the environment variable PATH in advance.

Note that testfile and resultfile will be removed after testing.

Example

This an example of a SpecTest working for Kinx Specification. SpecTest will automatically recognize a test code in your markdown document, and run it and compare to the expected result.

Note that some parts of Kinx Specification documentations are still under construction.

$ ./kinx --exec:spectest
Test Cout = 54
[<>[<*********>][<****>][<***>][<*>][<*>][<***>][<****>][<**>][<**>][<***>][<*>][<*>][W]
[W][W][W][W][W][W][W][W][W][W][W][W][W][W][W][W][W][W][W]]

<Test Result Detail>

Entry: docs/spec/README.md
    Kinx Specification with SpecTest (0.00s)
    Entry: docs/spec/statement/declaration.md
        Declaration statement (0.52s)
            Case[0] (Normal case) ........................... successful (  0.08s)
            Case[1] (With initializer) ...................... successful (  0.06s)
            Case[2] (With initializer of expression) ........ successful (  0.06s)
            Case[3] (Multiple variable declaration) ......... successful (  0.06s)
            Case[4] (Constant value (1)) .................... successful (  0.03s)
            Case[5] (Constant value (2)) .................... successful (  0.06s)
            Case[6] (Constant value (3)) .................... successful (  0.04s)
            Case[7] (Constant value (4)) .................... successful (  0.03s)
            Case[8] (Constant value (5)) .................... successful (  0.06s)
    Entry: docs/spec/statement/enum.md
        Enum statement (0.25s)
            Case[0] (Normal case) ........................... successful (  0.06s)
            Case[1] (With initializer (1)) .................. successful (  0.06s)
            Case[2] (With initializer (2)) .................. successful (  0.05s)
            Case[3] (The scope) ............................. successful (  0.07s)
    Entry: docs/spec/statement/expression.md
        Expression statement (0.19s)
            Case[0] (Assignment) ............................ successful (  0.06s)
            Case[1] (Exponent Evaluation) ................... successful (  0.06s)
            Case[2] (Logical Undefined Operator) ............ successful (  0.06s)
    Entry: docs/spec/statement/mixin.md
        Mixin statement (0.07s)
            Case[0] (Normal case) ........................... successful (  0.07s)
    Entry: docs/spec/statement/block.md
        Block statement (0.07s)
            Case[0] (Scope) ................................. successful (  0.07s)
    Entry: docs/spec/statement/if_else.md
        If-Else statement (0.20s)
            Case[0] (Normal case) ........................... successful (  0.06s)
            Case[1] (No else clause) ........................ successful (  0.06s)
            Case[2] (If-else combination) ................... successful (  0.06s)
    Entry: docs/spec/statement/switch_case.md
        Switch-Case statement (0.33s)
            Case[0] (Normal case) ........................... successful (  0.07s)
            Case[1] (With do-while) ......................... successful (  0.08s)
            Case[2] (Non-integer value) ..................... successful (  0.09s)
            Case[3] (Complex switch-case pattern) ........... successful (  0.06s)
    Entry: docs/spec/statement/while.md
        While statement (0.12s)
            Case[0] (Normal case) ........................... successful (  0.06s)
            Case[1] (Infinaite loop) ........................ successful (  0.06s)
    Entry: docs/spec/statement/do_while.md
        Do-While statement (0.12s)
            Case[0] (Normal case) ........................... successful (  0.06s)
            Case[1] (Infinaite loop) ........................ successful (  0.06s)
    Entry: docs/spec/statement/for.md
        For statement (0.20s)
            Case[0] (Normal case) ........................... successful (  0.06s)
            Case[1] (Infinaite loop) ........................ successful (  0.06s)
            Case[2] (Declation variable in scope) ........... successful (  0.07s)
    Entry: docs/spec/algorithm/qsort.md
        Quicksort (0.06s)
            Case[0] (Quicksort Algorithm) ................... successful (  0.06s)
    Entry: docs/spec/algorithm/mergesort.md
        Merge Sort (0.06s)
            Case[0] (Merge Sort Algorithm) .................. successful (  0.06s)
    Entry(nolink): docs/spec/statement/try_catch_finally.md
    Entry(nolink): docs/spec/statement/return.md
    Entry(nolink): docs/spec/statement/yield.md
    Entry(nolink): docs/spec/statement/throw.md
    Entry(nolink): docs/spec/statement/function.md
    Entry(nolink): docs/spec/statement/class.md
    Entry(nolink): docs/spec/statement/module.md
    Entry(nolink): docs/spec/statement/lambda.md
    Entry(nolink): docs/spec/statement/closure.md
    Entry(nolink): docs/spec/statement/module.md
    Entry(nolink): docs/spec/lib/primitive/integer.md
    Entry(nolink): docs/spec/lib/primitive/double.md
    Entry(nolink): docs/spec/lib/primitive/string.md
    Entry(nolink): docs/spec/lib/primitive/array.md
    Entry(nolink): docs/spec/lib/basic/file.md
    Entry(nolink): docs/spec/lib/basic/directory.md
    Entry(nolink): docs/spec/lib/basic/regex.md
    Entry(nolink): docs/spec/lib/basic/xml.md
    Entry(nolink): docs/spec/lib/basic/zip.md
    Entry(nolink): docs/spec/lib/net/http.md

<Test Result>
    Total Test Cases:       54
        Successful  :       34
        Failed      :        0
        Warning     :       20