Deno•3y ago

deno tap metadata

Hello. I am running deno tests with

deno test --reporter=tap

deno test --reporter=tap

. I would like to add additional fields (medatata) to test output as YAML Diagnostic document. This would require some Deno test API for adding metadata:

Deno.test({ name: "some test", metadata: { foo: "bar" }, fn: () => {});

Deno.test({ name: "some test", metadata: { foo: "bar" }, fn: () => {});

Deno.test({ name: "some test", fn: (t) => { t.set("foo", "bar"); });

Deno.test({ name: "some test", fn: (t) => { t.set("foo", "bar"); });

this would produce

TAP version 14
# ./foo.test.ts
ok 1 - some test
  ---
  foo: bar
  ...

TAP version 14
# ./foo.test.ts
ok 1 - some test
  ---
  foo: bar
  ...

Is something like this planned? And can I now work it around somehow?

Deno AI Helper•10/26/23, 5:05 PM

Based on the documentation, there is currently no explicit mention of a feature that allows adding metadata to test output in the TAP reporter format. The function does not seem to support a field in its options, and there is no method available in the test context.

However, you can always propose this feature to the Deno community on the official Deno GitHub repository. The Deno project is open-source and contributions are always welcome.

As for a workaround, you might consider including any necessary metadata in the test name or in console log statements within the test, although this would not have the same structured format as the YAML Diagnostic document you're aiming for. Please note that this workaround is not explicitly mentioned in the documentation and might not be ideal for your use case.

Helpful Links:
Testing API | Manual | Deno
Deno 1.15 Release Notes
Deno 1.17 Release Notes
Deno 1.18 Release Notes

MartinOP•10/26/23, 8:34 PM

Console.log makes no output if reporter is tap.