/qi

A testing framework for Blade programming language.

Primary LanguageBlade

Qi

A testing framework for Blade programming language.

Package Information

Getting started

Qi is a Nyssa package and can be installed using the command:

nyssa install qi

Qi is designed to run tests are out the directory tests and for this reason, all tests files must reside inside the tests directory.

Writing a simple test

Let's write a test for a hypothetical function that returns the product of two numbers. First, we'll create a file prod.b that contains the following code:

def prod(x, y) {
  return x * y
}

Now, let's create a test for it by creating a file prod.test.b in the tests directory and add the following code to it.

import ..prod

describe('Product test suite', || {
  it('should return 6 for 2 and 3', || {
    expect(prod(2, 3)).to_be(6)
  })
})

Now let's run the test. If you have installed Qi using nyssa (which is recommended), then you can run the following command at the root directory (the directory that contains the tests folder).

.blade/qi

You should get an output similar to this:

 PASS  tests/prod.test.b
  Product test suite
    ✔ should return 6 for 2 and 3 (1.09ms)
      ✔ expect "6" to be "6"

Test suites:  1 passed, 0 failed, 1 total
Tests:        1 passed, 0 failed, 1 total
Assertions:   1 passed, 0 failed, 1 total
Time:         1.092ms
Ran all test suites.

You have successfully created your first Qi test!

Read more documentation at: mcfriend99.github.io/qi