exit-rttc.test.js

/**
 * Module dependencies
 */

var util = require('util');
var _ = require('@sailshq/lodash');
var assert = require('assert');
var Machine = require('../');

var runSuite = require('../node_modules/rttc/spec/helpers/run-suite');
var TEST_SUITE = require('../node_modules/rttc/spec/coercion.spec.js');
var toRunTest = require('./util/test-exit-coercion.helper');
var expandSuite = require('../node_modules/rttc/spec/helpers/expand-suite');




describe('output coercion  (for exits)', function (){


  describe('using exhaustive fixtures from RTTC', function (){

    // Take the array of tests and extend them with some derivative
    // tests automatically.  Then run them.
    runSuite(expandSuite(TEST_SUITE), toRunTest );

  });//</using exhaustive fixtures from RTTC>



  describe('additional test cases specific to the machine runner', function() {

    it('should pass through expected data', function(done) {

      Machine.build({
        inputs: {
          foo: {
            example: 'foo bar'
          }
        },
        exits: {
          success: {
            example: 'hello'
          },
          error: {
            example: 'world'
          }
        },
        fn: function (inputs, exits, deps) {
          exits(null, 'foo');
        }
      })
      .configure({
        foo: 'hello'
      })
      .exec(function(err, result) {
        if(err) { return done(err); }
        assert(result === 'foo');
        done();
      });
    });

    it('should coerce invalid exit data into the correct types', function(done) {

      Machine.build({
        inputs: {
          foo: {
            example: 'foo bar'
          }
        },
        exits: {
          success: {
            example: 4
          },
          error: {
            example: 'world'
          }
        },
        fn: function (inputs, exits, deps) {
          exits(null, '100');
        }
      })
      .configure({
        foo: 'hello'
      })
      .exec(function(err, result) {
        if(err) { return done(err); }
        assert.strictEqual(result,100);
        done();
      });
    });

    it('should provide base types for values not present in the exit data', function(done) {

      Machine.build({
        inputs: {
          foo: {
            example: 'foo bar'
          }
        },
        exits: {
          success: {
            example: 4
          },
          error: {
            example: 'world'
          }
        },
        fn: function (inputs, exits, deps) {
          exits(null);
        }
      })
      .configure({
        foo: 'hello'
      })
      .exec(function(err, result) {
        if(err) { return done(err); }
        assert.strictEqual(result,0);
        done();
      });
    });


    it('should coerce string to number', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: 4
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success('whatever');
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.strictEqual(result,0);
        done();
      });
    });


    it('should coerce boolean to number', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: 4
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(true);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.strictEqual(result,1);
        done();
      });
    });


    it('should coerce undefined to example ({})', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: {}
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success();
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,{});
        done();
      });
    });


    it('should coerce 0 to example ({})', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: {}
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,{});
        done();
      });
    });

    it('should coerce 0 to example ({foo: ""})', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: {foo: 'bar'}
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,{foo:''});
        done();
      });
    });

    it('should coerce 0 to example ({foo: [""], bar: {}})', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: {foo: ['stuff'], bar: {}}
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,{foo:[], bar: {}});
        done();
      });
    });

    it('should coerce 0 to example ({foo: [""], bar: {baz: 0}})', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: {foo: ['stuff'], bar: {baz: 12412}}
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,{foo:[], bar: {baz: 0}});
        done();
      });
    });

    it('should coerce 0 to example ({foo: [""], someArray: []})', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: {foo: ['stuff'], someArray: []}
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,{foo:[], someArray: []});
        done();
      });
    });

    it('should coerce 0 to example ({foo: [""], someArray: []}) with someArray in example => ["*"]', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: {foo: ['stuff'], someArray: ['*']}
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,{foo:[], someArray: []});
        done();
      });
    });

    it('should coerce `{foo: ["hi"], someArray: [1234]}` to `{foo: ["hi"], someArray: [1234]}` with someArray in example => ["*"]', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: {foo: ['stuff'], someArray: ['*']}
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success({foo: ['hi'], someArray: [1234]});
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,{foo:['hi'], someArray: [1234]});
        done();
      });
    });

    it('should coerce undefined to example ([])', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: []
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success();
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,[]);
        done();
      });
    });

    it('should coerce null to example ([])', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: []
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(null);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,[]);
        done();
      });
    });

    it('should coerce 0 to example ([])', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: []
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,[]);
        done();
      });
    });

    it('should coerce 0 to example ([0])', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: [123]
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,[]);
        done();
      });
    });

    it('should coerce 0 to example ([""])', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: ['stuff']
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,[]);
        done();
      });
    });

    it('should coerce 0 to example ([false])', function(done) {

      Machine.build({
        inputs: {},
        exits: {
          success: {
            example: [true]
          }
        },
        fn: function (inputs, exits, deps) {
          exits.success(0);
        }
      }).exec(function(err, result) {
        if(err) { return done(err); }
        assert.deepEqual(result,[]);
        done();
      });
    });



    ///////////////////////////////////////////////////////////////////////////////////////////////
    // Some edge cases:
    ///////////////////////////////////////////////////////////////////////////////////////////////

    var edgeCaseMachineDef = {
      inputs: {
        criteria: {
          friendlyName: 'criteria',
          typeclass: 'dictionary',
          description: 'Waterline search criteria to use in retrieving Job instances'
        }
      },
      exits: {
        success: {
          friendlyName: 'then',
          example: {
            title: 'scott',
            description: 'scott',
            votes: 123,
            id: 123
          }
        },
        error: {
          example: undefined
        },
        notFound: {
          void: true
        }
      },
      fn: function(inputs, exits, env) {

        function Thing(){}
        var thing = new Thing();
        thing.id=1;
        thing.votes=null;
        thing.description='stuff';
        thing.title='thing';

        // return exits(null, thing);
        return exits.success(thing);
      },
      identity: 'findOne_job'
    };

    // Same as edgeCaseMachine but w/ a slightly different fn that uses switchback-style usage:
    var edgeCaseMachineDef2 = _.cloneDeep(edgeCaseMachineDef);
    edgeCaseMachineDef2.fn = function(inputs, exits, env) {
      function Thing(){}
      var thing = new Thing();
      thing.id=1;
      thing.votes=null;
      thing.description='stuff';
      thing.title='thing';
      return exits(null, thing);
    };


    it('should coerce output properly (null=>0 in this case) when using normal `exits.success(result)` from within the machine `fn`', function (done){
      Machine.build(edgeCaseMachineDef).configure({criteria: {id: 1}}).exec({
        error: function (err){
          return done(err);
        },
        success: function (result){
          assert.equal(result.votes, 0, 'Expected `votes` property of result to equal zero, but check out the result:'+util.inspect(result));

          return done();
        }
      });
    });

    it('should coerce output properly (null=>0 in this case) when using implementor switchback (`exits(err, result)`) within the machine `fn`', function (done){
      Machine.build(edgeCaseMachineDef2).configure({criteria: {id: 1}}).exec({
        error: function (err){
          return done(err);
        },
        success: function (result){
          assert.equal(result.votes, 0, 'Expected `votes` property of result to equal zero, but check out the result:'+util.inspect(result));

          return done();
        }
      });
    });




    it('should reject `null` exit example', function (done){
      Machine.build({
        inputs: {},
        exits: {
          success: {
            friendlyName: 'then',
            example: {
              title: 'scott',
              description: 'scott',
              votes: null,
              id: 123
            }
          }
        },
        fn: function (inputs, exits) {
          exits.success();
        }
      }).exec({
        error: function (err){
          return done();
        },
        success: function (result){
          return done(new Error('Expected error exit to be traversed because exit example contains a null value.'));
        }
      });
    });


  });//</additional test cases specific to the machine runner>

});