Add bazel-compile-commands

src/bazel-compile-commands/README.md

@@ -0,0 +1,42 @@
+# bazel-compile-commands (via Github Releases) (bazel-compile-commands)
+
+Generates `compile_commands.json` from Bazel builds, enabling accurate code intelligence (go-to-definition, cross-references, diagnostics) in editors that support the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/).
+
+## Example Usage
+
+```json
+"features": {
+    "ghcr.io/devcontainers-extra/features/bazel-compile-commands:1": {}
+}
+```
+
+## Options
+
+| Options Id | Description                                                                                                                      | Type   | Default Value |
+| ---------- | -------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------- |
+| version    | Version to install. Accepts `latest`, a numeric version like `0.22.4`, or the full release tag `bazel-compile-commands-v0.22.4`. | string | latest        |
+
+## Install behaviour
+
+The feature selects the best available package for the current environment:
+
+| Environment          | Package used                    |
+| -------------------- | ------------------------------- |
+| Ubuntu Noble (24.04) | Native `.deb` via `apt-get`     |
+| Other Linux          | Generic `.zip` (amd64 or arm64) |
+| macOS                | Universal `.zip`                |
+
+## Pairing with Bazel
+
+This feature pairs naturally with [`ghcr.io/devcontainers-community/features/bazel:1`](https://github.com/devcontainers-community/features-bazel), which installs Bazelisk and Buildifier. When both are present in `devcontainer.json`, the Bazel feature is installed first.
+
+```json
+"features": {
+    "ghcr.io/devcontainers-community/features/bazel:1": {},
+    "ghcr.io/devcontainers-extra/features/bazel-compile-commands:1": {}
+}
+```
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](devcontainer-feature.json). Add additional notes to a `NOTES.md`._

src/bazel-compile-commands/devcontainer-feature.json

@@ -0,0 +1,21 @@
+{
+    "id": "bazel-compile-commands",
+    "version": "1.0.0",
+    "name": "bazel-compile-commands (via Github Releases)",
+    "documentationURL": "http://github.com/devcontainers-extra/features/tree/main/src/bazel-compile-commands",
+    "description": "Generates compile_commands.json from Bazel builds.",
+    "options": {
+        "version": {
+            "default": "latest",
+            "description": "Version to install. Accepts 'latest' or a numeric version like '0.22.4'.",
+            "proposals": [
+                "latest",
+                "0.22.4"
+            ],
+            "type": "string"
+        }
+    },
+    "installsAfter": [
+        "ghcr.io/devcontainers-community/features/bazel"
+    ]
+}

src/bazel-compile-commands/install.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+set -e
+
+. ./library_scripts.sh
+
+# nanolayer is a cli utility which keeps container layers as small as possible
+# source code: https://github.com/devcontainers-extra/nanolayer
+# `ensure_nanolayer` is a bash function that will find any existing nanolayer installations,
+# and if missing - will download a temporary copy that automatically get deleted at the end
+# of the script
+ensure_nanolayer nanolayer_location "v0.5.6"
+
+# Upstream tags use a non-standard "bazel-compile-commands-v<ver>" format. Normalise
+# any plain version (e.g. "0.22.4" or "v0.22.4") so nanolayer can match it exactly.
+if [[ "${VERSION}" != "latest" && "${VERSION}" != bazel-compile-commands-* ]]; then
+    VERSION="bazel-compile-commands-v${VERSION#v}"
+fi
+
+$nanolayer_location \
+    install \
+    devcontainer-feature \
+    "ghcr.io/devcontainers-extra/features/gh-release:1" \
+    --option repo='kiron1/bazel-compile-commands' \
+    --option binaryNames='bazel-compile-commands' \
+    --option version="$VERSION" \
+    --option assetRegex='linux_' \
+    --option releaseTagRegex='bazel-compile-commands-v'
+
+echo 'Done!'

src/bazel-compile-commands/library_scripts.sh

