Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
e2e
 
 
 
 
img
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Test codecov npm version Tweet

Shoutout to Kateryna Jones for that sweet logo!

Testy.Ts is a modern TypeScript testing framework.

Why?

Writing tests should be fun. The other testing framework solutions do not make use of the full power of TypeScript. This one uses decorators and OOP and stuff. Therefore, it makes writing tests fun.

Installation

$ npm install --save-dev testyts
$ npm install -g testyts

Setup

To generate a basic testy.json configuration file, use the following command. To see all available configurations, see this section.

$ testyts init

Write some tests

The basics

Writing tests with Testy is simple. Don't forget to export your test suites though. Otherwise, they won't be discovered by the test runner.

@TestSuite()
export class MyTestSuite {
  @Test()
  onePlusOne() {
    // Act
    const result = 1 + 1;

    // Assert
    expect.toBeEqual(result, 2);
  }
}

Setup and teardown

Testy provides setup and teardown hooks.

@TestSuite()
export class MyTestSuite {
  @BeforeAll()
  beforeAll() {
    // This is executed before all the tests
  }

  @BeforeEach()
  beforeEach() {
    // This is executed before each test
  }

  @AfterEach()
  afterEach() {
    // This is executed after each test
  }

  @AfterAll()
  afterAll() {
    // This is executed after all the tests
  }
}

If you need to setup global stuff, you may do so by specifying a setup file in your testy.json.

testy.json

{
  "setupFile": "test-setup.ts"
}

test-setup.ts

// Import modules here, setup global variables, the whole nine yards
global['foo'] = 'I can be used in test 😎';

Asynchronous stuff

Asynchronous tests, setup and teardown methods are supported out of the box. Just make your method async.

@TestSuite()
export class MyTestSuite {
  @Test()
  async asyncTest() {
    // Asynchronous stuff
  }
}

Timeout

If a test is taking too long to complete, it will fail automatically. The default timeout it 2000 ms, but you can configure it. Please note that the Timeout decorator goes after the Test decorator.

@TestSuite()
export class MyTestSuite {
  @Test()
  @Timeout(100000) // Really slow test
  slowTest() {
    // Some test
  }
}

Reuse code!

This is where stuff gets interesting. Testy allows you to use base test classes. The base test can have setup and teardown methods. Your child test suite may also have setup and teardown methods. In that case, the base test methods are executed first.

class MyBaseTestSuite {
  // Setup/teardown extravaganza
}

@TestSuite()
class MyTestSuite extends MyBaseTestSuite {
  // My tests
}

Test cases

You can easily run the same test with different inputs using the TestCase decorator. The first argument is the test case name, the following arguments will be passed to your test method. Please note this decorator goes after the @Test decorator.

@TestSuite()
export class MyTestSuite {
  @Test()
  @TestCase('Two plus two is four', 2, 2, 4)
  @TestCase(`Minus one that's three`, 4, -1, 3)
  addition(a: number, b: number, result: number) {
    expect.toBeEqual(a + b, result);
  }
}

Asserting

There's a whole bunch of assertion methods and also a dash of syntactic sugar sexyness in the expect class.

expect.toBeTrue(2 > 1);
expect.toBeEqual('a', 'a');
expect.not.toBeEqual('p', 'np');
expect.toThrow(() => someNastyMethod());
expect.toBeSorted.inAscendingOrder([0, 1, 1, 2, 3, 5, 8]);
// More!

Ignoring or focusing some tests

You can ignore tests by calling the ignore method on a test suite or a test decorator. Ignored tests will still show up in the test report, but they will be marked as ignored.

@TestSuite.ignore() // This test suite will be ignored
export class MyTestSuite {
  // Your tests
}

@TestSuite()
export class MyTestSuite {
  @Test.ignore() // This test will be ignored
  onePlusOne() {
    // Some test
  }
}

You can also focus tests by calling the focus method on a test suite or a test decorator. If at least one test or test suite is focused, only focused tests or tests within a focused test suite will be run. The others will be reported as ignored. Ignored tests inside focused test suite will remain ignored.

@TestSuite.focus() // This test suite will be focused.
export class MyTestSuite {
...
}

@TestSuite()
export class MyTestSuite {

    @Test.focus() // This test will be focused
    onePlusOne() {
       // Your test
    }
}

Custom tests and test suites names

The tests and test suites names are inferred from the method or class name by default. You can specify a custom name.

@TestSuite('My glorious test suite')
export class MyTestSuite {
  @Test('Adding one plus one, should equal two')
  onePlusOne() {
    // Act
    const result = 1 + 1;

    // Assert
    expect.toBeEqual(result, 2);
  }
}

Configuration file

Key Description Type Note
include The test loader will look for tests in files that match any of those glob patterns string[] Required
tsconfig Alternate tsconfig for the test loader to use. If not specified, the loader will use the tsconfig.json in the current directory string Optional
timeout Global test timeout. By default, the global timeout is 2000 ms. The global timeout will be overriden by test-level timeouts. number Optional
setupFile A .ts or .js file that will be run before the tests run starts. string Optional
reporters Output format. {[reporter: ReporterName]: object } Optional.
reporter Output format. 'standard' | 'TAP' Deprecated

Example configuration file:

{
  "include": ["**/*.spec.ts"],
  "tsconfig": "./tsconfig.spec.json",
  "reporters": {
     "standard": {
       "color": true
     }
  },
  "timeout": 10000
}

Cli arguments

Cli arguments will override config file values.

-c --config <config> // Specify a testy.json configuration file
-t --tsconfig <tsconfig> // Specify a tsconfig.json file
-f --files "<files>" // Run only tests found in files matching the given glob patterns. A comma-separated list of glob patterns.
-r --reporter <reporter> // Specify a comma-separated list of reporters. Does not support reporters configs.
--reporter <reporter> // DEPRECATED. Specify a reporter. Either standard or TAP.

Run the tests

To run the tests, use the following command

$ testyts
$ testyts --config custom/config/file.json // To specify a custom configuration file
$ testyts --tsconfig custom/tsconfig.json // To specify a custom typescript configuration file (tsconfig.json)
$ testyts --files "my-first-file.spec.ts,my-folder/**.spec.ts" // To run tests in files matching the specified glob patterns

More documentation

The examples folder contains example projects with various use-cases.

Try it out online!

Here's an online REPL for you to try Testy.Ts!

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update unit tests and e2e tests as appropriate.

If you have any questions, do not hesitate to email me at aboisiermichaud@gmail.com.

More documentation

License

Code of conduct

The code of conduct can be consulted here.

Shoutout to Kateryna Jones for that sweet logo!
Shoutout to Kateryna Jones for that sweet logo!