Skip to content

Commit c3b8c23

Browse files
31chtumaisch
31ch
authored and
tumaisch
committed
Add scripted Jenkinsfile
1 parent 7ca366c commit c3b8c23

23 files changed

+3646
-103
lines changed

‎.clang-tidy‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
Checks: 'clang-analyzer-*,cppcoreguidelines-*,modernize-*,performance-*,portability-*,readability-*'

‎.devcontainer/Dockerfile‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# https://github.com/devcontainers/images/tree/main/src/cpp
22
FROM mcr.microsoft.com/devcontainers/cpp:1-debian-12
33

4-
# [Optional] Uncomment this section to install additional packages.
4+
# Install additional packages
55
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
66
&& apt-get -y install --no-install-recommends \
77
clang-format \
8+
clang-tidy \
9+
doxygen \
810
gcovr \
11+
graphviz \
12+
iwyu \
913
&& apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/*

‎.github/workflows/docker-build-publish.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Build and publish Docker image
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- ".devcontainer/Dockerfile"
9+
pull_request:
10+
branches:
11+
- main
12+
paths:
13+
- ".devcontainer/Dockerfile"
14+
workflow_dispatch:
15+
16+
jobs:
17+
build-and-publish:
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Set up QEMU
25+
uses: docker/setup-qemu-action@v3
26+
27+
- name: Set up Docker Buildx
28+
uses: docker/setup-buildx-action@v3
29+
30+
- name: Log in to GitHub Container Registry
31+
uses: docker/login-action@v3
32+
with:
33+
registry: ghcr.io
34+
username: ${{ github.actor }}
35+
password: ${{ secrets.GITHUB_TOKEN }}
36+
37+
- name: Build and push Docker image
38+
uses: docker/build-push-action@v6
39+
with:
40+
context: .
41+
file: .devcontainer/Dockerfile
42+
push: true
43+
tags: ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name }}:latest

‎.github/workflows/project-build-test.yml‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: Build and test the project
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths-ignore:
8+
- ".devcontainer/Dockerfile"
9+
pull_request:
10+
branches:
11+
- main
12+
paths-ignore:
13+
- ".devcontainer/Dockerfile"
14+
workflow_dispatch:
15+
16+
# IMPORTANT: make sure to use the 'runner user'when running jobs in a container!
17+
# Otherwise there will be 'dubious ownership' issues reported by Git.
18+
# Therefore, make sure to use the '--user 1001' option for the container.
19+
jobs:
20+
build-doc:
21+
runs-on: ubuntu-latest
22+
container:
23+
image: ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name }}:latest
24+
options: --user 1001
25+
steps:
26+
- name: Checkout code
27+
uses: actions/checkout@v4
28+
- name: Build documentation
29+
run: ./tools/build-docs.sh
30+
- name: Upload documentation
31+
uses: actions/upload-artifact@v4
32+
with:
33+
name: documentation
34+
path: "build/html"
35+
retention-days: 1
36+
37+
build-app:
38+
runs-on: ubuntu-latest
39+
container:
40+
image: ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name }}:latest
41+
options: --user 1001
42+
strategy:
43+
matrix:
44+
compiler: [gcc, clang]
45+
steps:
46+
- name: Checkout code
47+
uses: actions/checkout@v4
48+
with:
49+
submodules: "true"
50+
- name: Run clang-format
51+
run: ./tools/clang-format.sh
52+
- name: Build application
53+
run: |
54+
export ENABLE_IWYU=1
55+
export ENABLE_LWYU=1
56+
export ENABLE_CLANG_TIDY=1
57+
export ENABLE_CPPCHECK=1
58+
./tools/build-cmake-target.sh ${{ matrix.compiler }}-release cplusplus_training_project
59+
- name: Upload application
60+
uses: actions/upload-artifact@v4
61+
with:
62+
name: application-${{ matrix.compiler }}
63+
path: "build/${{ matrix.compiler }}-release/bin/cplusplus_training_project"
64+
retention-days: 1
65+
66+
test-app:
67+
runs-on: ubuntu-latest
68+
container:
69+
image: ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name }}:latest
70+
options: --user 1001
71+
strategy:
72+
matrix:
73+
compiler: [gcc, clang]
74+
steps:
75+
- name: Checkout code
76+
uses: actions/checkout@v4
77+
with:
78+
submodules: "true"
79+
- name: Build tests
80+
run: ./tools/build-cmake-target.sh ${{ matrix.compiler }}-coverage calculate_test
81+
- name: Run tests
82+
run: ./tools/run-test.sh build/${{ matrix.compiler }}-coverage/bin/calculate_test build/${{ matrix.compiler }}
83+
- name: Upload test results
84+
uses: actions/upload-artifact@v4
85+
with:
86+
name: test-results-${{ matrix.compiler }}
87+
path: "build/${{ matrix.compiler }}/*.xml"
88+
retention-days: 1

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
build
1+
.vscode/
2+
build/

‎.gitlab-ci.yml‎

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,18 @@ default:
55
stages:
66
- build
77
- test
8+
- deploy
89

910
include:
1011
- template: Jobs/Code-Quality.gitlab-ci.yml
12+
- component: $CI_SERVER_FQDN/devminds-ch/gitlab-component-clang-format/gitlab-component-clang-format@main
1113

1214
build-project:
1315
stage: build
1416
before_script:
1517
- git submodule update --init --recursive
1618
script:
17-
- mkdir build
18-
- cd build
19-
- cmake ..
20-
- make cplusplus_training_project
19+
- ./tools/build-cmake-target.sh gcc-release cplusplus_training_project
2120
artifacts:
2221
paths:
2322
- build/bin
@@ -28,15 +27,24 @@ build-unit-tests:
2827
before_script:
2928
- git submodule update --init --recursive
3029
script:
31-
- mkdir build
32-
- cd build
33-
- cmake ..
34-
- make calculate_test
30+
- ./tools/build-cmake-target.sh gcc-coverage calculate_test
3531
artifacts:
3632
paths:
3733
- build/
3834
expire_in: 1 week
3935

36+
build-documentation:
37+
stage: build
38+
before_script:
39+
- git submodule update --init --recursive
40+
- apt update && apt install -y doxygen
41+
script:
42+
- ./tools/build-docs.sh
43+
artifacts:
44+
paths:
45+
- build/html/
46+
expire_in: 1 week
47+
4048
code_quality:
4149
when: manual
4250

@@ -45,14 +53,23 @@ run-unit-tests:
4553
before_script:
4654
- apt update && apt install -y gcovr
4755
script:
48-
- cd build
49-
- ./bin/calculate_test --gtest_output="xml:test_report.xml"
50-
- gcovr -f ../src -f ../tests --xml-pretty --exclude-unreachable-branches --print-summary -o "coverage_report.xml" --root ${CI_PROJECT_DIR}
56+
- ./tools/run-test.sh build/gcc-coverage/bin/calculate_test build/gcc
5157
coverage: /^\s*lines:\s*\d+.\d+\%/
5258
artifacts:
5359
expire_in: 1 week
5460
reports:
55-
junit: build/test_report.xml
61+
junit: build/gcc/test-report.xml
5662
coverage_report:
5763
coverage_format: cobertura
58-
path: build/coverage_report.xml
64+
path: build/gcc/test-coverage.xml
65+
66+
pages:
67+
stage: deploy
68+
script:
69+
- mv build/html/ public/
70+
environment:
71+
name: "Pages production"
72+
url: "${CI_PAGES_URL}"
73+
artifacts:
74+
paths:
75+
- public/

‎CMakeLists.txt‎

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,41 @@ project(cplusplus_training_project)
1010
set(CMAKE_CXX_STANDARD 14)
1111
set(CMAKE_CXX_STANDARD_REQUIRED ON)
1212

13+
# Enable include-what-you-use (IWYU) if available
14+
find_program(IWYU_PATH NAMES include-what-you-use)
15+
if (IWYU_PATH AND DEFINED ENV{ENABLE_IWYU})
16+
message(STATUS "Enabling: include-what-you-use")
17+
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "${IWYU_PATH}")
18+
endif()
19+
20+
if(DEFINED ENV{ENABLE_LWYU})
21+
# Enable link-what-you-use (LWYU)
22+
message(STATUS "Enabling: link-what-you-use")
23+
set(CMAKE_LINK_WHAT_YOU_USE TRUE)
24+
endif()
25+
26+
# Enable cppcheck if available
27+
find_program(CPPCHECK_PATH NAMES cppcheck)
28+
if (CPPCHECK_PATH AND DEFINED ENV{ENABLE_CPPCHECK})
29+
message(STATUS "Enabling: cppcheck")
30+
set(CMAKE_CXX_CPPCHECK "${CPPCHECK_PATH}")
31+
endif()
32+
33+
# Enable clang-tidy if available
34+
find_program(CLANG_TIDY_PATH NAMES clang-tidy)
35+
if (CLANG_TIDY_PATH AND DEFINED ENV{ENABLE_CLANG_TIDY})
36+
message(STATUS "Enabling: clang-tidy")
37+
set(CMAKE_CXX_CLANG_TIDY "${CLANG_TIDY_PATH}")
38+
endif()
39+
40+
# Enable code coverage for GCC and Clang if PROFILE build type is selected
1341
if(CMAKE_BUILD_TYPE STREQUAL "PROFILE")
14-
# Setup code coverage for GCC
15-
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
16-
message(STATUS "Enabling code coverage for gcc")
42+
if((CMAKE_CXX_COMPILER_ID STREQUAL "GNU") OR (CMAKE_CXX_COMPILER_ID STREQUAL "Clang"))
43+
message(STATUS "Enabling code coverage")
1744
set(CMAKE_CXX_FLAGS_PROFILE --coverage)
18-
set(GCOV_LINK gcov)
45+
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
46+
set(GCOV_LINK gcov)
47+
endif()
1948
endif()
2049
endif()
2150

0 commit comments

Comments
 (0)