fix: 'getServicesInstancesFilteredByType' re-implemented (#93)

Author: alex-gilin

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@sap/cf-tools",
 	"displayName": "cf-tools",
-	"version": "1.1.0",
+	"version": "1.1.1",
 	"description": "Cloud Foundry API tools",
 	"bugs": {
 		"url": "https://github.com/sap-staging/cloud-foundry-tools-api.git/issues"

src/cfServicesUtil.ts

@@ -1,14 +1,11 @@
 import { Cli } from "./cli";
 import * as _ from "lodash";
 import { eFilters, ServiceInstanceInfo } from "./types";
-import { cfGetInstanceMetadata, cfGetTarget, cfGetServices, cfGetInstanceKeyParameters, cfGetManagedServiceInstances } from "./cf-local";
-import { padQuerySpace } from "./utils";
+import { cfGetInstanceMetadata, cfGetTarget, cfGetInstanceKeyParameters, cfGetManagedServiceInstances, cfGetServicePlansList } from "./cf-local";
 
 export async function getServicesInstancesFilteredByType(serviceTypes: string[]): Promise<ServiceInstanceInfo[]> {
-    const services = await cfGetServices(await padQuerySpace({ 'filters': [{ key: eFilters.names, value: _.join(_.map(serviceTypes, encodeURIComponent)) }] }));
-    return _.size(services) ? cfGetManagedServiceInstances({
-        'filters': [{ key: eFilters.service_offering_guids, value: _.join(_.map(services, 'guid')) }]
-    }) : [];
+    const guids = _.map(await cfGetServicePlansList({ filters: [{ key: eFilters.service_offering_names, value: _.join(_.map(serviceTypes, encodeURIComponent)) }] }), 'guid');
+    return _.size(guids) ? cfGetManagedServiceInstances({ 'filters': [{ key: eFilters.service_plan_guids, value: _.join(guids) }] }) : [];
 }
 
 /**

tests/cfServicesUtil.spec.ts

@@ -3,12 +3,11 @@ import * as _ from "lodash";
 import { SinonSandbox, SinonMock, createSandbox } from "sinon";
 import * as fsextra from "fs-extra";
 import * as cfLocal from "../src/cf-local";
-import { ITarget, ServiceInfo, ServiceInstanceInfo, eFilters, CF_PAGE_SIZE } from "../src/types";
+import { ITarget, ServiceInstanceInfo, eFilters, PlanInfo } from "../src/types";
 import * as cli from "../src/cli";
 import { getInstanceMetadata, isTargetSet, getInstanceCredentials, createServiceInstance, getServicesInstancesFilteredByType } from "../src/cfServicesUtil";
 import { expect, assert } from "chai";
 import { fail } from "assert";
-import { cfGetConfigFilePath } from "../src/utils";
 
 describe('services unit package tests', () => {
     let sandbox: SinonSandbox;
@@ -37,54 +36,55 @@ describe('services unit package tests', () => {
     });
 
     describe("getServicesInstancesFilteredByType", () => {
-        const spaceGuid = 'space-d2ff128b-e2a8-25f7-828a-24be6173db7b';
-
-        beforeEach(() => {
-            fsExtraMock.expects("readFile").withExactArgs(cfGetConfigFilePath(), "utf8").resolves(`{"SpaceFields": {
-                "GUID": "${spaceGuid}"
-            }}`);
-        });
 
         const types = ['saas-registry', 'audolog'];
-        const services: ServiceInfo[] = [{
+        const plans: PlanInfo[] = [{
             description: 'description1',
             guid: 'd2ff128b-e1a8-15f7-828a-24be6173db7b',
-            label: types[0],
-            service_plans_url: '/v2/services/d2ff128b-A1a8-45f7-828a-24be6173db7b/service_plans'
+            label: 'plan-1',
+            service_offering: {
+                description: 'service description',
+                guid: 'service-guid-1',
+                name: types[0]
+            }
         }, {
             description: 'description2',
-            guid: 'd2ff128b-e2a8-25f7-828a-24be6173db7b',
-            label: types[1],
-            service_plans_url: '/v2/services/d2ff128b-s1a8-45f7-828a-24be6173db7b/service_plans'
+            guid: 'other-e1a8-15f7-828a-24be6173db7b',
+            label: 'plan-2',
+            service_offering: {
+                description: 'service description',
+                guid: 'service-guid-2',
+                name: types[1]
+            }
         }];
         const instances: ServiceInstanceInfo[] = [{ label: "label1", serviceName: types[1] }, { label: "label3", serviceName: types[0] }];
-        const query = { 'filters': [{ key: eFilters.names, value: _.join(_.map(types, encodeURIComponent)) }, { key: eFilters.space_guids, value: spaceGuid }], per_page: CF_PAGE_SIZE };
+        const query = { 'filters': [{ key: eFilters.service_offering_names, value: _.join(_.map(types, encodeURIComponent)) }] };
 
         it("ok:: verify query parameters", async () => {
-            mockCfLocal.expects("cfGetServices").withExactArgs(query).resolves(services);
+            mockCfLocal.expects("cfGetServicePlansList").withExactArgs(query).resolves(plans);
             const servicesQuery = {
                 'filters': [{
-                    key: eFilters.service_offering_guids, value: _.join(_.map(services, 'guid'))
+                    key: eFilters.service_plan_guids, value: _.join(_.map(plans, 'guid'))
                 }]
             };
             mockCfLocal.expects("cfGetManagedServiceInstances").withExactArgs(servicesQuery).resolves(instances);
             assert.deepEqual(_.map(await getServicesInstancesFilteredByType(types), 'label'), [instances[0].label, instances[1].label]);
         });
 
         it("ok:: nothing match requested services", async () => {
-            mockCfLocal.expects("cfGetServices").withExactArgs(query).resolves([]);
-            expect(_.size(await getServicesInstancesFilteredByType(types))).to.be.equal(0);
+            const query = { 'filters': [{ key: eFilters.service_offering_names, value: encodeURIComponent('my type') }] };
+            mockCfLocal.expects("cfGetServicePlansList").withExactArgs(query).resolves(undefined);
+            expect(_.size(await getServicesInstancesFilteredByType(['my type']))).to.be.equal(0);
         });
 
         it("ok:: undefined services requested", async () => {
-            const query = { 'filters': [{ key: eFilters.names, value: _.join(_.map(null, encodeURIComponent)) }, { key: eFilters.space_guids, value: spaceGuid }], per_page: CF_PAGE_SIZE };
-            mockCfLocal.expects("cfGetServices").withExactArgs(query).resolves([]);
+            const query = { 'filters': [{ key: eFilters.service_offering_names, value: _.join(_.map(null, encodeURIComponent)) }] };
+            mockCfLocal.expects("cfGetServicePlansList").withExactArgs(query).resolves([]);
             expect(_.size(await getServicesInstancesFilteredByType(null))).to.be.equal(0);
         });
 
         it("exception:: cfGetManagedServiceInstances throws error", async () => {
-            const query = { 'filters': [{ key: eFilters.names, value: _.join(_.map(types, encodeURIComponent)) }, { key: eFilters.space_guids, value: spaceGuid }], per_page: CF_PAGE_SIZE };
-            mockCfLocal.expects("cfGetServices").withExactArgs(query).resolves(services);
+            mockCfLocal.expects("cfGetServicePlansList").withExactArgs(query).resolves(plans);
             const error = new Error("cfGetManagedServiceInstances failed");
             mockCfLocal.expects("cfGetManagedServiceInstances").throws(error);
             try {