Clean-up missing file code/test.

Author: nusbaume

src/physics/utils/pio_reader.F90

@@ -70,18 +70,14 @@ subroutine open_netcdf_file(this, file_path, errmsg, errcode)
          return
       end if
 
-      !if(file_path == 'UNSET_PATH') then
-      !   errcode = 1
-      !   errmsg = "Found UNSET_PATH trying to open file"
-      !   return
-      !end if
-
       !Open provided file with PIO:
-      call cam_pio_openfile(this%sima_pio_fh%pio_fh, file_path, PIO_NOWRITE, errcode=errcode)
+      call cam_pio_openfile(this%sima_pio_fh%pio_fh, file_path, PIO_NOWRITE, &
+      errcode=errcode)
 
       if(errcode /= PIO_NOERR) then
          !Extract error message from PIO and return:
-         call get_pio_errmsg(pio_inq_var_info_err, file_path, errcode, errmsg)
+         call get_pio_errmsg(1, file_path, errcode, errmsg, &
+         file_msg=.true.)
          return
       end if
 
@@ -2785,7 +2781,7 @@ subroutine get_netcdf_var_char_5d(this, varname, var, errmsg, errcode)
       errmsg = ''
    end subroutine get_netcdf_var_char_5d
 
-   subroutine get_pio_errmsg(caller_errcode, varname, errcode, errmsg)
+   subroutine get_pio_errmsg(caller_errcode, varname, errcode, errmsg, file_msg)
       !Set error message based off PIO error code,
       !and then reset PIO error code to caller-specified
       !error code.
@@ -2799,21 +2795,36 @@ subroutine get_pio_errmsg(caller_errcode, varname, errcode, errmsg)
       use pio, only: PIO_NOERR
 
       !Input/output arguments:
-      integer,          intent(in)    :: caller_errcode !New error code caller wants.
-      character(len=*), intent(in)    :: varname
-      integer,          intent(inout) :: errcode        !Error code
-      character(len=*), intent(inout) :: errmsg         !Error message
+      integer,           intent(in)    :: caller_errcode !New error code caller wants.
+      character(len=*),  intent(in)    :: varname
+      integer,           intent(inout) :: errcode        !Error code
+      character(len=*),  intent(inout) :: errmsg         !Error message
+      logical, optional, intent(in)    :: file_msg       !If true then error is for file.
 
       !Local variables:
       integer :: strerr !Error code returned if pio_strerror fails
       character(len=256) :: pio_error
+      logical :: file_msg_flag
 
+      !Check if error is for a file instead of a variable:
+      if (present(file_msg)) then
+         file_msg_flag = file_msg
+      else
+         file_msg_flag = .false.
+      end if
+
+      !Get error message from PIO:
       strerr = pio_strerror(errcode, pio_error)
-      write(errmsg, '(a,a,a,a)') 'Error for variable "', varname, '" - message: ', trim(pio_error)
       if(strerr /= PIO_NOERR) then
          write(errmsg, *) "Failed to get error message for PIO code: ", errcode
          errcode = pio_get_msg_err
       else
+         if (file_msg_flag) then
+            write(errmsg, '(a,a,a,a)') "Error for file '", varname, "' - message: ", trim(pio_error)
+         else
+            !Variable error message
+            write(errmsg, '(a,a,a,a)') "Error for variable '", varname, "' - message: ", trim(pio_error)
+         end if
          errcode = caller_errcode
       end if
    end subroutine get_pio_errmsg

src/utils/cam_pio_utils.F90

@@ -1284,7 +1284,7 @@ subroutine cam_pio_openfile(file, fname, mode, log_info, errcode)
       ! If an error code is present, make sure PIO returns an error
       ! instead of aborting:
       if (present(errcode)) then
-         call pio_seterrorhandling(file, PIO_BCAST_ERROR, &
+         call pio_seterrorhandling(pio_subsystem, PIO_BCAST_ERROR, &
          oldmethod=err_handling)
       end if
 
@@ -1309,7 +1309,7 @@ subroutine cam_pio_openfile(file, fname, mode, log_info, errcode)
       ! the error handling back to whatever was
       ! running before this routine:
       if (present(errcode)) then
-         call pio_seterrorhandling(file, err_handling)
+         call pio_seterrorhandling(pio_subsystem, err_handling)
       end if
 
    end subroutine cam_pio_openfile

test/unit/fortran/src/mock_routines/test_pio_reader.pf

@@ -83,7 +83,7 @@ subroutine test_pio_reader_already_opened_file_err()
     ! File name for testing:
     ! NOTE:  This specific file is added during the Github Actions workflow.
     character(len=*), parameter :: fname = &
-    '../../../rrtmgp-data/rrtmgp-gas-sw-g112.nc'
+    "../../../rrtmgp-data/rrtmgp-gas-sw-g112.nc"
 
     ! Expected error message:
     character(len=*), parameter :: expected_err_msg = &
@@ -134,11 +134,11 @@ subroutine test_pio_reader_no_file_err()
     ! File name for testing
     ! NOTE: This file does not actually exist.
     character(len=*), parameter :: fname = &
-    'glinda_the_good.nc'
+    "glinda_the_good.nc"
 
     ! Expected error message:
     character(len=*), parameter :: expected_err_msg = &
-    "Error opening file '"//fname//"': No such file or directory"
+    "Error for file '"//fname//"' - message: No such file or directory"
 
     ! Begin test:
 
@@ -152,8 +152,8 @@ subroutine test_pio_reader_no_file_err()
     write(*,*) "Error message: ", trim(errmsg)
 
     ! Check that the correct error was raised:
-    @assertTrue(errcode /= PIO_NOERR)
-    !@assertTrue(trim(errmsg) == expected_err_msg)
+    @assertTrue(errcode /= 0)
+    @assertTrue(trim(errmsg) == expected_err_msg)
 
     ! Perform test cleanup:
     deallocate(reader)

test/unit/fortran/utils/cam_pio_utils.F90

@@ -58,7 +58,8 @@ subroutine cam_pio_openfile(file, fname, mode, log_info, errcode)
       ! If an error code is present, make sure PIO returns an error
       ! instead of aborting:
       if (present(errcode)) then
-         call pio_seterrorhandling(pio_system, PIO_BCAST_ERROR) !, oldmethod=err_handling)
+         call pio_seterrorhandling(pio_system, PIO_BCAST_ERROR, &
+         oldmethod=err_handling)
       end if
 
       ierr = pio_openfile(pio_system, file, pio_iotype_netcdf, fname, mode)
@@ -80,9 +81,9 @@ subroutine cam_pio_openfile(file, fname, mode, log_info, errcode)
       ! If an error code is requested, then set
       ! the error handling back to whatever was
       ! running before this routine:
-      !if (present(errcode)) then
-         !call pio_seterrorhandling(file, err_handling)
-      !end if
+      if (present(errcode)) then
+         call pio_seterrorhandling(pio_system, err_handling)
+      end if
 
    end subroutine cam_pio_openfile
    !===========================================================================