Commit ee74f7b8 authored by Phil Hughes's avatar Phil Hughes

Merge branch 'winh-jest-ajax' into 'master'

Fail for unmocked axios requests in Jest

Closes #33715

See merge request gitlab-org/gitlab-ce!23965
parents deca6688 13bb3483
...@@ -94,68 +94,54 @@ describe('AjaxCache', () => { ...@@ -94,68 +94,54 @@ describe('AjaxCache', () => {
beforeEach(() => { beforeEach(() => {
mock = new MockAdapter(axios); mock = new MockAdapter(axios);
spyOn(axios, 'get').and.callThrough(); jest.spyOn(axios, 'get');
}); });
afterEach(() => { afterEach(() => {
mock.restore(); mock.restore();
}); });
it('stores and returns data from Ajax call if cache is empty', done => { it('stores and returns data from Ajax call if cache is empty', () => {
mock.onGet(dummyEndpoint).reply(200, dummyResponse); mock.onGet(dummyEndpoint).reply(200, dummyResponse);
AjaxCache.retrieve(dummyEndpoint) return AjaxCache.retrieve(dummyEndpoint).then(data => {
.then(data => { expect(data).toEqual(dummyResponse);
expect(data).toEqual(dummyResponse); expect(AjaxCache.internalStorage[dummyEndpoint]).toEqual(dummyResponse);
expect(AjaxCache.internalStorage[dummyEndpoint]).toEqual(dummyResponse); });
})
.then(done)
.catch(fail);
}); });
it('makes no Ajax call if request is pending', done => { it('makes no Ajax call if request is pending', () => {
mock.onGet(dummyEndpoint).reply(200, dummyResponse); mock.onGet(dummyEndpoint).reply(200, dummyResponse);
AjaxCache.retrieve(dummyEndpoint) return Promise.all([
.then(done) AjaxCache.retrieve(dummyEndpoint),
.catch(fail); AjaxCache.retrieve(dummyEndpoint),
]).then(() => {
AjaxCache.retrieve(dummyEndpoint) expect(axios.get).toHaveBeenCalledTimes(1);
.then(done) });
.catch(fail);
expect(axios.get.calls.count()).toBe(1);
}); });
it('returns undefined if Ajax call fails and cache is empty', done => { it('returns undefined if Ajax call fails and cache is empty', () => {
const errorMessage = 'Network Error'; const errorMessage = 'Network Error';
mock.onGet(dummyEndpoint).networkError(); mock.onGet(dummyEndpoint).networkError();
AjaxCache.retrieve(dummyEndpoint) expect.assertions(2);
.then(data => fail(`Received unexpected data: ${JSON.stringify(data)}`)) return AjaxCache.retrieve(dummyEndpoint).catch(error => {
.catch(error => { expect(error.message).toBe(`${dummyEndpoint}: ${errorMessage}`);
expect(error.message).toBe(`${dummyEndpoint}: ${errorMessage}`); expect(error.textStatus).toBe(errorMessage);
expect(error.textStatus).toBe(errorMessage); });
done();
})
.catch(fail);
}); });
it('makes no Ajax call if matching data exists', done => { it('makes no Ajax call if matching data exists', () => {
AjaxCache.internalStorage[dummyEndpoint] = dummyResponse; AjaxCache.internalStorage[dummyEndpoint] = dummyResponse;
mock.onGet(dummyEndpoint).reply(() => {
fail(new Error('expected no Ajax call!'));
});
AjaxCache.retrieve(dummyEndpoint) return AjaxCache.retrieve(dummyEndpoint).then(data => {
.then(data => { expect(data).toBe(dummyResponse);
expect(data).toBe(dummyResponse); expect(axios.get).not.toHaveBeenCalled();
}) });
.then(done)
.catch(fail);
}); });
it('makes Ajax call even if matching data exists when forceRequest parameter is provided', done => { it('makes Ajax call even if matching data exists when forceRequest parameter is provided', () => {
const oldDummyResponse = { const oldDummyResponse = {
important: 'old dummy data', important: 'old dummy data',
}; };
...@@ -164,21 +150,12 @@ describe('AjaxCache', () => { ...@@ -164,21 +150,12 @@ describe('AjaxCache', () => {
mock.onGet(dummyEndpoint).reply(200, dummyResponse); mock.onGet(dummyEndpoint).reply(200, dummyResponse);
// Call without forceRetrieve param return Promise.all([
AjaxCache.retrieve(dummyEndpoint) AjaxCache.retrieve(dummyEndpoint),
.then(data => { AjaxCache.retrieve(dummyEndpoint, true),
expect(data).toBe(oldDummyResponse); ]).then(data => {
}) expect(data).toEqual([oldDummyResponse, dummyResponse]);
.then(done) });
.catch(fail);
// Call with forceRetrieve param
AjaxCache.retrieve(dummyEndpoint, true)
.then(data => {
expect(data).toEqual(dummyResponse);
})
.then(done)
.catch(fail);
}); });
}); });
}); });
import axios from '~/lib/utils/axios_utils';
const testTimeoutInMs = 300; const testTimeoutInMs = 300;
jest.setTimeout(testTimeoutInMs); jest.setTimeout(testTimeoutInMs);
...@@ -14,3 +16,15 @@ afterEach(() => { ...@@ -14,3 +16,15 @@ afterEach(() => {
throw new Error(`Test took too long (${elapsedTimeInMs}ms > ${testTimeoutInMs}ms)!`); throw new Error(`Test took too long (${elapsedTimeInMs}ms > ${testTimeoutInMs}ms)!`);
} }
}); });
// fail tests for unmocked requests
beforeEach(done => {
axios.defaults.adapter = config => {
const error = new Error(`Unexpected unmocked request: ${JSON.stringify(config, null, 2)}`);
error.config = config;
done.fail(error);
return Promise.reject(error);
};
done();
});
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment