@sap/cds-dk 4.9.7 → 6.0.1

package/lib/k8s/event-mesh/index.js

@@ -0,0 +1,53 @@
+const wrapFeature = require('../wrapFeature');
+const { cds } = require('../modules');
+const LOG = cds.log();
+
+module.exports = wrapFeature('event_mesh', {
+    async isRequired(context) {
+        const env = await context.get('env');
+        return eventMeshServices(env).length > 0;
+    },
+
+    async getServiceBindings() {
+        return {
+            messaging: {
+                serviceInstanceName: 'event-mesh'
+            }
+        };
+    },
+
+    async getChartCapabilities() {
+        return {
+            "event_mesh": {
+                serviceOfferingName: 'enterprise-messaging',
+                servicePlanName: 'default',
+                config: 'event-mesh.json'
+            }
+        }
+    },
+
+    async addToChart(builder, { 'event_mesh': eventMesh }) {
+        await builder.addAllTemplates(__dirname);
+
+        const { config } = eventMesh;
+        if (config) {
+            if (!await builder.addChartFile(config, { optional: true })) {
+                LOG.warn(`Please add the "${config}" file to the chart folder.`);
+            }
+        }
+    }
+});
+
+function eventMeshServices(env) {
+    const kinds = [ '$', '$-http', '$-amqp', '$-shared', 'default-messaging' ].reduce( (map, key) => {
+        map[key.replace(/\$/, 'enterprise-messaging')] = true;
+        return map;
+    }, {});
+    const names = [];
+    for (const name in env.requires) {
+        const service = env.requires[name];
+        if (!kinds[name] && kinds[service.kind]) names.push(name);
+    }
+
+    return names;
+}

package/lib/k8s/event-mesh/lib.js

@@ -0,0 +1,9 @@
+const Path = require("path");
+
+async function addTemplates(builder) {
+  await builder.addTemplate(Path.join(__dirname, "resources/templates"), 'event-mesh.yaml');
+}
+
+module.exports = {
+  addTemplates
+};

package/lib/k8s/event-mesh/templates/event-mesh.yaml

@@ -0,0 +1 @@
+{{- include "cap.service-instance" . }}

package/lib/k8s/hana-deployer/index.js

@@ -0,0 +1,38 @@
+const wrapFeature = require('../wrapFeature');
+
+module.exports = wrapFeature('hana_deployer', {
+    async isRequired(context) {
+        const env = await context.get('env');
+        return env.requires.db && (env.requires.db.kind === 'sql' || env.requires.db.kind === 'hana');
+    },
+
+    async getChartCapabilities(context) {
+        const model = await context.get('model');
+
+        return {
+            hana_deployer: {
+                image: {
+                    repository: '<your-container-registry>/'+model.app.name+'-hana-deployer',
+                    tag: 'latest'
+                },
+                bindings: {
+                    hana: {
+                        fromSecret: null
+                    }
+                }
+            }
+        };
+    },
+
+    getServiceBindings() {
+        return {
+            db: {
+                fromSecret: null
+            }
+        }
+    },
+
+    async addToChart(builder) {
+        await builder.addAllTemplates(__dirname);
+    }
+});

package/lib/k8s/hana-deployer/templates/hana-deployer-job.yaml

