@sap/cds-dk 6.1.4 → 6.2.0

package/lib/k8s/deployment/subchart-override/templates/_web_application_helpers.tpl

@@ -1,81 +0,0 @@
-{{/*
-Old Service Bindings: volumes
-*/}}
-{{- define "cap.web-application.serviceVolumes" -}}
-    {{- $ := . -}}
-    {{ range $bindingName, $binding := $.Values.bindings -}}
-        {{- $secret := default (print $.Release.Name "-" $.Chart.Name "-" $bindingName) $binding.fromSecret }}
-- name: {{ $bindingName }}-secret
-  secret:
-    secretName: {{ $secret | quote }}
-      {{- if $.Values.global.oldServiceBindings }}
-- name: {{ $bindingName }}-metadata
-  secret:
-    secretName: {{ $secret | quote }}
-    optional: true
-    items:
-    - key: label
-      path: label
-    - key: plan
-      path: plan
-    - key: tags
-      path: tags
-      {{- end }}
-    {{- end -}}
-{{- end -}}
-
-{{/*
-Service Bindings: env vars
-*/}}
-{{- define "cap.web-application.env" }}
-  {{- $ := . }}
-    {{- range $key, $binding := $.Values.bindings }}
-        {{- $cleanKey := $key | upper | replace "-" "" | replace "_" "" | replace "." "" }}
-        {{- $prefix := print "CDS_ENVIRONMENT_K8S_SERVICEBINDINGS_" $cleanKey }}
-        {{- $secret := default (print $.Release.Name "-" $.Chart.Name "-" $key) $binding.fromSecret }}
-- name: {{ $prefix }}_SERVICE
-  valueFrom:
-    secretKeyRef:
-      name: {{ $secret | quote }}
-      key: label
-- name: {{ $prefix }}_PLAN
-  valueFrom:
-    secretKeyRef:
-      name: {{ $secret | quote }}
-      key: plan
-      optional: true
-  {{- if $.Values.global.oldServiceBindings }}
-- name: CDS_CONFIG
-  value: /etc/secrets/cds
-- name: {{ $prefix }}_SECRETSPATH
-  value: /etc/secrets/cds/requires/{{ $key }}/credentials
-        {{- else }}
-- name: {{ $prefix }}_SECRETSPATH
-  value: /bindings/{{ $key }}
-        {{- end }}
-  {{- end }}
-{{- end }}
-
-
-{{/*
-Old Service Bindings: volume mounts
-*/}}
-{{- define "cap.web-application.serviceMounts" }}
-    {{- $ := . -}}
-    {{- range $key, $binding := $.Values.bindings }}
-      {{- if not $.Values.global.oldServiceBindings }}
-- name: {{ $key }}-secret
-  mountPath: /bindings/{{ $key }}
-  readOnly: true
-      {{- else }}
-- name: {{ $key }}-secret
-  mountPath: /etc/secrets/cds/requires/{{ $key }}/credentials
-  readOnly: true
-- name: {{ $key }}-metadata
-  mountPath: /etc/secrets/cds/requires/{{ $key }}/vcap
-  readOnly: true
-      {{- end }}
-    {{- end }}
-{{- end }}
-
-

package/lib/k8s/destinations/index.js

@@ -1,40 +0,0 @@
-const wrapFeature = require('../wrapFeature');
-const { checkNeedDestinations } = require('./lib');
-
-module.exports = wrapFeature('destinations', {
-
-    async checkNeedDestinations(context) {
-        const env = await context.get('env');
-        return checkNeedDestinations(env);
-    },
-
-    async isRequired(context) {
-        return await this.checkNeedDestinations(context) || await context.collect('getDestinationsParameters');
-    },
-
-    async getServiceBindings(context) {
-        return await this.checkNeedDestinations(context) && {destinations: { serviceInstanceName: 'destinations' } };
-    },
-
-    async getChartCapabilities(context) {
-        return {
-            destinations: {
-                serviceOfferingName: 'destination',
-                servicePlanName: 'lite',
-                parameters: {
-                    version: "1.0.0",
-                    ...await context.collect('getDestinationsParameters')
-                }
-            }
-        }
-    },
-
-    async addToChart(builder, { destinations }) {
-        await builder.addAllTemplates(__dirname);
-
-        const { config } = destinations;
-        if (config) {
-            await builder.addChartFile(config);
-        }
-    }
-});

package/lib/k8s/destinations/lib.js

@@ -1,16 +0,0 @@
-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/destinations/templates/destinations.yaml

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

package/lib/k8s/docker/push.js

@@ -1,8 +0,0 @@
-const { exec } = require('../../util/exec');
-
-async function push(imageName, fullImageName) {
-    await exec `docker tag ${imageName} ${fullImageName}`;
-    await exec `docker push ${fullImageName}`;
-}
-
-module.exports = push;

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

@@ -1,53 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

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

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

@@ -1,48 +0,0 @@
-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
-                    }
-                },
-                resources: {
-                    limits: {
-                        cpu: "2000m",
-                        memory: "1G"
-                    },
-                    requests: {
-                        cpu: "1000m",
-                        memory: "1G"
-                    }
-                }
-            }
-        };
-    },
-
-    getServiceBindings() {
-        return {
-            db: {
-                fromSecret: null
-            }
-        }
-    },
-
-    async addToChart(builder) {
-        await builder.addAllTemplates(__dirname);
-    }
-});

package/lib/k8s/helm/Release.js

@@ -1,80 +0,0 @@
-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

@@ -1,53 +0,0 @@
-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'
-                    }
-                },
-                resources: {
-                    limits: {
-                        cpu: "2000m",
-                        memory: "1G"
-                    },
-                    requests: {
-                        cpu: "1000m",
-                        memory: "1G"
-                    }
-                }
-            }
-        }
-    },
-
-    getDestinationsParameters() {
-        return {
-            HTML5Runtime_enabled: true
-        }
-    },
-
-    isHtml5AppsRepoHostRequired() {
-        return true;
-    },
-
-    async addToChart(builder) {
-        await builder.addAllTemplates(__dirname);
-    }
-});

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

@@ -1,26 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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/index.js

@@ -1,153 +0,0 @@
-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 = {
-        additions: []
-    };
-
-    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, resources: 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

@@ -1,36 +0,0 @@
-/* @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

@@ -1,24 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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
-};