fix: work around flang issue blocking test

rouson · rouson · commit 6f4ddfdbc603 · 2024-08-05T23:13:21.000-05:00
This commit works around a LLVM Flang (flang-new) issue that prevents
test-assert-subroutine-error-termination.F90 from
1. Quietly executing false-assertion.f90 and
2. Detecting the exit status from false-assertion.f90.
diff --git a/README.md b/README.md
@@ -52,14 +52,6 @@ The [examples/README.md] file shows examples of writing constraints in notes on
 Downloading, Building, and Running Examples
 -------------------------------------------
 
-### Prerequisites
-1. A Fortran 2018 compiler.
-2. The [Fortran Package Manager].
-3. _Optional_: [OpenCoarrays] for parallel execution with the GNU Fortran compiler.
-
-Assert was developed primarily with `gfortran` 11.2.0 and `nagfor` 7.1.
-Recent versions of the Cray and Intel compilers should also suffice.  
-
 ### Downloading Assert
 ```
 git clone git@github.com:sourceryinstitute/assert
@@ -70,29 +62,34 @@ cd assert
 #### Single-image (serial) execution
 The following command builds Assert and runs the full test suite in a single image:
 ```
-fpm test
+fpm test --profile release
 ```
-where `fpm test` builds the Assert library and runs the test suite, including the tests.
+which builds the Assert library and runs the test suite.
 
 #### Multi-image (parallel) execution
 With `gfortran` and OpenCoarrays installed,
 ```
-fpm test --compiler caf --runner "cafrun -n 2"
+fpm test --compiler caf --profile release --runner "cafrun -n 2"
 ```
 To build and test with the Numerical Algorithms Group (NAG) Fortran compiler version
 7.1 or later, use
 ```
-fpm test --compiler=nagfor --flag="-coarray=cosmp -fpp -f2018"
+fpm test --compiler=nagfor --profile release --flag="-coarray=cosmp -fpp -f2018"
 ```
 
 ### Building and testing with the Intel `ifx` compiler
 ```
-fpm test --compiler ifx --flag -coarray
+fpm test --compiler ifx --profile release --flag -coarray
+```
+### Building and testing with the LLVM `flang-new` compiler
+```
+fpm test --compiler flang-new --flag "-mmlir -allow-assumed-rank -O3"
+
 ```
 
 ### Building and testing with the Numerical Algorithms Group (NAG) compiler
 ```
-fpm test --compiler nagfor --flag "-fpp -coarray=cosmp"
+fpm test --compiler nagfor --profile release --flag "-fpp -coarray=cosmp"
 ```
 
 ### Building and testing with the Cray Compiler Environment (CCE)
@@ -108,7 +105,7 @@ ftn $@
 ```
 Then build and test Assert with the command
 ```
-fpm test --compiler crayftn.sh
+fpm test --compiler crayftn.sh --profile release
 ```
 
 
diff --git a/example/false_assertion.F90 b/example/false_assertion.F90
@@ -1,4 +1,4 @@
-program intentionally_false_assertions
+program false_assertion
   use assert_m, only : assert
   implicit none
 
diff --git a/example/support-assert-test-suite/check-exit-status.f90 b/example/support-assert-test-suite/check-exit-status.f90
@@ -0,0 +1,14 @@
+program check_exit_status
+  ! Despite its location in the example subdirectory, this program is _not_ intended to
+  ! be a user-facing example. This program exists to work around an LLVM Flang (flang-new)
+  ! compiler issue. This program is invoked by test/test-assert-subroutine-error-termination.F90,
+  ! which reads the file this program writes to determine the exist status of the program
+  ! example/false-assertion.f90. The latter  program intentionally error terminates in order
+  ! to test the case wehn assertion = .false.
+  implicit none
+  integer exit_status, unit
+  read(*,*) exit_status
+  open(newunit=unit, file="build/exit_status", status="unknown")
+  write(unit,*) exit_status
+  close(unit)
+end program 
diff --git a/test/run-false-assertion.sh b/test/run-false-assertion.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+output=$(fpm run --example false_assertion --compiler flang-new --flag '-mmlir -allow-assumed-rank -O3' > /dev/null 2>&1)
+echo $?
diff --git a/test/test-assert-subroutine-error-termination.F90 b/test/test-assert-subroutine-error-termination.F90
@@ -5,32 +5,52 @@ program test_assert_subroutine_error_termination
   
   integer exit_status
 
+  ! TODO: add '--profile release' if used in the 'fpm test' invocation that causes the program
+  ! ../example/test-assert-subroutine-error-termination.F90 to excute this example program.
+
   print *
   print *,"The assert subroutine"
   call execute_command_line( &
-    command = "fpm run --example intentionally_false_assertions > /dev/null 2>&1", &
+#ifdef __GFORTRAN__
+    command = "fpm run --example false_assertion > /dev/null 2>&1", &
+#elif NAGFOR
+    command = "fpm run --example false_assertion --compiler nagfor --flag -fpp > /dev/null 2>&1", &
+#elif __flang__
+    command = "./test/run-false-assertion.sh | fpm run --example check-exit-status", &
+#elif __INTEL_COMPILER
+    command = "fpm run --example false_assertion --compiler ifx --flag -O3 > /dev/null 2>&1", &
+#elif __CRAYFTN
+    command = "fpm run --example false_assertion --compiler crayftn.sh > /dev/null 2>&1", &
+#else
+    command = "echo 'example/false_assertion.F90: unsupported compiler' && exit 1", &
+#endif
     wait = .true., &
     exitstat = exit_status &
   )
     
+#ifndef __flang__
   block
     logical error_termination
 
     error_termination = exit_status /=0
-#ifndef __flang__
     call co_all(error_termination)
-
     if (this_image()==1) then
-#endif
       if (error_termination) then
         print *,"  passes on error-terminating when assertion = .false."
       else 
         print *,"  FAILS to error-terminate when assertion = .false. (Yikes! Who designed this OS?)"
       end if
-#ifndef __flang__
     end if
-#endif
   end block
+#else
+    block
+      integer unit
+      open(newunit=unit, file="build/exit_status", status="old")
+      read(unit,*) exit_status
+      print *,trim(merge("passes","FAILS ",exit_status/=0)) // " on error-terminating when assertion = .false."
+      close(unit)
+    end block 
+#endif
 
 contains
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-program intentionally_false_assertions`
	`1`	`+program false_assertion`
`2`	`2`	`use assert_m, only : assert`
`3`	`3`	`implicit none`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#!/bin/bash`
	`2`	`+output=$(fpm run --example false_assertion --compiler flang-new --flag '-mmlir -allow-assumed-rank -O3' > /dev/null 2>&1)`
	`3`	`+echo $?`