diff --git a/metapackages/auto-instrumentations-node/package.json b/metapackages/auto-instrumentations-node/package.json index 443e3badc9..9396a61c16 100644 --- a/metapackages/auto-instrumentations-node/package.json +++ b/metapackages/auto-instrumentations-node/package.json @@ -53,6 +53,7 @@ "@opentelemetry/instrumentation-bunyan": "^0.30.0", "@opentelemetry/instrumentation-cassandra-driver": "^0.30.0", "@opentelemetry/instrumentation-connect": "^0.30.0", + "@opentelemetry/instrumentation-cucumber": "^0.32.0", "@opentelemetry/instrumentation-dataloader": "^0.2.0", "@opentelemetry/instrumentation-dns": "^0.30.0", "@opentelemetry/instrumentation-express": "^0.31.2", diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts index 2daba2146d..26a0476aa0 100644 --- a/metapackages/auto-instrumentations-node/src/utils.ts +++ b/metapackages/auto-instrumentations-node/src/utils.ts @@ -23,6 +23,7 @@ import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk'; import { BunyanInstrumentation } from '@opentelemetry/instrumentation-bunyan'; import { CassandraDriverInstrumentation } from '@opentelemetry/instrumentation-cassandra-driver'; import { ConnectInstrumentation } from '@opentelemetry/instrumentation-connect'; +import { CucumberInstrumentation } from '@opentelemetry/instrumentation-cucumber'; import { DataloaderInstrumentation } from '@opentelemetry/instrumentation-dataloader'; import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns'; import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express'; @@ -61,6 +62,7 @@ const InstrumentationMap = { '@opentelemetry/instrumentation-cassandra-driver': CassandraDriverInstrumentation, '@opentelemetry/instrumentation-connect': ConnectInstrumentation, + '@opentelemetry/instrumentation-cucumber': CucumberInstrumentation, '@opentelemetry/instrumentation-dataloader': DataloaderInstrumentation, '@opentelemetry/instrumentation-dns': DnsInstrumentation, '@opentelemetry/instrumentation-express': ExpressInstrumentation, diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/.eslintignore b/plugins/node/opentelemetry-instrumentation-cucumber/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-cucumber/.eslintrc.js new file mode 100644 index 0000000000..f756f4488b --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') +} diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/.npmignore b/plugins/node/opentelemetry-instrumentation-cucumber/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/LICENSE b/plugins/node/opentelemetry-instrumentation-cucumber/LICENSE new file mode 100644 index 0000000000..e50e8c80f9 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2022] OpenTelemetry Authors + + 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. diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/README.md b/plugins/node/opentelemetry-instrumentation-cucumber/README.md new file mode 100644 index 0000000000..1993e4e3d4 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/README.md @@ -0,0 +1,61 @@ +# OpenTelemetry Cucumber Instrumentation for Node.js + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image] + +This module provides automatic instrumentation for the [`@cucumber/cucumber`](https://www.npmjs.com/package/@cucumber/cucumber) module, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle. + +If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience. + +Compatible with OpenTelemetry JS API and SDK `1.0+`. + +## Installation + +```bash +npm install --save @opentelemetry/instrumentation-cucumber +``` + +## Usage + +```js +const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node'); +const { + CucumberInstrumentation, +} = require('@opentelemetry/instrumentation-cucumber'); +const { registerInstrumentations } = require('@opentelemetry/instrumentation'); + +const provider = new NodeTracerProvider(); +provider.register(); + +registerInstrumentations({ + instrumentations: [ + new CucucmberInstrumentation({ + // see under for available configuration + }), + ], +}); +``` + +### Cucumber Instrumentation Options + +Cucumber instrumentation has currently one option. You can set the following: + +| Options | Type | Description | +| ------- | -------- | --------------- | +| - | `Type[]` | what it will do | + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-cucumber +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-cucumber.svg diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/package.json b/plugins/node/opentelemetry-instrumentation-cucumber/package.json new file mode 100644 index 0000000000..72f0883092 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/package.json @@ -0,0 +1,58 @@ +{ + "name": "@opentelemetry/instrumentation-cucumber", + "version": "0.32.0", + "description": "OpenTelemetry cucumber automatic instrumentation package.", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "keywords": [ + "cucumber", + "instrumentation", + "nodejs", + "opentelemetry", + "profiling", + "tracing" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=14" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.js.map", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.0.0" + }, + "devDependencies": { + "@cucumber/cucumber": "^8.0.0", + "@opentelemetry/api": "^1.0.0", + "@opentelemetry/core": "^1.3.1", + "@opentelemetry/sdk-trace-base": "^1.3.1", + "@opentelemetry/sdk-trace-node": "^1.3.1", + "@types/mocha": "7.0.2", + "@types/node": "16.11.21", + "@types/semver": "7.3.8", + "@types/shimmer": "1.0.2", + "@types/sinon": "10.0.2", + "gts": "3.1.0", + "mocha": "7.2.0", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "sinon": "14.0.0", + "ts-mocha": "10.0.0", + "typescript": "4.3.5" + }, + "dependencies": { + "@opentelemetry/instrumentation": "^0.32.0" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-cucumber#readme" +} diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/src/index.ts b/plugins/node/opentelemetry-instrumentation-cucumber/src/index.ts new file mode 100644 index 0000000000..24c76056a1 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/src/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright The OpenTelemetry Authors + * + * 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 + * + * https://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. + */ + +export * from './instrumentation'; diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-cucumber/src/instrumentation.ts new file mode 100644 index 0000000000..9e9062fcf9 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/src/instrumentation.ts @@ -0,0 +1,236 @@ +import { diag, SpanKind, SpanStatusCode } from '@opentelemetry/api'; +import { + InstrumentationBase, + InstrumentationNodeModuleDefinition, + InstrumentationNodeModuleFile, + isWrapped, +} from '@opentelemetry/instrumentation'; + +import type * as cucumber from '@cucumber/cucumber'; +import type * as messages from '@cucumber/messages'; +import type TestCaseRunner from '@cucumber/cucumber/lib/runtime/test_case_runner'; +import type { + DefineStepPattern, + IDefineStepOptions, + IDefineTestRunHookOptions, +} from '@cucumber/cucumber/lib/support_code_library_builder/types'; +import * as _ from 'lodash'; + +import { VERSION } from './version'; + +const hooks = ['Before', 'BeforeStep', 'AfterStep', 'After'] as const; +const steps = ['Given', 'When', 'Then'] as const; +type Cucumber = typeof cucumber; +type Hook = typeof hooks[number]; +type Step = typeof steps[number]; + +// TODO: test retries + +export class CucumberInstrumentation extends InstrumentationBase { + constructor() { + super('@opentelemetry/instrumentation-cucumber', VERSION); + } + + init() { + return [ + new InstrumentationNodeModuleDefinition( + '@cucumber/cucumber', + ['*'], + (moduleExports, moduleVersion) => { + diag.debug(`Applying patch for @cucumber/cucumber@${moduleVersion}`); + steps.forEach(step => { + if (isWrapped(moduleExports[step])) { + this._unwrap(moduleExports, step); + } + this._wrap(moduleExports, step, this._getStepPatch(step)); + }); + hooks.forEach(hook => { + if (isWrapped(moduleExports[hook])) { + this._unwrap(moduleExports, hook); + } + this._wrap(moduleExports, hook, this._getHookPatch(hook)); + }); + return moduleExports; + }, + (moduleExports, moduleVersion) => { + if (moduleExports === undefined) return; + diag.debug(`Removing patch for @cucumber/cucumber@${moduleVersion}`); + [...hooks, ...steps].forEach(method => { + this._unwrap(moduleExports, method); + }); + }, + [ + new InstrumentationNodeModuleFile<{ + default: { new (): TestCaseRunner; prototype: TestCaseRunner }; + }>( + '@cucumber/cucumber/lib/runtime/test_case_runner.js', + ['*'], + (moduleExports, moduleVersion) => { + diag.debug( + `Applying patch for @cucumber/cucumber/lib/runtime/test_case_runner.js@${moduleVersion}` + ); + if (isWrapped(moduleExports.default.prototype.run)) { + this._unwrap(moduleExports.default.prototype, 'run'); + } + this._wrap( + moduleExports.default.prototype, + 'run', + this._getTestCaseRunPatch() + ); + return moduleExports; + }, + (moduleExports, moduleVersion) => { + if (moduleExports === undefined) return; + diag.debug( + `Removing patch for @cucumber/cucumber/lib/runtime/test_case_runner.js@${moduleVersion}` + ); + this._unwrap(moduleExports.default.prototype, 'run'); + } + ), + ] + ), + ]; + } + + private _getTestCaseRunPatch() { + const instrumentation = this; + return function (original: TestCaseRunner['run']): TestCaseRunner['run'] { + return async function (this: TestCaseRunner, ...args) { + const gherkinDocument = this[ + 'gherkinDocument' + ] as Required; + const { feature } = gherkinDocument; + const pickle = this['pickle'] as messages.Pickle; + const scenario = feature.children.find( + node => node?.scenario?.id === pickle.astNodeIds[0] + )?.scenario; + // https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/span-general/#source-code-attributes + return instrumentation.tracer.startActiveSpan( + `Feature: ${feature.name}\nScenario: ${pickle.name}`, + { + kind: SpanKind.CLIENT, + }, + async span => { + try { + span.setAttributes({ + 'cucumber.gherkinDocument.feature': JSON.stringify( + _.omit(gherkinDocument.feature, ['children']) + ), + 'cucumber.gherkinDocument.uri': gherkinDocument.uri, + 'cucumber.scenario': JSON.stringify( + _.omit(scenario, ['steps', 'examples']) + ), + }); + return await original.apply(this, args); + } catch (error: any) { + span.setStatus({ + code: SpanStatusCode.ERROR, + message: error.message, + }); + throw error; + } finally { + span.end(); + } + } + ); + }; + }; + } + + private _getHookPatch(name: H) { + const instrumentation = this; + return function (original: Cucumber[H]): Cucumber[H] { + return function ( + this: {}, + tagsOrOptions: string | IDefineTestRunHookOptions | Function, + code?: Function + ) { + if (typeof tagsOrOptions === 'function') { + code = tagsOrOptions; + tagsOrOptions = {}; + } + + function traceableCode( + this: cucumber.IWorld, + arg: cucumber.ITestCaseHookParameter + ) { + return instrumentation.tracer.startActiveSpan( + `${name}`, + { + kind: SpanKind.CLIENT, + }, + async span => { + try { + await code?.call(this, arg); + } catch (error: any) { + this.attach?.(JSON.stringify(span.spanContext())); + span.setStatus({ + code: SpanStatusCode.ERROR, + message: error.message, + }); + throw error; + } finally { + span.end(); + } + } + ); + } + return original.call(this, tagsOrOptions as any, traceableCode as any); + }; + }; + } + + private _getStepPatch(name: S) { + const instrumentation = this; + return function (original: Cucumber[S]): Cucumber[S] { + return function ( + this: {}, + pattern: DefineStepPattern, + options: IDefineStepOptions | Function, + code?: Function + ): void { + if (typeof options === 'function') { + code = options; + options = {}; + } + + function traceableCode(this: cucumber.IWorld, ...args: any[]) { + return instrumentation.tracer.startActiveSpan( + `${name} ${pattern}`, + { + kind: SpanKind.CLIENT, + }, + async span => { + try { + args.slice(0, -1).forEach((arg, index) => { + span.setAttribute( + `cucumber.step.args[${index}]`, + arg?.raw instanceof Function + ? JSON.stringify(arg.raw()) + : arg + ); + }); + await code?.apply(this, args); + } catch (error: any) { + this.attach?.(JSON.stringify(span.spanContext())); + span.setStatus({ + code: SpanStatusCode.ERROR, + message: error.message, + }); + throw error; + } finally { + span.end(); + } + } + ); + } + // cucumber asks for the number of arguments to match the specified pattern + // copy the value from the original function + Object.defineProperty(traceableCode, 'length', { + value: code?.length, + }); + return original.call(this, pattern, options, traceableCode as any); + }; + }; + } +} diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/src/types.ts b/plugins/node/opentelemetry-instrumentation-cucumber/src/types.ts new file mode 100644 index 0000000000..e69de29bb2 diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/test/cucumber.test.ts b/plugins/node/opentelemetry-instrumentation-cucumber/test/cucumber.test.ts new file mode 100644 index 0000000000..8d039d143f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/test/cucumber.test.ts @@ -0,0 +1,87 @@ +/* + * Copyright The OpenTelemetry Authors + * + * 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 + * + * https://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. + */ + +import { context } from '@opentelemetry/api'; +import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node'; +import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks'; +import { + InMemorySpanExporter, + SimpleSpanProcessor, +} from '@opentelemetry/sdk-trace-base'; +import { CucumberInstrumentation } from '../src'; +import * as path from 'path'; +import * as assert from 'assert'; + +const instrumentation = new CucumberInstrumentation(); +instrumentation.enable(); +instrumentation.disable(); + +import { + loadConfiguration, + loadSupport, + runCucumber, +} from '@cucumber/cucumber/api'; + +describe('CucumberInstrumentation', () => { + const provider = new NodeTracerProvider(); + const memoryExporter = new InMemorySpanExporter(); + const spanProcessor = new SimpleSpanProcessor(memoryExporter); + provider.addSpanProcessor(spanProcessor); + const tracer = provider.getTracer('default'); + const contextManager = new AsyncHooksContextManager().enable(); + + before(() => { + instrumentation.setTracerProvider(provider); + context.setGlobalContextManager(contextManager); + instrumentation.enable(); + }); + + afterEach(() => { + console.log(tracer); + contextManager.disable(); + contextManager.enable(); + memoryExporter.reset(); + }); + + it('should do something', async () => { + const { runConfiguration } = await loadConfiguration({ + provided: { + paths: [path.join(__dirname, 'features/basic.feature')], + require: [ + path.join(__dirname, 'features/support/world.ts'), + path.join(__dirname, 'features/step_definitions/steps.ts'), + ], + }, + }); + const support = await loadSupport(runConfiguration); + const merged = { ...runConfiguration, support }; + + await runCucumber(merged); + + const spans = memoryExporter.getFinishedSpans(); + // should have Feature span + const parent = spans.find(span => span.name.startsWith('Feature')); + assert(parent); + + // all other spans should have Feature span as a parent + assert.equal( + spans.filter(span => span.parentSpanId === parent.spanContext().spanId) + .length, + spans.length - 1 + ); + console.log(spans.map(span => span.name)); + }); +}); diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/test/features/basic.feature b/plugins/node/opentelemetry-instrumentation-cucumber/test/features/basic.feature new file mode 100644 index 0000000000..ce1222fa13 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/test/features/basic.feature @@ -0,0 +1,5 @@ +Feature: Basic + + Scenario: Button pushing + When I push the button + Then it is pushed to "limit" diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/test/features/step_definitions/steps.ts b/plugins/node/opentelemetry-instrumentation-cucumber/test/features/step_definitions/steps.ts new file mode 100644 index 0000000000..4b050d926c --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/test/features/step_definitions/steps.ts @@ -0,0 +1,10 @@ +import { When, Then } from '@cucumber/cucumber'; + +When('I push the button', async () => { + await new Promise(resolve => setTimeout(resolve, 10)); + console.log('hello'); +}); + +Then('it is pushed to {string}', to => { + console.log('pushed', to); +}); diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/test/features/support/world.ts b/plugins/node/opentelemetry-instrumentation-cucumber/test/features/support/world.ts new file mode 100644 index 0000000000..1a460a1362 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/test/features/support/world.ts @@ -0,0 +1,17 @@ +import { BeforeStep, AfterStep, After, Before } from '@cucumber/cucumber'; + +Before(() => { + console.log('before'); +}); + +BeforeStep(() => { + console.log('before step'); +}); + +AfterStep(() => { + console.log('after step'); +}); + +After(() => { + console.log('after'); +}); diff --git a/plugins/node/opentelemetry-instrumentation-cucumber/tsconfig.json b/plugins/node/opentelemetry-instrumentation-cucumber/tsconfig.json new file mode 100644 index 0000000000..568e7bb7cb --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-cucumber/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build", + "skipLibCheck": true + }, + "include": ["src/**/*.ts", "test/**/*.ts"] +}