CI: Test extended precision (#740)

Re-enable tests with extended precision

Author: gardner48

.github/workflows/build-llvm-container.yml

@@ -6,10 +6,10 @@ on:
 jobs:
   build_llvm_container:
     runs-on: ubuntu-22.04
-    steps:    
+    steps:
       - name: Check out repository code
         uses: actions/checkout@v4
-      
+
       - name: Free up disk space
         uses: ./.github/actions/free-space-ubuntu
 
@@ -27,11 +27,11 @@ jobs:
         run: |
           spack mirror add v0.21.0 https://binaries.spack.io/v0.21.0
           spack mirror add --oci-username ${{ github.actor }} --oci-password ${{ secrets.OCI_TOKEN }} sundials_spack_cache oci://ghcr.io/LLNL/sundials_spack_cache
-          spack buildcache keys --install --trust 
+          spack buildcache keys --install --trust
 
       - name: Install llvm@17.0.4
         run: spack install --no-check-signature llvm@17.0.4
-      
+
       - name: Push to buildcache
         if: ${{ !cancelled() }}
         run: |

.github/workflows/ubuntu-latest.yml

@@ -25,19 +25,18 @@ jobs:
       max-parallel: 2
       matrix:
         indexsize: [32, 64]
-        # Disable extended tests until compiler warnings are addressed
-        precision: ['single', 'double']
+        precision: ['single', 'double', 'extended']
         buildtype: ['Debug', 'Release', 'RelWithDebInfo']
         tpls: ['ON']
         exclude:
           - buildtype: Debug
             precision: single
-          # - buildtype: Debug
-          #   precision: extended
+          - buildtype: Debug
+            precision: extended
           - buildtype: Release
             precision: single
-          # - buildtype: Release
-          #   precision: extended
+          - buildtype: Release
+            precision: extended
           - buildtype: RelWithDebInfo
             precision: double
 

scripts/updateOutFiles.py

@@ -19,13 +19,32 @@
 # -----------------------------------------------------------------------------
 
 
+class colors:
+    SUCCESS = "\033[92m"
+    WARNING = "\033[93m"
+    ERROR = "\033[91m"
+    END = "\033[0m"
+
+
+def print_success(msg):
+    print(f"{colors.SUCCESS}{msg}{colors.END}")
+
+
+def print_warning(msg):
+    print(f"{colors.WARNING}{msg}{colors.END}")
+
+
+def print_error(msg):
+    print(f"{colors.ERROR}{msg}{colors.END}")
+
+
 # -----------------------------------------------------------------------------
 # main routine
 # -----------------------------------------------------------------------------
 def main():
 
     import argparse
-    import sys, os, shutil
+    import os, shutil
 
     parser = argparse.ArgumentParser(description="Update output files")
 
@@ -44,68 +63,80 @@ def main():
 
     # check inputs
     if not os.path.isdir(args.source):
-        print(f"Error: could not find {args.source}")
+        print_error(f"Error: could not find {args.source}")
         return -1
 
     if not os.path.isdir(args.destination):
-        print(f"Error: could not find {args.destination}")
+        print_error(f"Error: could not find {args.destination}")
         return -1
 
     # check that the output directory exists
     output = os.path.join(args.source, "Testing", "output")
     if not os.path.isdir(output):
-        print(f"Error: could not find {output}")
+        print_error(f"Error: could not find {output}")
         return -1
 
-    # create a list of all test run or just the failed tests
-    tests = []
+    # create a list of output files for all tests run or just the failed tests
+    output_files = []
 
     if args.all:
         # get names of all .out files
         for f in os.listdir(output):
             if f.endswith(".out"):
-                tests.append(f)
+                output_files.append(f)
     else:
         failed = os.path.join(args.source, "Testing", "Temporary", "LastTestsFailed.log")
 
         # extract test names from list and append .out
         with open(failed, "r") as f:
             for line in f:
-                tests.append(line.split(":")[1].rstrip() + ".out")
+                output_files.append(line.split(":")[1].rstrip() + ".out")
 
     # if failed tests were found update the output files
-    if tests:
+    if output_files:
+        num_output_files = len(output_files)
         paths = [
             os.path.join(args.destination, "examples"),
             os.path.join(args.destination, "test", "unit_tests"),
             args.destination,
         ]
-        for t in tests:
+        for idx, out_file in enumerate(output_files):
             if args.verbose > 0:
-                print(f"Searching for {t}")
+                print(f"[{idx + 1} of {num_output_files}] Test {out_file[:-4]}")
+            # Some tests do not have an output file (e.g., unit tests)
+            if not os.path.isfile(os.path.join(output, out_file)):
+                print_warning(f"  Warning: did not find the output file {out_file}")
+                continue
+            if args.verbose > 1:
+                print(f"  Searching for answer file {out_file}")
             found = False
             for p in paths:
+                if not os.path.isdir(p):
+                    continue
                 if args.verbose == 2:
                     print(f"  Looking in {p}")
-                for root, dirs, files in os.walk(p):
+                for root, _, files in os.walk(p):
                     if args.verbose == 3:
                         print(f"  Looking in {root}")
-                    if t in files:
+                    if out_file in files:
                         if args.verbose == 1:
                             print(f"  Found file in {root}")
                         if args.verbose > 1:
                             print("  Found file")
-                        shutil.copy(os.path.join(output, t), os.path.join(root, t))
+                        shutil.copy(os.path.join(output, out_file), os.path.join(root, out_file))
                         found = True
+                        if args.verbose > 0:
+                            print_success(f"  Answer file updated")
                         break
                 if found:
                     break
             if not found:
+                print_warning(f"  Warning: did not find the answer file {out_file}")
                 if args.copy:
-                    print(f"Warning: did not find {t}, copying to {args.destination}")
-                    shutil.copy(os.path.join(output, t), os.path.join(args.destination, t))
-                else:
-                    print(f"Warning: did not find {t}")
+                    print(f"  Copying {out_file} to {args.destination}")
+                    shutil.copy(
+                        os.path.join(output, out_file), os.path.join(args.destination, out_file)
+                    )
 
 
 # -----------------------------------------------------------------------------

test/answers

@@ -405,20 +405,13 @@ case "$testtype" in
         tarball=sundials
 
         # Test configs
-        for rt in single double extended; do
-            for is in 32 64; do
-                args_realtypes+=("${rt}")
-                args_indexsizes+=("${is}")
-                args_libtypes+=("static")
-                args_tpls+=("ON")
-                # Development test output files created with double
-                if [[ "${rt}" == "double" ]]; then
-                    args_suntests+=("DEV")
-                else
-                    args_suntests+=("STD")
-                fi
-                args_phase+=("")
-            done
+        for is in 32 64; do
+            args_realtypes+=("double")
+            args_indexsizes+=("${is}")
+            args_libtypes+=("static")
+            args_tpls+=("ON")
+            args_suntests+=("DEV")
+            args_phase+=("")
         done
         ;;
 

test/test_driver.sh

@@ -116,8 +116,8 @@ int main(int argc, char* argv[])
       printf("ERROR: Both the initial and final time are required\n");
       return (1);
     }
