js-factories/test/factory_spec.coffee

Object factory to create dynamic test fixtures

describe 'Factory', ->

  beforeEach ->
    Factory.define 'testFactSpecUser', (args...) ->
      args: args

  afterEach ->
    Factory.resetFactories()

  describe '::define', ->

    it 'registers a factory', ->
      result = Factory.create 'testFactSpecUser'
      result.args.should.deep.equal []

    it 'raises an error on existing factory', ->
      expect(-> Factory.define('testFactSpecUser', ->)).to.throw 'Factory testFactSpecUser is already defined'

    it 'raises an error on naming conflict with traits', ->
      expect(-> Factory.define('admin-user', ->)).to.throw 'Factory name \'admin-user\' can\'t use - in name. It clashes with the traits construct'

  describe '::create', ->

    it 'delivers options to the callback', ->
      result = Factory.create 'testFactSpecUser',
        hello: 'world'
        other: 'value'
      result.args[0].should.deep.equal { hello: 'world', other: 'value' }

    it 'accepts multiple arguments', ->
      result = Factory.create 'testFactSpecUser', 1, 2, 3
      result.args.should.deep.equal [1, 2, 3]

  describe '::createList', ->
    beforeEach ->
      Factory.define 'testFactory', (args...) ->
        index: @sequence('index')

    afterEach ->
      Factory.resetFactories()

    it 'creates the amount of items as indicated', ->
      result = Factory.createList 10, 'testFactory',
        hello: 'world'
        other: 'value'
      result.length.should.equal 10

    it 'creates all items in the list seperately', ->
      result = Factory.createList 10, 'testFactory',
        hello: 'world'
        other: 'value'
      result[0].index.should.equal 0
      result[9].index.should.equal 9

  describe 'helpers', ->

    describe 'traits', ->
      beforeEach ->
        Factory.define 'testFactSpecTraits', ->
          traits: @traits

      it 'delivers traits to the callback', ->
        result = Factory.create 'something-with-testFactSpecTraits'
        result.traits.should.deep.equal ['something', 'with']

    describe '#is', ->

      it 'checks if trait is set', ->
        Factory.define 'hasTrait', ->
          @is('hello')

        Factory.create('hello-hasTrait').should.be.ok
        Factory.create('bye-hasTrait').should.not.be.ok
        Factory.create('bye-other-hello-somewhere-hasTrait').should.be.ok

    describe '#trait', ->

      beforeEach ->
        Factory.define 'testFactSpecTrait', ->
          @trait('red', 'green', 'refactor')

      it 'returns undefined if no values match', ->
        expect(Factory.create('refgreen-testFactSpecTrait')).to.be.undefined

      it 'returns one of the provided trait values', ->
        Factory.create('green-testFactSpecTrait').should.equal 'green'
        Factory.create('red-testFactSpecTrait').should.equal 'red'

      it 'returns the first encountered if multiple values match', ->
        Factory.create('green-red-testFactSpecTrait').should.equal 'green'
        Factory.create('refactor-green-testFactSpecTrait').should.equal 'refactor'

    describe 'sequence', ->

      beforeEach ->
        Factory.define 'counter', ->
          @sequence('property')

        Factory.define 'otherCounter', ->
          @sequence('property')

        Factory.define 'abc', ->
          @sequence((c) -> ['a', 'b', 'c'][c])

      it 'provides sequencers scoped to factory and property', ->
        Factory.create('counter').should.equal 0
        Factory.create('otherCounter').should.equal 0
        Factory.create('counter').should.equal 1

      it 'can yield results', ->
        Factory.create('abc').should.equal 'a'
        Factory.create('abc').should.equal 'b'

    describe 'sample', ->

      beforeEach ->
        Factory.define 'sampling', ->
          @sample('henk', 'piet', 'kees')

      afterEach ->
        @mathStub?.restore()

      it 'returns one of the provided values', ->
        @mathStub = sinon.stub Math, 'random', -> 0.01
        Factory.create('sampling').should.eql 'henk'

      it 'uses random to decide value', ->
        @mathStub = sinon.stub Math, 'random', -> 0.99
        Factory.create('sampling').should.eql 'kees'