Merge pull request #136 from BerkeleyLab/call-prif_sync_all

Replace parallel statements with Caffeine calls

Author: ktras

.gitignore

@@ -6,3 +6,12 @@ fpm.toml
 
 # ford-generated documentation
 doc/html
+
+# executable programs
+a.out
+*.exe
+
+# compiler-generated intermediate files
+*.mod
+*.smod
+*.o

example/hello.f90

@@ -1,17 +1,23 @@
 program hello_world
   use iso_c_binding, only: c_bool
-  use prif, only : prif_init, this_image => prif_this_image_no_coarray, num_images => prif_num_images, prif_stop
+  use prif, only : &
+     prif_init &
+    ,prif_this_image_no_coarray &
+    ,prif_num_images &
+    ,prif_stop &
+    ,prif_error_stop
   implicit none
 
   integer :: init_exit_code, me, num_imgs
+  logical(kind=c_bool), parameter :: false = .false._c_bool
 
   call prif_init(init_exit_code)
-  if (init_exit_code /= 0) error stop "caffeinate returned a non-zero exit code"
+  if (init_exit_code /= 0) call prif_error_stop(quiet=false, stop_code_char="program startup failed")
 
-  call this_image(this_image=me)
-  call num_images(num_images=num_imgs)
+  call prif_this_image_no_coarray(this_image=me)
+  call prif_num_images(num_images=num_imgs)
   print *, "Hello from image", me, "of", num_imgs
 
-  call prif_stop(.false._c_bool, stop_code_int=0) ! normal termination
+  call prif_stop(quiet=false)
 
 end program

example/support-test/README.md

@@ -1,3 +1,7 @@
 Test Support
 ------------
-The programs in this directory intentionally error-terminate to support the `error stop` tests in `test/caf_error_stop.f90`, which use Fortran's `execute_command_line` to run the programms in this directory and check for the expected non-zero stop codes.  Running the tests in this manner enables the Vegetable tests to continue executing in the presence of error-terminating tests.
+The programs in this directory intentionally terminate to support the `stop` and `error stop` 
+unit tests, which use Fortran's `execute_command_line` to run the programs in this directory 
+and to check for the expected non-zero stop codes.  Running the tests in this manner enables 
+the tests to continue executing after the child process launched by `execute_command_line` 
+terminates.

example/support-test/error_stop_character_code.f90

@@ -0,0 +1,15 @@
+program error_stop_with_character_code
+  use iso_c_binding, only: c_bool
+  use prif, only : &
+     prif_init &
+    ,prif_stop &
+    ,prif_error_stop
+  implicit none
+
+  integer init_exit_code
+  logical(kind=c_bool), parameter :: false = .false._c_bool
+
+  call prif_init(init_exit_code)
+  call prif_error_stop(quiet=false, stop_code_char="USER_PROVIDED_STRING") ! a prif_error_stop unit test passes if this line executes error termination
+  call prif_stop(quiet=false) ! a prif_error_stop unit test fails if this line runs
+end program 

example/support-test/error_stop_integer_code.f90

@@ -0,0 +1,16 @@
+program error_stop_with_integer_code
+  use iso_c_binding, only: c_bool
+  use prif, only : &
+     prif_init &
+    ,prif_stop &
+    ,prif_error_stop
+  use unit_test_parameters_m, only : expected_error_stop_code 
+  implicit none
+
+  integer init_exit_code
+  logical(kind=c_bool), parameter :: false = .false._c_bool
+
+  call prif_init(init_exit_code)
+  call prif_error_stop(quiet=false, stop_code_int=expected_error_stop_code) ! a prif_error_stop unit test passes if this line executes error termination
+  call prif_stop(quiet=false) ! a prif_error_stop unit tests fails if this line runs
+end program

example/support-test/error_stop_with_character_code.f90

@@ -0,0 +1,16 @@
+program error_stop_with_no_code
+  use iso_c_binding, only: c_bool
+  use prif, only : &
+     prif_init &
+    ,prif_stop &
+    ,prif_error_stop
+  implicit none
+
+  integer init_exit_code
+  logical(kind=c_bool), parameter :: false = .false._c_bool
+
+  call prif_init(init_exit_code)
+  call prif_error_stop(quiet=false) ! a prif_error_stop unit test passes if this line correctly executes error termination
+  call prif_stop(quiet=false) ! a prif_error_stop unit test fails if this line runs
+     
+end program 

example/support-test/error_stop_with_integer_code.f90

@@ -0,0 +1,15 @@
+program stop_with_character_code
+  use iso_c_binding, only: c_bool
+  use prif, only : &
+     prif_init &
+    ,prif_stop &
+    ,prif_error_stop
+  implicit none
+
+  integer init_exit_code
+  logical(kind=c_bool), parameter :: false = .false._c_bool
+
+  call prif_init(init_exit_code)
+  call prif_stop(quiet=false, stop_code_char="USER_PROVIDED_STRING") ! a prif_stop unit test passes if this line executes normal termination
+  call prif_error_stop(quiet=false) ! a prif_stop unit test fails if this line runs
+end program 

