Merge pull request #52 from jsburckhardt/copilot/fix-51

feat: Add k3d feature to devcontainer features

Author: jsburckhardt

.github/workflows/test.yaml

@@ -20,6 +20,7 @@ jobs:
           - gic
           - gitleaks
           - jnv
+          - k3d
           - kyverno
           - notation
           - ruff

README.md

@@ -13,6 +13,7 @@ This repository contains a _collection_ of Features.
 | crane | https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md | crane is a tool for interacting with remote images and registries.|
 | skopeo | https://github.com/containers/skopeo | skopeo is a command line utility that performs various operations on container images and image repositories. It is install through package managers |
 | kyverno | https://kyverno.io/docs/introduction/ | Kyverno (Greek for “govern”) is a policy engine designed specifically for Kubernetes. |
+| k3d | https://k3d.io/ | K3d is a lightweight wrapper to run k3s (Rancher Lab's minimal Kubernetes distribution) in docker. |
 | cyclonedx | https://cyclonedx.org/ | cyclonedx is a command-line tool for working with Software Bill of Materials (SBOM). |
 | Copacelic | https://project-copacetic.github.io/copacetic/website/ | Project Copacetic: Directly patch container image vulnerabilities. Copa is a CLI tool written in Go and based on buildkit that can be used to directly patch container images given the vulnerability scanning results from popular tools like Trivy. |
 | Gic | https://github.com/jsburckhardt/gic | Reducing cognitive load by automating commit message generation, allowing developers to focus on coding instead of crafting messages. |
@@ -246,6 +247,23 @@ Running `ruff` inside the built container will print the help menu of ruff.
 ruff --version
 ```
 
+
+### `k3d`
+
+Running `k3d` inside the built container will print the help menu of k3d.
+
+```jsonc
+{
+    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+    "features": {
+        "ghcr.io/jsburckhardt/devcontainer-features/k3d:1": {}
+    }
+}
+```
+
+```bash
+k3d --version
+```
 ### `Codex-CLI`
 
 Running `codex` inside the built container will print the help menu of codex.

src/k3d/devcontainer-feature.json

@@ -0,0 +1,13 @@
+{
+    "name": "K3D",
+    "id": "k3d",
+    "version": "1.0.0",
+    "description": "K3d is a lightweight wrapper to run k3s (Rancher Lab's minimal Kubernetes distribution) in docker.",
+    "options": {
+        "version": {
+            "type": "string",
+            "default": "latest",
+            "description": "Version of k3d to install."
+        }
+    }
+}

src/k3d/install.sh

@@ -0,0 +1,91 @@
+#!/usr/bin/env bash
+
+K3D_VERSION="${VERSION:-"latest"}"
+GITHUB_API_REPO_URL="https://api.github.com/repos/k3d-io/k3d/releases"
+URL_RELEASES="https://github.com/k3d-io/k3d/releases"
+
+set -e
+
+# Clean up
+rm -rf /var/lib/apt/lists/*
+
+ARCH="$(uname -m)"
+# Map the architecture to the format used by k3d
+case ${ARCH} in
+x86_64) ARCH="amd64" ;;
+i686) ARCH="386" ;;
+armv7*) ARCH="arm" ;;
+aarch64) ARCH="arm64" ;;
+*)
+    echo "(!) Architecture ${ARCH} unsupported"
+    exit 1
+    ;;
+esac
+
+# Check if linux/windows/macOS
+OS="$(uname -s)"
+case ${OS} in
+Linux) OS="linux" ;;
+Darwin) OS="darwin" ;;
+*)
+    echo "(!) Platform ${OS} unsupported"
+    exit 1
+    ;;
+esac
+
+if [ "$(id -u)" -ne 0 ]; then
+    echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
+    exit 1
+fi
+
+# Checks if packages are installed and installs them if not
+check_packages() {
+    if ! dpkg -s "$@" >/dev/null 2>&1; then
+        if [ "$(find /var/lib/apt/lists/* | wc -l)" = "0" ]; then
+            echo "Running apt-get update..."
+            apt-get update -y
+        fi
+        apt-get -y install --no-install-recommends "$@"
+    fi
+}
+
+# Figure out correct version of a three part version number is not passed
+validate_version_exists() {
+    local variable_name=$1
+    local requested_version=${2}
+    if [ "${requested_version}" = "latest" ]; then 
+        requested_version=$(curl -sL ${GITHUB_API_REPO_URL}/latest | jq -r ".tag_name")
+        echo "Latest version is ${requested_version}"
+    fi
+    local version_list
+    version_list=$(curl -sL ${GITHUB_API_REPO_URL} | jq -r ".[].tag_name")
+    if ! echo "${version_list}" | grep "${requested_version}" >/dev/null 2>&1; then
+        echo -e "Invalid ${variable_name} value: ${requested_version}\nValid values:\n${version_list}" >&2
+        exit 1
+    fi
+    echo "${variable_name}=${requested_version}"
+}
+
+# Make sure we have curl and jq
+check_packages curl jq ca-certificates
+
+# Make sure version is available
+if [ "${K3D_VERSION}" = "latest" ]; then 
+    K3D_VERSION=$(curl -sL ${GITHUB_API_REPO_URL}/latest | jq -r ".tag_name")
+    echo "Latest version is ${K3D_VERSION}"
+fi
+validate_version_exists K3D_VERSION "${K3D_VERSION}"
+
+# Download and install binary
+K3D_DIST="k3d-${OS}-${ARCH}"
+echo "Downloading ${K3D_DIST} version ${K3D_VERSION}..."
+
+url="${URL_RELEASES}/download/${K3D_VERSION}/${K3D_DIST}"
+echo "Downloading ${url}..."
+curl -sSL --insecure "$url" -o /usr/local/bin/k3d
+chmod +x /usr/local/bin/k3d
+
+# Clean up
+rm -rf /var/lib/apt/lists/*
+
+echo "Done!"

test/_global/k3d-specific-version.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e
+source dev-container-features-test-lib
+check "k3d with specific version" /bin/bash -c "k3d version | grep '5.6.0'"
+
+reportResults

test/_global/scenarios.json

@@ -9,6 +9,7 @@
             "gic": {},
             "gitleaks": {},
             "jnv": {},
+            "k3d": {},
             "kyverno": {},
             "notation": {},
             "ruff": {},
@@ -111,5 +112,13 @@
                 "version": "v0.41.0"
             }
         }
+    },
+    "k3d-specific-version": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+        "features": {
+            "k3d": {
+                "version": "v5.6.0"
+            }
+        }
     }
 }

test/k3d/test.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e
+
+source dev-container-features-test-lib
+check "k3d" k3d version
+reportResults