Merge pull request #87 from SAP/cf

Fix service instance creation and space guid

Author: aleksandr-suvorov

src/model/configuration.ts

@@ -5,8 +5,8 @@ export interface IConfiguration {
     appId?: string;
     appName?: string;
     appVersion?: string;
-    spaceGuid?: string;
-    orgGuid?: string;
+    space?: string;
+    org?: string;
     sapCloudService?: string;
     destination?: string;
     type?: "cf" | "abap";

src/model/types.ts

@@ -10,7 +10,7 @@ export interface ICreateServiceInstanceParams {
     spaceGuid: string;
     planName: string;
     serviceName: string;
-    serviceInstanceName?: string;
+    serviceInstanceName: string;
     tags: string[];
     parameters?: any;
 }

src/repositories/html5RepoManager.ts

@@ -24,7 +24,7 @@ export default class HTML5RepoManager {
 
 
     private static async getHtml5RepoInfo(configuration: IConfiguration): Promise<IHTML5RepoInfo> {
-        const spaceGuid = await CFUtil.getSpaceGuid(configuration?.spaceGuid);
+        const spaceGuid = await CFUtil.getSpaceGuid(configuration?.space);
         const credentials = await this.getHTML5Credentials(spaceGuid);
         const token = await this.getToken(credentials);
         return {
@@ -46,7 +46,8 @@ export default class HTML5RepoManager {
         const createParams: ICreateServiceInstanceParams = {
             spaceGuid,
             planName: PLAN_NAME,
-            serviceName: SERVIСE_INSTANCE_NAME,
+            serviceName: "html5-apps-repo",
+            serviceInstanceName: SERVIСE_INSTANCE_NAME,
             tags: ["html5-apps-repo-rt"]
         };
         const serviceKeys = await CFUtil.getServiceInstanceKeys(getParams, createParams);

src/util/cfUtil.ts

@@ -1,5 +1,6 @@
 import { ICreateServiceInstanceParams, IGetServiceInstanceParams, IResource, IServiceInstance, IServiceKeys, KeyedMap } from "../model/types.js";
-import { cfCreateService, cfGetInstanceCredentials, cfGetTarget } from "@sap/cf-tools/out/src/cf-local.js";
+import { cfCreateService, cfGetInstanceCredentials } from "@sap/cf-tools/out/src/cf-local.js";
+import { getSpaceGuidThrowIfUndefined } from "@sap/cf-tools/out/src/utils.js";
 
 import { Cli } from "@sap/cf-tools/out/src/cli.js";
 import { eFilters } from "@sap/cf-tools/out/src/types.js";
@@ -42,15 +43,19 @@ export default class CFUtil {
 
     static async createService(params: ICreateServiceInstanceParams) {
         log.verbose(`Creating a service instance with parameters: ${JSON.stringify(params)}`);
-        const resources = await this.requestCfApi(`/v3/service_plans?names=${params.planName}&space_guids=${params.spaceGuid}`);
-        const publicPlan = resources.find(resource => resource.visibility_type === "public");
-        if (!publicPlan) {
-            throw new Error(`Cannot find a public plan by name '${params.serviceName}' in space '${params.spaceGuid}'`);
+        const serviceOfferings = await this.requestCfApi(`/v3/service_offerings?names=${params.serviceName}`);
+        if (serviceOfferings.length === 0) {
+            throw new Error(`Cannot find a service offering by name '${params.serviceName}'`);
+        }
+        const plans = await this.requestCfApi(`/v3/service_plans?service_offering_guids=${serviceOfferings[0].guid}`);
+        const plan = plans.find(plan => plan.name === params.planName);
+        if (!plan) {
+            throw new Error(`Cannot find a plan by name '${params.planName}' for service '${params.serviceName}'`);
         }
         try {
-            await cfCreateService(publicPlan.guid, params.serviceName, params.parameters, params.tags);
+            await cfCreateService(plan.guid, params.serviceInstanceName, params.parameters, params.tags);
         } catch (error: any) {
-            throw new Error(`Cannot create a service instance '${params.serviceName}' in space '${params.spaceGuid}': ${error.message}`);
+            throw new Error(`Cannot create a service instance '${params.serviceInstanceName}' in space '${params.spaceGuid}': ${error.message}`);
         }
     }
 
@@ -176,19 +181,8 @@ export default class CFUtil {
      * @memberof CFUtil
      */
     static async getSpaceGuid(spaceGuid?: string): Promise<string> {
-        if (spaceGuid == null) {
-            const spaceName = (await cfGetTarget())?.space;
-            if (spaceName) {
-                const resources = await this.requestCfApi(`/v3/spaces?names=${spaceName}`);
-                for (const resource of resources) {
-                    spaceGuid = resource.guid;
-                    break;
-                }
-            }
-        }
-        if (spaceGuid == null) {
-            throw new Error("Please login to Cloud Foundry with 'cf login' and try again");
-        }
-        return spaceGuid;
+        return spaceGuid ?? getSpaceGuidThrowIfUndefined().catch((e: any) => {
+            throw new Error("Please specify space and org guids in ui5.yaml or login to Cloud Foundry with 'cf login' and try again: " + e.message);
+        });
     }
 }

test/cfUtil.spec.ts

@@ -325,10 +325,25 @@ describe("CFUtil", () => {
     describe("when creating service", () => {
         const SPACE_GUID = "spaceGuid1";
         const NON_EXISTING_SERVICE_INSTANCE = "nonExistingServiceInstance";
+        const SERVICE = "service1";
         const SERVICE_INSTANCE = "serviceInstance1";
-        const PLAN = "serviceInstancePlan";
+        const PLAN = "app-runtime";
 
-        it("should create a service with parameters", async () => {
+        it("should create a service", async () => {
+            await createService(TestUtil.getResource("service_offerings.json"), TestUtil.getResource("service_plans.json"));
+        });
+
+        it("shouldn't find a plan by name", async () => {
+            await expect(createService(TestUtil.getResource("service_offerings.json"), JSON.stringify({ resources: [{ name: "app-something" }] })))
+                .to.be.rejectedWith("Cannot find a plan by name 'app-runtime' for service 'service1'");
+        });
+
+        it("ahouldn't find service offering", async () => {
+            await expect(createService(JSON.stringify({ resources: [] }), TestUtil.getResource("service_plans.json")))
+                .to.be.rejectedWith("Cannot find a service offering by name 'service1'");
+        });
+
+        async function createService(serviceOfferings: string, plans: string) {
             let call = 0;
             const credentialsJson = JSON.parse(TestUtil.getResource("credentials_bs.json"));
             const CFUtil = await esmock("../src/util/cfUtil.js", {}, {
@@ -342,8 +357,10 @@ describe("CFUtil", () => {
                                 } else {
                                     return TestUtil.getStdOut(TestUtil.getResource("service_instances_bs.json"));
                                 }
-                            } else if (args[1] === `/v3/service_plans?names=${PLAN}&space_guids=${SPACE_GUID}`) {
-                                return TestUtil.getStdOut(TestUtil.getResource("service_plans.json"));
+                            } else if (args[1] === `/v3/service_offerings?names=${SERVICE}`) {
+                                return TestUtil.getStdOut(serviceOfferings);
+                            } else if (args[1] === `/v3/service_plans?service_offering_guids=B8F4D0AC-9F30-4C18-B808-D8C1C6E2646E`) {
+                                return TestUtil.getStdOut(plans);
                             }
                         }
                     }
@@ -368,7 +385,8 @@ describe("CFUtil", () => {
                 spaceGuids: [SPACE_GUID],
                 names: [NON_EXISTING_SERVICE_INSTANCE]
             }, {
-                serviceName: SERVICE_INSTANCE,
+                serviceName: SERVICE,
+                serviceInstanceName: SERVICE_INSTANCE,
                 planName: PLAN,
                 spaceGuid: SPACE_GUID,
                 tags: ["tag1"]
@@ -380,33 +398,22 @@ describe("CFUtil", () => {
                     name: "serviceInstance1"
                 }
             });
-        });
+        }
 
     });
 
     describe("when getting space", () => {
         it("should get space from cf if not specified in options", async () => {
             const CFUtil = await esmock("../src/util/cfUtil.js", {}, {
-                "@sap/cf-tools/out/src/cli.js": {
-                    Cli: {
-                        execute: (args: string[]) => {
-                            if (args[1] === `/v3/spaces?names=${SPACE_NAME}`) {
-                                return TestUtil.getStdOut(TestUtil.getResource("spaces.json"))
-                            }
-                        }
-                    }
-                },
-                "@sap/cf-tools/out/src/cf-local.js": {
-                    cfGetTarget: () => Promise.resolve({ space: SPACE_NAME, "api endpoint": "apiEndpoint", "api version": "apiVersion", user: "user" })
+                "@sap/cf-tools/out/src/utils.js": {
+                    getSpaceGuidThrowIfUndefined: () => Promise.resolve("spaceGuid1")
                 }
             });
-            const SPACE_NAME = "spaceName1"
-            const spaceGuid = await CFUtil.getSpaceGuid();
-            expect(spaceGuid).to.equal("spaceGuid1");
+            expect(await CFUtil.getSpaceGuid()).to.equal("spaceGuid1");
         });
 
         it("should return space guid specified in options", async () => {
-            expect(await CFUtil.getSpaceGuid("spaceGuid1")).to.equal("spaceGuid1");
+            expect(await CFUtil.getSpaceGuid("spaceGuid2")).to.equal("spaceGuid2");
         });
     });
 

test/index.spec.ts

@@ -19,8 +19,8 @@ const OPTIONS: IProjectOptions = {
         appId: "appId",
         appName: "appName",
         appVersion: "appVersion",
-        spaceGuid: "spaceGuid",
-        orgGuid: "orgGuid",
+        space: "spaceGuid",
+        org: "orgGuid",
         sapCloudService: "sapCloudService",
         target: {
             url: "https://example.sap.com"

test/processors/processor.spec.ts

@@ -34,8 +34,8 @@ describe("Processor", () => {
             appId: "appId",
             appName: "appName",
             appVersion: "appVersion",
-            spaceGuid: "spaceGuid",
-            orgGuid: "orgGuid",
+            space: "spaceGuid",
+            org: "orgGuid",
             sapCloudService: "sapCloudService"
         });
         expect(processor instanceof CFProcessor)

test/repositories/html5RepoManager.spec.ts

@@ -17,8 +17,8 @@ describe("Html5RepoManager", () => {
             appId: "appId",
             appName: "appName",
             appVersion: "appVersion",
-            spaceGuid: "spaceGuid",
-            orgGuid: "orgGuid",
+            space: "spaceGuid",
+            org: "orgGuid",
             sapCloudService: "sapCloudService"
         }
     };

test/resources/service_offerings.json

@@ -0,0 +1,75 @@
+{
+    "pagination": {
+        "total_results": 1,
+        "total_pages": 1,
+        "first": {
+            "href": "https://api.btp.sap.com/v3/service_offerings?names=html5-apps-repo\u0026page=1\u0026per_page=50"
+        },
+        "last": {
+            "href": "https://api.btp.sap.com/v3/service_offerings?names=html5-apps-repo\u0026page=1\u0026per_page=50"
+        },
+        "next": null,
+        "previous": null
+    },
+    "resources": [
+        {
+            "guid": "B8F4D0AC-9F30-4C18-B808-D8C1C6E2646E",
+            "created_at": "2017-12-14T15:27:22Z",
+            "updated_at": "2025-03-20T07:08:12Z",
+            "name": "html5-apps-repo",
+            "description": "Enables storage of HTML5 applications and provides runtime environment for HTML5 applications.",
+            "available": true,
+            "tags": [
+                "html5appsrepo",
+                "html5-apps-repo-rt",
+                "html5-apps-rt",
+                "html5-apps-repo-dt",
+                "html5-apps-dt"
+            ],
+            "requires": [],
+            "shareable": false,
+            "documentation_url": "https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/11d77aa154f64c2e83cc9652a78bb985.html",
+            "broker_catalog": {
+                "id": "1CBFEF2B-350E-417B-B7BC-0BDE0699CCE3",
+                "metadata": {
+                    "displayName": "HTML5 Application Repository",
+                    "documentationUrl": "https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/11d77aa154f64c2e83cc9652a78bb985.html",
+                    "longDescription": "The HTML5 Application Repository service enables central storage of HTML5 applications in SAP BTP. In runtime, the service enables the consuming application, typically the application router, to access HTML5 application static content in a secure and efficient manner.",
+                    "supportUrl": "https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/9220a2fd35d84c888c0ae870ca62bfb7.html",
+                    "imageUrl": "data:image/svg+xml;base64,PHN2ZyBpZD0iaHRtbDUtYXBwbGljYXRpb25zIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1NiA1NiI+PGRlZnM+PHN0eWxlPi5jbHMtMXtmaWxsOiMwNTNiNzA7fS5jbHMtMntmaWxsOiMwYTZlZDE7fTwvc3R5bGU+PC9kZWZzPjxwYXRoIGNsYXNzPSJjbHMtMSIgZD0iTTQyLjMsMTlhOC4wMDgsOC4wMDgsMCwwLDAtNC4wNzgtNC40QTYuOTQ0LDYuOTQ0LDAsMCwwLDI3Ljc2OSw5LjkyOCw5LjQ1Myw5LjQ1MywwLDAsMCwxOS4wNiw0QzkuMDc4LDQsOS44LDE0LjYyMSw5LjgsMTQuNjIxYTguMzg3LDguMzg3LDAsMCwwLDIuNjEzLDE2LjM2NUgyOC4wMDd2LTNIMTIuNDEzYTUuMzg3LDUuMzg3LDAsMCwxLTEuNjc2LTEwLjUxNWwyLjMwOS0uNzU5TDEyLjc4MywxNC4zYTguMTE0LDguMTE0LDAsMCwxLDEuNS01LjI4NCw2LjQ4NCw2LjQ4NCwwLDAsMSwxMC43LDIuMDIybDEuMzA3LDMuMjlMMjkuMzE4LDEyLjVhMy45MjMsMy45MjMsMCwwLDEsMi4wNDQtLjU5MSwzLjk4OCwzLjk4OCwwLDAsMSwzLjkxNCwzLjI0OWwuMjg5LDEuNTI5LDEuNDE1LjY0NkE0LjgsNC44LDAsMCwxLDM4LjkzMywxOVoiLz48cG9seWdvbiBjbGFzcz0iY2xzLTIiIHBvaW50cz0iMzQuMDcgMjQuNjkxIDM1LjMwOCAyNC42OTEgMzUuMzA4IDI2LjA0NiAzNi42NiAyNi4wNDYgMzYuNjYgMjIgMzUuMzA4IDIyIDM1LjMwOCAyMy4zMzYgMzQuMDcgMjMuMzM2IDM0LjA3IDIyIDMyLjcxOCAyMiAzMi43MTggMjYuMDQ2IDM0LjA3IDI2LjA0NiAzNC4wNyAyNC42OTEiLz48cG9seWdvbiBjbGFzcz0iY2xzLTIiIHBvaW50cz0iMzguNDM5IDI2LjA0NiAzOS43OTIgMjYuMDQ2IDM5Ljc5MiAyMy4zNDIgNDAuOTgzIDIzLjM0MiA0MC45ODMgMjIgMzcuMjQ4IDIyIDM3LjI0OCAyMy4zNDIgMzguNDM5IDIzLjM0MiAzOC40MzkgMjYuMDQ2Ii8+PHBvbHlnb24gY2xhc3M9ImNscy0yIiBwb2ludHM9IjQyLjg5OSAyNC4wNCA0My44MyAyNS40NzkgNDMuODU0IDI1LjQ3OSA0NC43ODQgMjQuMDQgNDQuNzg0IDI2LjA0NiA0Ni4xMzEgMjYuMDQ2IDQ2LjEzMSAyMiA0NC43MiAyMiA0My44NTQgMjMuNDIxIDQyLjk4NiAyMiA0MS41NzYgMjIgNDEuNTc2IDI2LjA0NiA0Mi44OTkgMjYuMDQ2IDQyLjg5OSAyNC4wNCIvPjxwb2x5Z29uIGNsYXNzPSJjbHMtMiIgcG9pbnRzPSI1MC4wNTkgMjQuNzA4IDQ4LjE1NyAyNC43MDggNDguMTU3IDIyIDQ2LjgwNCAyMiA0Ni44MDQgMjYuMDQ2IDUwLjA1OSAyNi4wNDYgNTAuMDU5IDI0LjcwOCIvPjxwb2x5Z29uIGNsYXNzPSJjbHMtMiIgcG9pbnRzPSIzNi4xNyAzNC40OTEgMzYuNjg1IDQwLjI2OCA0MS4zNjMgNDAuMjY4IDQxLjM3NyA0MC4yNjggNDMuOTQ1IDQwLjI2OCA0My43MDIgNDIuOTg2IDQxLjM2MyA0My42MTcgNDEuMzYzIDQzLjYxOCA0MS4zNjEgNDMuNjE4IDM5LjAyNiA0Mi45ODggMzguODc2IDQxLjMxNiAzNy43NDIgNDEuMzE2IDM2Ljc3MSA0MS4zMTYgMzcuMDY1IDQ0LjYwNyA0MS4zNjEgNDUuNzk5IDQxLjM3IDQ1Ljc5NiA0MS4zNyA0NS43OTYgNDUuNjYyIDQ0LjYwNyA0NS42OTMgNDQuMjUzIDQ2LjE4NiAzOC43MzUgNDYuMjM3IDM4LjE3MiA0NS42NzIgMzguMTcyIDQxLjM3NyAzOC4xNzIgNDEuMzYzIDM4LjE3MiAzOC42MDMgMzguMTcyIDM4LjQxMSAzNi4wMjUgNDEuMzcgMzYuMDI1IDQxLjM3NyAzNi4wMjUgNDYuNDI4IDM2LjAyNSA0Ni40MzUgMzYuMDI1IDQ2LjQ3NyAzNS41NTQgNDYuNTczIDM0LjQ5MSA0Ni42MjMgMzMuOTI5IDQxLjM3NyAzMy45MjkgNDEuMzcgMzMuOTI5IDM2LjEyIDMzLjkyOSAzNi4xNyAzNC40OTEiLz48cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0zMC43NCwyNy45LDMyLjY3NCw0OS41OSw0MS4zNTcsNTJsOC43MDYtMi40MTNMNTIsMjcuOVpNNDcuNjg2LDQ3LjM1OCw0MS4zNyw0OS4xMDlsLTYuMzE2LTEuNzUxTDMzLjU2NywzMC43MTZoMTUuNloiLz48L3N2Zz4=",
+                    "serviceInventoryId": "SERVICE-123",
+                    "sm_offering_id": "0F20B7D8-99F3-42F2-A60A-EE4050FA22F0"
+                },
+                "features": {
+                    "plan_updateable": false,
+                    "bindable": true,
+                    "instances_retrievable": false,
+                    "bindings_retrievable": false,
+                    "allow_context_updates": false
+                }
+            },
+            "relationships": {
+                "service_broker": {
+                    "data": {
+                        "guid": "F76A4507-121A-43E5-8BA4-9604F434652D"
+                    }
+                }
+            },
+            "metadata": {
+                "labels": {},
+                "annotations": {}
+            },
+            "links": {
+                "self": {
+                    "href": "https://api.btp.sap.com/v3/service_offerings/B8F4D0AC-9F30-4C18-B808-D8C1C6E2646E"
+                },
+                "service_plans": {
+                    "href": "https://api.btp.sap.com/v3/service_plans?service_offering_guids=B8F4D0AC-9F30-4C18-B808-D8C1C6E2646E"
+                },
+                "service_broker": {
+                    "href": "https://api.btp.sap.com/v3/service_brokers/F76A4507-121A-43E5-8BA4-9604F434652D"
+                }
+            }
+        }
+    ]
+}