jasmine/spec/core/SpecSpec.js

describe('Spec', function() {
  it('#isPendingSpecException returns true for a pending spec exception', function() {
    const e = new Error(privateUnderTest.Spec.pendingSpecExceptionMessage);

    expect(privateUnderTest.Spec.isPendingSpecException(e)).toBe(true);
  });

  it('#isPendingSpecException returns true for a pending spec exception (even when FF bug is present)', function() {
    const fakeError = {
      toString: function() {
        return 'Error: ' + privateUnderTest.Spec.pendingSpecExceptionMessage;
      }
    };

    expect(privateUnderTest.Spec.isPendingSpecException(fakeError)).toBe(true);
  });

  it('#isPendingSpecException returns true for a pending spec exception with a custom message', function() {
    expect(
      privateUnderTest.Spec.isPendingSpecException(
        privateUnderTest.Spec.pendingSpecExceptionMessage + 'foo'
      )
    ).toBe(true);
  });

  it('#isPendingSpecException returns false for not a pending spec exception', function() {
    const e = new Error('foo');

    expect(privateUnderTest.Spec.isPendingSpecException(e)).toBe(false);
  });

  it("#isPendingSpecException returns false for thrown values that don't have toString", function() {
    expect(privateUnderTest.Spec.isPendingSpecException(void 0)).toBe(false);
  });

  describe('#executionFinished', function() {
    it('removes the fn if autoCleanClosures is true', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} },
        autoCleanClosures: true
      });

      spec.executionFinished();
      expect(spec.queueableFn.fn).toBeFalsy();
    });

    it('removes the fn after execution if autoCleanClosures is undefined', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} },
        autoCleanClosures: undefined
      });

      spec.executionFinished();
      expect(spec.queueableFn.fn).toBeFalsy();
    });

    it('does not remove the fn after execution if autoCleanClosures is false', function() {
      function originalFn() {}
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: originalFn },
        autoCleanClosures: false
      });

      spec.executionFinished();
      expect(spec.queueableFn.fn).toBe(originalFn);
    });
  });

  describe('#getSpecProperty', function() {
    it('get the property value', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.setSpecProperty('a', 4);
      expect(spec.getSpecProperty('a')).toBe(4);
    });
  });

  describe('#setSpecProperty', function() {
    it('adds the property to the result', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.setSpecProperty('a', 4);

      expect(spec.doneEvent().properties).toEqual({ a: 4 });
    });

    it('replace the property result when it was previously set', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.setSpecProperty('a', 'original-value');
      spec.setSpecProperty('b', 'original-value');
      spec.setSpecProperty('a', 'new-value');

      expect(spec.doneEvent().properties).toEqual({
        a: 'new-value',
        b: 'original-value'
      });
    });

    it('throws if the key is not a string', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      expect(function() {
        spec.setSpecProperty({}, '');
      }).toThrowError('Key must be a string');
    });

    it('throws if the value is not structured-cloneable', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      expect(function() {
        spec.setSpecProperty('k', new Promise(() => {}));
      }).toThrowError("Value can't be cloned");
    });

    it('throws if the value is not JSON-serializable', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      expect(function() {
        const v = {};
        v.self = v;
        spec.setSpecProperty('k', v);
      }).toThrowError("Value can't be cloned");
    });
  });

  describe('status', function() {
    it('returns "passed" by default', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });
      expect(spec.status())
        .withContext('status()')
        .toBe('passed');
      expect(spec.doneEvent().status)
        .withContext('doneEvent().status')
        .toBe('passed');
    });

    it('is "passed" if all expectations passed', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.addExpectationResult(true, {});

      expect(spec.status())
        .withContext('status()')
        .toBe('passed');
      expect(spec.doneEvent().status)
        .withContext('doneEvent().status')
        .toBe('passed');
    });

    it('is "failed" if any expectation failed', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.addExpectationResult(true, {});
      spec.addExpectationResult(false, {});

      expect(spec.status())
        .withContext('status()')
        .toBe('failed');
      expect(spec.doneEvent().status)
        .withContext('doneEvent().status')
        .toBe('failed');
    });

    it('is "pending" if created without a function body', function() {
      const startCallback = jasmine.createSpy('startCallback');
      const resultCallback = jasmine.createSpy('resultCallback');
      const spec = new privateUnderTest.Spec({
        onStart: startCallback,
        queueableFn: { fn: null },
        resultCallback: resultCallback
      });

      expect(spec.status())
        .withContext('status()')
        .toBe('pending');
      expect(spec.doneEvent().status)
        .withContext('doneEvent().status')
        .toBe('pending');
    });

    describe('after a call to executionFinished()', function() {
      describe('with excluded true', function() {
        it("is 'excluded'", function() {
          const spec = new privateUnderTest.Spec({
            queueableFn: { fn: () => {} }
          });

          spec.executionFinished(true, false);

          expect(spec.status())
            .withContext('status()')
            .toBe('excluded');
          expect(spec.doneEvent().status)
            .withContext('doneEvent().status')
            .toBe('excluded');
        });
      });

      describe('with failSpecWithNoExp true', function() {
        it("is 'failed' if there were no expectations", function() {
          const spec = new privateUnderTest.Spec({
            queueableFn: { fn: () => {} }
          });

          spec.executionFinished(false, true);

          expect(spec.status())
            .withContext('status()')
            .toBe('failed');
          expect(spec.doneEvent().status)
            .withContext('doneEvent().status')
            .toBe('failed');
        });
      });
    });

    describe('after a call to hadBeforeAllFailure()', function() {
      it("is 'failed'", function() {
        const spec = new privateUnderTest.Spec({
          queueableFn: { fn: () => {} }
        });

        spec.hadBeforeAllFailure();

        expect(spec.status())
          .withContext('status()')
          .toBe('failed');
        expect(spec.doneEvent().status)
          .withContext('doneEvent().status')
          .toBe('failed');
      });
    });
  });

  describe('#addExpectationResult', function() {
    it('keeps track of passed and failed expectations', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.addExpectationResult(true, { message: 'expectation1' });
      spec.addExpectationResult(false, { message: 'expectation2' });

      expect(spec.doneEvent().passedExpectations).toEqual([
        jasmine.objectContaining({ message: 'expectation1' })
      ]);
      expect(spec.doneEvent().failedExpectations).toEqual([
        jasmine.objectContaining({ message: 'expectation2' })
      ]);
    });

    describe("when 'throwOnExpectationFailure' is set", function() {
      it('throws an ExpectationFailed error', function() {
        const spec = new privateUnderTest.Spec({
          queueableFn: { fn: () => {} },
          throwOnExpectationFailure: true
        });

        spec.addExpectationResult(true, { message: 'passed' });
        expect(function() {
          spec.addExpectationResult(false, { message: 'failed' });
        }).toThrowError(jasmineUnderTest.private.errors.ExpectationFailed);

        expect(spec.doneEvent().failedExpectations).toEqual([
          jasmine.objectContaining({ message: 'failed' })
        ]);
      });
    });

    describe("when 'throwOnExpectationFailure' is not set", function() {
      it('does not throw', function() {
        const spec = new privateUnderTest.Spec({
          queueableFn: { fn: () => {} }
        });

        spec.addExpectationResult(false, { message: 'failed' });

        expect(spec.doneEvent().failedExpectations).toEqual([
          jasmine.objectContaining({ message: 'failed' })
        ]);
      });
    });
  });

  it('forwards late expectation failures to onLateError', function() {
    const onLateError = jasmine.createSpy('onLateError');
    const spec = new privateUnderTest.Spec({
      onLateError,
      queueableFn: { fn: function() {} }
    });
    const data = {
      matcherName: '',
      passed: false,
      expected: '',
      actual: '',
      error: new Error('nope')
    };

    spec.reportedDone = true;
    spec.addExpectationResult(false, data, true);

    expect(onLateError).toHaveBeenCalledWith(
      jasmine.objectContaining({
        message: jasmine.stringMatching(/^Error: nope/)
      })
    );
    expect(spec.doneEvent().failedExpectations).toEqual([]);
  });

  it('does not forward non-late expectation failures to onLateError', function() {
    const onLateError = jasmine.createSpy('onLateError');
    const spec = new privateUnderTest.Spec({
      onLateError,
      queueableFn: { fn: function() {} }
    });
    const data = {
      matcherName: '',
      passed: false,
      expected: '',
      actual: '',
      error: new Error('nope')
    };

    spec.addExpectationResult(false, data, true);

    expect(onLateError).not.toHaveBeenCalled();
  });

  it('forwards late handleException calls to onLateError', function() {
    const onLateError = jasmine.createSpy('onLateError');
    const spec = new privateUnderTest.Spec({
      onLateError,
      queueableFn: { fn: function() {} }
    });

    spec.reportedDone = true;
    spec.handleException(new Error('oops'));

    expect(onLateError).toHaveBeenCalledWith(
      jasmine.objectContaining({
        message: jasmine.stringMatching(/^Error: oops/)
      })
    );
    expect(spec.doneEvent().failedExpectations).toEqual([]);
  });

  it('does not forward non-late handleException calls to onLateError', function() {
    const onLateError = jasmine.createSpy('onLateError');
    const spec = new privateUnderTest.Spec({
      onLateError,
      queueableFn: { fn: function() {} }
    });
    const error = new Error('oops');

    spec.handleException(error);

    expect(onLateError).not.toHaveBeenCalled();
    expect(spec.doneEvent().failedExpectations.length).toEqual(1);
  });

  it('clears the reportedDone flag when reset', function() {
    const spec = new privateUnderTest.Spec({
      queueableFn: { fn: function() {} }
    });
    spec.reportedDone = true;

    spec.reset();

    expect(spec.reportedDone).toBeFalse();
  });

  it('does not throw an ExpectationFailed error when handling an error', function() {
    const resultCallback = jasmine.createSpy('resultCallback');
    const spec = new privateUnderTest.Spec({
      queueableFn: { fn: function() {} },
      resultCallback: resultCallback,
      throwOnExpectationFailure: true
    });

    spec.handleException('failing exception');
  });

  it('can return its full name', function() {
    const getPath = jasmine
      .createSpy('getPath')
      .and.returnValue(['expected', 'val']);

    const spec = new privateUnderTest.Spec({
      getPath,
      queueableFn: { fn: null }
    });

    expect(spec.getFullName()).toBe('expected val');
    expect(getPath.calls.mostRecent().args[0]).toBe(spec);
  });

  it('can return its full path', function() {
    const getPath = jasmine
      .createSpy('getPath')
      .and.returnValue(['expected val']);

    const spec = new privateUnderTest.Spec({
      getPath,
      queueableFn: { fn: null }
    });

    expect(spec.getPath()).toEqual(['expected val']);
    expect(getPath.calls.mostRecent().args[0]).toBe(spec);

    expect(spec.metadata.getPath()).toEqual(['expected val']);
  });

  describe('#handleException', function() {
    it('records a failure', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: {}
      });

      spec.handleException('foo');

      expect(spec.doneEvent().failedExpectations).toEqual([
        {
          message: 'foo thrown',
          matcherName: '',
          passed: false,
          stack: null,
          globalErrorType: undefined
        }
      ]);
    });

    it('does not record an additional failure when the error is ExpectationFailed', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: {}
      });

      spec.handleException(
        new jasmineUnderTest.private.errors.ExpectationFailed()
      );

      expect(spec.doneEvent().failedExpectations).toEqual([]);
    });
  });

  describe('#debugLog', function() {
    it('adds the messages to the result', function() {
      const timer = jasmine.createSpyObj('timer', ['start', 'elapsed']);
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} },
        timer: timer
      });
      const t1 = 123;
      const t2 = 456;

      expect(spec.doneEvent().debugLogs).toBeNull();
      timer.elapsed.and.returnValue(t1);
      spec.debugLog('msg 1');
      expect(spec.doneEvent().debugLogs).toEqual([
        { message: 'msg 1', timestamp: t1 }
      ]);
      timer.elapsed.and.returnValue(t2);
      spec.debugLog('msg 2');
      expect(spec.doneEvent().debugLogs).toEqual([
        { message: 'msg 1', timestamp: t1 },
        { message: 'msg 2', timestamp: t2 }
      ]);
    });

    describe('When the spec passes', function() {
      it('removes the logs from the result', function() {
        const spec = new privateUnderTest.Spec({
          queueableFn: { fn: () => {} }
        });

        spec.debugLog('msg');
        spec.executionFinished();

        expect(spec.doneEvent().debugLogs).toBeNull();
      });
    });

    describe('When the spec fails', function() {
      it('includes the messages in the result', function() {
        const timer = jasmine.createSpyObj('timer', ['start', 'elapsed']);
        const spec = new privateUnderTest.Spec({
          queueableFn: { fn: () => {} },
          timer: timer
        });
        const timestamp = 12345;

        timer.elapsed.and.returnValue(timestamp);

        spec.debugLog('msg');
        spec.handleException(new Error('nope'));
        spec.executionFinished();

        expect(spec.doneEvent().debugLogs).toEqual([
          { message: 'msg', timestamp: timestamp }
        ]);
      });
    });
  });

  describe('#startedEvent', function() {
    it('includes only properties that are known before execution', function() {
      const spec = new privateUnderTest.Spec({
        id: 'spec1',
        parentSuiteId: 'suite1',
        description: 'a spec',
        filename: 'somefile.js',
        getPath() {
          return ['a suite', 'a spec'];
        },
        queueableFn: { fn: () => {} }
      });

      expect(spec.startedEvent()).toEqual({
        id: 'spec1',
        parentSuiteId: 'suite1',
        description: 'a spec',
        fullName: 'a suite a spec',
        filename: 'somefile.js'
      });
    });
  });

  describe('#doneEvent', function() {
    it('returns the event for a passed spec', function() {
      const timer = {
        start() {},
        elapsed() {
          return 123;
        }
      };
      const spec = new privateUnderTest.Spec({
        id: 'spec1',
        parentSuiteId: 'suite1',
        description: 'a spec',
        filename: 'somefile.js',
        getPath() {
          return ['a suite', 'a spec'];
        },
        queueableFn: { fn: () => {} },
        timer: timer
      });

      spec.addExpectationResult(true, {
        matcherName: 'a passing expectation',
        passed: true
      });
      spec.executionFinished(false, false);

      expect(spec.doneEvent()).toEqual({
        id: 'spec1',
        parentSuiteId: 'suite1',
        description: 'a spec',
        fullName: 'a suite a spec',
        filename: 'somefile.js',
        status: 'passed',
        passedExpectations: [
          {
            matcherName: 'a passing expectation',
            passed: true,
            message: 'Passed.',
            stack: '',
            globalErrorType: undefined
          }
        ],
        failedExpectations: [],
        deprecationWarnings: [],
        debugLogs: null, // TODO change to []
        properties: null, // TODO change to {}
        pendingReason: '',
        duration: 123
      });
    });

    it('returns the event for a failed spec', function() {
      const timer = {
        start() {},
        elapsed() {
          return 123;
        }
      };
      const spec = new privateUnderTest.Spec({
        id: 'spec1',
        parentSuiteId: 'suite1',
        description: 'a spec',
        filename: 'somefile.js',
        getPath() {
          return ['a suite', 'a spec'];
        },
        queueableFn: { fn: () => {} },
        timer: timer
      });

      spec.addExpectationResult(true, {
        matcherName: 'a passing expectation',
        passed: true
      });
      spec.addExpectationResult(false, {
        matcherName: 'a failing expectation',
        passed: false,
        error: new Error('failed')
      });
      spec.executionFinished(false, false);

      expect(spec.doneEvent()).toEqual({
        id: 'spec1',
        parentSuiteId: 'suite1',
        description: 'a spec',
        fullName: 'a suite a spec',
        filename: 'somefile.js',
        status: 'failed',
        passedExpectations: [
          {
            matcherName: 'a passing expectation',
            passed: true,
            message: 'Passed.',
            stack: '',
            globalErrorType: undefined
          }
        ],
        failedExpectations: [
          {
            matcherName: 'a failing expectation',
            passed: false,
            message: jasmine.stringMatching(/^Error: failed/),
            stack: jasmine.stringContaining('SpecSpec.js'),
            globalErrorType: undefined
          }
        ],
        deprecationWarnings: [],
        debugLogs: null, // TODO change to []
        properties: null, // TODO change to {}
        pendingReason: '',
        duration: 123
      });
    });

    it("reports a status of 'pending' for a declaratively pended spec", function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: {}
      });

      spec.executionFinished(false, false);

      const result = spec.doneEvent();
      expect(result.status).toEqual('pending');
      expect(result.pendingReason).toEqual('');
    });

    it("reports a status of 'pending' for a spec pended by #pend", function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.pend('nope');
      spec.executionFinished(false, false);

      const result = spec.doneEvent();
      expect(result.status).toEqual('pending');
      expect(result.pendingReason).toEqual('nope');
    });

    it("reports a status of 'excluded' for an excluded spec", function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.executionFinished(true, false);

      expect(spec.doneEvent().status).toEqual('excluded');
    });

    describe('When failSpecWithNoExpectations is true', function() {
      it("reports a status of 'failed' for a spec with no expectations", function() {
        const spec = new privateUnderTest.Spec({
          queueableFn: { fn: () => {} }
        });

        spec.executionFinished(false, true);

        expect(spec.doneEvent().status).toEqual('failed');
      });
    });

    it('includes deprecation warnings', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.addDeprecationWarning('stop that');

      expect(spec.doneEvent().deprecationWarnings).toEqual([
        {
          // TODO: remove irrelevant properties
          message: 'stop that',
          stack: jasmine.stringContaining('SpecSpec.js'),
          matcherName: undefined,
          passed: undefined,
          globalErrorType: undefined
        }
      ]);
    });

    it('includes debug logs', function() {
      const timer = {
        start() {},
        elapsed() {
          return 123;
        }
      };
      const spec = new privateUnderTest.Spec({
        timer,
        queueableFn: { fn: () => {} }
      });

      spec.debugLog('maybe this will help');

      expect(spec.doneEvent().debugLogs).toEqual([
        {
          message: 'maybe this will help',
          timestamp: 123
        }
      ]);
    });

    it('includes spec properties', function() {
      const spec = new privateUnderTest.Spec({
        queueableFn: { fn: () => {} }
      });

      spec.setSpecProperty('foo', 'bar');
      spec.setSpecProperty('baz', { grault: ['wombat'] });

      expect(spec.doneEvent().properties).toEqual({
        foo: 'bar',
        baz: { grault: ['wombat'] }
      });
    });

    // it("excludes properties that aren't in the public API");
  });
});