README.md

libtest utils

This library is used as handy tool to run integration tests for core.ai services.

Code Guardian

How to USE

// Add test dependency in package.json
import {installMysql,  uninstallMysql} from libtestutils;
try{
await installMysql();
await uninstallMysql();
} catch (e){
console.log(e)
}

TODOs after template use

1. Update package.json with your app defaults
2. Check Build actions on pull requests.
3. create a home page in wiki by going to wiki link https://github.com/<your_org>/<your_repo>/wiki
4. Goto github repository > settings> and uncheck Allow merge commits
5. In sonar cloud, enable Automatic analysis from Administration Analysis Method for the first time before a pull request is raised:
6. Check codacy runs on pull requests, set codacy defaults. You may remove codacy if sonar cloud is only needed.
7. Update the above Code Guardian badges; change all id=aicore_template-nodejs-ts to the sonar id of your project fields. see this PR: aicore/libcache#13

Commands available

Building

Since this is a pure JS template project, build command just runs test with coverage.

> npm install   // do this only once.
> npm run build

Linting

To lint the files in the project, run the following command:

> npm run lint

To Automatically fix lint errors:

> npm run lint:fix

Testing

To run all tests:

> npm run test

Additionally, to run unit/integration tests only, use the commands:

> npm run test:unit
> npm run test:integ

Coverage Reports

To run all tests with coverage:

> npm run cover
 
After running coverage, detailed reports can be found in the coverage folder listed in the output of coverage command.
Open the file in browser to view detailed reports.

To run unit/integration tests only with coverage
```shell
> npm run cover:unit
> npm run cover:integ