example/support-test/error_stop_with_no_code.f90

@@ -1,14 +1,16 @@
-program stop_with_no_code
+program stop_with_integer_code
   use iso_c_binding, only: c_bool
-  use prif, only : prif_init, prif_stop
+  use prif, only : &
+     prif_init &
+    ,prif_stop &
+    ,prif_error_stop
+  use unit_test_parameters_m, only : expected_stop_code
   implicit none
 
-  integer :: init_exit_code
+  integer init_exit_code
+  logical(kind=c_bool), parameter :: false = .false._c_bool
 
   call prif_init(init_exit_code)
-  if (init_exit_code /= 0) error stop "caffeinate returned a non-zero exit_code"
-
-  call prif_stop(.false._c_bool, 1)
-
-  stop 2 ! caffeine/test/zzz_finalization_test.f90 reports a failure if this line runs
+  call prif_stop(quiet=false, stop_code_int=expected_stop_code) ! a prif_stop unit test passes if this line executes normal termination
+  call prif_error_stop(quiet=false) ! a prif_stop unit test fails if this line runs
 end program 

example/support-test/stop_with_character_code.f90

@@ -1,14 +1,15 @@
 program stop_with_no_code
   use iso_c_binding, only: c_bool
-  use prif, only : prif_init, prif_stop
+  use prif, only : &
+     prif_init &
+    ,prif_stop &
+    ,prif_error_stop
   implicit none
 
-  integer :: init_exit_code
+  integer init_exit_code
+  logical(kind=c_bool), parameter :: false = .false._c_bool
 
   call prif_init(init_exit_code)
-  if (init_exit_code /= 0) error stop "caffeinate returned a non-zero exit_code"
-
-  call prif_stop(.false._c_bool)
-
-  stop 1 ! caffeine/test/zzz_finalization_test.f90 reports a failure if this line runs
+  call prif_stop(false) ! a prif_stop test passes if this line executes normal termination
+  call prif_error_stop(quiet=false) ! a prif_stop test fails if this line runs
 end program 

example/support-test/stop_with_integer_code.f90

@@ -24,7 +24,7 @@ subroutine prif_stop_integer(stop_code)
       !! synchronize, stop the executing image, and provide the stop_code, or 0 if not present, as the process exit status
       integer, intent(in), optional :: stop_code
 
-      sync all
+      call prif_sync_all
 
       !write(output_unit, *) "caf_stop: stop code '", stop_code, "'"
       write(output_unit, *) stop_code
@@ -39,7 +39,7 @@ subroutine prif_stop_character(stop_code)
       !! synchronize, stop the executing image, and provide the stop_code as the process exit status
       character(len=*), intent(in) :: stop_code
 
-      sync all
+      call prif_sync_all
 
       write(output_unit, *) "caf_stop: stop code '" // stop_code // "'"
       flush output_unit

example/support-test/stop_with_no_code.f90

@@ -0,0 +1,16 @@
+! Copyright (c), The Regents of the University
+! Terms of use are as specified in LICENSE.txt
+module unit_test_parameters_m
+  !! Define values for consistent use throughout the test suite
+  implicit none
+
+  private
+  public :: expected_stop_code
+  public :: expected_error_stop_code
+
+  enum, bind(C)
+    enumerator :: expected_stop_code=99, expected_error_stop_code
+      ! used in stop/error-stop unit tests and example/test-support supporting programs
+  end enum
+
+end module unit_test_parameters_m

src/caffeine/program_termination_s.f90

@@ -1,44 +1,75 @@
 module caf_error_stop_test
-    use veggies, only: test_item_t, describe, result_t, it, assert_that
+    use veggies, only: test_item_t, describe, result_t, it, assert_that, assert_equals
+    use unit_test_parameters_m, only : expected_error_stop_code
 
     implicit none
     private
     public :: test_prif_this_image
 
