ngraph.graph/test/iteration.js

graph data structure

var test = require('tap').test,
  createGraph = require('..');

test('forEachLinkedNode respects orientation', function(t) {
  t.plan(3);

  var graph = createGraph();
  graph.addLink(1, 2);
  graph.addLink(2, 3);
  var oriented = true;
  graph.forEachLinkedNode(2, function(node, link) {
    t.ok(link.toId === 3, 'Only 3 is connected to node 2, when traversal is oriented');
  }, oriented);

  graph.forEachLinkedNode(2, function(node, link) {
    t.ok(link.toId === 3 || link.toId === 2, 'both incoming and outgoing links are visited');
  }, !oriented);

  t.end();
});

test('forEachLinkedNode handles self-loops', function(t) {
  t.plan(1);

  var graph = createGraph();
  graph.addLink(1, 1);
  // we should visit exactly one time
  graph.forEachLinkedNode(1, function(node, link) {
    t.ok(link.fromId === 1 && link.toId === 1, 'Link 1 is visited once');
  });

  t.end();
});

test('forEachLinkedNode will not crash on invalid node id', function(t) {
  t.plan(0);
  var graph = createGraph();
  graph.addLink(1, 2);
  graph.forEachLinkedNode(3, function() {
    t.notOk(true, 'This code will never be executed');
  });
});

test('forEachLinkedNode can quit fast for oriented graphs', function(t) {
  var graph = createGraph();
  var oriented = true;
  graph.addLink(1, 2);
  graph.addLink(1, 3);

  var visited = 0;
  graph.forEachLinkedNode(1, function() {
    t.ok(true, 'Visited first link');
    visited += 1;
    return true; // We want to stop right now!
  }, oriented);
  t.equal(visited, 1, 'One link is visited');
  t.end();
});

test('forEachLinkedNode can quit fast for non-oriented graphs', function(t) {
  var graph = createGraph();
  var oriented = false;
  graph.addLink(1, 2);
  graph.addLink(1, 3);

  var visited = 0;
  graph.forEachLinkedNode(1, function() {
    t.ok(true, 'Visited first link');
    visited += 1;
    return true; // We want to stop right now!
  }, oriented);

  t.equal(visited, 1, 'One link is visited');
  t.end();
});

test('forEachLinkedNode returns quitFast flag', function(t) {
  var graph = createGraph();
  graph.addLink(1, 2);
  graph.addLink(1, 3);

  var fastQuit = graph.forEachLinkedNode(1, function() {
    return true; // Stop right now.
  });

  t.ok(fastQuit, 'Fast quit triggered when callback opted out');

  var notSoFast = graph.forEachLinkedNode(1, function() { });
  t.notOk(notSoFast, 'Fast quit is not triggered when all elements visited');
  t.end();
});

test('forEachLink visits each link', function(t) {
  t.plan(1);
  var graph = createGraph();
  graph.addLink(1, 2);
  graph.forEachLink(function(link) {
    t.ok(link.fromId === 1 && link.toId === 2, 'Link is here');
  });
  t.end();
});

test('forEachLink will not crash on empty callback', function(t) {
  var graph = createGraph();
  graph.addLink(1, 2);
  graph.forEachLink(); // didn't pass callback, no worries.
  t.end();
});

test('forEachNode will stop when requested', function(t) {
  t.plan(1);
  var graph = createGraph();
  graph.addLink(1, 2);
  graph.forEachNode(function(node) {
    t.equal(node.id, 1, 'We visit only one node');
    return true; // we want to stop now!
  });

  t.end();
});

test('forEachNode returns fastQuit', function(t) {
  var graph = createGraph();
  graph.addLink(1, 2);
  var fastQuit = graph.forEachNode(function(node) {
    t.equal(node.id, 1, 'We visit only one node');
    return true; // we want to stop now!
  }); // no callback? No worries

  t.ok(fastQuit, 'fastQuit is set when callback opted out');

  var notSoFast = graph.forEachNode(function() { });
  t.notOk(notSoFast, 'fastQuit is not set when all nodes visited');
  t.end();
});

test('forEachNode throws when callback is not a function', function(t) {
  var graph = createGraph();
  graph.addLink(1, 2);
  t.throws(function() {
    graph.forEachNode('not a function');
  });
  t.end();
});

test('forEachLink stops when requested', function(t) {
  var graph = createGraph();
  graph.addLink(1, 2);
  graph.addLink(2, 3);

  var visitCount = 0;
  graph.forEachLink(function() {
    visitCount += 1;
    return true;
  });
  t.equal(visitCount, 1, 'only one link visited');
  t.end();
});