test: adds test cases for installation functions

Author: nadeem-cs

test/unit/installation-test.js

@@ -3,8 +3,9 @@ import { expect } from 'chai'
 import { App } from '../../lib/marketplace/app'
 import { describe, it } from 'mocha'
 import MockAdapter from 'axios-mock-adapter'
-import { appInstallMock, appMock, installationMock } from './mock/objects'
+import { appInstallMock, appMock, installationConfigLocationMock, installationMock, installedAppsMock, installedStacksMock, installedUsersMock } from './mock/objects'
 import { Installation } from '../../lib/marketplace/installation'
+import { WebHooks } from '../../lib/marketplace/installation/webhooks'
 
 describe('Contentstack apps installation test', () => {
   it('Installation without installation uid', done => {
@@ -13,27 +14,35 @@ describe('Contentstack apps installation test', () => {
     expect(installation.fetch).to.be.equal(undefined)
     expect(installation.update).to.be.equal(undefined)
     expect(installation.uninstall).to.be.equal(undefined)
-    expect(installation.findAll).to.be.equal(undefined)
+    expect(installation.fetchAll).to.be.equal(undefined)
     expect(installation.installationData).to.be.equal(undefined)
     expect(installation.configuration).to.be.equal(undefined)
     expect(installation.setConfiguration).to.be.equal(undefined)
+    expect(installation.getConfigLocation).to.be.equal(undefined)
     expect(installation.serverConfig).to.be.equal(undefined)
     expect(installation.setServerConfig).to.be.equal(undefined)
+    expect(installation.webhooks).to.be.equal(undefined)
     done()
   })
 
   it('Installation with app uid', done => {
     const uid = appMock.uid
-    const installation = makeInstallation({ app_uid: uid })
-    expect(installation.urlPath).to.be.equal(undefined)
+    const installation = makeInstallation({ data: { app_uid: uid } })
+    expect(installation.urlPath).to.be.equal('/installations')
     expect(installation.fetch).to.be.equal(undefined)
     expect(installation.update).to.be.equal(undefined)
     expect(installation.uninstall).to.be.equal(undefined)
     expect(installation.installationData).to.be.equal(undefined)
     expect(installation.configuration).to.be.equal(undefined)
     expect(installation.setConfiguration).to.be.equal(undefined)
+    expect(installation.getConfigLocation).to.be.equal(undefined)
     expect(installation.serverConfig).to.be.equal(undefined)
     expect(installation.setServerConfig).to.be.equal(undefined)
+    expect(installation.webhooks).to.be.equal(undefined)
+    expect(installation.fetchAll).to.not.equal(undefined)
+    expect(installation.getInstalledApps).to.not.equal(undefined)
+    expect(installation.getInstalledUsers).to.not.equal(undefined)
+    expect(installation.getInstalledStacks).to.not.equal(undefined)
     done()
   })
 
@@ -47,9 +56,14 @@ describe('Contentstack apps installation test', () => {
     expect(installation.installationData).to.not.equal(undefined)
     expect(installation.configuration).to.not.equal(undefined)
     expect(installation.setConfiguration).to.not.equal(undefined)
+    expect(installation.getConfigLocation).to.not.equal(undefined)
     expect(installation.serverConfig).to.not.equal(undefined)
     expect(installation.setServerConfig).to.not.equal(undefined)
-    expect(installation.findAll).to.be.equal(undefined)
+    expect(installation.webhooks).to.not.equal(undefined)
+    expect(installation.fetchAll).to.be.equal(undefined)
+    expect(installation.getInstalledApps).to.be.equal(undefined)
+    expect(installation.getInstalledUsers).to.be.equal(undefined)
+    expect(installation.getInstalledStacks).to.be.equal(undefined)
     done()
   })
 
@@ -158,6 +172,7 @@ describe('Contentstack apps installation test', () => {
       })
       .catch(done)
   })
+
   it('Set installation configuration test', done => {
     const mock = new MockAdapter(Axios)
     const uid = installationMock.uid
@@ -173,6 +188,7 @@ describe('Contentstack apps installation test', () => {
       })
       .catch(done)
   })
+
   it('Get installation server config test', done => {
     const mock = new MockAdapter(Axios)
     const uid = installationMock.uid
@@ -188,6 +204,7 @@ describe('Contentstack apps installation test', () => {
       })
       .catch(done)
   })
+
   it('Get installation installationData test', done => {
     const mock = new MockAdapter(Axios)
     const uid = installationMock.uid
@@ -232,6 +249,77 @@ describe('Contentstack apps installation test', () => {
       })
       .catch(done)
   })
+
+  it('getConfigLocation call should retrieve uilocation configuration details of an installation', done => {
+    const mock = new MockAdapter(Axios)
+    const uid = installationConfigLocationMock.uid
+    mock.onGet(`/installations/${uid}/locations/configuration`).reply(200, {
+      data: installationConfigLocationMock
+    })
+
+    makeInstallation({ data: { uid } })
+      .getConfigLocation()
+      .then((response) => {
+        expect(response.data).to.be.eql(installationConfigLocationMock)
+        done()
+      })
+      .catch(done)
+  })
+
+  it('should get object of WebHook class when webhooks function is called with uid', () => {
+    const webHook = makeInstallation({ data: { uid: 'uid' } }).webhooks('webhookUid')
+
+    expect(webHook).to.be.instanceOf(WebHooks)
+    expect(webHook.uid).to.be.equal('webhookUid')
+    expect(webHook.listExecutionLogs).to.not.equal(undefined)
+    expect(webHook.getExecutionLog).to.not.equal(undefined)
+    expect(webHook.retryExecution).to.not.equal(undefined)
+  })
+
+  it('getInstalledApps call should fetch all the installed apps in your Contentstack organization', done => {
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/installations/view/apps`).reply(200, {
+      data: installedAppsMock
+    })
+
+    makeInstallation({ data: {} })
+      .getInstalledApps()
+      .then((response) => {
+        expect(response.data).to.be.eql(installedAppsMock)
+        done()
+      })
+      .catch(done)
+  })
+
+  it('getInstalledUsers call should fetch all the installed Users in your Contentstack organization', done => {
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/installations/view/users`).reply(200, {
+      data: installedUsersMock
+    })
+
+    makeInstallation({ data: {} })
+      .getInstalledUsers()
+      .then((response) => {
+        expect(response.data).to.be.eql(installedUsersMock)
+        done()
+      })
+      .catch(done)
+  })
+
+  it('getInstalledStacks call should fetch all the installed Stacks in your Contentstack organization', done => {
+    const mock = new MockAdapter(Axios)
+    mock.onGet(`/installations/view/stacks`).reply(200, {
+      data: installedStacksMock
+    })
+
+    makeInstallation({ data: {} })
+      .getInstalledStacks()
+      .then((response) => {
+        expect(response.data).to.be.eql(installedStacksMock)
+        done()
+      })
+      .catch(done)
+  })
 })
 
 export function checkInstallation (installation) {

test/unit/mock/objects.js

@@ -683,6 +683,43 @@ const branchMergeQueueFindMock = {
   ]
 }
 
