Can't make commit due to dependencies hash

[vryy]

When I made a commit, the precommit hook throws this error:

Github workflow dependencies hash is up to date..........................Failed - hook id: check-dependencies-hash - exit code: 1

Expecting all jobs to have the dependencies hash b384c190.

The following jobs do not have the correct hash:
In .github/workflows/checkcode.yml:

• clang-tidy
• verify-headers
  In .github/workflows/buildtest.yml:
• gcc13_assertions_build
• gcc13_assertions_test
• gcc9_build
• gcc9_test_minimal
• gcc9_test_install
• clang18_build
• clang18_test_minimal
  In .github/workflows/coverage.yml:
• gcc13_coverage_build
• gcc13_coverage_test
• report
  In .github/workflows/documentation.yml:
• doxygen
• readthedocs
  In .github/workflows/nightly_tests.yml:
• gcc13_assertions_build
• gcc13_assertions_test
• gcc9_build
• gcc9_test
• clang18_build
• clang18_test
• gcc13_asan_build
• gcc13_asan_test

Virtually all workflows are touched, although I did not make any change to the dependency. May I know what this check does and how to pass it?

[sebproell]

@vryy Can you post the --name-only diff of what you are trying to commit? I assume you modified one of the files that gets hashed to ensure all dependencies are in sync, see https://github.com/4C-multiphysics/4C/blob/main/docker/dependencies/compute_dependencies_hash.sh#L12.

[vryy]

Here it is

cmake/setup_install.cmake
cmake/templates/4CConfig.cmake.in
cmake/templates/4CSettings.cmake.in
cmake/templates/4CTargets.cmake.in
cmake/templates/ArborX.cmake.in
cmake/templates/Backtrace.cmake.in
cmake/templates/Boost.cmake.in
cmake/templates/CLN.cmake.in
cmake/templates/FFTW.cmake.in
cmake/templates/HDF5.cmake.in
cmake/templates/MIRCO.cmake.in
cmake/templates/MPI.cmake.in
cmake/templates/Qhull.cmake.in
cmake/templates/Trilinos.cmake.in
cmake/templates/yaml-cpp.cmake.in
tests/install_test/CMakeLists.txt.in
tests/install_test/main.cpp.in
tests/install_test/test_install.sh.in

Actually these new files create problem. But they do not touch the dependencies.

[amgebauer]

This commit hook tries to solve the following problem:

4C needs to build and run the tests within a specific version of the dependencies image. Therefore we generate a hash based on the dependencies-folder and the docker file and tag the resulting image with this hash. In every job, we do the check whether we are running in the correct image.

In our GitHub workflows, we need to explicitly add the tag. We cannot determine it on runtime. If it happens that we forget to adapt this tag in our GitHub workflows, the pipeline will fail. This might happen only after merge in some situations.

To avoid this very early, we added the pre-commit check that verifies that we always specify the correct dependencies-image in our GitHub workflows.

Normally, if you don't change the dependencies, the computation of the hash should be the same on every machine. If this is not the case, it's a bad choice of the hash.

To investigate why this does not work on your machine, let's do the computation of the hash step-by-step and compare the outputs. Note, the following outputs refer to the state from January 9, 2025:

• Step 1: Compute hash of all dependencies files

find dependencies docker/dependencies -not -wholename '*/trilinos_develop/*' -not -name 'README.md' -type f -exec sha1sum {} \;

The output for the current main should be

2ccb95eea6c74ea5b0e892ba6e83158aef0ff32c  dependencies/current/trilinos/install.sh
8ad814d0a9272652590d4092e67f162057c1f492  dependencies/current/suitesparse/install.sh
b532c00fad9a4c507f75c6f4145483cff5493c6b  dependencies/current/cmake/install.sh
c24671ac9bccccfcc29cecc41352673604050246  dependencies/current/qhull/install.sh
54c5e619f8c2ede1e09468a46ab251e996c6d50d  dependencies/current/superlu_dist/install.sh
33067be6b328f83630cf59dc6bc55e9106809ba5  dependencies/current/backtrace/install.sh
eb8768634ec3dc6adb51c0ca558e700d2b11159c  dependencies/testing/paraview/install.sh
791a7d2eb2d534f3ada539b7285ebd91c6b06f49  dependencies/testing/mathjax/install.sh
de94b45a5d3fc1c5370f64d5c21ad67803b523b1  docker/dependencies/Dockerfile
db6e6d2067bdee67320ac01b034215caa2d3c6ce  docker/dependencies/compute_dependencies_hash.sh