+   integer, parameter :: max_message_len = 128
+
 contains
     function test_prif_this_image() result(tests)
         type(test_item_t) :: tests
 
         tests = describe( &
                 "A program that executes the prif_error_stop function", &
-                [ it("exits with a non-zero exitstat when stop code is an integer", check_integer_stop_code) &
-                 ,it("exits with a non-zero exitstat when stop code is an character", check_character_stop_code) &
+                [ it("exits with a non-zero exitstat when the program omits the stop code", exit_with_no_stop_code) &
+                 ,it("prints a character stop code and exits with a non-zero exitstat", exit_with_character_stop_code) &
+                 ,it("prints an integer stop code and exits with exitstat equal to the stop code", exit_with_integer_stop_code) &
                 ])
     end function
 
-    function check_integer_stop_code() result(result_)
+    function exit_with_no_stop_code() result(result_)
         type(result_t) :: result_
         integer exit_status
+        integer command_status
+        character(len=max_message_len) command_message
 
         call execute_command_line( &
-          command = "./build/run-fpm.sh run --example error_stop_integer_code > /dev/null 2>&1", &
-          wait = .true., &
-          exitstat = exit_status &
+          command = "./build/run-fpm.sh run --example error_stop_with_no_code > /dev/null 2>&1" &
+         ,wait = .true. &
+         ,exitstat = exit_status &
+         ,cmdstat = command_status &
+         ,cmdmsg = command_message &
         )   
-        result_ = assert_that(exit_status /= 0)
+        result_ = assert_that(exit_status /= 0) .and. assert_equals(0, command_status, command_message)
+
+    end function
+
+    function exit_with_integer_stop_code() result(result_)
+        type(result_t) :: result_
+        integer exit_status
+        integer command_status
+        character(len=max_message_len) command_message
+
+        call execute_command_line( &
+          command = "./build/run-fpm.sh run --example error_stop_with_integer_code > /dev/null 2>&1" &
+         ,wait = .true. &
+         ,exitstat = exit_status &
+         ,cmdstat = command_status &
+         ,cmdmsg = command_message &
+        )
+        result_ = &
+         assert_equals(expected_error_stop_code, exit_status, "exit_status") &
+         .and. assert_equals(0, command_status, command_message)
 
     end function
 
-    function check_character_stop_code() result(result_)
+    function exit_with_character_stop_code() result(result_)
         type(result_t) :: result_
         integer exit_status
+        integer command_status
+        character(len=max_message_len) command_message
 
         call execute_command_line( &
-          command = "./build/run-fpm.sh run --example error_stop_character_code > /dev/null 2>&1", &
-          wait = .true., &
-          exitstat = exit_status &
+          command = "./build/run-fpm.sh run --example error_stop_with_character_code > /dev/null 2>&1" &
+         ,wait = .true. &
+         ,exitstat = exit_status &
+         ,cmdstat = command_status &
+         ,cmdmsg = command_message &
         )   
-        result_ = assert_that(exit_status /= 0)
+        result_ = assert_that(exit_status /= 0) .and. assert_equals(0, command_status, command_message)
 
     end function
 

src/caffeine/unit_test_parameters_m.f90

@@ -1,5 +1,6 @@
 module caf_stop_test
     use veggies, only: test_item_t, describe, result_t, it, assert_that, assert_equals
+    use unit_test_parameters_m, only : expected_stop_code
 
     implicit none
     private
@@ -13,7 +14,7 @@ function test_prif_this_image() result(tests)
                 "A program that executes the prif_stop function", &
                 [ it("exits with a zero exitstat when the program omits the stop code", exit_with_no_stop_code) &
                  ,it("prints an integer stop code and exits with exitstat equal to the stop code", exit_with_integer_stop_code) &
-                 ,it("prints a character stop code and exits with a non-zero existat", exit_with_character_stop_code) &
+                 ,it("prints a character stop code and exits with a non-zero exitstat", exit_with_character_stop_code) &
                 ])
     end function
 
@@ -25,36 +26,34 @@ function exit_with_no_stop_code() result(result_)
           command = "./build/run-fpm.sh run --example stop_with_no_code > /dev/null 2>&1", &
           wait = .true., &
           exitstat = exit_status &
-        )   
+        )
         result_ = assert_equals(0, exit_status)
 
     end function
 
     function exit_with_integer_stop_code() result(result_)
         type(result_t) :: result_
         integer exit_status
-        integer, parameter :: expected_stop_code=1 ! defined in example/support-test/stop_with_integer_code.f90
 
         call execute_command_line( &
           command = "./build/run-fpm.sh run --example stop_with_integer_code > /dev/null 2>&1", &
           wait = .true., &
           exitstat = exit_status &
-        )   
+        )
         result_ = assert_equals(expected_stop_code, exit_status)
 
     end function
 
     function exit_with_character_stop_code() result(result_)
         type(result_t) :: result_
         integer exit_status
-        integer, parameter :: expected_exit_code=1 ! defined in src/caffeine/program_termination.f90
 
         call execute_command_line( &
           command = "./build/run-fpm.sh run --example stop_with_character_code > /dev/null 2>&1", &
           wait = .true., &
           exitstat = exit_status &
         )   
-        result_ = assert_equals(expected_exit_code, exit_status)
+        result_ = assert_equals(0, exit_status) ! the standard recommends zero exit status for character stop codes
 
     end function
 

test/caf_error_stop_test.f90

@@ -1,8 +1,18 @@
-! Generated by cart. DO NOT EDIT
+! This file was originally generated by cart, but then manually edited. 
+! DO NOT REGENERATE THIS FILE!
 program main
+    use iso_c_binding, only : c_bool
+    use prif, only : &
+        prif_stop &
+       ,prif_error_stop
     implicit none
 
-    if (.not.run()) stop 1
+    logical(kind=c_bool), parameter :: false = .false._c_bool
+
+    if (.not.run()) call prif_error_stop(quiet=false, stop_code_char = "Unit tests failed to run")
+
+    call prif_stop(quiet=false)
+
 contains
     function run() result(passed)
         use a00_caffeinate_test, only: &