Skip to content

ci: add validation step for generated pkg-config files #1150

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

Open
srinjoy933 wants to merge 7 commits into
base: master
Choose a base branch
from
+41 −2
Open

ci: add validation step for generated pkg-config files #1150

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5eb04c9
ci: add validation step for generated pkg-config files
srinjoy933 Mar 20, 2026
0de3e80
Merge branch 'master' of https://github.com/fortran-lang/stdlib into …
srinjoy933 Mar 23, 2026
a7f6645
ci: dynamically locate pkg-config file
srinjoy933 Mar 23, 2026
17c696a
ci: updated
srinjoy933 Mar 23, 2026
71ddb0e
Merge branch 'master' of https://github.com/fortran-lang/stdlib into …
srinjoy933 Mar 24, 2026
73eb5b6
updated
srinjoy933 Mar 24, 2026
e61c35e
done
srinjoy933 Apr 4, 2026
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
40 changes: 38 additions & 2 deletions .github/workflows/CI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ on: [push, pull_request]
env:
CMAKE_BUILD_PARALLEL_LEVEL: "2" # 2 cores on each GHA VM, enable parallel builds
CTEST_OUTPUT_ON_FAILURE: "ON" # This way we don't need a flag to ctest
CTEST_PARALLEL_LEVEL: "2"
Copy link
Copy Markdown
Member

@jvdp1 jvdp1 Mar 25, 2026

Choose a reason for hiding this comment

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

why is this removed?

Copy link
Copy Markdown
Contributor Author

@srinjoy933 srinjoy933 Mar 25, 2026

Choose a reason for hiding this comment

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

Hi @jvdp1! I removed the parallel testing flags to bypass a race condition in the upstream test suite that was causing the CI to crash on this branch.Specifically, the I/O example tests (example_open, example_savetxt, and example_loadtxt) all hardcode their read/write operations to the exact same file (example/io/example.dat). When CTest runs them in parallel, they step on each other (e.g., loadtxt tries to read floats while example_open is writing English text to the same file), which causes an .

Removing the parallel flag forces CTest to run them sequentially, which immediately fixed the CI.

Copy link
Copy Markdown
Contributor Author

@srinjoy933 srinjoy933 Mar 29, 2026

Choose a reason for hiding this comment

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

Hey @jvdp1 @jalvesz is removing this part will create any problem? I checked and tested and according to me it will not create any problem as such, that's why I suggest that it can be removed

Copy link
Copy Markdown
Member

@jvdp1 jvdp1 Apr 1, 2026

Choose a reason for hiding this comment

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

I never like to remove a feature (here parallelization) to solve another problem (here with I/O tests). It will only hide the underlying problem that will re-appear later. Therefore, I suggest to add the parallelization feature and try to solve the underlying problem in another PR

CTEST_TIME_TIMEOUT: "5" # some failures hang forever
HOMEBREW_NO_ANALYTICS: "ON" # Make Homebrew installation a little quicker
HOMEBREW_NO_AUTO_UPDATE: "ON"
Expand Down Expand Up @@ -106,10 +105,47 @@ jobs:
run: >-
ctest
--test-dir ${{ env.BUILD_DIR }}
--parallel
--output-on-failure
--no-tests=error

- name: Install project
if: ${{ contains(matrix.build, 'cmake') }}
run: cmake --install ${{ env.BUILD_DIR }}

- name: Validate generated pkg-config file
Copy link
Copy Markdown
Member

@jvdp1 jvdp1 Mar 25, 2026

Choose a reason for hiding this comment

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

Thank you @srinjoy933 . It is a nice improvment, and the paths are now checked.

In the past, we got some issues with the pkg-config files (e..g, issues with the order of the libs, ...; see e.g. #1102).
I wonder if it would be approriate to add a specific CI yml file for testing pkg-config files (even for compilation).

Copy link
Copy Markdown
Contributor Author

@srinjoy933 srinjoy933 Mar 25, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Thank you @jvdp1 ! I completely agree. Setting up a dedicated .yml workflow that actually compiles a dummy Fortran program using the generated pkg-config flags is the best way to catch those linking order bugs like #1102.
Since this current PR is stable and successfully catches the basic path/double-prefixing errors, would you prefer to merge this ? I would be more than happy to open a fresh issue and a follow-up PR dedicated specifically to building out that standalone pkg-config compilation CI workflow.

if: ${{ matrix.build == 'cmake' }}
shell: bash
run: |
# 1. Dynamically find the directory containing the .pc file (handles lib vs lib64)
PC_FILE=$(find $PWD/_dist -name "fortran_stdlib.pc" | head -n 1)

if [ -z "$PC_FILE" ]; then
echo "Error: fortran_stdlib.pc was not found in the installation directory!"
exit 1
fi

PC_DIR=$(dirname "$PC_FILE")
export PKG_CONFIG_PATH="$PC_DIR:$PKG_CONFIG_PATH"
echo "Found pkg-config file in: $PC_DIR"

# 2. Check if the module can be found and the syntax is valid
pkg-config --validate fortran_stdlib

# 3. Extract the paths that pkg-config generated
LIB_DIR=$(pkg-config --variable=libdir fortran_stdlib)
INC_DIR=$(pkg-config --variable=includedir fortran_stdlib)

# 4. Verify the paths actually exist to catch double-prefixing
if [ ! -d "$LIB_DIR" ]; then
echo "Error: Library directory '$LIB_DIR' does not exist."
exit 1
fi

if [ ! -d "$INC_DIR" ]; then
echo "Error: Include directory '$INC_DIR' does not exist."
exit 1
fi

# 5. Print flags for debugging CI logs
echo "Resolved CFLAGS: $(pkg-config --cflags fortran_stdlib)"
echo "Resolved LIBS: $(pkg-config --libs fortran_stdlib)"
Loading