Merge pull request #64 from CloudBoltSoftware/feature/ENG-24556-add-catalog-settings

ENG-24556 updated test for catalog settings

Author: bernardthered

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbolt/cb-api-helper",
-  "version": "0.5.8",
+  "version": "0.5.9",
   "scripts": {
     "co:login": "aws sso login && aws codeartifact login --tool npm --repository cloudbolt-npm --domain cloudbolt --domain-owner 499620025628",
     "husky:install": "husky install",

package.json

@@ -0,0 +1,15 @@
+import crud from '../../../crudOperations'
+
+const URL = 'v3/cmp/settings'
+
+export default {
+  /**
+   * Retrieve Settings for mainly the Catalog
+   * @param options Optionally select specific fields that can be returned alone.
+   * example: '/?fields=catalogViewingMode' only returns the catalogViewingMode value
+   * Full list: runQuickSetup,catalogViewingMode,catalogShowCategoriesFilter,
+   * catalogShowOsBuildsFilter,catalogShowResourceTypesFilter,catalogShowGroupsFilter
+   * @returns {Promise} API Response of the Settings object, or the specific fields requested
+   */
+  list: (options) => crud.getItems(URL, options)
+}

src/api/services/v3/cmp/SettingsService.js

@@ -0,0 +1,17 @@
+import { baseApi } from '../../../baseApi'
+import SettingsService from './SettingsService'
+
+test('settings calls the correct endpoint', async () => {
+  const mockFn = jest.spyOn(baseApi, 'get').mockResolvedValue({})
+  await SettingsService.list()
+  expect(mockFn).toHaveBeenCalledWith('/v3/cmp/settings/')
+})
+
+test('settings list passes options correctly', async () => {
+  const testOptions = '?fields=runQuickSetup'
+  const mockFn = jest.spyOn(baseApi, 'get').mockResolvedValue({
+    data: { runQuickSetup: 'true' }
+  })
+  await SettingsService.list(testOptions)
+  expect(mockFn).toHaveBeenCalledWith('/v3/cmp/settings/?fields=runQuickSetup')
+})

src/api/services/v3/cmp/SettingsService.test.js

@@ -34,6 +34,7 @@ import RolesService from './RolesService'
 import ServerActionsService from './ServerActionsService'
 import ServerService from './ServerService'
 import ServerSummaryService from './ServerSummaryService'
+import SettingsService from './SettingsService'
 import SystemService from './SystemService'
 import UiExtensionComponentsService from './UiExtensionComponentsService'
 import UserService from './UserService'
@@ -76,6 +77,7 @@ export default {
   serverActions: ServerActionsService,
   serverSummary: ServerSummaryService,
   servers: ServerService,
+  settings: SettingsService,
   uiExtensionComponents: UiExtensionComponentsService,
   users: UserService
 }

src/api/services/v3/cmp/index.js

@@ -44,6 +44,7 @@ const services = [
   'serverActions',
   'serverSummary',
   'servers',
+  'settings',
   'uiExtensionComponents',
   'users'
 ]