@@ -0,0 +1,41 @@
+#
+# HANA single-tenant DB deployment
+#
+{{- if .Values.hana_deployer }}
+  {{- if or (not (hasKey .Values.hana_deployer "enabled")) .Values.hana_deployer.enabled }}
+{{- $ := merge (dict "root" . "name" "hana-deployer") .Values.hana_deployer . }}
+{{- template "cap.expect" (list . "hana_deployer.bindings.hana.fromSecret" "hana_deployer.image.repository") }}
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: {{ .Release.Name }}-hana-deployer
+  labels: {{- include "cap.labels" $ | nindent 4 }}
+  annotations:
+    "helm.sh/hook": "post-install,pre-upgrade"
+    "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
+  namespace: {{ .Release.Namespace }}
+spec:
+  backoffLimit: 4
+  template:
+    metadata:
+      labels:
+        {{- include "cap.labels" $ | nindent 8 }}
+        sidecar.istio.io/inject: "false"
+    spec:
+      restartPolicy: Never
+      {{- include "cap.imagePullSecrets" $ | nindent 6 }}
+      volumes:
+        {{- include "cap.sapcp.bindingsVolumes" $ | nindent 10 }}
+      containers:
+      - name: hana-deployer
+        image: {{ include "cap.image" $ }}
+        imagePullPolicy: {{ include "cap.imagePullPolicy" $ }}
+        env:
+        - name: EXIT
+          value: 'true'
+        volumeMounts:
+          {{- include "cap.sapcp.bindingsVolumeMounts" $ | nindent 10 }}
+---
+{{ include "cap.sapcp.bindings" $ }}
+{{ end }}
+{{ end }}

package/lib/k8s/helm/Release.js

@@ -0,0 +1,80 @@
+const { throwError } = require('../util');
+const { exec } = require('../../util/exec');
+const { yaml } = require('../modules');
+const fs = require('fs').promises;
+const Path = require('path');
+
+async function status({ releaseName, namespace }) {
+    const result = await exec({stdio: [ 'inherit', 'pipe', 'inherit'], acceptStatuses: '*'}) `helm status ${releaseName} --namespace ${namespace}`;
+    if (result.status === 0) {
+        const output = Buffer.from(result.output[1]).toString();
+        const lines = output.split(/[\n\r]+/sg);
+        const status = {};
+        for (const line of lines) {
+            const m = line.match(/\s*([^:]+)\s*:\s*(.*)/);
+            if (m) {
+                status[m[1].toLowerCase()] = m[2];
+            }
+        }
+
+        if (!status.status) throwError(`Internal error: helm status didn't return STATUS value.`);
+        return status;
+    } else {
+        return { name: releaseName, status: 'not found' }
+    }
+}
+
+async function deploy({ options, releaseName, namespace, chartPath, values }) {
+    const valuesArg = formatValues(values);
+    await exec `helm upgrade ${releaseName} ./${chartPath} --install --namespace ${namespace} ${valuesArg && ['--set', valuesArg]} ${formatOptions(options)}`;
+}
+
+async function template({ options, releaseName, namespace, chartPath, values }) {
+    const valuesArg = formatValues(values);
+    await exec `helm template ${releaseName} ./${chartPath} --namespace ${namespace} ${valuesArg && ['--set', valuesArg]} ${formatOptions(options)}`;
+}
+
+function formatOptions(options = {}) {
+    const args = [];
+    if (options.debug) args.push('--debug');
+    return args;
+}
+
+async function undeploy({ releaseName, namespace }) {
+    await exec `helm uninstall ${releaseName} --namespace ${namespace}`;
+}
+
+function formatValues(values) {
+    const valuesArray = collectValues(values);
+    return valuesArray.join(',');
+}
+
+function collectValues(values, prefix = '') {
+    const valuesArray = [];
+
+    for (const name of Reflect.ownKeys(values)) {
+        const value = values[name];
+        if (typeof value === 'object') {
+            valuesArray.push(...collectValues(value, `${prefix}${name}.`));
+        } else if (typeof value !== 'undefined') {
+            // @TODO: Escaping?
+            valuesArray.push(`${prefix}${name}=${values[name]}`);
+        }
+    }
+
+    return valuesArray;
+}
+
+async function values(chartPath) {
+    return yaml.parse(await fs.readFile(Path.join(chartPath, 'values.yaml'), 'utf-8'));
+
+}
+
+
+module.exports = {
+    status,
+    deploy,
+    undeploy,
+    template,
+    values
+}

package/lib/k8s/html5-apps-deployer/index.js

