jasmine/spec/core/SuiteBuilderSpec.js

describe('SuiteBuilder', function() {
  beforeEach(function() {
    // Rethrow exceptions to ease debugging
    spyOn(privateUnderTest.Suite.prototype, 'handleException').and.callFake(
      function(e) {
        throw e;
      }
    );
    spyOn(privateUnderTest.Spec.prototype, 'handleException').and.callFake(
      function(e) {
        throw e;
      }
    );
  });

  it('creates the top suite', function() {
    const env = { configuration: () => ({}) };
    const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

    expect(suiteBuilder.topSuite).toBeInstanceOf(privateUnderTest.Suite);
    expect(suiteBuilder.topSuite.description).toEqual(
      'Jasmine__TopLevel__Suite'
    );
    expect(suiteBuilder.topSuite.parentSuite).toBeUndefined();
  });

  describe('#describe', function() {
    definesSuites('describe');
  });

  describe('#fdescribe', function() {
    definesSuites('fdescribe');

    it('focuses the suite', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      const suite = suiteBuilder.fdescribe('a suite', function() {
        suiteBuilder.it('a spec');
      });

      expect(suite.isFocused).toBeTrue();
      expect(suiteBuilder.focusedRunables).toEqual([suite.id]);
    });

    it('unfocuses any focused ancestor suite', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      const grandparent = suiteBuilder.fdescribe('a suite', function() {
        suiteBuilder.describe('another suite', function() {
          suiteBuilder.fdescribe('the focused suite', function() {
            suiteBuilder.it('a spec');
          });
        });
      });

      expect(suiteBuilder.focusedRunables).not.toContain(grandparent.id);
    });
  });

  describe('#xdescribe', function() {
    definesSuites('xdescribe');

    it('excludes the suite', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      const suite = suiteBuilder.xdescribe('a suite', function() {
        suiteBuilder.it('a spec');
      });

      expect(suite.markedExcluding).toBeTrue();
    });

    it('causes child suites to be marked excluded', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      let suite;
      suiteBuilder.xdescribe('a suite', function() {
        suite = suiteBuilder.describe('another suite', function() {
          suiteBuilder.it('a spec');
        });
      });

      expect(suite.markedExcluding).toBeTrue();
    });
  });

  describe('#it', function() {
    definesSpecs('it');
  });

  describe('#fit', function() {
    definesSpecs('fit');
  });

  describe('#xit', function() {
    definesSpecs('xit');
  });

  function definesSuites(fnName) {
    it('links suites to their parents and children', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      let child;
      const parent = suiteBuilder[fnName]('parent', function() {
        child = suiteBuilder[fnName]('child', function() {
          suiteBuilder.it('a spec');
        });
      });

      expect(suiteBuilder.topSuite.children).toEqual([sameInstanceAs(parent)]);
      expect(parent.children).toEqual([sameInstanceAs(child)]);
      expect(child.parentSuite).toBe(parent);
      expect(parent.parentSuite).toBe(suiteBuilder.topSuite);
    });

    it('gives each suite a unique ID', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      let child;
      const parent = suiteBuilder[fnName]('parent', function() {
        child = suiteBuilder[fnName]('child', function() {
          suiteBuilder.it('a spec');
        });
      });

      const ids = [suiteBuilder.topSuite.id, parent.id, child.id];

      for (const id of ids) {
        expect(id).toMatch(/^suite[0-9]$/);
      }

      expect(new Set(ids).size).toEqual(3);
    });
  }

  function definesSpecs(fnName) {
    it('adds the spec to its suite', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      let spec;
      const suite = suiteBuilder.describe('a suite', function() {
        spec = suiteBuilder[fnName]('a spec', function() {});
      });

      expect(suite.children).toEqual([sameInstanceAs(spec)]);
    });

    it('gives each spec a unique ID', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      const spec1 = suiteBuilder[fnName]('a spec', function() {});
      const spec2 = suiteBuilder[fnName]('another spec', function() {});

      expect(spec1.id).toMatch(/^spec[0-9]+$/);
      expect(spec2.id).toMatch(/^spec[0-9]+$/);
      expect(spec1.id).not.toEqual(spec2.id);
    });

    it('gives each spec a full path', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });
      let spec;

      suiteBuilder.describe('a suite', function() {
        suiteBuilder.describe('a nested suite', function() {
          spec = suiteBuilder[fnName]('a spec', function() {});
        });
      });

      expect(spec.getPath()).toEqual(['a suite', 'a nested suite', 'a spec']);
    });
  }

  function sameInstanceAs(expected) {
    return {
      asymmetricMatch: function(actual) {
        return actual === expected;
      },
      jasmineToString: function(pp) {
        return '<same instance as ' + pp(expected) + '>';
      }
    };
  }

  describe('Duplicate name handling', function() {
    describe('When forbidDuplicateNames is true', function() {
      let env;

      beforeEach(function() {
        env = { configuration: () => ({ forbidDuplicateNames: true }) };
      });

      it('forbids duplicate spec names', function() {
        const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

        expect(function() {
          suiteBuilder.describe('a suite', function() {
            suiteBuilder.describe('a nested suite', function() {
              suiteBuilder.it('a spec');
              suiteBuilder.it('a spec');
            });
          });
        }).toThrowError(
          'Duplicate spec name "a spec" found in "a suite a nested suite"'
        );
      });

      it('forbids duplicate spec names in the top suite', function() {
        const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

        expect(function() {
          suiteBuilder.it('another spec');
          suiteBuilder.it('another spec');
        }).toThrowError(
          'Duplicate spec name "another spec" found in top suite'
        );
      });

      it('forbids duplicate suite names', function() {
        const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

        expect(function() {
          suiteBuilder.describe('a suite', function() {
            suiteBuilder.describe('a nested suite', function() {
              suiteBuilder.describe('another suite', function() {
                suiteBuilder.it('a spec');
              });
              suiteBuilder.describe('another suite', function() {
                suiteBuilder.it('a spec');
              });
            });
          });
        }).toThrowError(
          'Duplicate suite name "another suite" found in "a suite a nested suite"'
        );
      });

      it('forbids duplicate suite names in the top suite', function() {
        const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

        expect(function() {
          suiteBuilder.describe('a suite', function() {
            suiteBuilder.it('a spec');
          });
          suiteBuilder.describe('a suite', function() {
            suiteBuilder.it('a spec');
          });
        }).toThrowError('Duplicate suite name "a suite" found in top suite');
      });

      it('allows spec and suite names to be duplicated in different suites', function() {
        const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

        expect(function() {
          suiteBuilder.describe('suite a', function() {
            suiteBuilder.describe('dupe suite', function() {
              suiteBuilder.it('dupe spec');
              suiteBuilder.describe('child suite', function() {
                suiteBuilder.it('dupe spec');
              });
            });
          });
          suiteBuilder.describe('suite b', function() {
            suiteBuilder.describe('dupe suite', function() {
              suiteBuilder.it('dupe spec');
            });
          });
        }).not.toThrow();
      });
    });

    describe('When forbidDuplicateNames is false', function() {
      let env;

      beforeEach(function() {
        env = { configuration: () => ({ forbidDuplicateNames: false }) };
      });

      it('allows duplicate spec and suite names', function() {
        const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

        expect(function() {
          suiteBuilder.describe('dupe suite', function() {
            suiteBuilder.it('dupe spec');
            suiteBuilder.it('dupe spec');
          });
          suiteBuilder.describe('dupe suite', function() {
            suiteBuilder.it('dupe spec');
            suiteBuilder.it('dupe spec');
          });
        }).not.toThrow();
      });
    });
  });

  describe('#parallelReset', function() {
    it('resets the top suite result', function() {
      privateUnderTest.Suite.prototype.handleException.and.callThrough();

      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      suiteBuilder.topSuite.handleException(new Error('nope'));
      suiteBuilder.parallelReset();

      expect(suiteBuilder.topSuite.doneEvent()).toEqual({
        id: suiteBuilder.topSuite.id,
        description: 'Jasmine__TopLevel__Suite',
        fullName: '',
        status: 'passed',
        failedExpectations: [],
        deprecationWarnings: [],
        duration: null,
        properties: null,
        parentSuiteId: null,
        filename: undefined
      });
    });

    it('removes children of the top suite', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });
      suiteBuilder.describe('a suite', function() {
        suiteBuilder.it('a nested spec');
      });
      suiteBuilder.it('a spec');

      suiteBuilder.parallelReset();

      expect(suiteBuilder.topSuite.children).toEqual([]);
    });

    it('preserves top suite befores and afters', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });

      function beforeAll() {}
      function beforeEach() {}
      function afterEach() {}
      function afterAll() {}

      suiteBuilder.beforeAll(beforeAll);
      suiteBuilder.beforeEach(beforeEach);
      suiteBuilder.afterEach(afterEach);
      suiteBuilder.afterAll(afterAll);

      suiteBuilder.parallelReset();

      expect(suiteBuilder.topSuite.beforeAllFns).toEqual([
        jasmine.objectContaining({ fn: beforeAll })
      ]);
      expect(suiteBuilder.topSuite.beforeFns).toEqual([
        jasmine.objectContaining({ fn: beforeEach })
      ]);
      expect(suiteBuilder.topSuite.afterFns).toEqual([
        jasmine.objectContaining({ fn: afterEach })
      ]);
      expect(suiteBuilder.topSuite.afterAllFns).toEqual([
        jasmine.objectContaining({ fn: afterAll })
      ]);
    });

    it('resets totalSpecsDefined', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });
      suiteBuilder.it('a spec');

      suiteBuilder.parallelReset();

      expect(suiteBuilder.totalSpecsDefined).toEqual(0);
    });

    it('resets focusedRunables', function() {
      const env = { configuration: () => ({}) };
      const suiteBuilder = new privateUnderTest.SuiteBuilder({ env });
      suiteBuilder.fit('a spec', function() {});

      suiteBuilder.parallelReset();

      expect(suiteBuilder.focusedRunables).toEqual([]);
    });
  });
});