@@ -0,0 +1,173 @@
+#!/usr/bin/env bash
+
+clean_download() {
+    # The purpose of this function is to download a file with minimal impact on container layer size
+    # this means if no valid downloader is found (curl or wget) then we install a downloader (currently wget) in a
+    # temporary manner, and making sure to
+    # 1. uninstall the downloader at the return of the function
+    # 2. revert back any changes to the package installer database/cache (for example apt-get lists)
+    # The above steps will minimize the leftovers being created while installing the downloader
+    # Supported distros:
+    #  debian/ubuntu/alpine
+
+    url=$1
+    output_location=$2
+    tempdir=$(mktemp -d)
+    downloader_installed=""
+
+    function _apt_get_install() {
+        tempdir=$1
+
+        # copy current state of apt list - in order to revert back later (minimize contianer layer size)
+        cp -p -R /var/lib/apt/lists $tempdir
+        apt-get update -y
+        apt-get -y install --no-install-recommends wget ca-certificates
+    }
+
+    function _apt_get_cleanup() {
+        tempdir=$1
+
+        echo "removing wget"
+        apt-get -y purge wget --auto-remove
+
+        echo "revert back apt lists"
+        rm -rf /var/lib/apt/lists/*
+        rm -r /var/lib/apt/lists && mv $tempdir/lists /var/lib/apt/lists
+    }
+
+    function _apk_install() {
+        tempdir=$1
+        # copy current state of apk cache - in order to revert back later (minimize contianer layer size)
+        cp -p -R /var/cache/apk $tempdir
+
+        apk add --no-cache wget
+    }
+
+    function _apk_cleanup() {
+        tempdir=$1
+
+        echo "removing wget"
+        apk del wget
+    }
+    # try to use either wget or curl if one of them already installer
+    if type curl >/dev/null 2>&1; then
+        downloader=curl
+    elif type wget >/dev/null 2>&1; then
+        downloader=wget
+    else
+        downloader=""
+    fi
+
+    # in case none of them is installed, install wget temporarly
+    if [ -z $downloader ]; then
+        if [ -x "/usr/bin/apt-get" ]; then
+            _apt_get_install $tempdir
+        elif [ -x "/sbin/apk" ]; then
+            _apk_install $tempdir
+        else
+            echo "distro not supported"
+            exit 1
+        fi
+        downloader="wget"
+        downloader_installed="true"
+    fi
+
+    if [ $downloader = "wget" ]; then
+        wget -q $url -O $output_location
+    else
+        curl -sfL $url -o $output_location
+    fi
+
+    # NOTE: the cleanup procedure was not implemented using `trap X RETURN` only because
+    # alpine lack bash, and RETURN is not a valid signal under sh shell
+    if ! [ -z $downloader_installed ]; then
+        if [ -x "/usr/bin/apt-get" ]; then
+            _apt_get_cleanup $tempdir
+        elif [ -x "/sbin/apk" ]; then
+            _apk_cleanup $tempdir
+        else
+            echo "distro not supported"
+            exit 1
+        fi
+    fi
+
+}
+
+ensure_nanolayer() {
+    # Ensure existance of the nanolayer cli program
+    local variable_name=$1
+
+    local required_version=$2
+    # normalize version
+    if ! [[ $required_version == v* ]]; then
+        required_version=v$required_version
+    fi
+
+    local nanolayer_location=""
+
+    # If possible - try to use an already installed nanolayer
+    if [[ -z "${NANOLAYER_FORCE_CLI_INSTALLATION}" ]]; then
+        if [[ -z "${NANOLAYER_CLI_LOCATION}" ]]; then
+            if type nanolayer >/dev/null 2>&1; then
+                echo "Found a pre-existing nanolayer in PATH"
+                nanolayer_location=nanolayer
+            fi
+        elif [ -f "${NANOLAYER_CLI_LOCATION}" ] && [ -x "${NANOLAYER_CLI_LOCATION}" ]; then
+            nanolayer_location=${NANOLAYER_CLI_LOCATION}
+            echo "Found a pre-existing nanolayer which were given in env variable: $nanolayer_location"
+        fi
+
+        # make sure its of the required version
+        if ! [[ -z "${nanolayer_location}" ]]; then
+            local current_version
+            current_version=$($nanolayer_location --version)
+            if ! [[ $current_version == v* ]]; then
+                current_version=v$current_version
+            fi
+
+            if ! [ $current_version == $required_version ]; then
+                echo "skipping usage of pre-existing nanolayer. (required version $required_version does not match existing version $current_version)"
+                nanolayer_location=""
+            fi
+        fi
+
+    fi
+
+    # If not previuse installation found, download it temporarly and delete at the end of the script
+    if [[ -z "${nanolayer_location}" ]]; then
+
+        if [ "$(uname -sm)" == "Linux x86_64" ] || [ "$(uname -sm)" == "Linux aarch64" ]; then
+            tmp_dir=$(mktemp -d -t nanolayer-XXXXXXXXXX)
+
+            clean_up() {
+                ARG=$?
+                rm -rf $tmp_dir
+                exit $ARG
+            }
+            trap clean_up EXIT
+
+            if [ -x "/sbin/apk" ]; then
+                clib_type=musl
+            else
+                clib_type=gnu
+            fi
+
+            tar_filename=nanolayer-"$(uname -m)"-unknown-linux-$clib_type.tgz
+
+            # clean download will minimize leftover in case a downloaderlike wget or curl need to be installed
+            clean_download https://github.com/devcontainers-extra/nanolayer/releases/download/$required_version/$tar_filename $tmp_dir/$tar_filename
+
+            tar xfzv $tmp_dir/$tar_filename -C "$tmp_dir"
+            chmod a+x $tmp_dir/nanolayer
+            nanolayer_location=$tmp_dir/nanolayer
+
+        else
+            echo "No binaries compiled for non-x86-linux architectures yet: $(uname -m)"
+            exit 1
+        fi
+    fi
+
+    # Expose outside the resolved location
+    declare -g ${variable_name}=$nanolayer_location
+
+}

test/bazel-compile-commands/scenarios.json

@@ -0,0 +1,25 @@
+{
+    "test": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu-24.04",
+        "features": {
+            "ghcr.io/devcontainers-community/features/bazel:1": {},
+            "bazel-compile-commands": {}
+        }
+    },
+    "test_specific_version": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu-24.04",
+        "features": {
+            "ghcr.io/devcontainers-community/features/bazel:1": {},
+            "bazel-compile-commands": {
+                "version": "0.22.4"
+            }
+        }
+    },
+    "test_debian": {
+        "image": "mcr.microsoft.com/devcontainers/base:debian",
+        "features": {
+            "ghcr.io/devcontainers-community/features/bazel:1": {},
+            "bazel-compile-commands": {}
+        }
+    }
+}

test/bazel-compile-commands/test.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -e
+
+source dev-container-features-test-lib
+
+check "bazel-compile-commands is installed" bazel-compile-commands --version
+check "bazelisk is installed" bazelisk --version
+
+reportResults

test/bazel-compile-commands/test_debian.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -e
+
+source dev-container-features-test-lib
+
+check "bazel-compile-commands is installed" bazel-compile-commands --version
+check "bazelisk is installed" bazelisk --version
+
+reportResults

test/bazel-compile-commands/test_specific_version.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+
+source dev-container-features-test-lib
+
+which bazel-compile-commands
+check "bazel-compile-commands version is 0.22.4" sh -c "bazel-compile-commands --version 2>&1 | grep '0.22.4'"
+check "bazelisk is installed" bazelisk --version
+
+reportResults