Merge pull request #127 from JacobDomagala/126-update-tools

[#126]: Update tools and ubuntu image

.github/workflows/linter.yml

@@ -35,5 +35,3 @@ jobs:
           extra-mypy-options: "--ignore-missing-imports --show-error-codes"
           extra-flake8-options: "--max-line-length=120 --ignore=E203,E402"
           extra-pycodestyle-options: "--max-line-length=120 --ignore=E203,E402"
-
-

.github/workflows/shellcheck.yml

@@ -13,4 +13,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Run ShellCheck
-        uses: ludeeus/action-shellcheck@master
+        uses: ludeeus/action-shellcheck@master
+        with:
+          ignore_names: llvm.sh # External file

.github/workflows/test_action.yml

@@ -74,4 +74,3 @@ jobs:
 
             ***
             ### [Result for pull_request_target (non CMake)](https://github.com/JacobDomagala/TestRepo/pull/7#issuecomment-1404101648)
-

.github/workflows/unit_tests.yml

@@ -23,5 +23,3 @@ jobs:
       - name: Test with pytest
         run: |
           pytest
-
-

docker/static_analysis.dockerfile

@@ -1,8 +1,8 @@
-FROM ubuntu:23.04 as base
+FROM ubuntu:24.04 AS base
 
 # Define versions as environment variables
-ENV CLANG_VERSION=18 \
-    CPPCHECK_VERSION=2.14.0 \
+ENV CLANG_VERSION=20 \
+    CPPCHECK_VERSION=2.16.0 \
     CXX=clang++ \
     CC=clang \
     DEBIAN_FRONTEND=noninteractive

entrypoint_cpp.sh

@@ -67,16 +67,16 @@ else
         cat cppcheck_*.txt > cppcheck.txt
 
         # Excludes for clang-tidy are handled in python script
-        debug_print "Running run-clang-tidy-18 $CLANG_TIDY_ARGS -p $(pwd) $files_to_check >>clang_tidy.txt 2>&1"
-        eval run-clang-tidy-18 "$CLANG_TIDY_ARGS" -p "$(pwd)" "$files_to_check" >clang_tidy.txt 2>&1 || true
+        debug_print "Running run-clang-tidy-20 $CLANG_TIDY_ARGS -p $(pwd) $files_to_check >>clang_tidy.txt 2>&1"
+        eval run-clang-tidy-20 "$CLANG_TIDY_ARGS" -p "$(pwd)" "$files_to_check" >clang_tidy.txt 2>&1 || true
 
     else
         # Excludes for clang-tidy are handled in python script
         debug_print "Running cppcheck -j $num_proc $files_to_check $CPPCHECK_ARGS --output-file=cppcheck.txt ..."
         eval cppcheck -j "$num_proc" "$files_to_check" "$CPPCHECK_ARGS" --output-file=cppcheck.txt || true
 
-        debug_print "Running run-clang-tidy-18 $CLANG_TIDY_ARGS $files_to_check >>clang_tidy.txt 2>&1"
-        eval run-clang-tidy-18 "$CLANG_TIDY_ARGS" "$files_to_check" >clang_tidy.txt 2>&1 || true
+        debug_print "Running run-clang-tidy-20 $CLANG_TIDY_ARGS $files_to_check >>clang_tidy.txt 2>&1"
+        eval run-clang-tidy-20 "$CLANG_TIDY_ARGS" "$files_to_check" >clang_tidy.txt 2>&1 || true
     fi
 
     cd /

llvm.sh

@@ -27,25 +27,25 @@ BASE_URL="http://apt.llvm.org"
 needed_binaries=(lsb_release wget add-apt-repository gpg)
 missing_binaries=()
 for binary in "${needed_binaries[@]}"; do
-    if ! which "$binary" &>/dev/null ; then
-        missing_binaries+=("$binary")
+    if ! which $binary &>/dev/null ; then
+        missing_binaries+=($binary)
     fi
 done
 if [[ ${#missing_binaries[@]} -gt 0 ]] ; then
-    echo "You are missing some tools this script requires: " "${missing_binaries[@]}"
+    echo "You are missing some tools this script requires: ${missing_binaries[@]}"
     echo "(hint: apt install lsb-release wget software-properties-common gnupg)"
     exit 4
 fi
 
 # Set default values for commandline arguments
 # We default to the current stable branch of LLVM
 LLVM_VERSION=$CURRENT_LLVM_STABLE
+ALL=0
 DISTRO=$(lsb_release -is)
 VERSION=$(lsb_release -sr)
 UBUNTU_CODENAME=""
 CODENAME_FROM_ARGUMENTS=""
 # Obtain VERSION_CODENAME and UBUNTU_CODENAME (for Ubuntu and its derivatives)
-# shellcheck disable=SC1091
 source /etc/os-release
 DISTRO=${DISTRO,,}
 case ${DISTRO} in
@@ -76,18 +76,21 @@ esac
 if [ "$#" -ge 1 ] && [ "${1::1}" != "-" ]; then
     if [ "$1" != "all" ]; then
         LLVM_VERSION=$1
+    else
+        # special case for ./llvm.sh all
+        ALL=1
     fi
     OPTIND=2
     if [ "$#" -ge 2 ]; then
       if [ "$2" == "all" ]; then
           # Install all packages
+          ALL=1
           OPTIND=3
       fi
     fi
 fi
 
 while getopts ":hm:n:" arg; do
-    # shellcheck disable=SC2220
     case $arg in
     h)
         usage
@@ -124,7 +127,9 @@ LLVM_VERSION_PATTERNS[15]="-15"
 LLVM_VERSION_PATTERNS[16]="-16"
 LLVM_VERSION_PATTERNS[17]="-17"
 LLVM_VERSION_PATTERNS[18]="-18"
-LLVM_VERSION_PATTERNS[19]=""
+LLVM_VERSION_PATTERNS[19]="-19"
+LLVM_VERSION_PATTERNS[20]="-20"
+LLVM_VERSION_PATTERNS[21]=""
 
 if [ ! ${LLVM_VERSION_PATTERNS[$LLVM_VERSION]+_} ]; then
     echo "This script does not support LLVM version $LLVM_VERSION"
@@ -138,7 +143,7 @@ if [[ -n "${CODENAME}" ]]; then
     REPO_NAME="deb ${BASE_URL}/${CODENAME}/  llvm-toolchain${LINKNAME}${LLVM_VERSION_STRING} main"
 
     # check if the repository exists for the distro and version
-    if ! wget -q --method=HEAD "${BASE_URL}/${CODENAME}" &> /dev/null; then
+    if ! wget -q --method=HEAD ${BASE_URL}/${CODENAME} &> /dev/null; then
         if [[ -n "${CODENAME_FROM_ARGUMENTS}" ]]; then
             echo "Specified codename '${CODENAME}' is not supported by this script."
         else
@@ -156,12 +161,25 @@ if [[ ! -f /etc/apt/trusted.gpg.d/apt.llvm.org.asc ]]; then
     wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc
 fi
 
-# shellcheck disable=SC2006
 if [[ -z "`apt-key list 2> /dev/null | grep -i llvm`" ]]; then
     # Delete the key in the old format
-    apt-key del AF4F7421
+    apt-key del AF4F7421 || true
 fi
+if [[ "${VERSION_CODENAME}" == "bookworm" ]]; then
+    # add it twice to workaround:
+    # https://github.com/llvm/llvm-project/issues/62475
+    add-apt-repository -y "${REPO_NAME}"
+fi
+
 add-apt-repository -y "${REPO_NAME}"
 apt-get update
-PKG="clang-$LLVM_VERSION lld-$LLVM_VERSION clangd-$LLVM_VERSION clang-tidy-$LLVM_VERSION"
-apt-get install -y "$PKG"
+PKG="clang-$LLVM_VERSION lldb-$LLVM_VERSION lld-$LLVM_VERSION clangd-$LLVM_VERSION clang-tidy-$LLVM_VERSION clang-format-$LLVM_VERSION clang-tools-$LLVM_VERSION"
+if [[ $ALL -eq 1 ]]; then
+    # same as in test-install.sh
+    # No worries if we have dups
+    PKG="$PKG clang-tidy-$LLVM_VERSION clang-format-$LLVM_VERSION clang-tools-$LLVM_VERSION llvm-$LLVM_VERSION-dev lld-$LLVM_VERSION lldb-$LLVM_VERSION llvm-$LLVM_VERSION-tools libomp-$LLVM_VERSION-dev libc++-$LLVM_VERSION-dev libc++abi-$LLVM_VERSION-dev libclang-common-$LLVM_VERSION-dev libclang-$LLVM_VERSION-dev libclang-cpp$LLVM_VERSION-dev libunwind-$LLVM_VERSION-dev"
+    if test $LLVM_VERSION -gt 14; then
+        PKG="$PKG libclang-rt-$LLVM_VERSION-dev libpolly-$LLVM_VERSION-dev"
+    fi
+fi
+apt-get install -y $PKG

src/sa_utils.py

@@ -318,7 +318,9 @@ def create_or_edit_comment(comment_body):
         pull_request.create_issue_comment(body=comment_body)
 
 
-def generate_output(is_note, file_path, file_line_start, file_line_end, description):
+def generate_output(
+    is_note, prefix_and_file_path, file_line_start, file_line_end, description
+):
     """
     Generate a formatted output string based on the details of a code issue.
 
@@ -344,14 +346,15 @@ def generate_output(is_note, file_path, file_line_start, file_line_end, descript
     """
 
     if not is_note:
+        prefix, file_path = prefix_and_file_path
         if TARGET_REPO_NAME != REPO_NAME:
             if file_path not in FILES_WITH_ISSUES:
                 try:
-                    with open(f"{file_path}", encoding="utf-8") as file:
+                    with open(f"{prefix}/{file_path}", encoding="utf-8") as file:
                         lines = file.readlines()
                         FILES_WITH_ISSUES[file_path] = lines
                 except FileNotFoundError:
-                    print(f"Error: The file '{file_path}' was not found.")
+                    print(f"Error: The file '{prefix}/{file_path}' was not found.")
 
             modified_content = FILES_WITH_ISSUES[file_path][
                 file_line_start - 1 : file_line_end - 1

src/static_analysis_cpp.py

@@ -64,7 +64,11 @@ def create_comment_for_output(
                 )
                 was_note = is_note
                 new_line = utils.generate_output(
-                    is_note, file_path, file_line_start, file_line_end, description
+                    is_note,
+                    (prefix, file_path),
+                    file_line_start,
+                    file_line_end,
+                    description,
                 )
 
                 if utils.check_for_char_limit(new_line):

src/static_analysis_python.py

@@ -104,7 +104,7 @@ def create_comment_for_output(tool_output, files_changed_in_pr, output_to_consol
             )
 
             new_line = utils.generate_output(
-                False, file_path, file_line_start, file_line_end, description
+                False, ("", file_path), file_line_start, file_line_end, description
             )
 
             if utils.check_for_char_limit(new_line):