0.1.0 • Published 7 years ago
telemetry-events-module-tests v0.1.0
telemetry-events-module-tests
Stability: 1 - Experimental
A bundle of Jest tests for testing modules using TelemetryEvents.
Contributors
Contents
Installation
npm install telemetry-events-module-tests
Usage
To run the below example run:
npm run readme
"use strict";
const events = require("events");
const LogTelemetryEvents = require("telemetry-events-log");
const pkg = require("../package.json");
const QuantifyTelemetryEvents = require("telemetry-events-quantify");
const TelemetryEvents = require("telemetry-events");
const TraceTelemetryEvents = require("telemetry-events-trace");
const util = require("util");
const MyModule = function(config = {})
{
if (!(this instanceof MyModule))
{
return new MyModule(config);
}
const self = this;
events.EventEmitter.call(self);
self.name = pkg.name;
self.version = pkg.version;
self._telemetry = new TelemetryEvents(
{
package: pkg,
emitter: self
}
);
self._logs = new LogTelemetryEvents(
{
telemetry: self._telemetry
}
);
self._log = self._logs.log;
self._metrics = new QuantifyTelemetryEvents(
{
telemetry: self._telemetry
}
);
self._tracing = new TraceTelemetryEvents(
{
telemetry: self._telemetry
}
);
};
util.inherits(MyModule, events.EventEmitter);
const telemetryEventsTests = require("../index.js");
telemetryEventsTests(
{
construct: () => new MyModule(),
package: pkg
}
);
Tests
No tests at this time.
Documentation
telemetryEventsTests(config)
config
: Objectconstruct
: Function Function that should return a correctly instantiated instance of module to be tested.package
: Object Parsedpackage.json
to extract modulename
andversion
from.
Executes tests ensuring that the instantiated module returned by calling construct
sets up expected telemetry functionality.
Releases
We follow semantic versioning policy (see: semver.org):
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes, MINOR version when you add functionality in a backwards-compatible manner, and PATCH version when you make backwards-compatible bug fixes.
caveat: Major version zero is a special case indicating development version that may make incompatible API changes without incrementing MAJOR version.
0.1.0
7 years ago