check code format in CI (#533)

* splitting code coverage * fixed flags * debugging code coverage * debugging code coverage * debugging code coverage * debugging code coverage * check code format in ci * check code format in ci * reformatted code files * reformatted code files * fixing ci format * fixing ci format * fixing ci format * fixing ci format * more fixes * more fixes * more fixes * added .clang-format * added .clang-format * added .clang-format * added .clang-format * changing runner for developer workflow * changing runner for developer workflow * another fix * updated doxyfile.in * fixed docs
NOAA-EMC · Oct 29, 2024 · da8e6f1 · da8e6f1
1 parent f82b45b
commit da8e6f1
Show file tree

Hide file tree

Showing 13 changed files with 719 additions and 375 deletions.
diff --git a/.github/workflows/developer.yml b/.github/workflows/developer.yml
@@ -14,21 +14,41 @@ concurrency:
 
 jobs:
   developer:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     env:
       CC: gcc
       CXX: g++
 
     strategy:
       fail-fast: true
       matrix:
-        config: ["asan/code coverage", "memcheck"]
+        config: ["asan", "code coverage", "memcheck", "docs", "format"]
 
     steps:
     - name: install-dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install libpng-dev zlib1g-dev libjpeg-dev doxygen libopenjp2-7-dev valgrind libaec-dev
+        sudo apt-get install libpng-dev zlib1g-dev libjpeg-dev libopenjp2-7-dev libaec-dev 
+
+    - name: install-format-dependencies
+      if: matrix.config == 'format'      
+      run: |
+        sudo apt-get install clang-format
+
+    - name: install-docs-dependencies
+      if: matrix.config == 'docs'      
+      run: |
+        sudo apt-get install doxygen
+
+    - name: install-memory-dependencies
+      if: matrix.config == 'memory'      
+      run: |
+        sudo apt-get install valgrind
+
+    - name: install-code_coverage-dependencies
+      if: matrix.config == 'code coverage'      
+      run: |
+        sudo apt-get install clang-format
         python3 -m pip install gcovr
 
     - name: "Build dependencies"
@@ -49,37 +69,73 @@ jobs:
         key: data-2
 
     - name: asan
-      if: matrix.config == 'asan/code coverage'
+      if: matrix.config == 'asan'
       run: |
         set -x
         export CC=gcc
-        cmake -S g2c -B g2c/build -DUSE_AEC=ON -DJasper_ROOT=$GITHUB_WORKSPACE/nceplibs/jasper -DBUILD_G2C=ON -DLOGGING=On -DENABLE_DOCS=On -DPTHREADS=ON -DFTP_TEST_FILES=ON -DFTP_LARGE_TEST_FILES=OFF -DTEST_FILE_DIR=/home/runner/data -DCMAKE_BUILD_TYPE=Debug
+        cmake -S g2c -B g2c/build -DUSE_AEC=ON -DJasper_ROOT=$GITHUB_WORKSPACE/nceplibs/jasper -DBUILD_G2C=ON -DLOGGING=On -DPTHREADS=ON -DFTP_TEST_FILES=ON -DFTP_LARGE_TEST_FILES=OFF -DTEST_FILE_DIR=/home/runner/data -DCMAKE_BUILD_TYPE=Debug-DCMAKE_C_FLAGS="-Werror -g -O0 -fsanitize=address -fno-omit-frame-pointer" 
         cmake --build g2c/build --parallel 2 --verbose
         ctest --test-dir g2c/build --verbose --output-on-failure --rerun-failed
-        gcovr --root g2c -v  --html-details --exclude g2c/tests --exclude g2c/build/CMakeFiles --print-summary -o test-coverage.html
+        
+    - name: code_coverage
+      if: matrix.config == 'code coverage'
+      run: |
+        set -x
+        export CC=gcc
+        cmake -S g2c -B g2c/build -DUSE_AEC=ON -DJasper_ROOT=$GITHUB_WORKSPACE/nceplibs/jasper -DBUILD_G2C=ON -DLOGGING=On -DPTHREADS=ON -DFTP_TEST_FILES=ON -DFTP_LARGE_TEST_FILES=OFF -DTEST_FILE_DIR=/home/runner/data -DCMAKE_BUILD_TYPE=Debug-DCMAKE_C_FLAGS="-g -fprofile-arcs -ftest-coverage -fprofile-abs-path -O0"
+        pwd
+        cd g2c/build
+        make VERBOSE=1
+        ctest --verbose --output-on-failure --rerun-failed
+        gcovr --root .. -v  --html-details --exclude tests --exclude CMakeFiles --print-summary -o test-coverage.html
+        pwd
         ls -l
+        ls -l src
         
     - name: memcheck
       if: matrix.config == 'memcheck'
       run: |
         set -x
         export LD_LIBRARY_PATH="/home/runner/jasper/lib:$LD_LIBRARY_PATH"
-        cmake -S g2c -B g2c/build -DUSE_AEC=ON -DJasper_ROOT=$GITHUB_WORKSPACE/nceplibs/jasper -DBUILD_G2C=ON -DLOGGING=On -DENABLE_DOCS=On -DPTHREADS=ON -DFTP_TEST_FILES=ON -DTEST_FILE_DIR=/home/runner/data -DCMAKE_BUILD_TYPE=Debug
+        cmake -S g2c -B g2c/build -DUSE_AEC=ON -DJasper_ROOT=$GITHUB_WORKSPACE/nceplibs/jasper -DBUILD_G2C=ON -DLOGGING=On -DPTHREADS=ON -DFTP_TEST_FILES=ON -DTEST_FILE_DIR=/home/runner/data -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS="-g" 
         cmake --build g2c/build --parallel 2 --verbose
         ctest --test-dir g2c/build
         ls -l g2c/build
         
+    - name: docs
+      if: matrix.config == 'docs'
+      run: |
+        set -x
+        export LD_LIBRARY_PATH="/home/runner/jasper/lib:$LD_LIBRARY_PATH"
+        cmake -S g2c -B g2c/build -DUSE_AEC=ON -DJasper_ROOT=$GITHUB_WORKSPACE/nceplibs/jasper -DBUILD_G2C=ON -DENABLE_DOCS=On -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS="-g" 
+        cmake --build g2c/build --parallel 2 --verbose
+        ls -l g2c/build/docs/html
+        
+    - name: format
+      if: matrix.config == 'format'
+      run: |
+        set -x
+        cd g2c
+        clang-format --version        
+        find . -name '*.[ch]'|xargs clang-format -Werror --verbose --dry-run
+        
     - name: cache-data
       if: steps.cache-data.outputs.cache-hit != 'true'
       run: |
         mkdir ~/data
         cp $GITHUB_WORKSPACE/g2c/build/tests/data/* ~/data
         
     - name: upload-test-coverage
-      if: matrix.config == 'asan/code coverage'      
+      if: matrix.config == 'code coverage'      
       uses: actions/upload-artifact@v4
       with:
         name: g2c-test-coverage
         path: |
           *.html
           *.css
+    - uses: actions/upload-artifact@v4
+      if: matrix.config == 'docs'
+      with:
+        name: docs
+        path: |
+          g2c/build/docs/html
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,6 @@ build/
 install/
 .vscode/
 
-*.[ao]
 *.mod
 *.so
 *.swp
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,6 @@ build/ @@
     install/
     .vscode/
-    *.[ao]
     *.mod
     *.so
     *.swp
@@ Expand Down @@