@dexit/module-base

Base utilities and typings for a Dexit module.

What is Dexit?

The Dexit aims to create a framework for integration testing of complex applications which consist of various services such as API servers, databases, pub/sub systems and so on. The Dexit allows you to easily test these services altogether.

Usage

Install the package:

npm install --save @dexit/module-base

Typings

Use typings in your Dexit module as follows:

import { ITestModule } from "@dexit/module-base"

const MyModule: ITestModule = {
    ...
};

module.exports = MyModule;

Module Test Runner

If you want to test your module you can the TestRunner class.

import { ModuleTestRunner, IRunEnv } from "@dexit/module-base"

const runner = new ModuleTestRunner(myModuleDefinition);

const env: IRunEnv = {
    debug: false,
    taskPath: "task",
    document: {
        name: "test",
        filename: __filename,
        fullPath: __filename
    }
};

const runResult = await runner.run("command", args, env);
const expectErrors = runner.expect("command", args, runResult, env)

License Apache 2.0

Copyright 2018 Jiri Hybek [e-mail]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.