Merge pull request #40 from jsburckhardt/feat/add-python-uv

feat(uv): add uv/uvx devcontainer feature

Author: jsburckhardt

.devcontainer.json

@@ -34,6 +34,8 @@
     "features": {
         "ghcr.io/devcontainers/features/docker-in-docker:2": {},
         "ghcr.io/stuartleeks/dev-container-features/shell-history:0": {},
+        "ghcr.io/jsburckhardt/devcontainer-features/gic:1": {}
+
 
     },
     "updateContentCommand": "npm install -g @devcontainers/cli",

.gic.yaml

@@ -0,0 +1,41 @@
+llm_instructions: |
+  You are a commit message generator that follows the semantic release format based on Angular commit guidelines. The user will provide a git diff, and your task is to analyze the changes and generate a SINGLE appropriate git commit message. The message should clearly indicate the type of changes (e.g., feat, fix, chore, docs, style, refactor, test, build, ci, perf, or revert), a brief summary of the change in imperative mood, and optionally include a scope in parentheses. If applicable, include a body with additional details and a footer with references to any related issues or breaking changes.
+  Commit message can have more than one scope and can be multiline.
+
+  Use breaking change only and only if the change is a feature based on code changes.
+
+  Example Format between ~~~:
+
+  ~~~
+  <type>(<scope>): <short description>
+
+  [optional body]
+
+  [optional footer(s)]
+  ~~~
+
+  return ONLY and ONLY the commit message with no ~~~ and no ```.
+
+  If more than one action is performed, use the following order:
+  feat, fix, chore, docs, refactor, test, build, ci, perf, revert
+
+  Example Usage:
+
+  Input: git commit diff: ...
+  Output: A commit message following the format based on the analysis of the diff.
+
+  Example Commit Messages:
+
+  feat(api): add new endpoint for user authentication
+  fix(ui): resolve button alignment issue on mobile devices
+  chore(deps): update dependencies to latest versions
+  docs(readme): add instructions for setting up the project locally
+  refactor(auth): simplify token validation logic
+  test(auth): add unit tests for login functionality
+  perf(core): improve rendering performance by optimizing the DOM updates
+api_version: 2024-02-15-preview
+azure_endpoint: https://generic-aoai-01.openai.azure.com/
+connection_type: azure
+model_deployment_name: gpt-4o
+should_commit: true
+tokens: 4000

.github/workflows/test.yaml

@@ -21,6 +21,7 @@ jobs:
           - cyclonedx
           - copa
           - gic
+          - uv
           - gitleaks
           - jnv
         baseImage:

README.md

@@ -16,6 +16,7 @@ This repository contains a _collection_ of Features.
 | 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. |
+| UV/UVX | https://docs.astral.sh/uv/ | An extremely fast Python package and project manager, written in Rust. A single tool to replace pip, pip-tools, pipx, poetry, pyenv, virtualenv, and more. |
 | Gitleaks | https://gitleaks.io/ | Gitleaks is a SAST tool for detecting and preventing hardcoded secrets like passwords, api keys, and tokens in git repos. Gitleaks is an easy-to-use, all-in-one solution for detecting secrets, past or present, in your code. |
 | Zarf | https://zarf.dev/ | Zarf eliminates the complexity of air gap software delivery for Kubernetes clusters and cloud-native workloads using a declarative packaging strategy to support DevSecOps in offline and semi-connected environments. |
 | jnv | https://github.com/ynqa/jnv | jnv is designed for navigating JSON, offering an interactive JSON viewer and jq filter editor. |
@@ -208,3 +209,20 @@ Running `jnv -h` inside the built container will print the help menu of jnv.
 ```bash
 $ jnv -h
 ```
+
+### `UV/UVX`
+
+Running `uv` or `uvx` inside the built container will print the help menu of gic.
+
+```jsonc
+{
+    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+    "features": {
+        "ghcr.io/jsburckhardt/devcontainer-features/uv:1": {}
+    }
+}
+```
+
+```bash
+$ uv --version
+```

src/gic/install.sh

@@ -8,42 +8,39 @@ BINARY_NAME="gic"
 set -e
 
 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
+    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
 
 # Clean up
 rm -rf /var/lib/apt/lists/*
 
 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
+    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
 }
 
-
 # make sure we have packages
 check_packages curl tar jq ca-certificates
 
-
 # Function to get the latest version from GitHub API
 get_latest_version() {
     LATEST_URL="https://api.github.com/repos/$REPO_OWNER/$REPO_NAME/releases/latest"
     curl -s "$LATEST_URL" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/'
 }
 
-# Check if a version is passed as an argument
-if [ -z "$1" ]; then
-    # No version provided, get the latest version
+# Check if a version is provided via environment variable or passed as an argument
+if [ -z "$VERSION" ] || [ "$VERSION" == "latest" ]; then
     VERSION=$(get_latest_version)
-    echo "No version provided, installing the latest version: $VERSION"
+    echo "No version provided or 'latest' specified, installing the latest version: $VERSION"
 else
-    VERSION=$1
-    echo "Installing specified version: $VERSION"
+    # trim the v from the version
+    echo "Installing version from environment variable: $VERSION"
 fi
 
 # Determine the OS and architecture following the naming template

src/kyverno/install.sh

@@ -1,5 +1,4 @@
 #!/usr/bin/env bash
-
 KYVERNO_VERSION="${VERSION:-"latest"}"
 GITHUB_API_REPO_URL="https://api.github.com/repos/kyverno/kyverno/releases"
 URL_RELEASES="https://github.com/kyverno/kyverno/releases"
@@ -73,7 +72,7 @@ echo "Downloading ${KYVERNO_FILENAME}..."
 
 url="${URL_RELEASES}/download/${KYVERNO_VERSION}/${KYVERNO_FILENAME}"
 echo "Downloading ${url}..."
-curl -sSL $url -o "${KYVERNO_FILENAME}"
+curl -sSL "$url" -o "${KYVERNO_FILENAME}"
 tar -zxvf "${KYVERNO_FILENAME}" -C /usr/local/bin/ kyverno
 rm "${KYVERNO_FILENAME}"
 

src/uv/devcontainer-feature.json

@@ -0,0 +1,13 @@
+{
+    "name": "uv/uvx",
+    "id": "uv",
+    "version": "1.0.0",
+    "description": "A single tool to replace pip, pip-tools, pipx, poetry, pyenv, virtualenv, and more.",
+    "options": {
+        "version": {
+            "type": "string",
+            "default": "latest",
+            "description": "Version of UV to install. Accepts versions with 'v' prefix."
+        }
+    }
+}

src/uv/install.sh

@@ -0,0 +1,114 @@
+#!/bin/bash
+
+# Variables
+REPO_OWNER="astral-sh"
+REPO_NAME="uv"
+BINARY_NAME="uv"
+
+set -e
+
+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
+
+# Clean up
+rm -rf /var/lib/apt/lists/*
+
+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
+}
+
+# make sure we have packages
+check_packages curl tar jq ca-certificates
+
+# Function to get the latest version from GitHub API
+get_latest_version() {
+    LATEST_URL="https://api.github.com/repos/$REPO_OWNER/$REPO_NAME/releases/latest"
+    curl -s "$LATEST_URL" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/'
+}
+
+# Check if a version is passed as an argument
+if [ -z "$VERSION" ] || [ "$VERSION" == "latest" ]; then
+    # No version provided, get the latest version
+    VERSION=$(get_latest_version)
+    echo "No version provided or 'latest' specified, installing the latest version: $VERSION"
+else
+    VERSION=${VERSION#"v"}
+    echo "Installing version from environment variable: $VERSION"
+fi
+
+# Determine the OS and architecture following the naming template
+OS=$(uname | tr '[:upper:]' '[:lower:]')
+ARCH=$(uname -m)
+
+case "$ARCH" in
+    x86_64)
+        ARCH="x86_64"
+        ;;
+    i686)
+        ARCH="i686"
+        ;;
+    armv7l)
+        ARCH="armv7"
+        ;;
+    aarch64)
+        ARCH="aarch64"
+        ;;
+    powerpc64)
+        ARCH="powerpc64"
+        ;;
+    powerpc64le)
+        ARCH="powerpc64le"
+        ;;
+    s390x)
+        ARCH="s390x"
+        ;;
+    *)
+        echo "Unsupported architecture: $ARCH"
+        exit 1
+        ;;
+esac
+
+# Construct the download URL to match the naming template
+if [[ "$OS" == "darwin" ]]; then
+    OS="apple-darwin"
+elif [[ "$OS" == "linux" ]]; then
+    OS="unknown-linux-gnu"
+else
+    echo "Unsupported OS: $OS"
+    exit 1
+fi
+
+DOWNLOAD_URL="https://github.com/$REPO_OWNER/$REPO_NAME/releases/download/$VERSION/${REPO_NAME}-${ARCH}-${OS}.tar.gz"
+
+# Create a temporary directory for the download
+TMP_DIR=$(mktemp -d)
+cd "$TMP_DIR" || exit
+
+# Download the binary tarball
+echo "Downloading $BINARY_NAME from $DOWNLOAD_URL"
+curl -LO "$DOWNLOAD_URL"
+
+# Extract the tarball
+echo "Extracting the tarball"
+tar -xzf "${REPO_NAME}-${ARCH}-${OS}.tar.gz"
+
+# Move the binary to /usr/local/bin
+echo "Installing $BINARY_NAME"
+mv ${REPO_NAME}-${ARCH}-${OS}/* /usr/local/bin/
+
+
+# Cleanup
+cd - || exit
+rm -rf "$TMP_DIR"
+
+# Verify installation
+echo "Verifying installation"
+$BINARY_NAME --version

test/_global/all-tools.sh

@@ -10,6 +10,7 @@ check "kyverno" kyverno version
 check "cyclonedx" cyclonedx --version
 check "gitleaks" gitleaks version
 check "gic" gic --version
+check "uv" uv --version
 check "jnv" jnv -V
 check "zarf" zarf version
 

test/_global/kyverno-specific-version.sh

@@ -2,6 +2,6 @@
 
 set -e
 source dev-container-features-test-lib
-check "kyverno with specific version" /bin/bash -c "kyverno version | grep '1.11.4'"
+check "kyverno with specific version" /bin/bash -c "kyverno version | grep '1.12.6'"
 
 reportResults