feat: add integration tests for queryRecords and deleteRecordsByIds methods. fix: implemented deleteRecordsByIds method and wrote unit tests
This commit is contained in:
StevanFreeborn
@@ -1,100 +1,74 @@
|
||||
import { StringRecordValue } from './../../src/models/StringRecordValue';
|
||||
import { OnspringClient, Record } from './../../src';
|
||||
import { expect } from 'chai';
|
||||
import { baseURL, apiKey } from '../mochaRootHooks';
|
||||
|
||||
describe('deleteRecordById', function () {
|
||||
this.timeout(30000);
|
||||
this.retries(3);
|
||||
|
||||
it('should delete a record', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_SURVEY_ID === undefined) {
|
||||
expect.fail('TEST_SURVEY_ID is not defined');
|
||||
}
|
||||
|
||||
const recordId = await addRecord();
|
||||
const response = await client.deleteRecordById(
|
||||
parseInt(process.env.TEST_SURVEY_ID),
|
||||
recordId
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(204);
|
||||
expect(response.isSuccessful).to.be.true;
|
||||
expect(response.message).to.equal('');
|
||||
expect(response.data).to.not.be.null;
|
||||
});
|
||||
|
||||
it('should return a 401 error when the API key is invalid', async function () {
|
||||
const client = new OnspringClient(baseURL, 'invalid');
|
||||
const response = await client.deleteRecordById(1, 1);
|
||||
|
||||
expect(response.statusCode).to.equal(401);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
|
||||
it('should return a 403 error when the API key does not have access to the record', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_APP_ID_NO_ACCESS === undefined) {
|
||||
expect.fail('TEST_APP_ID_NO_ACCESS is not defined');
|
||||
}
|
||||
|
||||
const response = await client.deleteRecordById(
|
||||
parseInt(process.env.TEST_APP_ID_NO_ACCESS),
|
||||
1
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(403);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.not.be.null.and.not.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
|
||||
it('should return a 404 error when the record does not exist', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_APP_ID === undefined) {
|
||||
expect.fail('TEST_APP_ID is not defined');
|
||||
}
|
||||
|
||||
const response = await client.deleteRecordById(
|
||||
parseInt(process.env.TEST_APP_ID),
|
||||
0
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(404);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
});
|
||||
|
||||
async function addRecord(): Promise<number> {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_SURVEY_ID === undefined) {
|
||||
expect.fail('TEST_SURVEY_ID is not defined');
|
||||
}
|
||||
|
||||
if (process.env.TEST_TEXT_FIELD === undefined) {
|
||||
expect.fail('TEST_TEXT_FIELD is not defined');
|
||||
}
|
||||
|
||||
const request = new Record(parseInt(process.env.TEST_SURVEY_ID), null);
|
||||
|
||||
request.addValue(
|
||||
new StringRecordValue(parseInt(process.env.TEST_TEXT_FIELD), 'test')
|
||||
);
|
||||
|
||||
const response = await client.saveRecord(request);
|
||||
|
||||
if (response.data === null || response.data.id === undefined) {
|
||||
expect.fail('Record ID is not defined');
|
||||
}
|
||||
|
||||
return response.data.id;
|
||||
}
|
||||
import { OnspringClient } from '../../src';
|
||||
import { expect } from 'chai';
|
||||
import { baseURL, apiKey } from '../mochaRootHooks';
|
||||
import { addRecord } from '../utils/addRecord';
|
||||
|
||||
describe('deleteRecordById', function () {
|
||||
this.timeout(30000);
|
||||
this.retries(3);
|
||||
|
||||
it('should delete a record', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_SURVEY_ID === undefined) {
|
||||
expect.fail('TEST_SURVEY_ID is not defined');
|
||||
}
|
||||
|
||||
const recordId = await addRecord(baseURL, apiKey);
|
||||
const response = await client.deleteRecordById(
|
||||
parseInt(process.env.TEST_SURVEY_ID),
|
||||
recordId
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(204);
|
||||
expect(response.isSuccessful).to.be.true;
|
||||
expect(response.message).to.equal('');
|
||||
expect(response.data).to.not.be.null;
|
||||
});
|
||||
|
||||
it('should return a 401 error when the API key is invalid', async function () {
|
||||
const client = new OnspringClient(baseURL, 'invalid');
|
||||
const response = await client.deleteRecordById(1, 1);
|
||||
|
||||
expect(response.statusCode).to.equal(401);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
|
||||
it('should return a 403 error when the API key does not have access to the record', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_APP_ID_NO_ACCESS === undefined) {
|
||||
expect.fail('TEST_APP_ID_NO_ACCESS is not defined');
|
||||
}
|
||||
|
||||
const response = await client.deleteRecordById(
|
||||
parseInt(process.env.TEST_APP_ID_NO_ACCESS),
|
||||
1
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(403);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.not.be.null.and.not.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
|
||||
it('should return a 404 error when the record does not exist', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_APP_ID === undefined) {
|
||||
expect.fail('TEST_APP_ID is not defined');
|
||||
}
|
||||
|
||||
const response = await client.deleteRecordById(
|
||||
parseInt(process.env.TEST_APP_ID),
|
||||
0
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(404);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
});
|
||||
|
||||
@@ -0,0 +1,77 @@
|
||||
import { OnspringClient } from '../../src';
|
||||
import { expect } from 'chai';
|
||||
import { baseURL, apiKey } from '../mochaRootHooks';
|
||||
import { addRecord } from '../utils/addRecord';
|
||||
|
||||
describe('deleteRecordsByIds', function () {
|
||||
this.timeout(30000);
|
||||
this.retries(3);
|
||||
|
||||
it('should delete records', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_SURVEY_ID === undefined) {
|
||||
expect.fail('TEST_SURVEY_ID is not defined');
|
||||
}
|
||||
|
||||
const recordId1 = await addRecord(baseURL, apiKey);
|
||||
const recordId2 = await addRecord(baseURL, apiKey);
|
||||
|
||||
const response = await client.deleteRecordsByIds(
|
||||
parseInt(process.env.TEST_SURVEY_ID),
|
||||
[recordId1, recordId2]
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(204);
|
||||
expect(response.isSuccessful).to.be.true;
|
||||
expect(response.message).to.equal('');
|
||||
expect(response.data).to.not.be.null;
|
||||
});
|
||||
|
||||
it('should return a 400 error when no record ids are provided', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_SURVEY_ID === undefined) {
|
||||
expect.fail('TEST_SURVEY_ID is not defined');
|
||||
}
|
||||
|
||||
const response = await client.deleteRecordsByIds(
|
||||
parseInt(process.env.TEST_SURVEY_ID),
|
||||
[]
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(400);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.not.be.null.and.not.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
|
||||
it('should return a 401 error when an invalid API key is used', async function () {
|
||||
const client = new OnspringClient(baseURL, 'invalid');
|
||||
|
||||
const response = await client.deleteRecordsByIds(1, [1]);
|
||||
|
||||
expect(response.statusCode).to.equal(401);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
|
||||
it('should return a 403 error when the API key does not have access to the app', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_APP_ID_NO_ACCESS === undefined) {
|
||||
expect.fail('TEST_APP_ID_NO_ACCESS is not defined');
|
||||
}
|
||||
|
||||
const response = await client.deleteRecordsByIds(
|
||||
parseInt(process.env.TEST_APP_ID_NO_ACCESS),
|
||||
[1]
|
||||
);
|
||||
|
||||
expect(response.statusCode).to.equal(403);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.not.be.null.and.not.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
});
|
||||
@@ -1,5 +1,159 @@
|
||||
import { OnspringClient } from './../../src';
|
||||
import { expect } from 'chai';
|
||||
import { baseURL, apiKey } from '../mochaRootHooks';
|
||||
|
||||
describe('queryRecords', function () {});
|
||||
import {
|
||||
DataFormat,
|
||||
FilterOperators,
|
||||
OnspringClient,
|
||||
PagingRequest,
|
||||
QueryFilter,
|
||||
QueryRecordsRequest,
|
||||
} from '../../src';
|
||||
import { expect } from 'chai';
|
||||
import { baseURL, apiKey } from '../mochaRootHooks';
|
||||
|
||||
describe('queryRecords', function () {
|
||||
this.timeout(30000);
|
||||
this.retries(3);
|
||||
|
||||
it('should return records', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_SURVEY_ID === undefined) {
|
||||
expect.fail('TEST_SURVEY_ID is not defined');
|
||||
}
|
||||
|
||||
if (process.env.TEST_SURVEY_AUTO_NUMBER_FIELD === undefined) {
|
||||
expect.fail('TEST_SURVEY_AUTO_NUMBER_FIELD is not defined');
|
||||
}
|
||||
|
||||
const appId = parseInt(process.env.TEST_SURVEY_ID);
|
||||
const fieldId = parseInt(process.env.TEST_SURVEY_AUTO_NUMBER_FIELD);
|
||||
const filter = new QueryFilter(fieldId, FilterOperators.GreaterThan, 0);
|
||||
const request = new QueryRecordsRequest(appId, filter.toString());
|
||||
const response = await client.queryRecords(request);
|
||||
|
||||
expect(response.statusCode).to.equal(200);
|
||||
expect(response.isSuccessful).to.be.true;
|
||||
expect(response.message).to.equal('');
|
||||
expect(response.data).to.not.be.null;
|
||||
|
||||
if (response.data != null) {
|
||||
expect(response.data.pageNumber).to.not.be.null;
|
||||
expect(response.data.pageSize).to.not.be.null;
|
||||
expect(response.data.totalPages).to.not.be.null;
|
||||
expect(response.data.totalRecords).to.not.be.null;
|
||||
|
||||
response.data.items.forEach((record) => {
|
||||
expect(record.appId).to.equal(appId);
|
||||
expect(record.recordId).to.not.be.null;
|
||||
expect(record.fieldData).to.not.be.null;
|
||||
|
||||
if (record.fieldData != null) {
|
||||
record.fieldData.forEach((field) => {
|
||||
expect(field.fieldId).to.not.be.null;
|
||||
expect(field.value).to.not.be.null;
|
||||
expect(field.type).to.not.be.undefined;
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
it('should return records when data format, paging information, and fields are passed as parameters', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_SURVEY_ID === undefined) {
|
||||
expect.fail('TEST_SURVEY_ID is not defined');
|
||||
}
|
||||
|
||||
if (process.env.TEST_SURVEY_AUTO_NUMBER_FIELD === undefined) {
|
||||
expect.fail('TEST_SURVEY_AUTO_NUMBER_FIELD is not defined');
|
||||
}
|
||||
|
||||
const appId = parseInt(process.env.TEST_SURVEY_ID);
|
||||
const fieldId = parseInt(process.env.TEST_SURVEY_AUTO_NUMBER_FIELD);
|
||||
const filter = new QueryFilter(fieldId, FilterOperators.GreaterThan, 0);
|
||||
const request = new QueryRecordsRequest(
|
||||
appId,
|
||||
filter.toString(),
|
||||
[fieldId],
|
||||
DataFormat.Formatted,
|
||||
new PagingRequest(1, 1)
|
||||
);
|
||||
|
||||
const response = await client.queryRecords(request);
|
||||
|
||||
expect(response.statusCode).to.equal(200);
|
||||
expect(response.isSuccessful).to.be.true;
|
||||
expect(response.message).to.equal('');
|
||||
expect(response.data).to.not.be.null;
|
||||
|
||||
if (response.data != null) {
|
||||
expect(response.data.pageNumber).to.not.be.null;
|
||||
expect(response.data.pageSize).to.not.be.null;
|
||||
expect(response.data.totalPages).to.not.be.null;
|
||||
expect(response.data.totalRecords).to.not.be.null;
|
||||
|
||||
response.data.items.forEach((record) => {
|
||||
expect(record.appId).to.equal(appId);
|
||||
expect(record.recordId).to.not.be.null;
|
||||
expect(record.fieldData).to.not.be.null;
|
||||
|
||||
if (record.fieldData != null) {
|
||||
record.fieldData.forEach((field) => {
|
||||
expect(field.fieldId).to.not.be.null;
|
||||
expect(field.value).to.not.be.null;
|
||||
expect(field.type).to.not.be.undefined;
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
it('should return a 400 error if page size is invalid', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
const request = new QueryRecordsRequest(1, '', [], DataFormat.Formatted, {
|
||||
pageNumber: 1,
|
||||
pageSize: 1001,
|
||||
});
|
||||
|
||||
const response = await client.queryRecords(request);
|
||||
|
||||
expect(response.statusCode).to.equal(400);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.not.be.null.and.not.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
|
||||
it('should return a 401 error if the API key is invalid', async function () {
|
||||
const client = new OnspringClient(baseURL, 'invalid');
|
||||
const request = new QueryRecordsRequest(1, '');
|
||||
const response = await client.queryRecords(request);
|
||||
|
||||
expect(response.statusCode).to.equal(401);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
|
||||
it('should return a 403 error if the API key does not have access to the app', async function () {
|
||||
const client = new OnspringClient(baseURL, apiKey);
|
||||
|
||||
if (process.env.TEST_APP_ID_NO_ACCESS === undefined) {
|
||||
expect.fail('TEST_APP_ID_NO_ACCESS is not defined');
|
||||
}
|
||||
|
||||
if (process.env.TEST_SURVEY_AUTO_NUMBER_FIELD === undefined) {
|
||||
expect.fail('TEST_SURVEY_AUTO_NUMBER_FIELD is not defined');
|
||||
}
|
||||
|
||||
const appId = parseInt(process.env.TEST_APP_ID_NO_ACCESS);
|
||||
const fieldId = parseInt(process.env.TEST_SURVEY_AUTO_NUMBER_FIELD);
|
||||
const filter = new QueryFilter(fieldId, FilterOperators.GreaterThan, 0);
|
||||
const request = new QueryRecordsRequest(appId, filter.toString());
|
||||
const response = await client.queryRecords(request);
|
||||
|
||||
expect(response.statusCode).to.equal(403);
|
||||
expect(response.isSuccessful).to.be.false;
|
||||
expect(response.message).to.not.be.null.and.not.be.undefined;
|
||||
expect(response.data).to.be.null;
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user