@@ -0,0 +1,43 @@
+const wrapFeature = require('../wrapFeature');
+
+module.exports = wrapFeature('html5_apps_deployer', {
+    async getChartCapabilities(context) {
+        const model = await context.get('model');
+        const projectName = model.app.name;
+        return {
+            'html5_apps_deployer': {
+                cloudService: null,
+                backendDestinations: {},
+                image: {
+                    repository: "<your-container-registry>/" + projectName + "-html5-deployer" ,
+                    tag: "latest"
+                },
+                bindings: {
+                    xsuaa: {
+                        serviceInstanceName: 'xsuaa'
+                    },
+                    destination: {
+                        serviceInstanceName: 'destinations'
+                    },
+                    html5_apps_repo: {
+                        serviceInstanceName: 'html5-apps-repo-host'
+                    }
+                }
+            }
+        }
+    },
+
+    getDestinationsParameters() {
+        return {
+            HTML5Runtime_enabled: true
+        }
+    },
+
+    isHtml5AppsRepoHostRequired() {
+        return true;
+    },
+
+    async addToChart(builder) {
+        await builder.addAllTemplates(__dirname);
+    }
+});

package/lib/k8s/html5-apps-deployer/templates/_html5_deployment_helpers.tpl

@@ -0,0 +1,16 @@
+{{/*
+Backend Destinations
+*/}}
+{{- define "cap.backendDestinations" -}}
+{{- $ := . -}}
+{{- $destinations := list -}}
+{{- range $destinationName, $destination := .backendDestinations -}}
+    {{- $destination := merge (dict "name" $destinationName) $destination -}}
+    {{- $deployment := (get $.root.Values $destination.service) -}}
+    {{- $srv := merge (dict "name" $destination.service "destination" $destination "deployment" $deployment) $.root -}}
+    {{- $destinationHost := include "cap.deploymentHost" $srv -}}
+    {{- $currentDestination := dict "Name" $destination.name "Type" "HTTP" "ProxyType" "Internet" "URL" (print  "https://" $destinationHost "." $.root.Values.global.domain ($destination.path | default "")) "Authentication" "NoAuthentication" "sap.cloud.service" $.cloudService "HTML5.forwardAuthToken" "true" -}}
+    {{- $destinations = (append $destinations $currentDestination) -}}
+{{- end -}}
+{{- $destinations | toJson }}
+{{- end -}}

package/lib/k8s/html5-apps-deployer/templates/html5-apps-deployer-job.yaml

@@ -0,0 +1,53 @@
+{{- if .Values.html5_apps_deployer }}
+  {{- if or (not (hasKey .Values.html5_apps_deployer "enabled")) .Values.html5_apps_deployer.enabled }}
+
+{{- $ := merge (dict "root" . "name" "html5-apps-deployer") .Values.html5_apps_deployer . }}
+{{- if $.backendDestinations }}
+  {{- if not (.Values.destinations.parameters.HTML5Runtime_enabled) }}
+    {{- fail "destinations.parameters.HTML5Runtime_enabled must be set to true for use with Launchpad Service" }}
+  {{- end }}
+{{- end }}
+{{- template "cap.expect" (list . "html5_apps_deployer.image.repository") }}
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: {{ .Release.Name }}-html5-apps-deployer
+  namespace: {{ .Release.Namespace }}
+  labels: {{- include "cap.labels" $ | nindent 4 }}
+  annotations:
+    "helm.sh/hook": "post-install,post-upgrade"
+    "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
+spec:
+  backoffLimit: 4
+  template:
+    metadata:
+      labels:
+        {{- include "cap.labels" $ | nindent 8 }}
+        sidecar.istio.io/inject: "false"
+    spec:
+      {{- include "cap.imagePullSecrets" $ | nindent 6 }}
+      restartPolicy: Never
+      volumes:
+        {{- include "cap.sapcp.bindingsVolumes" $ | nindent 10 }}
+      containers:
+      - name: html5-deployer
+        image: {{ include "cap.image" $ }}
+        imagePullPolicy: {{ include "cap.imagePullPolicy" $ }}
+        volumeMounts:
+          {{- include "cap.sapcp.bindingsVolumeMounts" $ | nindent 10 }}
+        env:
+          - name: EXIT_PROCESS_AFTER_UPLOAD
+            value: "true"
+          - name: PORT
+            value: "5000"
+            # TODO: cloud service should be configurable in the HTML5 apps
+          - name: SAP_CLOUD_SERVICE
+            value: {{ $.cloudService }}
+            # TODO: destination name should be configurable in the HTML5 apps
+          - name: BACKEND_DESTINATIONS
+            value: >
+              {{ include "cap.backendDestinations" $ }}
+---
+{{ include "cap.sapcp.bindings" $ }}
+  {{- end }}
+{{- end }}

