[RFC]: Migrate from tape to in-house @stdlib/test/harness

Ouverte
#10,365 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
20/100
Type d'issue
Refactorisation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
javascript, node.js

Piste de recherche

Commencez par lire le @stdlib/test/harness proposé avec les modèles existants de @stdlib/bench/harness, puis examinez les fichiers de test de lib, package.json, le Makefile de stdlib et tools/harness.js. Comparez l’exécution actuelle des tests basée sur tape et la sortie TAP avec le harness proposé ; la migration est terminée lorsque le périmètre de migration, les assertions prises en charge et la validation CI sont convenus et fonctionnent pour tous les tests concernés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Description

This RFC proposes

Proposal: Migrate stdlib Tests to In-House @stdlib/test/harness

This proposal delivers a tape-equivalent in-house test runner as @stdlib/test/harness, directly porting its minimal TAP API while matching @stdlib/bench/harness patterns. It eliminates the tape dep, supports only stdlib's used assertions (equal, strictEqual, ok, deepEqual, pass, fail, plan, end, test), and adds @stdlib/string/format interpolation—no parallelism, grouping, or extras like mocha/jest.

Before/After Test File

Before (tape):

'use strict';

var tape = require( 'tape' );
var foo = require( './../lib' );

tape( 'main export is a function', function test( t ) {
	t.ok( true, 'should be true' );
	t.strictEqual( typeof foo, 'function', 'main export is a function' );
	t.end();
});

tape( 'computes correctly', function test( t ) {
	t.plan( 2 );
	t.equal( foo( 3 ), 9, 'returns 9' );
	t.deepEqual( foo(  ),, 'deep equal' );[1][2][3]
	t.end();
After (@stdlib/test/harness):

After (@stdlib/test/harness):

```javascript
'use strict';

var test = require( '@stdlib/test/harness' );
var foo = require( './../lib' );

test( 'main export is a function', function test( t ) {
	t.ok( true, 'should be true' );
	t.strictEqual( typeof foo, 'function', 'main export is %s', 'function' );
	t.end();
});

test( 'computes correctly', function test( t ) {
	t.plan( 2 );
	t.equal( foo( 3 ), 9, 'returns %d', 9 );
	t.deepEqual( foo(  ),, 'deep equal' );[1][2][3]
	t.end();
});

Changes: Swap require('tape') → require('@stdlib/test/harness'). Assertions identical—no renames/refactors. Interpolation optional (%s/%d/%j via @stdlib/string/format).

Study of References

Reviewed tape source (tape-testing/tape): TAP stream via events, nested tests, async end(), assertion tracking. Compared to @stdlib/bench/harness: Similar b.bench()/test(), exports harness/stream factory, stdout TAP—no deps. Stdlib tests (e.g., Makefile/package.json scans): Use ~6 assertions max, plain TAP, no advanced tape features. Impl ports tape's core (test context, assert/incr count, TAP lines) to ~400 LOC Node streams.

Automation Strategy

  • Publish @stdlib/test/harness (bench mirror: libtests, Makefile).
  • Global replace: grep -rl "require('tape')" lib/ | xargs sed -i "s|require('tape')|require('@stdlib/test\/harness')|g" (handles escapes).
  • Glob run: Update stdlib Makefile: $(QUIET) $(NODE) $(TOOLS_DIR)/harness.js $(shell find lib -name 'test.*.js').
  • Validate: CI diff old/new TAP (tape | harness); fix interpolation mismatches via optional post-sed (regex scan t.equal/ok args).
  • Coverage: Stick with istanbul (nyc/c8 drops Node 10-12 compat).
Related Issues

[Idea]: develop a project test runner

Questions

No.

Other

No.

Checklist
  • I have read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.
  • The issue name begins with RFC:.
Langage dominant
JavaScript
Étoiles
6k
Forks
1.3k
Merge moyen
1 j 21 h
PR mergées (30 j)
224

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de stdlib-js/stdlib

Toutes les issues de stdlib-js/stdlib

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.