Merge pull request #9 from The-Nefarious-Developer/typescript

Implement sap-cap-typescript-node

Author: NickChecan

README.md

@@ -22,6 +22,7 @@ Ths repository generates the following docker/devcontainer images using GHCR:
 | Image                     | Base Image                                                                                                            | Variants                                                          |
 |---------------------------|-----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|
 | sap-cap-javascript-node   | [mcr.microsoft.com/devcontainers/javascript-node](https://hub.docker.com/r/microsoft/devcontainers-javascript-node)   | [Versions Available](./src/sap-cap-javascript-node/variants.json) |
+| sap-cap-typescript-node   | [mcr.microsoft.com/devcontainers/typescript-node](https://hub.docker.com/r/microsoft/devcontainers-typescript-node)   | [Versions Available](./src/sap-cap-typescript-node/variants.json) |
 
 ## How it works
 

src/sap-cap-typescript-node/.devcontainer/Dockerfile

@@ -0,0 +1,44 @@
+ARG VARIANT=22-bookworm
+FROM mcr.microsoft.com/devcontainers/typescript-node:${VARIANT}
+LABEL org.opencontainers.image.source="https://github.com/The-Nefarious-Developer/devcontainer-images"
+
+ARG CF_PATH=/home/node/.cf
+
+# Set execution user otherwise the CF CLI directory is going to be created by root
+# and auth or ownership would need to be granted with "sudo chown -R node $CF_PATH"
+USER node
+
+# Place dependencies in non-root user directory, as per documentation:
+# https://github.com/nodejs/docker-node/blob/main/docs/BestPractices.md
+ENV NPM_CONFIG_PREFIX=/home/node/.npm-global
+ENV PATH=$PATH:/home/node/.npm-global/bin
+
+# This is needed as the common CF CLI installation procedure is not configuring
+# the correct path for plugins. More info at https://cli.cloudfoundry.org/en-US/v8/
+ENV CF_PLUGIN_HOME=${CF_PATH}/plugins
+
+RUN \
+    # Avoid getting stuck with interactive prompts
+    export DEBIAN_FRONTEND=noninteractive \
+    # Install Cloud Foundry CLI
+    && wget -q -O - https://packages.cloudfoundry.org/debian/cli.cloudfoundry.org.key | sudo apt-key add - \
+    && echo "deb https://packages.cloudfoundry.org/debian stable main" | sudo tee /etc/apt/sources.list.d/cloudfoundry-cli.list \
+    # Cache busting for CF CLI installation
+    && sudo apt-get update \ 
+    && sudo apt-get install cf8-cli \
+    # Install Cloud Foundry Plugins
+    && cf install-plugin multiapps -f \
+    && cf install-plugin html5-plugin -f \
+    # Install SAPUI5 CLI
+    && npm install --global @ui5/cli \
+    # Install CAP Tooling
+    && npm install --global @sap/cds-dk \
+    # Install the Cloud MTA Build Tool (MBT) 
+    && npm install --global mbt \
+    # Install Yeoman
+    && npm install --global yo \
+    # Install TypeScript
+    && npm install --global typescript \
+    && npm install --global ts-node \
+    # Install Typescript CDS lib to avoid constantly precompiling files during dev
+    && npm install --global tsx

src/sap-cap-typescript-node/.devcontainer/devcontainer.json

@@ -0,0 +1,30 @@
+{
+	"name": "CAP",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": {
+			// The variant arg will be replaced by the versions in the variants.json file during the build process
+      		"VARIANT": "__VARIANT__"
+    	}
+	},
+	// Configure tool-specific properties
+	"customizations": {
+		// Configure properties specific to VS Code
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created
+			"extensions": [
+				"SAPSE.vscode-cds",
+				"SAPSE.sap-ux-fiori-tools-extension-pack",
+				"Orta.vscode-jest"
+			]
+		}
+	},
+	// Use 'forwardPorts' to make a list of ports inside the container available locally
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created
+	// "postCreateCommand": "npm install",
+
+	// Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root
+	"remoteUser": "node"
+}

src/sap-cap-typescript-node/variants.json

@@ -0,0 +1,10 @@
+{
+    "variants": [
+        "22-bookworm",
+        "22-bullseye",
+        "20-bookworm",
+        "20-bullseye",
+        "18-bookworm",
+        "18-bullseye"
+    ]
+}

test/sap-cap-typescript-node/test.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# shellcheck disable=SC1091
+source "$(dirname "$0")/../test-utils/harness.sh"
+
+# setup "sap-cap-typescript-node" "22-bookworm"
+setup "sap-cap-typescript-node" "$VARIANT"
+
+run_test "Node version is correct" "node -v" "${IMAGE_TAG:0:2}"
+run_test "NPM is present" "npm --help" "npm <command>"
+run_test "CloudFoundry CLI is present" "cf --version" "cf version 8"
+run_test "CAP Development Toolkit is present" "cds version" "@cap-js/asyncapi"
+run_test "Typescript is present" "tsc -v" "Version"
+run_test "ts-node is present is present" "ts-node -v" "v"
+run_test "CAP Typescript Plugin is present" "cds-tsx" ""
+run_test "Container defaults to non-root user" "whoami" "node"
+run_test "Non-root user is able to sudo" "sudo whoami" "root"