-    T0 = (sunrealtype)atof(argv[3]);
-    Tf = (sunrealtype)atof(argv[4]);
+    T0 = SUNStrToReal(argv[3]);
+    Tf = SUNStrToReal(argv[4]);
     if (SUNRabs(T0) >= SUNRabs(Tf))
     {
       printf("ERROR: |T0| must be less than |Tf|\n");
@@ -132,8 +132,8 @@ int main(int argc, char* argv[])
       printf("ERROR: Both tshift and tscale are required\n");
       return (1);
     }
-    tshift = (sunrealtype)atof(argv[5]);
-    tscale = (sunrealtype)atof(argv[6]);
+    tshift = SUNStrToReal(argv[5]);
+    tscale = SUNStrToReal(argv[6]);
     if (SUNRabs(tscale) < TINY)
     {
       printf("ERROR: |tscale| must be greater than %" GSYM "\n", TINY);
@@ -397,6 +397,12 @@ int main(int argc, char* argv[])
   printf("IMEX solution:\n");
   N_VPrint_Serial(y);
 
+#if defined(SUNDIALS_EXTENDED_PRECISION)
+  /* The 5th order case with extended precision tends to slightly under solve
+     so we loosen the comparison tolerance by 5% */
+  if (order == 5) { reltol *= SUN_RCONST(1.05); };
+#endif
+
   /* check the solution error */
   flag = compute_error(y, ans, tmp, reltol, abstol);
   if (flag != 0) { return (1); }