ci: add support for rust linting in the ci

Allows building of ci/Dockerfile and uses the image to do
rust format and clippy as GitHub actions

Signed-off-by: Alan Wandke <[email protected]>

Author: awandke

.dockerignore

@@ -0,0 +1,24 @@
+---
+name: Rust Format and Clippy
+
+on:
+  push:
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    container:
+      image: ghcr.io/nationalsecurityagency/seabee:build
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check formatting
+        run: cargo fmt -- --check
+
+      - name: Run Clippy
+        run: cargo clippy --all-targets --all-features --no-deps

.github/workflows/rust-lint.yml

@@ -1,10 +1,10 @@
 ARG DOCKER_MIRROR
 
-FROM ${DOCKER_MIRROR}rust:1.79.0-slim
+FROM ${DOCKER_MIRROR}rust:slim
 
-COPY scripts/update_root_dependencies.sh /scripts/update_root_dependencies.sh
-COPY scripts/update_test_dependencies.sh /scripts/update_test_dependencies.sh
-COPY scripts/update_dependencies.sh /scripts/update_dependencies.sh
+LABEL org.opencontainers.image.source=https://github.com/NationalSecurityAgency/seabee
+
+COPY scripts /scripts
 
 RUN DOCKER=1 /scripts/update_dependencies.sh \
     && rm -rf /var/lib/apt/lists/*

ci/Dockerfile

@@ -5,17 +5,22 @@ TOP_DIR=$(dirname "$(dirname "$(realpath "$0" || true)")")
 ASCIINEMA_VERSION=2.4.0
 POETRY_VERSION=1.8.3
 PYTHON_VERSION=3.9
-RUST_VERSION=1.79.0
 
 ASCIINEMA=asciinema
 export DOCKER="${DOCKER:-0}"
 POETRY=poetry
 PYTHON=python3
 RUSTUP="$HOME/.cargo/bin/rustup"
 
+# Docker container doesn't have sudo
+SUDO="sudo"
+if [ "$DOCKER" -eq 1 ]; then
+  SUDO=""
+fi
+
 if [ "$EUID" -eq 0 ] && [ "$DOCKER" -eq 0 ]; then
   printf "Please don't run this script as root or sudo\n"
-  exit
+  exit 1
 fi
 
 # https://unix.stackexchange.com/a/567537
@@ -45,11 +50,14 @@ python_check() {
   source "$HOME/.bashrc" && poetry install
 }
 
+# install the latest stable verison of rust
 rust_check() {
   if ! command -V "$RUSTUP" &>/dev/null; then
     printf "Rustup not detected. Installing...\n"
-    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --profile default --default-toolchain $RUST_VERSION -y
+    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --profile default stable -y
   fi
+  # Install rust lints
+  rustup component add rustfmt clippy
 }
 
 autocast_check() {
@@ -58,7 +66,7 @@ autocast_check() {
   fi
 }
 
-sudo "$TOP_DIR"/scripts/update_root_dependencies.sh
+$SUDO "$TOP_DIR"/scripts/update_root_dependencies.sh
 python_check
 rust_check
 autocast_check

scripts/update_dependencies.sh

@@ -21,7 +21,7 @@ version_greater_equal() {
 os_check() {
   ID=$(grep "^ID=" /etc/os-release | cut -d= -f2 | tr -d "\"")
   case $ID in
-  ubuntu)
+  ubuntu | debian)
     USE_APT=1
     ;;
   fedora | rocky)
@@ -34,7 +34,7 @@ os_check() {
 install_system_packages() {
   printf "Installing tools and libraries needed for development\n"
   local common_deps
-  common_deps=(clang pipx python3 python3-pip strace)
+  common_deps=(clang make pipx python3 python3-pip strace)
   # depedencies necessary to build static libraries for libelf and zlib
   # which are dependencies of libbpf which is also built statically
   local library_deps library_deps_deb library_deps_dnf