+const installationConfigLocationMock = {
+  uid: 'Installation_UID',
+  created_at: '2023-02-28T09:41:01.288Z',
+  updated_at: '2023-02-28T09:41:01.288Z',
+  created_by: 'blt22e22222d22d2f22222a2b2f',
+  updated_by: 'blt22e22222d22d2f22222a2b2f',
+  tags: [],
+  ACL: [],
+  _version: 1,
+  title: 'App Name',
+  config: {},
+  type: 'stack_config_widget',
+  app_installation_uid: '***REMOVED***',
+  app_uid: '***REMOVED***',
+  signed: true,
+  enable: true,
+  src: 'http://localhost:3000/config'
+}
+
+const installedAppsMock = {
+  app1: 'data1',
+  app2: 'data2',
+  app3: 'data3'
+}
+
+const installedUsersMock = {
+  user1: 'data1',
+  user2: 'data2',
+  user3: 'data3'
+}
+
+const installedStacksMock = {
+  stack1: 'data1',
+  stack2: 'data2',
+  stack3: 'data3'
+}
+
 function mockCollection (mockData, type) {
   const mock = {
     ...cloneDeep(noticeMock),
@@ -751,6 +788,10 @@ export {
   branchMergeAllMock,
   branchMergeQueueFindMock,
   branchMergeQueueFetchMock,
+  installationConfigLocationMock,
+  installedAppsMock,
+  installedUsersMock,
+  installedStacksMock,
   mockCollection,
   entryMockCollection,
   checkSystemFields