https://github.com/anko/tap-to-tapson

convert a TAP stream to a tapson stream
https://github.com/anko/tap-to-tapson

Last synced: 4 months ago
JSON representation

convert a TAP stream to a tapson stream

• Host: GitHub
• URL: https://github.com/anko/tap-to-tapson
• Owner: anko
• Created: 2015-08-13T22:14:09.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-08-13T22:52:21.000Z (almost 11 years ago)
• Last Synced: 2025-06-12T23:02:37.879Z (12 months ago)
• Language: LiveScript
• Size: 121 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.markdown

Awesome Lists containing this project

README

          
# tap-to-tapson [![](https://img.shields.io/npm/v/tap-to-tapson.svg?style=flat-square)][1] [![](https://img.shields.io/travis/anko/tap-to-tapson.svg?style=flat-square)][2]

Reads [TAP 13][3], produces [tapson][4] (v1.0.x) as equivalent as possible.

     | tap-to-tapson | 

Also works as a node module, with streams:

    var tapToTapson = require("tap-to-tapson")();

    process.stdin.pipe(tapToTapson).pipe(process.stdout);

## Mapping examples

Comments are interpreted as a "heading" for the `expected` properties of the

following tests, until the next comment appears.

    TAP version 13

    ok 1 before any headings

    # Serious business

    ok 2 should throw

    ok 3

    ok 4

    # Even more serious

    ok 5

    ok 6 what

    1..6

    {"ok":true,"expected":"before any headings"}

    {"ok":true,"expected":"Serious business: should throw"}

    {"ok":true,"expected":"Serious business"}

    {"ok":true,"expected":"Serious business"}

    {"ok":true,"expected":"Even more serious"}

    {"ok":true,"expected":"Even more serious: what"}

Tests marked "TODO" or "SKIP" fail with `actual`-property set to reason given.

    TAP version 13

    not ok 1 answer to life the universe and everything # TODO not written yet

    not ok 2 database smoketest # SKIP database not configured

    1..2

    {"ok":false,"expected":"answer to life the universe and everything","actual":"TODO: not written yet"}

    {"ok":false,"expected":"database smoketest","actual":"SKIP: database not configured"}

Any assert's YAML block goes in the `actual` property. ("TODO" and

"SKIP"-directives are ignored here.)

    TAP Version 13

    not ok 1 Resolve address

      ---

      message: "Failed with error 'hostname peebles.example.com not found'"

      severity: fail

      data:

        got:

          hostname: 'peebles.example.com'

          address: ~

        expected:

          hostname: 'peebles.example.com'

          address: '85.193.201.85'

      ...

    1..1

    {"ok":false,"expected":"Resolve address","actual":"message: \"Failed with error 'hostname peebles.example.com not found'\"\nseverity: fail\ndata:\n  got:\n    hostname: peebles.example.com\n    address: null\n  expected:\n    hostname: peebles.example.com\n    address: 85.193.201.85\n"}

A TAP plan given ahead of time becomes a set of tapson planned tests.  (The

output is representative.  The `id`s are random but match the test results.)

    TAP version 13

    1..3

    ok 1

    ok 2

    ok 3

    {"id":"2654782ca1d79720181551c031c7ed3f3e157634"}

    {"id":"314cf30f5c39abb4798bbbf30327be092bd765bc"}

    {"id":"a010bf964ecb2709bd1c996630c65b28dff1e99d"}

    {"id":"2654782ca1d79720181551c031c7ed3f3e157634","ok":true}

    {"id":"314cf30f5c39abb4798bbbf30327be092bd765bc","ok":true}

    {"id":"a010bf964ecb2709bd1c996630c65b28dff1e99d","ok":true}

[1]: https://www.npmjs.com/package/tap-to-tapson

[2]: https://travis-ci.org/anko/tap-to-tapson

[3]: https://testanything.org/tap-version-13-specification.html

[4]: https://github.com/anko/tapson