Skip to content

Latest commit

 

History

History
277 lines (200 loc) · 6.91 KB

spec.md

File metadata and controls

277 lines (200 loc) · 6.91 KB
Raw

TOC

fixture.specs

should call the builders for all fixture fields.

buildStub = sinon
  .stub(property_builders_1.default, 'generateField')
  .returns({ name: 'prop', value: 'value' });
const fixture = userFixture.create();
expect(buildStub).to.be.callCount(3);
buildStub.restore();

should add string properties to the fixture.

const fixture = userFixture.create();
expect(fixture).to.have.property('firstName', 'firstName2');
expect(fixture).to.have.property('lastName', 'lastName2');

overrides

should let users override values for specific fields on the fixture.

const fixture = userFixture.create({ firstName: 'Joey' });
expect(fixture.firstName).to.be.equal('Joey');

should allow users to use a function to override the fixture.

const fixture = userFixture.create((user) => (user.firstName = 'Joey'));
expect(fixture.firstName).to.be.equal('Joey');

should call create function once.

const builderFn = sinon.spy();
const fixture = userFixture.create(builderFn);
expect(builderFn).to.be.calledOnce;

can add new fields to the object through overrides.

const fixture = userFixture.create({ id: 1 });
expect(fixture).to.have.property('id', 1);
const f2 = userFixture.create((user) => (user.id = 1));
expect(f2).to.have.property('id', 1);

withValues()

increments the specified value for the field value.

const fixture = new fixture_1.default('email'.withValue('userEmail')).create();
expect(fixture.email).to.equal('userEmail1');

asConstant()

should create fields using a constant value that does not change between instances.

const builder = new fixture_1.default('firstName'.asConstant('Bob'));
const fixture1 = builder.create();
const fixture2 = builder.create();
expect(fixture1).to.have.property('firstName', 'Bob');
expect(fixture2).to.have.property('firstName', 'Bob');

asDate()

should return a date for the property.

const fixture = userFixture.create();
expect(fixture).to.have.property('date');
expect(fixture.date).to.be.an.instanceof(Date);

should increment the date instances when specified.

const today = new Date();
const builder = new fixture_1.default('date'.asDate({ incrementDay: true }));
const f1 = builder.create();
const f2 = builder.create();
expect(f1.date.getDate()).to.be.equal(today.getDate());
expect(f2.date.getDate()).to.be.equal(today.getDate() + 1);

asBoolean()

should create a boolean field.

const fb = new fixture_1.default('flag'.asBoolean());
const f = fb.create();
expect(f.flag).be.a('boolean');

asEmail()

should populate field with an email address.

const fb = new fixture_1.default('email'.asEmail());
const f = fb.create();
expect(f.email).to.equal('email1@example.com');

asArray

should create an array field on the fixture.

const builder = new fixture_1.default('roles'.asArray());
const f = builder.create();
expect(f.roles).to.be.an('array');
expect(f.roles).to.eql(['roles1']);

should create an array with the specified length.

const builder = new fixture_1.default('roles'.asArray({ length: 3 }));
const f = builder.create();
expect(f.roles).to.have.lengthOf(3);

should create an array of the specified type.

const builder = new fixture_1.default(
  'roles'.asArray({
    length: 3,
    builder: index_1.propertyBuilders.asNumberBuilder,
  }),
);
const f = builder.create();
expect(f.roles).to.eql([1, 2, 3]);

as()

should create field using the function passed to it.

const builder = new fixture_1.default('field'.as((inc) => `field${inc}`));
const f = builder.create();
expect(f.field).to.be.equal('field1');

pickFrom

should pick from one of the provided values to populate the field.

const options = ['a', 'b', 'c', 'd'];
const builder = new fixture_1.default('prop'.pickFrom(options));
const f = builder.create();
expect(options).to.include(f.prop);

should throw an error if options are not provided.

expect(() => new fixture_1.default('prop'.pickFrom([]))).to.throw();

fromFixture()

creates a property based on the fixture.

const innerBuilder = new fixture_1.default('a', 'b');
const outerBuilder = new fixture_1.default('c'.fromFixture(innerBuilder));
const fixture = outerBuilder.create();
expect(fixture).to.have.property('c');
expect(fixture.c).to.eql({ a: 'a1', b: 'b1' });

uses overrides from the provided fixture.

const innerBuilder = new fixture_1.default('a', 'b');
const outerBuilder = new fixture_1.default('c'.fromFixture(innerBuilder));
const fixture = outerBuilder.create({ c: { d: 'd1', e: 'e1' } });
expect(fixture).to.have.property('c');
expect(fixture.c).to.eql({ d: 'd1', e: 'e1' });

arrayOfFixture()

creates an array of fixtures.

const innerFixture = new fixture_1.default('a', 'b');
const outerFixture = new fixture_1.default('c'.arrayOfFixture(innerFixture));
const fixture = outerFixture.create();
expect(fixture.c).to.be.an('array');
expect(fixture.c).to.have.lengthOf(3);
expect(fixture.c[0]).to.have.property('a');

name generators

should populate fields using the name generators.

const userGenerator = new fixture_1.default(
  'firstName'.asFirstName(),
  'lastName'.asLastName(),
  'fullName'.asFullName(),
);
const user = userGenerator.create();
expect(user.firstName).to.be.a('string');
expect(user.lastName).to.be.a('string');
expect(user.fullName).to.be.a('string');

asLoremIpsum()

should generate the lorem ipusm text.

const builder = new fixture_1.default('lorem'.asLoremIpsum());
const f = builder.create();
expect(f.lorem.length > 10).to.be.true;

should make text longer than the min.

const builder = new fixture_1.default('lorem'.asLoremIpsum({ minLength: 20, maxLength: 50 }));
const f = builder.create();
expect(f.lorem.length > 20).to.be.true;
expect(f.lorem.length < 50).to.be.true;