test.status.js

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib 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.
*/

'use strict';

// cspell:words ndone

// MODULES //

var tape = require( 'tape' );
var factory = require( './../lib/factory.js' );


// TESTS //

tape( 'main export is a function', function test( t ) {
	t.ok( true, __filename );
	t.ok( typeof factory === 'function', 'main export is a function' );
	t.end();
});

tape( 'the function returns a status object that tracks progress (short-circuit)', function test( t ) {
	var anyByAsync;
	var files;
	var op;

	anyByAsync = factory( predicate );
	files = [ './file1.js', './file2.js' ];
	op = anyByAsync( files, done );

	// Verify the status object immediately after invocation:
	t.equal( typeof op, 'object', 'returns an object' );
	t.equal( op.status, 'pending', 'initial status is pending' );
	t.equal( op.ndone, 0, 'initial ndone is 0' );

	function predicate( value, next ) {
		setTimeout( onTimeout, 0 );

		function onTimeout() {
			next( null, true );
		}
	}

	function done( err, result ) {
		if ( err ) {
			t.fail( err.message );
			return t.end();
		}
		t.equal( result, true, 'returns expected result' );
		t.equal( op.status, 'ok', 'status is ok upon completion' );

		// Short-circuit: only one file was processed:
		t.equal( op.ndone, 1, 'short-circuited after first match' );
		t.end();
	}
});

tape( 'the function returns a status object that tracks a full scan', function test( t ) {
	var files;
	var op;

	files = [ './file1.js', './file2.js' ];
	op = factory( predicate )( files, done );

	function predicate( value, next ) {
		setTimeout( onTimeout, 50 );

		function onTimeout() {
			// Always false, so all files must be checked:
			next( null, false );
		}
	}

	function done( err, result ) {
		if ( err ) {
			t.fail( err.message );
			return t.end();
		}
		t.equal( result, false, 'returns expected result' );
		t.equal( op.ndone, 2, 'all operations completed for a full scan' );
		t.end();
	}
});