add fish-debian.sh as a feature (#1263)

Author: eitsupi

script-library/container-features/src/devcontainer-features.json

@@ -609,6 +609,48 @@
 				"python-3-postgres"
 			]
 		},
+		{
+			"id": "fish",
+			"name": "fish shell and Fisher",
+			"documentationURL": "https://github.com/microsoft/vscode-dev-containers/blob/main/script-library/docs/fish.md",
+			"options": {
+				"version": {
+					"type": "string",
+					"enum": ["latest"],
+					"default": "latest",
+					"description": "Currently unused."
+				}
+			},
+			"buildArg": "_VSC_INSTALL_FISH",
+			"include": [
+				"cpp",
+				"kubernetes-helm",
+				"kubernetes-helm-minikube",
+				"docker-from-docker",
+				"docker-in-docker",
+				"dotnet",
+				"dotnet-fsharp",
+				"dotnet-mssql",
+				"powershell",
+				"java",
+				"go",
+				"php",
+				"ruby",
+				"rust",
+				"typescript-node",
+				"javascript-node",
+				"python-3",
+				"python-3-anaconda",
+				"python-3-miniconda",
+				"ubuntu",
+				"debian",
+				"javascript-node-mongo",
+				"javascript-node-postgres",
+				"php-mariadb",
+				"ruby-rails-postgres",
+				"python-3-postgres"
+			]
+		},
 		{
 			"id": "node",
 			"name": "Node.js (via nvm) and yarn",

script-library/container-features/src/feature-scripts.env

@@ -21,4 +21,5 @@ _VSC_INSTALL_RUST="rust-debian.sh /usr/local/cargo /usr/local/rustup automatic t
 _VSC_INSTALL_POWERSHELL="powershell-debian.sh ${_BUILD_ARG_POWERSHELL_VERSION:-latest}"
 _VSC_INSTALL_DESKTOP_LITE="desktop-lite-debian.sh automatic ${_BUILD_ARG_DESKTOP_LITE_PASSWORD:-vscode} true ${_BUILD_ARG_DESKTOP_LITE_VNCPORT:-5901} ${_BUILD_ARG_DESKTOP_LITE_WEBPORT:-6080}"
 _VSC_INSTALL_DOTNET="dotnet-debian.sh ${_BUILD_ARG_DOTNET_VERSION:-latest} ${_BUILD_ARG_DOTNET_RUNTIMEONLY:-false} automatic true /usr/local/dotnet dotnet"
+_VSC_INSTALL_FISH="fish-debian.sh"
 _VSC_INSTALL_JUPYTERLAB="jupyterlab-debian.sh ${_BUILD_ARG_JUPYTERLAB_VERSION:-latest}"

script-library/container-features/test-features.env

@@ -50,4 +50,5 @@ _VSC_INSTALL_DESKTOP_LITE=true
 _VSC_INSTALL_DOTNET=true
 _BUILD_ARG_DOTNET_VERSION=latest
 _BUILD_ARG_DOTNET_RUNTIMEONLY=false
+_VSC_INSTALL_FISH=true
 _VSC_INSTALL_AWS_CLI=true

script-library/docs/fish.md

@@ -8,21 +8,41 @@
 
 **OS support**: Debian 9+, Ubuntu 16.04+.
 
-**Maintainer:** [@andreiborisov](https://github.com/andreiborisov)
+**Maintainer:** [@andreiborisov](https://github.com/andreiborisov), [@eitsupi](https://github.com/eitsupi)
 
 ## Syntax
 
 ```text
 ./fish-debian.sh [Install Fisher flag] [Non-root user]
 ```
 
-|Argument|Default|Description|
-|--------|-------|-----------|
-| Install Fisher flag | `true` | A `true`/`false` flag that indicates whether to install [Fisher plugin manager](https://github.com/jorgebucaran/fisher). |
-|Non-root user|`automatic`| Specifies a user in the container other than root that will use fish shell. A value of `automatic` will cause the script to check for a user called `vscode`, then `node`, `codespace`, and finally a user with a UID of `1000` before falling back to `root`. |
+Or as a feature:
+
+```json
+"features": {
+    "fish": "latest"
+}
+```
+
+| Argument            | Feature option | Default     | Description                                                                                                                                                                                                                                                    |
+| ------------------- | -------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Install Fisher flag |                | `true`      | A `true`/`false` flag that indicates whether to install [Fisher plugin manager](https://github.com/jorgebucaran/fisher).                                                                                                                                       |
+| Non-root user       |                | `automatic` | Specifies a user in the container other than root that will use fish shell. A value of `automatic` will cause the script to check for a user called `vscode`, then `node`, `codespace`, and finally a user with a UID of `1000` before falling back to `root`. |
 
 ## Usage
 
+### Feature use
+
+To install these capabilities in your primary dev container, reference it in `devcontainer.json` as follows:
+
+```json
+"features": {
+    "fish": "latest"
+}
+```
+
+### Script use
+
 Usage:
 
 1. Add [`fish-debian.sh`](../fish-debian.sh) to `.devcontainer/library-scripts`

script-library/fish-debian.sh

@@ -20,6 +20,8 @@ if [ "$(id -u)" -ne 0 ]; then
     exit 1
 fi
 
+export DEBIAN_FRONTEND=noninteractive
+
 # Determine the appropriate non-root user
 if [ "${USERNAME}" = "auto" ] || [ "${USERNAME}" = "automatic" ]; then
     USERNAME=""
@@ -37,13 +39,32 @@ elif [ "${USERNAME}" = "none" ] || ! id -u ${USERNAME} > /dev/null 2>&1; then
     USERNAME=root
 fi
 
-export DEBIAN_FRONTEND=noninteractive
+# Function to run apt-get if needed
+apt_get_update_if_needed()
+{
+    if [ ! -d "/var/lib/apt/lists" ] || [ "$(ls /var/lib/apt/lists/ | wc -l)" = "0" ]; then
+        echo "Running apt-get update..."
+        apt-get update
+    else
+        echo "Skipping apt-get update."
+    fi
+}
+
+# Checks if packages are installed and installs them if not
+check_packages() {
+    if ! dpkg -s "$@" > /dev/null 2>&1; then
+        apt_get_update_if_needed
+        apt-get -y install --no-install-recommends "$@"
+    fi
+}
+
+check_packages curl ca-certificates gnupg2 apt-transport-https
 
 # Install fish shell
 echo "Installing fish shell..."
 if grep -q 'Ubuntu' < /etc/os-release; then
     apt-get -y install --no-install-recommends software-properties-common
-    apt-add-repository ppa:fish-shell/release-3
+    apt-add-repository -y ppa:fish-shell/release-3
     apt-get update
     apt-get -y install --no-install-recommends fish
     apt-get autoremove -y

script-library/test/regression/run-scripts.sh

@@ -91,6 +91,7 @@ if [ "${DISTRO}" = "debian" ]; then
     runScript desktop-lite "${USERNAME} changeme false"
     runScript docker-in-docker "false ${USERNAME} false"
     runScript powershell
+    runScript fish
     if [ "${architecture}" = "amd64" ] || [ "${architecture}" = "x86_64" ] || [ "${architecture}" = "arm64" ] || [ "${architecture}" = "aarch64" ]; then
         runScript java "13.0.2.j9-adpt /usr/local/sdkman2 ${USERNAME} false"
     fi