• Step 2: Sort the output

find dependencies docker/dependencies -not -wholename '*/trilinos_develop/*' -not -name 'README.md' -type f -exec sha1sum {} \; | sort

The output for the current main should be

2ccb95eea6c74ea5b0e892ba6e83158aef0ff32c  dependencies/current/trilinos/install.sh
33067be6b328f83630cf59dc6bc55e9106809ba5  dependencies/current/backtrace/install.sh
54c5e619f8c2ede1e09468a46ab251e996c6d50d  dependencies/current/superlu_dist/install.sh
791a7d2eb2d534f3ada539b7285ebd91c6b06f49  dependencies/testing/mathjax/install.sh
8ad814d0a9272652590d4092e67f162057c1f492  dependencies/current/suitesparse/install.sh
b532c00fad9a4c507f75c6f4145483cff5493c6b  dependencies/current/cmake/install.sh
c24671ac9bccccfcc29cecc41352673604050246  dependencies/current/qhull/install.sh
db6e6d2067bdee67320ac01b034215caa2d3c6ce  docker/dependencies/compute_dependencies_hash.sh
de94b45a5d3fc1c5370f64d5c21ad67803b523b1  docker/dependencies/Dockerfile
eb8768634ec3dc6adb51c0ca558e700d2b11159c  dependencies/testing/paraview/install.sh

• Step 3: Compute hash from all hashes:

find dependencies docker/dependencies -not -wholename '*/trilinos_develop/*' -not -name 'README.md' -type f -exec sha1sum {} \; | sort | sha1sum

The output for the current main should be

28cfb9d07a205cb13a0c3be6e78f1a9231bb51de  -

• Step 4: Only take 8 characters of the hash

find dependencies docker/dependencies -not -wholename '*/trilinos_develop/*' -not -name 'README.md' -type f -exec sha1sum {} \; | sort | sha1sum | cut -c -8

The output for the current main should be

28cfb9d0

Can you check locally and post where the algorithm produces a different output on your machine?

[vryy]

Thanks, now I got it. I got different results right in the first step:

2ccb95eea6c74ea5b0e892ba6e83158aef0ff32c dependencies/current/trilinos/install.sh
54c5e619f8c2ede1e09468a46ab251e996c6d50d dependencies/current/superlu_dist/install.sh
739346b5d6b3fe3675243b156c7ffe55f60cc3c9 dependencies/current/qhull/2020.2.tar.gz
c24671ac9bccccfcc29cecc41352673604050246 dependencies/current/qhull/install.sh
33067be6b328f83630cf59dc6bc55e9106809ba5 dependencies/current/backtrace/install.sh
8ad814d0a9272652590d4092e67f162057c1f492 dependencies/current/suitesparse/install.sh
b532c00fad9a4c507f75c6f4145483cff5493c6b dependencies/current/cmake/install.sh
791a7d2eb2d534f3ada539b7285ebd91c6b06f49 dependencies/testing/mathjax/install.sh
eb8768634ec3dc6adb51c0ca558e700d2b11159c dependencies/testing/paraview/install.sh
de94b45a5d3fc1c5370f64d5c21ad67803b523b1 docker/dependencies/Dockerfile
db6e6d2067bdee67320ac01b034215caa2d3c6ce docker/dependencies/compute_dependencies_hash.sh

The reason is that I installed qhull right from dependencies/current/qhull and there is some leftover. After removing it, I have identical results 28cfb9d0.

So now one should not tinker around these dependencies folder to not be screwed up ...