gh-45: Update exercises to match new lesson structure (#65)

Author: connoraird

.github/workflows/test-exercises.yaml

@@ -51,7 +51,7 @@ jobs:
       - name: Test episode 2
         run: podman build . -f docker-tests/Dockerfile.02
 
-      - name: Test episode 2
+      - name: Test episode 3
         run: podman build . -f docker-tests/Dockerfile.03
 
       - name: Test episode 4

episodes/6-parameterising-pfunit-tests.md

@@ -345,15 +345,16 @@ testParameters = dot_product_test_parameters(a, b, expected_dot_product, "10x10
 
 ::: challenge
 
-### Challenge: Parameterising temperature conversion tests with pFUnit, part 1
+### Challenge: Parameterising tests with pFUnit, part 1
 
-Begin parameterising your pFUnit tests of temperature conversions by creating a custom derived type for your test parameters.
-
-See part 2 of [3-writing-your-first-unit-test/challenge](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/3-writing-your-first-unit-test/challenge).
+Take a look at
+[4-fortran-unit-test-syntax/challenge](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/4-fortran-unit-test-syntax/challenge).
+Complete tasks 1 and 2.1.
 
 ::: solution
 
-A solution is provided in [3-writing-your-first-unit-test/solution](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/3-writing-your-first-unit-test/solution).
+A solution is provided in
+[4-fortran-unit-test-syntax/solution](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/4-fortran-unit-test-syntax/solution).
 
 :::
 
@@ -413,23 +414,6 @@ our test case type called **setUp**.
 
 ::::::::::::::::::::
 
-::: challenge
-
-### Challenge: Parameterising temperature conversion tests with pFUnit, part 2
-
-Continue parameterising your pFUnit tests of temperature conversions by Updating your custom test case type to utilise your new
-parameter type.
-
-See part 2 of [3-writing-your-first-unit-test/challenge](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/3-writing-your-first-unit-test/challenge).
-
-::: solution
-
-A solution is provided in [3-writing-your-first-unit-test/solution](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/3-writing-your-first-unit-test/solution).
-
-:::
-
-:::
-
 ::::::::::::
 
 :::::::::::: spoiler
@@ -478,16 +462,16 @@ Let's look at the key aspects of this function:
 
 ::: challenge
 
-### Challenge: Parameterising temperature conversion tests with pFUnit, part 3
-
-Continue parameterising your pFUnit tests of temperature conversions by defining your parameters sets and returning them from your
-test suite function.
+### Challenge: Parameterising tests with pFUnit, part 2
 
-See part 2 of [3-writing-your-first-unit-test/challenge](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/3-writing-your-first-unit-test/challenge).
+Continuing with
+[4-fortran-unit-test-syntax/challenge](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/4-fortran-unit-test-syntax/challenge),
+complete task 2.2.
 
 ::: solution
 
-A solution is provided in [3-writing-your-first-unit-test/solution](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/3-writing-your-first-unit-test/solution).
+A solution is provided in
+[4-fortran-unit-test-syntax/solution](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/4-fortran-unit-test-syntax/solution).
 
 :::
 
@@ -520,16 +504,16 @@ The key aspects are:
 
 ::: challenge
 
-### Challenge: Parameterising temperature conversion tests with pFUnit, part 4
-
-Finish parameterising your pFUnit tests of temperature conversions by Updating your test subroutine to make use of your new custom
-parameter type and test suite.
+### Challenge: Parameterising tests with pFUnit, part 3
 
-See part 2 of [3-writing-your-first-unit-test/challenge](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/3-writing-your-first-unit-test/challenge).
+Continuing with
+[4-fortran-unit-test-syntax/challenge](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/4-fortran-unit-test-syntax/challenge),
+complete task 3.
 
 ::: solution
 
-A solution is provided in [3-writing-your-first-unit-test/solution](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/3-writing-your-first-unit-test/solution).
+A solution is provided in
+[4-fortran-unit-test-syntax/solution](https://github.com/carpentries-incubator/fortran-unit-testing/tree/main/exercises/4-fortran-unit-test-syntax/solution).
 
 :::
 

exercises/3-writing-your-first-unit-test/challenge/README.md

@@ -75,11 +75,6 @@ A file [test_temp_conversions.pf](./test/pfunit/test_temp_conversions.pf) contai
 for your pFUnit test(s) has been provided. Comments within this file indicate the aspects of
 the pFUnit test you must write.
 
-> Note: This template has been written to facilitate conversion of
-> [test_temp_conversions.f90](./test/standard_fortran/test_temp_conversions.f90) as provided with this repo
-> to pFUnit. If your version of test_temp_conversions.f90, produced in Part 1, is significantly
-> different, You may prefer to use a different structure to the one provided in the template.
-
 #### Building the test
 
 - **i. Build your new test(s) with Make** - A top level [Makefile](./Makefile) has already been provided to build the

exercises/3-writing-your-first-unit-test/challenge/test/pfunit/test_temp_conversions.pf

@@ -6,27 +6,11 @@ module test_temp_conversions
 
     public
 
-    !*************************************************************************!
-    !                            Derived Types                                !
-    !-------------------------------------------------------------------------!
-
-    !> Test parameter type to package the test parameters
-    ! Your changes here...
-
-    !> Test case type to specify the style of test (paramaterized)
-    ! Your changes here...
-
-    !*************************************************************************!
-
 contains
 
     !*************************************************************************!
     !                      Test fahrenheit_to_celsius                         !
     !-------------------------------------------------------------------------!
-
-    !> Test Suite for tests of fahrenheit_to_celsius
-    ! Your changes here...
-
     !> Test Logic, unit test subroutine for fahrenheit_to_celsius
     ! Your changes here...
 
@@ -36,26 +20,9 @@ contains
     !*************************************************************************!
     !                         Test celsius_to_kelvin                          !
     !-------------------------------------------------------------------------!
-
-    !> Test Suite for tests of celsius_to_kelvin
-    ! Your changes here...
-
     !> Test Logic, unit test subroutine for celsius_to_kelvin
     ! Your changes here...
 
     !*************************************************************************!
 
-
-    !*************************************************************************!
-    !                          Type Constructors                              !
-    !-------------------------------------------------------------------------!
-
-    !> Constructor for converting test parameters into a test case
-    ! Your changes here...
-
-    !> Constructor for converting test parameters into a string
-    ! Your changes here...
-
-    !*************************************************************************!
-
 end module test_temp_conversions

exercises/3-writing-your-first-unit-test/solution/pfunit/test_temp_conversions.pf

@@ -6,66 +6,43 @@ module test_temp_conversions
 
     public
 
-    !*************************************************************************!
-    !                            Derived Types                                !
-    !-------------------------------------------------------------------------!
-
-    !> Test parameter type to package the test parameters
-    @TestParameter
-    type, extends(AbstractTestParameter) :: temp_conversions_test_params_t
-        !> The temperature to input into the function being tested
-        real :: input
-        !> Theb temperature expected to be returned from the function being tested
-        real :: expected_output
-        !> A description of the test to be outputted for logging
-        character(len=100) :: description
-    contains
-        procedure :: toString => temp_conversions_test_params_t_toString
-    end type temp_conversions_test_params_t
-
-    !> Test case type to specify the style of test (paramaterized)
-    @TestCase(constructor=new_test_case)
-    type, extends(ParameterizedTestCase) :: temp_conversions_test_case_t
-        type(temp_conversions_test_params_t) :: params
-    end type temp_conversions_test_case_t
-
-    !*************************************************************************!
-
 contains
 
     !*************************************************************************!
     !                      Test fahrenheit_to_celsius                         !
     !-------------------------------------------------------------------------!
+    !> Test Logic, unit test subroutine for fahrenheit_to_celsius with 0.0°F
+    @Test
+    subroutine test_fahrenheit_to_celsius()
+        integer, parameter :: num_tests = 4
+        real :: actual_output, inputs(num_tests), expected_outputs(num_tests)
+        character(len=200) :: failure_message
+        integer :: i
 
-    !> Test Suite for tests of fahrenheit_to_celsius
-    function fahrenheit_to_celsius_testsuite() result(params)
-        !> An array of test parameters, each specifying an individual test
-        class(temp_conversions_test_params_t), allocatable :: params(:)
-
-        params = [ &
-            temp_conversions_test_params_t(0.0, -17.777779, "0.0 °F"), &
-            temp_conversions_test_params_t(32.0, 0.0, "0.0 °C"), &
-            temp_conversions_test_params_t(-100.0, -73.333336, "100 °F"), &
-            temp_conversions_test_params_t(1.23,-17.094444, "Decimal °F") &
+        inputs = [  &
+            0.0,    &
+            32.0,   &
+            -100.0, &
+            1.23    &
+        ]
+        expected_outputs = [ &
+            -17.777779,      &
+            0.0,             &
+            -73.333336,      &
+            -17.094444       &
         ]
-    end function fahrenheit_to_celsius_testsuite
-
-    !> Test Logic, unit test subroutine for fahrenheit_to_celsius
-    @Test(testParameters={fahrenheit_to_celsius_testsuite()})
-    subroutine test_fahrenheit_to_celsius(this)
-        !> The test case which indicates the type of test we are running
-        class(temp_conversions_test_case_t), intent(inout) :: this
 
-        character(len=200) :: failure_message
-        real :: actual_output
+        do i = 1, num_tests
+            ! Get the actual celsius value returned from fahrenheit_to_celsius
+            actual_output = fahrenheit_to_celsius(inputs(i))
 
-        ! Get the actual celsius value returned from fahrenheit_to_celsius
-        actual_output = fahrenheit_to_celsius(this%params%input)
+            ! Populate the failure message
+            write(failure_message, '(A,F7.2,A,F7.2,A,F7.2,A)') "Failed With ", inputs(i), " °F: Expected ", &
+                    expected_outputs(i), "°C but got ", actual_output, "°C"
+            @assertEqual(expected_outputs(i), actual_output, tolerance=1e-6, message=trim(failure_message))
 
-        ! Populate the failure message
-        write(failure_message, '(A,F7.2,A,F7.2,A,F7.2,A)') "Failed With ", this%params%input, " °F: Expected ", &
-                this%params%expected_output, "°C but got ", actual_output, "°C"
-        @assertEqual(this%params%expected_output, actual_output, tolerance=1e-6, message=trim(failure_message))
+            failure_message = ""
+        end do
 
     end subroutine test_fahrenheit_to_celsius
 
@@ -75,63 +52,40 @@ contains
     !*************************************************************************!
     !                         Test celsius_to_kelvin                          !
     !-------------------------------------------------------------------------!
-
-    !> Test Suite for tests of celsius_to_kelvin
-    function celsius_to_kelvin_testsuite() result(params)
-        !> An array of test parameters, each specifying an individual test
-        class(temp_conversions_test_params_t), allocatable :: params(:)
-
-        params = [ &
-            temp_conversions_test_params_t(0.0, 273.15, "0.0 °C"), &
-            temp_conversions_test_params_t(-273.15, 0.0, "0.0 °K"), &
-            temp_conversions_test_params_t(-173.15, 100.0, "100.0 °K") &
-        ]
-    end function celsius_to_kelvin_testsuite
-
     !> Test Logic, unit test subroutine for celsius_to_kelvin
-    @Test(testParameters={celsius_to_kelvin_testsuite()})
-    subroutine test_celsius_to_kelvin(this)
-        !> The test case which indicates the type of test we are running
-        class(temp_conversions_test_case_t), intent(inout) :: this
-
+    @Test
+    subroutine test_celsius_to_kelvin()
+        integer, parameter :: num_tests = 3
+        real :: actual_output, inputs(num_tests), expected_outputs(num_tests)
         character(len=200) :: failure_message
-        real :: actual_output
-
-        ! Get the actual kelvin value returned from celsius_to_kelvin
-        actual_output = celsius_to_kelvin(this%params%input)
-
-        ! Populate the failure message
-        write(failure_message, '(A,F7.2,A,F7.2,A,F7.2,A)') "Failed With ", this%params%input, "°C: Expected ", &
-                this%params%expected_output, "°K but got ", actual_output, "°K"
-        @assertEqual(this%params%expected_output, actual_output, tolerance=1e-6, message=trim(failure_message))
-
-    end subroutine test_celsius_to_kelvin
+        integer :: i
 
-    !*************************************************************************!
+        inputs = [   &
+            0.0,     &
+            -273.15, &
+            -173.15  &
+        ]
 
+        expected_outputs = [ &
+            273.15,          &
+            0.0,             &
+            100.0            &
+        ]
 
-    !*************************************************************************!
-    !                          Type Constructors                              !
-    !-------------------------------------------------------------------------!
+        do i = 1, num_tests
 
-    !> Constructor for converting test parameters into a test case
-    function new_test_case(testParameter) result(tst)
-        !> The parameters to be converted to a test case
-        type(temp_conversions_test_params_t), intent(in) :: testParameter
-        !> The test case to return after conversion from parameters
-        type(temp_conversions_test_case_t) :: tst
+            ! Get the actual kelvin value returned from celsius_to_kelvin
+            actual_output = celsius_to_kelvin(inputs(i))
 
-        tst%params = testParameter
-    end function new_test_case
+            ! Populate the failure message
+            write(failure_message, '(A,F7.2,A,F7.2,A,F7.2,A)') "Failed With ", inputs(i), "°C: Expected ", &
+                    expected_outputs(i), "°K but got ", actual_output, "°K"
+            @assertEqual(expected_outputs(i), actual_output, tolerance=1e-6, message=trim(failure_message))
 
-    !> Constructor for converting test parameters into a string
-    function temp_conversions_test_params_t_toString(this) result(string)
-        !> The parameters to be converted to a string
-        class(temp_conversions_test_params_t), intent(in) :: this
-        character(:), allocatable :: string
+            failure_message = ""
+        end do
 
-        string = trim(this%description)
-    end function temp_conversions_test_params_t_toString
+    end subroutine test_celsius_to_kelvin
 
     !*************************************************************************!
 

exercises/4-fortran-unit-test-syntax/challenge/CMakeLists.txt

@@ -8,6 +8,8 @@ project(
   DESCRIPTION "Conway's game of life"
 )
 
+set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -ffree-line-length-none")
+
 # Define src files
 set(SRC_DIR "${PROJECT_SOURCE_DIR}/src")
 set(PROJ_SRC_FILES

exercises/4-fortran-unit-test-syntax/challenge/README.md

@@ -21,7 +21,7 @@ cmake --build build
 
 1. Update the [test/CMakeLists.txt](./test/CMakeLists.txt) to build the fully implemented test, **test_evolve_board.pf**.
 2. Finish the partially implemented tests in [test](./test/) and ensure they are built via CMake.
-    - [test_check_for_steady_state.pf](./test/test_check_for_steady_state.pf)
-    - [test_read_model_from_file.pf](./test/test_read_model_from_file.pf)
+    1. [test_check_for_steady_state.pf](./test/test_check_for_steady_state.pf)
+    2. [test_read_model_from_file.pf](./test/test_read_model_from_file.pf)
 3. Write a completely new pFUnit test for the subroutine `find_steady_state` in [game_of_life_mod.f90](./src/game_of_life_mod.f90)
    and ensure it is built via CMake.