# Karma test framework
Gathering coverage and test information using the SeaLights Node.js Test Listener is done in a few steps and commands, detailed below in a table comparing the relevancy of each, depending on the type of tests you’re running
Step
Command
Unit Tests
Functional Tests
1
Starting the Test Stage
2
Executing your application instrumented by Sealights
3
Run your Karma tests
4.a
Upload Coverage Report
4.b
Upload JUnit Report
5
End the Test Stage
{% hint style="info" %}
See '[Generating an Agent token](https://docs.sealights.io/knowledgebase/settings/token-access-and-management#token-list-and-token-creation-2)' for instructions on how to generate a token
{% endhint %}
## Starting the Test Stage
First, the SeaLights server needs to be notified that a test stage is starting.
{% code overflow="wrap" %}
```sh
npx slnodejs start --tokenfile /path/to/sltoken.txt --buildsessionidfile buildSessionId --teststage "Unit Tests"ests"
```
{% endcode %}
{% hint style="info" %}
See [Command Reference](/knowledgebase/setup-and-configuration/sealights-agents-and-plugins/node.js-agent/command-reference.md#starting-a-test-stage) for full parameter details
{% endhint %}
## Running your tests
### Functional Tests
Before running your functional tests, you need to set up your backend or frontend applications to send the coverage to Sealights (test footprints):
* [Running Backend Server](/knowledgebase/setup-and-configuration/sealights-agents-and-plugins/node.js-agent/backend-server-application/running-backend-server.md)
* [Front-End App: Scan & Instrument](/knowledgebase/setup-and-configuration/sealights-agents-and-plugins/node.js-agent/front-end-application/front-end-app-scan-and-instrument.md)
Once set up, you now run your tests normally while generating one or more JUnit XML result files to be reported to the SeaLights server.
### Unit Tests
To report the test and coverage information to SeaLights, you need to run the karma tests while producing coverage information and a JUnit results file.
* For the JUnit results XML file, you can use the **karma-junit-reporter** reporter.
* See [npm: karma-junit-reporter](https://www.npmjs.com/package/karma-junit-reporter) for more details.
* For the coverage, you need to use the **karma-coverage** configured to generate a `coverage-final.json` file by using the *coverageReporter* type `json`.
* See [npm: karma-coverage](https://www.npmjs.com/package/karma-coverage) for more details.
To generate these report files, update your `karma.conf.js` and add or update the `reporters`, `coverageReporter`, and `junitReporter` sections:
{% code overflow="wrap" lineNumbers="true" %}
```
module.exports = function (config) {
config.set({
// your existing config...
reporters: ['progress', 'junit', 'coverage'],
coverageReporter: {
type: 'json',
dir: 'karma-reports',
subdir: '.',
file: 'coverage-final.json',
},
junitReporter: {
outputDir: 'karma-reports',
outputFile: 'junit.xml',
useBrowserName: false,
},
});
};
```
{% endcode %}
## Uploading Test Metadata
### Upload coverage report files from Unit Tests
Once done running the Unit Tests, you upload the coverage report files to the SeaLights server using the **nycReport** option
{% code overflow="wrap" lineNumbers="true" %}
```sh
npx slnodejs nycReport --tokenfile /path/to/sltoken.txt --buildsessionidfile buildSessionId [--report ./coverage/coverage-final.json]
```
{% endcode %}
### Upload test results report files
Once done running the tests, you upload the test results file to the SeaLights server using the **uploadReports** option
{% code overflow="wrap" lineNumbers="true" %}
```sh
npx slnodejs uploadReports --tokenfile /path/to/sltoken.txt --buildsessionidfile buildSessionId --reportFile junit.xml
```
{% endcode %}
## Ending the Test Stage
Finally, the server needs to be notified that a test stage has ended.
{% code overflow="wrap" lineNumbers="true" %}
```sh
npx slnodejs end --tokenfile /path/to/sltoken.txt --buildsessionidfile buildSessionId
```
{% endcode %}
## Sample - Capturing Unit Tests with Karma
Below, a sample script running the Unit Tests while instrumenting for client-side (front-end) coverage
{% code overflow="wrap" lineNumbers="true" %}
```sh
#Install the project dependencies
npm install
# transpile the code with source maps to the dist folder
npm run build
# Install the SeaLights agents
npm i slnodejs
# Create a SeaLights ignore file to only include the src folder
echo '**/vendor*.js' > .slignore
echo '**/polyfills*.js' >> .slignore
# Scan the source files to provide SeaLights the structure of the project
npx slnodejs scan --tokenfile sltoken.txt --buildsessionidfile buildSessionId --workspacepath dist --scm git --projectRoot $(pwd)
npx slnodejs instrument --tokenfile sltoken.txt --buildsessionidfile buildSessionId --outputpath sl_dist --workspacepath dist
# Notify SeaLights the Unit Tests are starting
npx slnodejs start --tokenfile sltoken.txt --buildsessionidfile buildSessionId.txt --testStage "Unit Tests"
# Run the unit tests while ignoring the error code returned from Karma if the tests fail
# This should be with coverage and Junit reports enabled - we assume they're placed in the 'karma-reports' folder
set +e
npm run test
set -e
# Upload the coverage and tests results to SeaLights
npx slnodejs nycReport --tokenfile sltoken.txt --buildsessionidfile buildSessionId.txt --report ./karma-reports/coverage-final.json
npx slnodejs uploadReports --tokenfile sltoken.txt --buildsessionidfile buildSessionId.txt --reportFile ./karma-reports/junit.xml
# Notify SeaLights the Unit Tests have finished
npx slnodejs end --tokenfile sltoken.txt --buildsessionidfile buildSessionId.txt
```
{% endcode %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.sealights.io/knowledgebase/setup-and-configuration/sealights-agents-and-plugins/node.js-agent/supported-test-frameworks/karma-test-framework.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.