Skip to content

do basic CI code checks in the docker #1250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

do basic CI code checks in the docker #1250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions .github/docker/ubuntu-22.04.Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2024 Intel Corporation
# Copyright (C) 2024-2025 Intel Corporation
# Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

Expand Down Expand Up @@ -37,7 +37,11 @@ ARG MISC_DEPS="\
clang \
python3-pip \
sudo \
whois"
whois \
wget \
libenchant-2-dev \
jq \
doxygen"

# Update and install required packages
RUN apt-get update \
Expand All @@ -55,6 +59,7 @@ RUN mkdir --mode 777 /opt/umf/
# Additional dependencies (installed via pip)
COPY third_party/requirements.txt /opt/umf/requirements.txt
RUN pip3 install --no-cache-dir -r /opt/umf/requirements.txt
RUN pip3 install bandit codespell
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this is not in requirements?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lukaszstolarczuk could you help here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done: #1276


# Add a new (non-root) 'test_user'
ENV USER test_user
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr_push.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ permissions:

jobs:
CodeChecks:
uses: ./.github/workflows/reusable_checks.yml
uses: ./.github/workflows/reusable_docker_checks.yml
DocsBuild:
uses: ./.github/workflows/reusable_docs_build.yml
FastBuild:
Expand Down
41 changes: 17 additions & 24 deletions .github/workflows/reusable_checks.yml → .github/workflows/reusable_docker_checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Basic checks on the code, incl. coding style, spelling, bandit analysis.
# TODO: add license check
name: Basic checks

on: workflow_call
Expand All @@ -10,48 +9,43 @@ permissions:
jobs:
CodeChecks:
name: Basic code checks
runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-22.04' || 'ubuntu-latest' }}
runs-on: 'DSS-L0-FLEX'
container:
image: localhost:5000/umf_docker:latest
# root is needed at least for the checkout step, see
# https://github.com/actions/checkout/issues/1575
options: --user root

steps:
- name: Checkout repository
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0

- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y black cmake clang-format-15 cmake-format libhwloc-dev doxygen

# Latest distros do not allow global pip installation
- name: Install Python requirements in venv
run: |
python3 -m venv .venv
. .venv/bin/activate
echo "$PATH" >> $GITHUB_PATH
python3 -m pip install -r third_party/requirements.txt
python3 -m pip install bandit codespell

- name: Configure CMake
- name: Configure CMake
run: >
cmake
-B ${{github.workspace}}/build
-B build
-DUMF_FORMAT_CODE_STYLE=ON
-DUMF_BUILD_TESTS=OFF
-DUMF_BUILD_LEVEL_ZERO_PROVIDER=OFF
-DUMF_BUILD_CUDA_PROVIDER=OFF
-DUMF_BUILD_LIBUMF_POOL_JEMALLOC=OFF

- name: Check C/C++ formatting
run: cmake --build build --target clang-format-check
run: |
cmake --build build --target clang-format-check
git diff --exit-code

- name: Check CMake formatting
run: |
cmake --build build --target cmake-format-apply
git diff --exit-code

- name: Check Python formatting
run: cmake --build build --target black-format-check
run: |
cmake --build build --target black-format-check
git diff --exit-code

- name: Run check-license
run: |
Expand All @@ -67,10 +61,9 @@ jobs:

- name: Check spelling in docs
run: |
cmake -B build
cmake --build build --target docs
sphinx-build -b spelling ./build/docs_build/config ./build/docs_build/spelling_log -W

# Run Bandit recursively, but omit _deps directory (with 3rd party code) and python's venv
# Run Bandit recursively, but omit _deps directory (with 3rd party code)
- name: Run Bandit
run: python3 -m bandit -r . -x '/_deps/,/.venv/'
run: python3 -m bandit -r . -x '/_deps/'