package/lib/k8s/html5-apps-repo-host/index.js

@@ -0,0 +1,26 @@
+const wrapFeature = require('../wrapFeature');
+
+module.exports = wrapFeature('html5_apps_repo_host', {
+
+    async isRequired(context) {
+        return await context.collectBool('isHtml5AppsRepoHostRequired');
+    },
+
+    async getChartCapabilities() {
+        return {
+            'html5_apps_repo_host': {
+                serviceOfferingName: 'html5-apps-repo',
+                servicePlanName: 'app-host'
+            }
+        }
+    },
+
+    async addToChart(builder, { html5_apps_repo_host }) {
+        await builder.addAllTemplates(__dirname);
+
+        const { config } = html5_apps_repo_host;
+        if (config) {
+            await builder.addChartFile(config);
+        }
+    }
+});

package/lib/k8s/html5-apps-repo-host/lib.js

@@ -0,0 +1,16 @@
+function checkNeedDestinations(env) {
+  const kinds = [ 'odata', 'odata-v2', 'odata-v4', 'rest' ].reduce( (map, key) => {
+      map[key] = true;
+      return map;
+  }, {});
+  for (const service in env.requires) {
+      const require = env.requires[service];
+      if (!kinds[service] && kinds[require.kind]) return true;
+  }
+
+  return false;
+}
+
+module.exports = {
+  checkNeedDestinations
+};

package/lib/k8s/html5-apps-repo-host/templates/html5-apps-repo-host.yaml

@@ -0,0 +1 @@
+{{- include "cap.service-instance" . }}

package/lib/k8s/index.js

