fix: organize integration tests according to method targets. fix: set timeouts and retries for integration tests

2023-02-14 23:49:18 -06:00
parent 97ae716e93
commit d314b1745b
8 changed files with 33 additions and 18 deletions
@@ -0,0 +1,66 @@
+import { OnspringClient } from '../../src/index';
+import { expect } from 'chai';
+import { baseURL, apiKey } from '../mochaRootHooks';
+
+describe('getAppById', function () {
+  this.timeout(30000);
+  this.retries(3);
+
+  it('should return an app', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+
+    if (process.env.TEST_APP_ID === undefined) {
+      return expect.fail('TEST_APP_ID is not defined');
+    }
+
+    const appId = parseInt(process.env.TEST_APP_ID);
+    const response = await client.getAppById(appId);
+
+    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.id).to.equal(appId);
+      expect(response.data.name).to.not.be.null;
+      expect(response.data.href).to.not.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.getAppById(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 api key does not have access to the requested app', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+
+    if (process.env.TEST_APP_ID_NO_ACCESS === undefined) {
+      return expect.fail('TEST_APP_ID_NO_ACCESS is not defined');
+    }
+
+    const appId = parseInt(process.env.TEST_APP_ID_NO_ACCESS);
+    const response = await client.getAppById(appId);
+
+    expect(response.statusCode).to.equal(403);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.not.be.undefined.and.not.be.null;
+    expect(response.data).to.be.null;
+  });
+
+  it('should return a 404 error when an app id cannot be found', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const response = await client.getAppById(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,82 @@
+import { OnspringClient, PagingRequest } from '../../src/index';
+import { expect } from 'chai';
+import { baseURL, apiKey } from '../mochaRootHooks';
+
+describe('getApps', function () {
+  this.timeout(30000);
+  this.retries(3);
+
+  it('should return a paged list of apps', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const response = await client.getApps();
+
+    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;
+      expect(response.data.items).to.not.be.null;
+
+      if (response.data.items != null) {
+        expect(response.data.items.length).to.be.greaterThan(0);
+        response.data.items.forEach((item) => {
+          expect(item.id).to.not.be.null;
+          expect(item.name).to.not.be.null;
+          expect(item.href).to.not.be.null;
+        });
+      }
+    }
+  });
+
+  it('should return a paged list of apps with with correct page size and number when passed paging request', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const response = await client.getApps(new PagingRequest(1, 1));
+
+    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.equal(1);
+      expect(response.data.pageSize).to.equal(1);
+      expect(response.data.totalPages).to.not.be.null;
+      expect(response.data.totalRecords).to.not.be.null;
+      expect(response.data.items).to.not.be.null;
+
+      if (response.data.items != null) {
+        expect(response.data.items.length).to.equal(1);
+        response.data.items.forEach((item) => {
+          expect(item.id).to.not.be.null;
+          expect(item.name).to.not.be.null;
+          expect(item.href).to.not.be.null;
+        });
+      }
+    }
+  });
+
+  it('should return a 400 response when an invalid page size is used', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const response = await client.getApps({ pageNumber: 1, pageSize: 1001 });
+
+    expect(response.statusCode).to.equal(400);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.not.be.undefined.and.not.be.null;
+    expect(response.data).to.be.null;
+  });
+
+  it('should return a 401 response when an invalid api key is used', async function () {
+    const client = new OnspringClient(baseURL, 'invalid');
+    const response = await client.getApps();
+
+    expect(response.statusCode).to.equal(401);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.be.undefined;
+    expect(response.data).to.be.null;
+  });
+});
@@ -0,0 +1,65 @@
+import { OnspringClient } from '../../src/index';
+import { expect } from 'chai';
+import { baseURL, apiKey } from '../mochaRootHooks';
+
+describe('getAppsByIds', function () {
+  this.timeout(30000);
+  this.retries(3);
+
+  it('should return a collection of apps', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const appIds = process.env.TEST_APP_IDS;
+
+    if (appIds === undefined) {
+      return expect.fail('TEST_APP_IDS is not defined');
+    }
+
+    const appIdsAsNumbers = appIds.split(',').map((id) => parseInt(id));
+    const response = await client.getAppsByIds(appIdsAsNumbers);
+
+    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.items).to.not.be.null;
+      expect(response.data.items)
+        .to.be.an('array')
+        .that.has.lengthOf(appIdsAsNumbers.length);
+
+      response.data.items.forEach((item) => {
+        expect(item.id).to.not.be.null;
+        expect(item.name).to.not.be.null;
+        expect(item.href).to.not.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.getAppsByIds([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 api key does not have access to any of the requested app', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const appIds = process.env.TEST_APP_IDS_NO_ACCESS;
+
+    if (appIds === undefined) {
+      return expect.fail('TEST_APP_IDS_NO_ACCESS is not defined');
+    }
+
+    const appIdsAsNumbers = appIds.split(',').map((id) => parseInt(id));
+    const response = await client.getAppsByIds(appIdsAsNumbers);
+
+    expect(response.statusCode).to.equal(403);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.not.be.undefined.and.not.be.null;
+    expect(response.data).to.be.null;
+  });
+});