@sap/cds-dk 6.1.5 → 6.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cds-dk",
-  "version": "6.1.5",
+  "version": "6.2.0",
   "description": "Command line client and development toolkit for the SAP Cloud Application Programming Model",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [
@@ -16,9 +16,9 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@sap/cds": "^6.1.0",
+    "@sap/cds": "^6.2.0",
     "@sap/cds-foss": "^4",
-    "@sap/eslint-plugin-cds": "^2.5.0",
+    "@sap/eslint-plugin-cds": "^2.6.0",
     "axios": ">=0.21",
     "connect-livereload": "^0.6.1",
     "eslint": "^8",
@@ -34,7 +34,8 @@
     "xml-js": "^1.6.11"
   },
   "optionalDependencies": {
-    "sqlite3": "5.0.11"
+    "@sap/cds-mtxs": "^1.2.0",
+    "sqlite3": "^5.0.4"
   },
   "files": [
     "bin/",

package/lib/init/template/helm/update/index.js

@@ -1,28 +0,0 @@
-/* eslint-disable no-unused-vars */
-/* eslint-disable no-unreachable */
-const path = require('path');
-const TemplateBase = require('../../templateBase');
-const ProjectReader = require('../../../util/projectReader');
-const { OPTION_HELM } = require('../../../constants');
-
-module.exports = class HelmUpdateTemplate extends TemplateBase {
-    constructor(projectPath, generator) {
-        super(projectPath, generator, __dirname, true);
-        this.projectReader = new ProjectReader(this);
-    }
-
-    async getDependencies() {
-        return [ OPTION_HELM ];
-    }
-
-    async checkEnabled() {
-        return await this.fsUtil.pathExists(this.chartPath());
-    }
-
-    chartPath() {
-        return path.join(this.projectPath, 'chart');
-    }
-
-    async run() {
-    }
-};

package/lib/k8s/ChartAdder.js

@@ -1,75 +0,0 @@
-
-
-const { yaml } = require('./modules');
-const path = require('path');
-const fs = require('fs').promises;
-const FsUtil = require('../../lib/init/util/fsUtil')
-const TemplateUtil = require('../../lib/init/util/templateUtil')
-
-class ChartAdder {
-    /**
-     *
-     * @param {{ builder: import('./ChartBuilder') }} param0
-     */
-    constructor({ builder, resources, chartValues, chartDependencies, app, mergeSemantics }) {
-        this.builder = builder;
-        this.resources = resources;
-        this.chartValues = chartValues;
-        this.app = app;
-        this.mergeSemantics = mergeSemantics;
-        this.dependencies = chartDependencies;
-        this.templateUtil = new TemplateUtil(null, new FsUtil());
-    }
-
-    async execute() {
-        await this.copyTemplates();
-        await this.copySchema();
-        await this.addChartValues();
-        await this.addChartFile();
-    }
-
-    async copyTemplates() {
-        await this.builder.addAllTemplates(this.resources);
-    }
-
-    async copySchema() {
-        let valuesSchema = JSON.parse(await fs.readFile(path.join(this.resources, 'schemas', 'values.schema.json'), { encoding: 'utf8' }))
-        let valuesRootSchema = JSON.parse(await fs.readFile(path.join(this.resources, 'schemas', 'values.root.schema.json'), { encoding: 'utf8' }))
-
-        await this.builder.writeChartFile('values.schema.json', JSON.stringify(valuesSchema, null, 4));
-        await this.builder.writeChartFile('values.root.schema.json', JSON.stringify(valuesRootSchema, null, 4));
-    }
-
-    async addChartValues() {
-        const values = this.chartValues;
-        const valuesYaml = yaml.stringify(JSON.parse(JSON.stringify(values)));
-
-        await this.builder.mergeChartFile('values.yaml', valuesYaml, this.mergeSemantics)
-    }
-
-    async addChartFile() {
-        const chart = {
-            apiVersion: 'v2',
-            name: this.app.name,
-            description: this.app.description,
-            type: 'application',
-            version: this.app.version, // should be Chart version
-            appVersion: this.app.version,
-            dependencies: this.dependencies
-        };
-
-        const header = `#
-# This file is generated by "cds add helm"
-`
-
-        const chartYaml = header + yaml.stringify(JSON.parse(JSON.stringify(chart)));
-        await this.builder.writeChartFile('Chart.yaml', chartYaml);
-    }
-
-    async getSavedValues() {
-        return yaml.parse(await fs.readFile(this.builder.chartPath('values.yaml'), 'utf-8'));
-    }
-}
-
-
-module.exports = ChartAdder;

package/lib/k8s/ChartBuilder.js

@@ -1,192 +0,0 @@
-const { cds, yaml } = require('./modules');
-const { readFileIfExists, throwError, parseMd5File, writeMd5File } = require('./util');
-const FsUtil = require('../../lib/init/util/fsUtil')
-const TemplateUtil = require('../../lib/init/util/templateUtil')
-const fs = require('fs').promises;
-const Path = require('path');
-const LOG = cds.log('k8s');
-
-/**
- *
- */
-
-const crypto = require('crypto');
-
-class ChartBuilder {
-    constructor({ path, rootPath = process.cwd() }) {
-        this.path = path;
-        this.rootPath = rootPath;
-        this.tackedFiles = [];
-        this.oldTrackingData = undefined;
-        this.newTrackingData = {};
-        this.templateUtil = new TemplateUtil(null, new FsUtil());
-        this.ended = false;
-    }
-
-    async begin() {
-        await this.loadOldTrackingData();
-        await this.makeDirs();
-    }
-
-    async makeDirs() {
-        await fs.mkdir(Path.join(this.path, 'templates'), { recursive: true });
-    }
-
-    async writeChartFile(fileName, data) {
-        if (this.ended) throwError `Internal Error: Cannot write file ${fileName} after end()`;
-
-        const filePath = Path.join(this.path, fileName);
-        if (!await this.checkAndWarnIfChartFileIsModified(filePath)) {
-            await fs.writeFile(filePath, data);
-        }
-        this.track(filePath, data);
-    }
-
-    async mergeChartFile(fileName, data, mergeSemantics) {
-        const filePath = Path.join(this.path, fileName);
-        const modified = await this.isChartFileModified(filePath);
-        if (modified) {
-            LOG(`Merging updates into modified file "${filePath}"`);
-            const newYamlContent = yaml.parseDocument(data);
-
-            await this.templateUtil.mergeYAML(filePath, newYamlContent, null, mergeSemantics);
-        } else {
-
-            const header = `
-# yaml-language-server: $schema=./values.root.schema.json
-
-`
-            data = header + data;
-            await this.writeChartFile(fileName, data);
-        }
-
-        this.track(filePath, data);
-    }
-
-    async addChartFile(sourcePath, { fileName = Path.basename(sourcePath), merge = false, optional = false, mergeSemantics } = {}) {
-        if (!Path.isAbsolute(sourcePath)) {
-            sourcePath = Path.join(this.rootPath, sourcePath);
-        }
-
-        const data = await readFileIfExists(sourcePath, 'utf-8');
-        if (typeof data === "undefined") {
-            if (optional)
-                return false;
-            else
-                throwError `File *${sourcePath}* not found.`;
-        }
-
-        if (merge) {
-            await this.mergeChartFile(fileName, data, mergeSemantics);
-        } else {
-            await this.writeChartFile(fileName, data);
-        }
-
-        return true;
-    }
-
-    async addTemplate(sourcePath, sourceFileName, { targetFileName = sourceFileName, merge = false } = {}) {
-        await this.addChartFile(Path.join(sourcePath, sourceFileName), { fileName: Path.join('templates', targetFileName), merge });
-    }
-
-    async addSubchartFiles(sourceBasePath, subchart) {
-        await this.addAllFiles(sourceBasePath, Path.join('charts', subchart));
-        await this.addAllFiles(Path.join(sourceBasePath, 'templates'), Path.join('charts', subchart, 'templates'));
-    }
-
-    async addAllTemplates(sourceBasePath, templatesDir = 'templates') {
-        await this.addAllFiles(Path.join(sourceBasePath, templatesDir), 'templates');
-    }
-
-    async addAllFiles(sourcePath, targetPath = '.') {
-        await fs.mkdir(this.chartPath(targetPath), { recursive: true });
-        for (const sourceFile of await fs.readdir(sourcePath, { withFileTypes: true })) {
-            if (sourceFile.isFile()) {
-                await this.addChartFile(Path.join(sourcePath, sourceFile.name), { fileName: Path.join(targetPath, sourceFile.name) });
-            }
-        }
-    }
-
-
-    async loadOldTrackingData() {
-        this.oldTrackingData = await parseMd5File(Path.join(this.path, '.cds-add-helm-files.md5'));
-    }
-
-    async track(path, data) {
-        const key = pathKey(this.path, path);
-        this.newTrackingData[key] = hash(data);
-    }
-
-    async checkAndWarnIfChartFileIsModified(path) {
-        if (await this.isChartFileModified(path)) {
-            LOG.warn(modifiedMsg(path));
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    async isChartFileModified(path) {
-        const data = await readFileIfExists(path, 'utf-8');
-        if(data == undefined) {
-            return false;
-        }
-
-        const key = pathKey(this.path, path);
-        const currentHash = hash(data);
-        return this.oldTrackingData != undefined && this.oldTrackingData[key] != currentHash;
-    }
-
-    async end() {
-        this.ended = true;
-
-        for (const path of this.obsoleteFiles()) {
-            if (await this.isChartFileModified(path)) {
-                LOG.warn(`Kept no longer used file "${path}" because it is modified`);
-            } else {
-                LOG.warn(`Removing no longer used file "${path}" from chart`);
-                try {
-                    await fs.unlink(path);
-                } catch(error) {
-                    if (error.code !== 'ENOENT') throw error;
-                }
-            }
-        }
-
-        await this.writeNewTrackingData();
-    }
-
-    obsoleteFiles() {
-        return Object.keys(this.oldTrackingData).filter( path => !this.newTrackingData[path]).map( path => this.a(path) );
-    }
-
-    async writeNewTrackingData() {
-        await writeMd5File(Path.join(this.path, '.cds-add-helm-files.md5'), this.newTrackingData)
-    }
-
-    a(path) {
-        return Path.join(this.path, path)
-    }
-
-    chartPath(...path) {
-        return Path.join(this.path, ...path);
-    }
-}
-
-function hash(data) {
-    return crypto.createHash('md5').update(data).digest('base64');
-}
-
-function pathKey(basePath, path) {
-    return Path.posix.normalize(toPosix(Path.relative(basePath, path)))
-}
-
-function toPosix(path) {
-    return path.replace(/\\/g, '/');
-}
-
-function modifiedMsg(path) {
-    return `Chart file "${path}" has been modified and will not be updated.`;
-}
-
-module.exports = ChartBuilder;

package/lib/k8s/Context.js

@@ -1,71 +0,0 @@
-const { throwError } = require('./util');
-
-/**
- * The context holds elements that are used to build up the CAP project. It allows
- * decoupling between this objects. It should be used in a way that the Context is initialized
- * with the elements (also referred to as "plugins") and each of them implements the required
- * interface for the type of element.
- */
-class Context {
-    constructor(objs) {
-        this.modified = true;
-        this.objs = objs || {};
-    }
-
-    async get(name) {
-        if (this.objs[name]) {
-            if (typeof this.objs[name] === 'function') {
-                this.objs[name] = await this.objs[name](this) || {};
-            }
-
-            return this.objs[name];
-        } else {
-            throwError `Unknown module *${name}*`;
-        }
-    }
-
-    async loadAll() {
-        while (this.modified) {
-            this.modified = false;
-            for (const name in this.objs) {
-                await this.get(name);
-            }
-        }
-    }
-
-    add(name, obj) {
-        this.modified = true;
-        this.objs[name] = obj;
-    }
-
-    has(name) {
-        return !!this.objs[name];
-    }
-
-    async filter(name) {
-        await this.loadAll();
-        return Object.values(this.objs).filter( obj => obj[name] );
-    }
-
-    async forEach(name, call) {
-        const filtered = await this.filter(name);
-        for (const plugin of filtered) {
-            await call(plugin);
-        }
-    }
-
-    async collect(name) {
-        let obj = {};
-        await this.forEach(name, async (plugin) => obj = {...obj, ...await plugin[name]()});
-        return Object.keys(obj).length > 0 ? obj : undefined;
-    }
-
-    async collectBool(name) {
-        let bool = false;
-        await this.forEach(name, async (plugin) => bool = bool || await plugin[name]());
-        return bool;
-    }
-
-}
-
-module.exports = Context;

package/lib/k8s/ImageUtil.js

@@ -1,21 +0,0 @@
-const { throwError } = require('./util');
-
-class ImageUtil {
-    constructor(config) {
-        this.config = config.images;
-    }
-    imageName(imageSuffix) {
-        const imagePrefix = this.config.imagePrefix || throwError `Expect *images.prefix* property.`;
-        return `${imagePrefix}-${imageSuffix}`;
-    }
-
-    get imageRegistry() {
-        return this.config.imageRegistry || throwError `Expect *images.registry* property.`;
-    }
-
-    fullImageName(suffix) {
-        return `${this.imageRegistry}/${this.imageName(suffix)}:latest`;
-    }
-}
-
-module.exports = ImageUtil;

package/lib/k8s/auditlog/index.js

@@ -1,29 +0,0 @@
-const wrapFeature = require('../wrapFeature');
-
-module.exports = wrapFeature('auditlog', {
-    getServiceBindings() {
-        return {
-            auditlog: {
-                serviceInstanceName: 'auditlog'
-            }
-        };
-    },
-
-    getChartCapabilities() {
-        return {
-            auditlog: {
-                serviceOfferingName: 'auditlog-api',
-                servicePlanName: 'default'
-            }
-        }
-    },
-
-    async addToChart(builder, { auditlog }) {
-        await builder.addAllTemplates(__dirname);
-
-        const { config } = auditlog;
-        if (config) {
-            await builder.addChartFile(config);
-        }
-    }
-});

package/lib/k8s/auditlog/templates/auditlog.yaml

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

package/lib/k8s/buildModel.js

@@ -1,68 +0,0 @@
-const { throwError } = require('./util');
-const readProject = require('./readProject');
-const Path = require('path');
-
-/**
- * Build data model of the CAP project for Kubernetes build, push, charts and chart deployment
- *
- * @returns
- */
-async function buildModel(context) {
-    const k8s = await context.get('config');
-    const projectPath = await context.get('projectPath');
-
-    const project = await readProject(projectPath);
-    const cap = project.cap;
-
-    const services = buildServices(cap);
-    const isJava = typeof k8s.isJava !== 'undefined' ? k8s.isJava : cap.isJava;
-    const language = isJava ? 'Java' : 'Node';
-
-    const model = {
-        app: {
-            name: cap.appName,
-            description: cap.appDescription,
-            version: cap.appVersion
-        },
-        isMultiTenant: cap.isMultitenant,
-        isJava,
-        language,
-        services
-    }
-
-    model.getChartValues = function() {
-        return {
-            global: {
-                domain: null,
-                imagePullSecret: {}
-            }
-        }
-    };
-
-    model.path = function(path = '.') {
-        return Path.join(projectPath, path);
-    }
-
-    return model;
-}
-
-function buildServices(cap) {
-    const prefix = `${cap.appName}-`;
-    let services = {};
-    for (const req of cap.requires) {
-        const resource = req.resource;
-        if (!resource.name.startsWith(prefix)) throwError `Unexpected resource name _${resource.name}_. Should start with _${prefix}_`;
-        const name = resource.name.substr(prefix.length);
-
-        if (name === 'db') continue; // TODO: hard coded with srv.bindings.db.secret;
-
-        // TODO: needs improvement
-        services[name] = {
-            label: resource.service
-        };
-    }
-
-    return services;
-}
-
-module.exports = buildModel;

package/lib/k8s/connectivity/index.js

@@ -1,80 +0,0 @@
-const wrapFeature = require('../wrapFeature');
-
-module.exports = wrapFeature('connectivity', {
-    async extendChartDeployment(context, name, deployment, mergeSemantics) {
-        const model = await context.get('model');
-        const prefix = model.app.name;
-
-        deployment.env = {
-            ...(deployment.env || {}),
-            CDS_ENVIRONMENT_K8S_SERVICEBINDINGS_CONNECTIVITY_SECRETSPATH: '/bindings/connectivity',
-            CDS_ENVIRONMENT_K8S_SERVICEBINDINGS_CONNECTIVITY_SERVICE: 'connectivity'
-        };
-
-        deployment.additionalVolumes = deployment.additionalVolumes || [];
-        deployment.additionalVolumes.push(
-            {
-                name: "connectivity-secret",
-                volumeMount: {
-                    mountPath: "/bindings/connectivity",
-                    readOnly: true
-                },
-                projected: {
-                    sources: [
-                        {
-                            secret: {
-                                name: `${prefix}-connectivity-binding`,
-                                optional: false
-                            }
-                        },
-                        {
-                            secret: {
-                                name: `${prefix}-connectivity-binding`,
-                                optional: false,
-                                items: [
-                                    {
-                                        key: "token_service_url",
-                                        path: "url"
-                                    }
-                                ]
-                            }
-                        },
-                        {
-                            configMap: {
-                                name: `${prefix}-connectivity-proxy-info`,
-                                optional: false
-                            }
-                        }
-                    ]
-                }
-            }
-        );
-
-        mergeSemantics.additions.push({
-            ref: `{name}-additional-volumes`,
-            in: `${name}.additionalVolumes`,
-            where: [{
-                property: 'name',
-                isEqualTo: 'connectivity-secret'
-            }]
-        });
-    },
-
-    async getChartCapabilities(context) {
-        const model = await context.get('model');
-        const prefix = model.app.name;
-
-        return {
-            connectivity: {
-                serviceOfferingName: 'connectivity',
-                servicePlanName: 'connectivity_proxy',
-                secretName: `${prefix}-connectivity-binding`,
-                configMapName: `${prefix}-connectivity-proxy-info`
-            }
-        }
-    },
-
-    async addToChart(builder) {
-        await builder.addAllTemplates(__dirname);
-    }
-});

package/lib/k8s/deployment/index.js

@@ -1,79 +0,0 @@
-const fs = require('fs').promises;
-const Path = require('path');
-const { yaml } = require('../modules');
-
-class Deployment {
-    constructor({context, name, language}) {
-        this.context = context;
-        this.name = name;
-        this.language = language;
-    }
-
-    async getChartDeployments(context) {
-        const model = await context.get('model');
-
-        let bindings = {};
-        await context.forEach('getServiceBindings',
-            async plugin => bindings = {...bindings, ...await plugin.getServiceBindings(context)}
-        );
-
-        const language = this.language || model.language;
-        const memory = language === 'Java' ? '1G' : '500M';
-        const cpu = language === 'Java' ? '1000m' : '500m';
-        const env = language === 'Java' ? {SPRING_PROFILES_ACTIVE: "cloud"} : undefined;
-
-        return {
-            [this.name]: {
-                bindings,
-                image: {
-                    repository: '<your-container-registry>/'+model.app.name+'-'+this.name,
-                    tag: 'latest'
-                },
-                env,
-                resources: {
-                    limits: {
-                        'ephemeral-storage': '1G',
-                        memory
-                    },
-                    requests: {
-                        cpu,
-                        'ephemeral-storage': '1G',
-                        memory
-                    }
-                },
-                health_check: {
-                    liveness: {
-                        path: '/'
-                    },
-                    readiness: {
-                        path: '/'
-                    }
-                }
-            }
-        }
-    }
-
-    async getChartDependencies() {
-        return [{
-            name: 'web-application',
-            alias: this.name,
-            version: await webApplicationChartVersion()
-        }]
-    }
-
-    async addToChart(builder) {
-        await builder.addSubchartFiles(webApplicationChartPath, 'web-application');
-    }
-}
-
-const webApplicationChartPath = process.env.WEB_APPLICATION_CHART || Path.join(__dirname, 'subchart');
-
-async function webApplicationChartVersion() {
-    const chartFilePath = Path.join(webApplicationChartPath, 'Chart.yaml');
-    const chartFile = await fs.readFile(chartFilePath, 'utf-8');
-    return yaml.parse(chartFile).version;
-}
-
-module.exports = function (context) {
-    return new Deployment({context, name: 'srv'});
-}