Tape: how to replace t.test and t.skip

[Haroenv]

Our codebase has quite a few of those, but now that's the only warning left, except sinon ( #68 )

An example test with those looks like:

'use strict';

var algoliasearchHelper = require('../../../index');

var _ = require('lodash');

var fakeClient = {
  addAlgoliaAgent: function() {}
};

test('helper.hasRefinements(attribute)', function() {
  var helper;

  // cannot be tested since there's no way to know that a numeric refinement
  // was once added then removed thus we always return false when not found
  t.skip('undefined attribute', function(tt) {
    setup();
    tt.throws(_.partial(helper.hasRefinements, 'unknown'), Error, 'it throws when unknown attribute');
    tt.end();
  });

  t.test('numericRefinement', function(tt) {
    tt.test('with refinement', function(ttt) {
      setup();
      helper.addNumericRefinement('price', '=', 1337);
      ttt.equal(helper.hasRefinements('price'), true);
      ttt.end();
    });

    tt.test('without refinement', function(ttt) {
      setup();
      helper.addNumericRefinement('price', '=', 1337);
      helper.clearRefinements('price');
      ttt.equal(helper.hasRefinements('price'), false);
      ttt.end();
    });
  });

  t.test('facet', function(tt) {
    tt.test('with refinement', function(ttt) {
      setup({
        facets: ['color']
      });
      helper.toggleFacetRefinement('color', 'red');
      ttt.equal(helper.hasRefinements('color'), true);
      ttt.end();
    });

    tt.test('without refinement', function(ttt) {
      setup({
        facets: ['color']
      });
      ttt.equal(helper.hasRefinements('color'), false);
      ttt.end();
    });
  });

  t.test('disjunctiveFacet', function(tt) {
    tt.test('with refinement', function(ttt) {
      setup({
        disjunctiveFacets: ['author']
      });
      helper.toggleFacetRefinement('author', 'John Spartan');
      ttt.equal(helper.hasRefinements('author'), true);
      ttt.end();
    });

    tt.test('without refinement', function(ttt) {
      setup({
        disjunctiveFacets: ['author']
      });
      ttt.equal(helper.hasRefinements('author'), false);
      ttt.end();
    });
  });

  t.test('hierarchicalFacet', function(tt) {
    tt.test('with refinement', function(ttt) {
      setup({
        hierarchicalFacets: [{
          name: 'category',
          attributes: ['category.lvl0', 'category.lvl1']
        }]
      });
      helper.toggleFacetRefinement('category', 'Action Movies > Max');
      ttt.equal(helper.hasRefinements('category'), true);
      ttt.end();
    });

    tt.test('without refinement', function(ttt) {
      setup({
        hierarchicalFacets: [{
          name: 'category',
          attributes: ['category.lvl0', 'category.lvl1']
        }]
      });
      ttt.equal(helper.hasRefinements('category'), false);
      ttt.end();
    });
  });

  function setup(params) {
    helper = algoliasearchHelper(fakeClient, 'index', params);
  }
});

[Haroenv]

t.test can be replaced by describe the outer test, and test the inner one, but I'm not sure how many levels deep that can go. Seems to be infinite with tape.

t.skip can be replaced by describe.skip

[skovhus]

So the test here is a bit funky. It doesn't really follow Tape documentation.

IMO

test('helper.hasRefinements(attribute)', function() {
  t.skip('undefined attribute', function(tt) {

should be

test('helper.hasRefinements(attribute)', function(t) {
  t.skip('undefined attribute', function() {

So if you get rid of all the ttt and tt and just use the t coming from test(... then the conversion should be fine.

[Haroenv]

Oh that would help too! I’ll do that change then, didn’t happen in many cases AFAICT

[skovhus]

Did it work? : )

[Haroenv]

We aren't moving to Jest right now yet, so I didn't spend to much effort on those tests. Will reopen if we need more help after moving to a more standard way of writing those tests