@@ -0,0 +1,153 @@
+const Context = require('./Context');
+const buildModel = require('./buildModel');
+const ChartAdder = require('./ChartAdder');
+const ChartBuilder = require('./ChartBuilder');
+const { resource, mergeDeep, readFileIfExists } = require('./util');
+const fs = require('fs');
+const Path = require('path');
+const { cds, yaml } = require('./modules');
+
+async function context(projectPath, features = []) {
+    if (!Path.isAbsolute(projectPath)) projectPath = Path.join(process.cwd(), projectPath);
+
+    const projectEnv = cds.env.for('cds', projectPath);
+    process.env.NODE_ENV='production';
+    process.env.CDS_ENV='production';
+    const productiveEnv = cds.env.for('cds', projectPath);
+
+    const config = JSON.parse(JSON.stringify(projectEnv.k8s || {}));
+
+    const context = new Context({
+        projectPath,
+        config,
+        'effective-config': context => effectiveConfig(context),
+        features: featuresFactory(features),
+        env: productiveEnv,
+        model: buildModel,
+        auth: require('./xsuaa'),
+        multitenancy: require('./multitenancy'),
+        'hana-deployer': require('./hana-deployer'),
+        connectivity: require('./connectivity'),
+        destinations: require('./destinations'),
+        'event-mesh': require('./event-mesh'),
+        'auditlog': require('./auditlog'),
+        'html5-apps-deployer': require('./html5-apps-deployer'),
+        'html5-apps-repo-host': require('./html5-apps-repo-host'),
+        'srv': require('./deployment'),
+    });
+
+    return context;
+}
+
+// eslint-disable-next-line no-unused-vars
+async function addChart(context, path = 'chart', _features) {
+    const model = await context.get('model');
+
+    const mergeSemantics = {
+        existences: []
+    };
+
+    context.add('chartPath', path);
+
+    await context.forEach('prepareChart',
+        async plugin => plugin.prepareChart()
+    );
+
+    // Collect chart values
+    let chartValues = {};
+    await context.forEach('getChartValues',
+        async plugin => chartValues = {...chartValues, ...await plugin.getChartValues()}
+    );
+
+    // Collect deployments
+    let deployments = {};
+    await context.forEach('getChartDeployments',
+        async plugin => deployments = {...deployments, ...await plugin.getChartDeployments(context)}
+    );
+
+    // Extend deployments
+    for (const name in deployments) {
+        await context.forEach('extendChartDeployment',
+            async plugin => await plugin.extendChartDeployment(context, name, deployments[name], mergeSemantics)
+        );
+    }
+
+    Object.assign(chartValues, deployments);
+
+    // Collect capabilities
+    let capabilities = {};
+    await context.forEach('getChartCapabilities',
+        async plugin => capabilities = {...capabilities, ...await plugin.getChartCapabilities(context)}
+    );
+
+    Object.assign(chartValues, capabilities);
+
+    // Collect chart dependencies (subcharts)
+    let chartDependencies = [];
+    await context.forEach('getChartDependencies',
+        async plugin => chartDependencies.push(...await plugin.getChartDependencies(context))
+    );
+
+    // Create chart
+    const projectPath = await context.get('projectPath');
+    const builder = new ChartBuilder({ path, rootPath: projectPath });
+    await builder.begin();
+
+    const chartAdder = new ChartAdder({ builder, chartValues, chartDependencies, template: resource('helm/chart'), app: model.app, mergeSemantics });
+    await chartAdder.execute();
+
+    let values;
+    try {
+        values = await chartAdder.getSavedValues();
+    } catch (error) {
+        console.log('Skip adding features because of broken chart/values.yaml file.')
+    }
+
+    if (values) await context.forEach('addToChart', async plugin => plugin.addToChart(builder, values));
+
+    await builder.end();
+}
+
+
+async function hasChart(context, path = 'chart') {
+    return fs.existsSync(path);
+}
+
+function featuresFactory(_features) {
+    return async function(context) {
+        const features = new Set(_features);
+
+        // Collect enabled features
+        const effectiveConfig = await context.get('effective-config');
+        for (const name in effectiveConfig) {
+            const entry = effectiveConfig[name];
+            if (entry && entry.enabled !== false) features.add(name);
+        }
+
+        return features;
+    }
+}
+
+async function effectiveConfig(context) {
+    const skeleton = { images: {} };
+    let result;
+
+    const chartPath = context.has('chartPath') ? await context.get('chartPath') : 'chart';
+    const valuesFile = await readFileIfExists(Path.join(chartPath, 'values.yaml'), 'utf-8');
+    if (valuesFile) {
+        const values = yaml.parse(valuesFile);
+        const config = await context.get('config');
+        result = mergeDeep(values, config);
+    } else {
+        result = await context.get('config');
+    }
+
+    return Object.assign(skeleton, result);
+}
+
+module.exports = {
+    context,
+    addChart,
+    hasChart,
+    effectiveConfig
+}

package/lib/k8s/modules.js

@@ -0,0 +1,36 @@
+/* @sap/cds */
+const cds = require('@sap/cds/lib');
+const cds_cli = require('@sap/cds/bin/cds');
+
+/* @sap/cds-dk */
+const term = require('../util/term');
+const ProjectReader = require('../init/util/projectReader');
+const TemplateBase = require('../init/template/templateBase');
+const CDSGenerator = require('../init/index');
+
+/* @sap/cds-foss */
+const yaml = require("@sap/cds-foss")("yaml");
+
+/* other FOSS */
+const glob = require('glob');
+const xmlJs = require('xml-js');
+
+module.exports = {
+    /* @sap/cds */
+    cds,
+    cds_cli,
+    env: cds.env,
+
+    /* @sap/cds-dk */
+    term,
+    ProjectReader,
+    TemplateBase,
+    CDSGenerator,
+
+    /* @sap/cds-foss */
+    yaml,
+
+    /* other FOSS */
+    glob,
+    xmlJs
+};

