gh-49: Add exercises into lesson (#48)

* Add exercises into lesson

* Use prek not pre-commit in workflow

* Use correct path the docker files

* Rename dockerfile to remove episode reference

* Test using aleskxyz/build-push to run tests

* Login before running tests

* Remove linting

* Use podman for build as this is what we logged in with

* Refer to the parent image for this repo rather than intro-to-modern-fortran

* Update links to old ucl-arc repo to the new repo

* Add accidentally deleted index.md back in

Author: connoraird

.github/workflows/test-exercises.yaml

@@ -0,0 +1,59 @@
+---
+name: "Exercise tests"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - ready_for_review
+      - reopened
+      - synchronize
+
+concurrency:
+  cancel-in-progress: true
+  group: >-
+    ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+
+jobs:
+  testing:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
+      attestations: read
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Log in to ghcr.io
+        uses: redhat-actions/podman-login@4934294ad0449894bcd1e9f191899d7292469603 # v1
+        with:
+          username: ${{ github.actor }}
+          password: ${{ github.token }}
+          registry: ghcr.io
+
+      - name: Test episode 1
+        run: podman build . -f docker-tests/Dockerfile.01
+
+      - name: Test episode 2
+        run: podman build . -f docker-tests/Dockerfile.02
+
+      - name: Test episode 2
+        run: podman build . -f docker-tests/Dockerfile.03
+
+      - name: Test episode 4
+        run: podman build . -f docker-tests/Dockerfile.04
+
+      - name: Test episode 5
+        run: podman build . -f docker-tests/Dockerfile.05
+
+      - name: Test episode 6
+        run: podman build . -f docker-tests/Dockerfile.06

.gitignore

@@ -1,3 +1,11 @@
+# Vale linter
+!.github/styles/config/
+!.github/styles/config/vocabularies/
+!.github/styles/config/vocabularies/Base
+.github/styles/*
+.github/styles/config/*
+.github/styles/config/vocabularies/*
+
 # sandpaper files
 episodes/*html
 site/*
@@ -49,3 +57,17 @@ docs/
 # translation temp files
 po/*~
 
+# pFUnit source code repo
+./pfunit
+
+# vscode configuration
+.vscode
+
+# exercise build artifacts
+**.mod
+**build
+**build-cmake
+
+# Python environment and artifacts
+*.egg-info
+.venv

README.md

@@ -18,3 +18,29 @@ sandpaper::build_lesson()
 ```
 
 This will create a local build of the site at [site/docs/index.html](./site/docs/index.html).
+
+## Dependencies
+
+This repo utilises [fortitude](https://fortitude.readthedocs.io/en/stable/) alongside [pre-commit](https://pre-commit.com/) for
+linting. To install these tools we use pip therefore contributors will require python version 3.9 or above.
+
+To setup pre-commit and fortitude
+
+1. Create a python virtual environment and activate it
+
+   ```sh
+   python3 -m venv .venv
+   source .venv/bin/activate # or `source .venv/scripts/activate` on windows
+   ```
+
+2. Install the dev dependencies
+
+   ```sh
+   python -m pip install -r requirements.txt
+   ```
+
+3. Turn on pre-commit
+
+   ```sh
+   pre-commit install
+   ```

config.yaml

@@ -34,7 +34,7 @@ life_cycle: 'pre-alpha'
 license: 'CC-BY 4.0'
 
 # Link to the source repository for this lesson
-source: 'https://github.com/UCL-ARC/fortran-unit-testing-lesson'
+source: 'https://github.com/carpentries-incubator/fortran-unit-testing'
 
 # Default branch of your lesson
 branch: 'main'

docker-tests/Dockerfile.01

@@ -0,0 +1,21 @@
+FROM ghcr.io/carpentries-incubator/fortran-unit-testing:main
+
+COPY --chown=vscode exercises/1-into-to-unit-tests /home/vscode/1-into-to-unit-tests
+
+WORKDIR /home/vscode/1-into-to-unit-tests/challenge
+
+# Build challenge's tests with cmake
+RUN cmake -B build && \
+    cmake --build build
+# Run test with ctest
+RUN ctest --test-dir build --output-on-failure
+
+# clean build 
+RUN rm -rf build
+
+# Build solution's tests with cmake
+RUN mv ../solution/test_maths_solution.f90 test/test_maths.f90 && \
+    cmake -B build && \
+    cmake --build build
+# Run test with ctest
+RUN ctest --test-dir build --output-on-failure

docker-tests/Dockerfile.02

@@ -0,0 +1,13 @@
+FROM ghcr.io/carpentries-incubator/fortran-unit-testing:main
+
+COPY --chown=vscode exercises/2-refactoring-fortran /home/vscode/2-refactoring-fortran
+
+# Build challenge with cmake
+WORKDIR /home/vscode/2-refactoring-fortran/challenge
+RUN cmake -B build && \
+    cmake --build build
+
+# Build solution with cmake
+WORKDIR /home/vscode/2-refactoring-fortran/solution
+RUN cmake -B build && \
+    cmake --build build

docker-tests/Dockerfile.03

@@ -0,0 +1,66 @@
+FROM ghcr.io/carpentries-incubator/fortran-unit-testing:main
+
+COPY --chown=vscode exercises/3-writing-your-first-unit-test /home/vscode/3-writing-your-first-unit-test
+
+# Test the Challenge code
+
+WORKDIR /home/vscode/3-writing-your-first-unit-test/challenge
+
+# Build with CMake
+RUN cmake -B build-std && \
+    cmake --build build-std
+    
+# Test with CMake
+RUN ctest --test-dir build-std --output-on-failure
+
+# Build with Make
+RUN FC=/usr/bin/f95 make tests
+
+# Test with Make
+RUN ./build/standard_fortran_tests
+
+
+# Test the Solution code
+
+# Copy solution code
+RUN cp ../solution/standard_fortran/test_temp_conversions.f90 test/standard_fortran/test_temp_conversions.f90 && \
+    cp ../solution/pfunit/* test/pfunit/
+
+# Build with make
+
+# Uncomment pfunit comments
+RUN sed -i -E 's/tests: standard_fortran_tests \#\| pfunit_tests/tests: standard_fortran_tests \| pfunit_tests/g' Makefile
+RUN sed -i -E 's/clean: \#clean_pfunit/clean: clean_pfunit/g' Makefile
+
+# Clean up anything from the previous builds
+RUN make clean
+RUN rm -rf build-std
+
+# Build
+RUN FC=/usr/bin/f95 make tests
+
+# Run pFUnit tests
+RUN ./test/pfunit/tests
+
+# Run standard_fortran tests
+RUN ./build/standard_fortran_tests
+
+# Run cleanup again
+RUN make clean
+
+
+# Build with CMake
+
+# Build without pFUnit
+RUN cmake -B build-std && \
+    cmake --build build-std
+
+# Rebuild with pFUnit
+RUN cmake -B build-pf -DCMAKE_PREFIX_PATH=/home/vscode/pfunit/build/installed && \
+    cmake --build build-pf
+
+# Test without pFUnit
+RUN ctest --test-dir build-std --output-on-failure
+
+# Test with pFUnit
+RUN ctest --test-dir build-pf --output-on-failure

docker-tests/Dockerfile.04

@@ -0,0 +1,13 @@
+FROM ghcr.io/carpentries-incubator/fortran-unit-testing:main
+
+COPY --chown=vscode exercises/4-fortran-unit-test-syntax /home/vscode/4-fortran-unit-test-syntax
+
+WORKDIR /home/vscode/4-fortran-unit-test-syntax/solution
+
+# build tests with cmake
+RUN cmake -B build -DCMAKE_PREFIX_PATH=/home/vscode/pfunit/build/installed && \
+    cmake --build build
+
+# test pfunit with ctest
+RUN ctest --test-dir build --output-on-failure
+

docker-tests/Dockerfile.05

@@ -0,0 +1,15 @@
+FROM ghcr.io/carpentries-incubator/fortran-unit-testing:main
+
+COPY --chown=vscode exercises/5-debugging-a-failing-test /home/vscode/5-debugging-a-failing-test
+
+WORKDIR /home/vscode/5-debugging-a-failing-test/challenge
+
+# Fix intentional bug in code
+RUN sed -i -E 's/.*matrix\(row, col\) = temp_matrix\(row, col\)/matrix\(col, row\) = temp_matrix\(row, col\)/g' src/matrix_transforms.f90
+
+# build tests with cmake
+RUN cmake -B build -DCMAKE_PREFIX_PATH=/home/vscode/pfunit/build/installed && \
+    cmake --build build
+
+# test pfunit with ctest
+RUN ctest --test-dir build --output-on-failure

docker-tests/Dockerfile.06

@@ -0,0 +1,39 @@
+FROM ghcr.io/carpentries-incubator/fortran-unit-testing:main
+
+COPY --chown=vscode exercises/6-testing-parallel-code /home/vscode/6-testing-parallel-code
+
+WORKDIR /home/vscode/6-testing-parallel-code/challenge
+
+# Fix intentional bug in code
+RUN mv ../solution/test_find_steady_state.pf ./test/ && \
+    mv ../solution/test_exchange_boundaries.pf ./test/ && \
+    echo "add_pfunit_ctest (pfunit_find_steady_state_tests\n\
+    TEST_SOURCES \"\${PROJECT_SOURCE_DIR}/test/test_find_steady_state.pf\"\n\
+    LINK_LIBRARIES sut\n\
+    MAX_PES 8\n\
+    )\n\
+    \n\
+    add_pfunit_ctest (pfunit_exchange_boundaries\n\
+    TEST_SOURCES \"\${PROJECT_SOURCE_DIR}/test/test_exchange_boundaries.pf\"\n\
+    LINK_LIBRARIES sut\n\
+    MAX_PES 4\n\
+    )\n\
+" >> test/CMakeLists.txt && \
+    sed -i -E 's/TEST_FLAGS = -I\$\(BUILD_DIR\) \$\(PFUNIT_EXTRA_FFLAGS\)/TEST_FLAGS = -I\$\(BUILD_DIR\) \$\(PFUNIT_EXTRA_FFLAGS\) -lpfunit/g' test/Makefile && \
+    sed -i -E 's/test_get_local_grid_info.pf/test_get_local_grid_info.pf \\\n  test_find_steady_state.pf  \\\n  test_exchange_boundaries.pf/g' test/Makefile
+
+# build tests with cmake
+RUN cmake -B build-cmake -DCMAKE_PREFIX_PATH=/home/vscode/pfunit/build/installed && \
+    cmake --build build-cmake
+
+# test with ctest, allowing MPI to oversubscribe
+RUN ctest --test-dir build-cmake --output-on-failure
+
+# Remove any generated code
+RUN make clean
+
+# Build tests with make
+RUN make tests
+
+# Run make tests
+RUN mpirun -np 8 ./test/tests