Add support for connections via cds bind

.gitignore

@@ -74,3 +74,6 @@ default-*.json
 
 /secrets
 yarn.lock
+
+# added by cds bind
+.cdsrc-private.json

CHANGELOG.json

@@ -1,4 +1,11 @@
 [
+    {
+        "date": "2022-05-20",
+        "version": "3.202205.4",
+        "Changed": [
+            "Add connection support for [`cds bind`](https://cap.cloud.sap/docs/advanced/hybrid-testing#bind-to-cloud-services) and the resulting `.cdsrc-private.json`. Note this will make each command take a few seconds longer as credentials are no longer stored locally but looked up from cf or k8s dynamically with each command"
+        ]
+    },
     {
         "date": "2022-05-12",
         "version": "3.202205.3",

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [3.202205.4] - 2022-05-20
+
+**Changed**
+
+- Add connection support for [`cds bind`](https://cap.cloud.sap/docs/advanced/hybrid-testing#bind-to-cloud-services) and the resulting `.cdsrc-private.json`. Note this will make each command take a few seconds longer as credentials are no longer stored locally but looked up from cf or k8s dynamically with each command
+
 ## [3.202205.3] - 2022-05-12
 
 **Changed**

_i18n/messages.properties

@@ -232,6 +232,7 @@ requestedVersion=Requested Node.js Version: {0}
 versionCheckFail=Node.js version wanted: {0},  but found: {1}
 warning=Warning!
 cds-dk=To use the openAPI feature you must install @sap/cds-dk as a separate global module
+cds-dk2=To use the cds bind feature for connections, you must install @sap/cds-dk as a separate global module
 gui.tableType=Table Type
 gui.fields=Fields
 gui.constraints=Constraints

bin/openDBExplorer.js

@@ -14,7 +14,7 @@ export function handler (argv) {
 export async function getDBX(prompts) {
     base.debug('getDBX')
     try {
-        let options = conn.getConnOptions(prompts)
+        let options = await conn.getConnOptions(prompts)
 
         const host = options.hana.host
         let dbxURL = ''

bin/systemInfo.js

@@ -45,7 +45,7 @@ export async function sysInfo(prompts) {
       }
 
       case OUTPUTS.ENV: {
-        environmentOutput(prompts)
+        await environmentOutput(prompts)
         break
       }
       case OUTPUTS.DBX: {
@@ -76,14 +76,14 @@ export async function basicOutput() {
   base.outputTable(results)
 }
 
-export function environmentOutput(prompts) {
+export async function environmentOutput(prompts) {
   prompts.disableVerbose = true
-  console.log(conn.getConnOptions(prompts))
+  console.log(await conn.getConnOptions(prompts))
 }
 
 export async function dbxOutput(prompts) {
   prompts.disableVerbose = true
-  let connDetails = conn.getConnOptions(prompts)
+  let connDetails = await conn.getConnOptions(prompts)
   const dbStatus = await base.createDBConnection()
   const dbVersion = await dbInspect.getHANAVersion(dbStatus)
   const unknown = base.bundle.getText("hc.unknown")

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hana-cli",
-  "version": "3.202205.3",
+  "version": "3.202205.4",
   "description": "HANA Developer Command Line Interface",
   "main": "index.js",
   "bin": {

utils/connections.js

@@ -10,6 +10,12 @@ import * as path from 'path'
 import dotenv from 'dotenv'
 import { homedir } from 'os'
 import * as xsenv from '@sap/xsenv'
+import cds from '@sap/cds'
+// @ts-ignore
+const LOG = cds.log('bind')
+import { createRequire } from 'module'
+const require = createRequire(import.meta.url)
+
 
 /**
  * Check parameter folders to see if the input file exists there
@@ -89,6 +95,15 @@ export function getEnv() {
     return getFileCheckParents(`.env`)
 }
 
+/**
+ * Check current and parent directories for a .cdsrc-private.json
+ * @returns {string} - the file path if found 
+ */
+export function getCdsrcPrivate() {
+    base.debug('getCdsrcPrivate')
+    return getFileCheckParents(`.cdsrc-private.json`)
+}
+
 /**
  * Resolve Environment by deciding which option between default-env and default-env-admin we should take
  * @param {*} options 
@@ -108,9 +123,9 @@ export function resolveEnv(options) {
 /**
  * Get Connection Options from input prompts
  * @param {object} prompts - input prompts
- * @returns {object} connection options
+ * @returns {Promise<object>} connection options
  */
-export function getConnOptions(prompts) {
+export async function getConnOptions(prompts) {
     base.debug('getConnOptions')
     delete process.env.VCAP_SERVICES
     let envFile
@@ -120,12 +135,41 @@ export function getConnOptions(prompts) {
         envFile = getDefaultEnvAdmin()
     }
 
-    //No Admin option or no default-env-admin.json file found - try for .env 
+    //No Admin option or no default-env-admin.json file found - try for .cdsrc-private.json and cds bind
     if (!envFile) {
-        let dotEnvFile = getEnv()
-        dotenv.config({ path: dotEnvFile })
+        let cdsrcPrivate = getCdsrcPrivate()
+
+        //No Admin option or no default-env-admin.json file found - try for .env 
+        if (!cdsrcPrivate) {
+            let dotEnvFile = getEnv()
+            dotenv.config({ path: dotEnvFile })
+        } else {
+            try {
+                const data = fs.readFileSync(cdsrcPrivate,
+                { encoding: 'utf8', flag: 'r' })
+                const object = JSON.parse(data)
+                const resolveBinding = require('@sap/cds-dk/lib/bind/bindingResolver').resolver(LOG)
+                let resolvedService = await resolveBinding(null, object.requires['[hybrid]'].db.binding)
+                let options = { hana: resolvedService.credentials }
+                options.hana.pooling = true
+                base.debug(options)
+                base.debug(base.bundle.getText("connectionFile"))
+                base.debug(`.cdsrc-private.json`)
+                if (base.verboseOutput(prompts)) { console.log(`${base.bundle.getText("connFile2")} ${`.cdsrc-private.json`} \n`) }
+                return (options)
+            }
+            catch (e) {
+                if (e.code !== 'MODULE_NOT_FOUND') {
+                    // Re-throw not "Module not found" errors 
+                    throw e
+                  }
+                  throw base.bundle.getText("cds-dk2")
+            }
+        }
     }
 
+
+
     //No .env File found or it doesn't contain a VCAP_SERVICES - try other options
     base.debug(process.env.VCAP_SERVICES)
     base.debug(envFile)
@@ -185,10 +229,10 @@ export function getConnOptions(prompts) {
 }
 
 /**
- * Create Databse Connection 
+ * Create Database Connection 
  * @param {object} prompts - input prompt values
  * @param {boolean} directConnect - Direct Connection parameters are supplied in prompts
- * @returns {Promise<object>} HANA DB conneciton of type hdb
+ * @returns {Promise<object>} HANA DB connection of type hdb
  */
 export async function createConnection(prompts, directConnect = false) {
     base.debug('createConnection')
@@ -198,7 +242,7 @@ export async function createConnection(prompts, directConnect = false) {
     if (directConnect) {
         options.hana = prompts
     } else {
-        options = getConnOptions(prompts)
+        options = await getConnOptions(prompts)
     }
 
     base.debug(`In Create Connection`)