README
¶
tengo-tester
CLI to test a Tengo script
Overview
tengo-tester is a CLI tool to test Tengo scripts. Tengo is a fast script language for Go.
We can define tests of Tengo scripts in the tengo-tester configuration file and test scripts by tengo-tester run.
Limitation
https://github.com/d5/tengo/blob/master/docs/objects.md#user-object-types
tengo-tester doesn't support the Tengo's User Extension.
On the other hand, all standard library can be used.
Install
Download from GitHub Releases
$ tengo-tester --version
tengo-tester version 0.1.0
Getting Started
Write a Tengo script which we want to test.
foo.tengo
name := "foo"
Generate the configuration file .tengo-tester.yaml by tengo-tester init.
$ tengo-tester init
Edit the configuration file.
.tengo-tester.yaml
---
entries:
- name: main
script_file: foo.tengo
tests:
- name: test foo
var_name: name
equal: foo
Run test.
$ tengo-tester run
Change the configuraiton equal from foo to fo for the test to fail.
$ tengo-tester run
test fails
entry_name: main
test_name: test
the value of the variable foo is unexpected (-want, +got)
string(
- "fo",
+ "foo",
)
entry fails
entry_name: main
FATA[0000]
exit status 1
Examples
Please see examples.
On the directory, there are some examples of configuration files.
We can execute the test with them.
For example,
$ tengo-tester run -c examples/hello_world.yaml
Configuration Reference
---
entries:
- name: main # entry name
script_file: foo.tengo # the tested script file path
params: # the parameter of the tengo script.
var_name: var_value
tests:
- name: foo # test name
script: |
# tengo script to test the result
# If the test fails, set the error message to the variable "err_msg".
fmt := import("fmt")
err_msg := ""
if result.foo != "foo" {
err_msg = fmt.sprintf("foo = %v, wanted foo", result.foo)
}
script_file: foo_test.tengo # file path to a test script
var_name: foo # the variable name to be tested
equal: foo # When `equal` isn't nil, the test fails if the variable isn't equal to the value of `equal`.
is_nil: true # When `is_nil` is true, the test fails if the variable isn't nil.
is_not_nil: true # When `is_not_nil` is true, the test fails if the variable is nil.
Configuration file path
The configuration file path can be specified with the --config (-c) option.
If the confgiuration file path isn't specified, the file named .tengo-tester.yml or .tengo-tester.yaml would be searched from the current directory to the root directory.
the base directory of the relative path
There are some configuration which are file paths. If a file path is a relative path, the base directory of the relative path is the directory where the configuration file exists.
The type of map key should be string in entry.params and test.equal
entry.params and test.equal is a variable of a Tengo script.
The type of map key of Tengo script should be string.
https://github.com/d5/tengo/blob/master/docs/tutorial.md#values-and-value-types
So the test fails if the map key whose type isn't string is found.
ex.
---
entries:
- name: main
script_file: foo.tengo
params:
foo:
true: 1 # the key is boolean
tests:
- name: test
var_name: result
equal: hello
$ tengo-tester run
FATA[0000] format config: convert entry.params: entry_name: main: key: foo: the map key should be string : true
Directories