package/lib/k8s/multitenancy/index.js

@@ -0,0 +1,24 @@
+const wrapFeature = require('../wrapFeature');
+
+module.exports = wrapFeature('multitenancy', {
+    /**
+     * @param {import('../ChartBuilder')} builder
+     */
+     async addToChart(builder, { multitenancy }) {
+        await builder.addAllTemplates(__dirname);
+
+        if (multitenancy.config) {
+            await builder.addChartFile(multitenancy.config);
+        }
+    },
+
+    // eslint-disable-next-line no-unused-vars
+    async getChartCapabilities(context) {
+        return {
+            xsuaa: {
+                serviceOfferingName: 'saas-registry',
+                servicePlanName: 'application'
+            }
+        }
+    },
+});

package/lib/k8s/multitenancy/lib.js

@@ -0,0 +1,25 @@
+const { exec } = require("../../util/exec");
+const Path = require("path");
+
+async function renderXsSecurityJson(projectPath) {
+  const result = await exec({
+    cwd: projectPath,
+    stdio: ["inherit", "pipe", "inherit"],
+  })`cds compile srv -2 xsuaa`;
+  const xsSecurityJson = result.stdout;
+  return xsSecurityJson;
+}
+
+/**
+ * @param {import('../ChartBuilder')} builder
+ */
+async function addTemplates(builder) {
+  const templates = Path.join(__dirname, 'templates');
+  await builder.addTemplate(templates, 'xsuaa.yaml');
+  await builder.addTemplate(templates, 'registry.yaml');
+}
+
+module.exports = {
+  renderXsSecurityJson,
+  addTemplates
+};

package/lib/k8s/multitenancy/templates/saas-registry.yaml

@@ -0,0 +1,19 @@
+{{- if (default dict .Values.multitenancy).enabled }}
+  {{- $srvHostFull := include "cap.deploymentHostFull" (merge (dict "name" "srv" "deployment" .Values.srv) . ) }}
+  {{- $defaultAppUrls := dict
+    "getDependencies" (print "https://" $srvHostFull "/mtx/v1/provisioning/dependencies")
+    "onSubscription" (print "https://" $srvHostFull "/mtx/v1/provisioning/tenant/{tenantId}")
+    "onSubscriptionAsync" false
+    "onUnSubscriptionAsync" false
+    "callbackTimeoutMillis" 300000
+  }}
+  {{- $defaultParameters := dict
+      "xsappname" .Values.xsuaa.parameters.xsappname
+      "appName" .Values.xsuaa.parameters.xsappname
+      "displayName" .Chart.Name
+      "description" .Chart.Description
+      "category" "CAP Application"
+      "appUrls" $defaultAppUrls
+  }}
+  {{- include "cap.service-instance" (merge (dict "defaultParameters" $defaultParameters . )) }}
+{{ end }}

package/lib/k8s/readProject.js

@@ -0,0 +1,14 @@
+
+
+const { ProjectReader, TemplateBase, CDSGenerator } = require('./modules');
+
+async function readProject(path = '') {
+        /* TODO: Ugly way to access project information -> talk to the guys */
+        const reader = new ProjectReader(new ProjectTemplate(path, new CDSGenerator(), ''));
+        return await reader.read();
+}
+
+class ProjectTemplate extends TemplateBase {
+}
+
+module.exports = readProject;

package/lib/k8s/resources/helm/chart/templates/NOTES.txt

@@ -0,0 +1,11 @@
+Thank you for installing {{ .Chart.Name }} version {{ .Chart.Version }}.
+
+The release "{{ .Release.Name }}" is installed in namespace "{{ .Release.Namespace }}".
+
+Your services are available at:
+{{- $root := . }}
+{{- range $name := include "cap.deploymentNames" . | split ";" }}
+  {{- $deployment := (get $root.Values $name) }}
+  {{- $ := merge (dict "name" $name "deployment" $deployment) $root }}
+  - https://{{ include "cap.deploymentHostFull" $ }}
+{{- end }}