Unit tests for grb2_inq.c (#555)

* initial test set up

* set up for testable static variables

* Update grb2_inq.c

* try making compile definition public?

* refactor and print to test changes

* add some error codes to grb2_get_data() & set up first test

* debug broken test

* change a few error codes

* add tests for grb2_get_lonlat()

* another test

* more tests

* Update test_grb2_inq.c

* debug failing case

* tests for grb2_size_gridmeta()

* fix test

* more tests

* gridmeta fix

* documented changes for wrong function

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* add some error codes

* debug

* more tests

* Update test_grb2_inq.c

* update test and see if it gives -2

* check current output

* another test

* another test

* remove last to debug

* debug

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* trying to get -4 return

* Update CMakeLists.txt

* Update test_grb2_inq.c

* remove the failing test and set up

* Update test_grb2_inq.c

* set up with different file

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* Update test_grb2_inq.c

* done with test

* remove some new functions that ended up not being used

* debug test

* debug

* add more print statements to test

* debugging

* more debug

* more debug, add NULL to end of varargs

* debug spack

* turn off part of test if jpeg not available

Author: AlysonStahl-NOAA

.github/workflows/Spack.yml

@@ -33,10 +33,10 @@ jobs:
         package-name: wgrib2
         package-variants: ${{ matrix.variants }}
         custom-recipe: spack/package.py
-        use-repo-cache: true
+        use-repo-cache: false
         spack-compiler: gcc
         use-common-build-cache: true
-        cache-spack-lock: true
+        cache-spack-lock: false
         repo-cache-key-suffix: ${{ matrix.os }}-${{ matrix.variants }}-
 
   recipe-check:

src/c_api/c_wgrib2api.h

@@ -53,6 +53,7 @@ int wgrib2_add_cmd(const char *string);
 int wgrib2_cmd(void);
 int wgrib2_list_cmd(void);
 
-
 void fatal_error(const char *fmt, ...);
 
+/* Functions to support unit testing only. */
+void grb2_inq_set_state(int last_options_val, int good_val, int npnts_val);

src/c_api/grb2_inq.c

@@ -52,12 +52,26 @@ static int inv_no;
 /**
  * This function performs an inquiry of a grib message.
  * 
+ * ### Program History Log
+ * Date | Programmer | Comments
+ * -----|------------|---------
+ * 3/2018 | W. Ebisuzaki | Initial
+ * 7/2026 | A. Stahl | New error codes for testing purposes
+ * 
  * @param grb Input grib file.
  * @param inv Inventory of input file.
  * @param options Bitwise OR of option flags.
  * options = SEQUENTIAL | DATA | LATLON | WENS | RAW_ORDER | META | GRIDMETA | REGEX
  * @param ... Additional optional arguments.
  *
+ * @return The number of points in the grid, error code otherwise
+ * - 0 :: Failure in wgrib2_get_mem_buffer_size()
+ * - -1 :: Conflicting options (e.g., WENS and LATLON used together)
+ * - -2 :: Failed to call wgrib2
+ * - -3 :: Error retrieving memory buffer
+ * - -4 :: Error parsing basic grid info
+ * - -5 :: Inventory number greater than 1
+ * 
  * @return The number of points in the grid, or 0 if an error occurred.
  *
  * @author Wesley Ebisuzaki @date 3/2018
@@ -119,11 +133,11 @@ long long int grb2_inqVA(const char *grb, const char *inv, unsigned int options,
     if (options & WENS) {
         if (options & LATLON) {
             fprintf(stderr,"grb2_inq: WENS option cannot be used at same time as LATLON option\n");
-            return 1;
+            return -1;
         }
         if (options & RAW_ORDER) {
             fprintf(stderr,"grb2_inq: WENS option cannot be used at same time as RAW_ORDER option\n");
-            return 1;
+            return -1;
         }
         wgrib2_add_cmd("-order");
         wgrib2_add_cmd("we:ns");
@@ -133,7 +147,7 @@ long long int grb2_inqVA(const char *grb, const char *inv, unsigned int options,
     if (options & RAW_ORDER) {
         if (options & LATLON) {
             fprintf(stderr,"grb2_inq: RAW_ORDER option cannot be used at same time as LATLON option\n");
-            return 1;
+            return -1;
         }
         wgrib2_add_cmd("-order");
         wgrib2_add_cmd("raw");
@@ -156,19 +170,19 @@ long long int grb2_inqVA(const char *grb, const char *inv, unsigned int options,
     wgrib2_list_cmd();
 
     i = wgrib2_cmd();
-    if (i) return 0;		/* failed call to wgrib2 */
+    if (i) return -2;		/* failed call to wgrib2 */
 
     /* read basic parameters in register 19 */
 
     bufsize = sizeof(buffer);
     i = wgrib2_get_mem_buffer((unsigned char *) buffer, bufsize, 19);
-    if (i != 0) return 0; /* something wrong .. probably not found */
+    if (i != 0) return -3; /* something wrong .. probably not found */
 
     i = sscanf(buffer, "%11d %11u %11u %11u %11d %11d",&inv_no,&npnts,&nx_,&ny_,&msg_no, &submsg);
     printf(">>> wgrb2_scannf = %d\n",i);
-    if (i != 6) return 0;
+    if (i != 6) return -4;
 
-    if (inv_no > 1) return 0;
+    if (inv_no > 1) return -5;
 
     /* finally success */
     good = 1;
@@ -179,10 +193,22 @@ long long int grb2_inqVA(const char *grb, const char *inv, unsigned int options,
 /**
  * Get memory-copy of grid data from RPN register.
  * 
+ * ### Program History Log
+ * Date | Programmer | Comments
+ * -----|------------|---------
+ * 3/2018 | W. Ebisuzaki | Initial
+ * 7/2026 | A. Stahl | New error codes for testing purposes
+ * 
  * @param data Pointer to the data array.
  * @param ndata Number of data points.
  * 
- * @return 0 on success, 1 on error.
+ * @return 
+ * - 0 :: success
+ * - 10 :: last find did not work
+ * - 11 :: wrong size data
+ * - 12 :: grb2_inq did not request reading data
+ * 
+ * See documentation for wgrib2_get_reg_data() for additional error codes.
  * 
  * @note Grid data stored in register 19.
  * 
@@ -192,15 +218,15 @@ int grb2_get_data(float *data, int ndata) {
 
     if (good == 0) {
         fprintf(stderr,"grb2_get_data: last find did not work.\n");
-        return 1;
+        return 10;
     }
     if (ndata != npnts) {
         fprintf(stderr,"grb2_get_data: wrong size data.\n");
-        return 1;
+        return 11;
     }
     if ((last_options & DATA) == 0) {
         fprintf(stderr,"grb2_get_data: grb2_inq did not request reading data.\n");
-        return 1;
+        return 12;
     }
 
     return  wgrib2_get_reg_data(data, ndata, 19);
@@ -209,11 +235,24 @@ int grb2_get_data(float *data, int ndata) {
 /**
  * Get memory-copy of longitude and latitude data from RPN registers.
  *
+ * ### Program History Log
+ * Date | Programmer | Comments
+ * -----|------------|---------
+ * 3/2018 | W. Ebisuzaki | Initial
+ * 7/2026 | A. Stahl | New error codes for testing purposes
+ * 
  * @param lon Pointer to the longitude array.
  * @param lat Pointer to the latitude array.
  * @param ndata Number of data points.
  *
- * @return 0 on success, error code otherwise.
+ * @return 
+ * - 0 :: success
+ * - 10 :: last find did not work
+ * - 11 :: wrong size data
+ * - 12 :: grb2_inq did not request reading lonlat
+ * 
+ * See documentation for wgrib2_get_reg_data() for additional error codes. This function
+ * returns the sum of the error codes from reading the longitude and latitude registers.
  *
  * @note Longitude and latitude data stored in registers 17 and 18, respectively.
  * 
@@ -223,15 +262,15 @@ int grb2_get_lonlat(float *lon, float *lat, int ndata) {
     int err1, err2;
     if (good == 0) {
         fprintf(stderr,"grb2_get_lonlat: last find did not work.\n");
-        return 1;
+        return 10;
     }
     if (ndata != npnts) {
         fprintf(stderr,"grb2_get_lonlat: wrong size data.\n");
-        return 1;
+        return 11;
     }
     if ((last_options & LONLAT) == 0) {
         fprintf(stderr,"grb2_get_lonlat: grb2_inq did not request reading lonlat.\n");
-        return 1;
+        return 12;
     }
 
     err1 = wgrib2_get_reg_data(lon, ndata, 17);
@@ -242,8 +281,17 @@ int grb2_get_lonlat(float *lon, float *lat, int ndata) {
 /**
  * Get the size of the memory buffer for metadata stored in RPN register.
  *
- * @return Size of the memory buffer for metadata, or 0 if an error occurred.
- *
+ * ### Program History Log
+ * Date | Programmer | Comments
+ * -----|------------|---------
+ * 3/2018 | W. Ebisuzaki | Initial
+ * 7/2026 | A. Stahl | New error codes for testing purposes
+ * 
+ * @return Size of the memory buffer for metadata on success, error code otherwise
+ * - 0 :: Failure in wgrib2_get_mem_buffer_size()
+ * - -1 :: last find did not work
+ * - -2 :: grb2_inq did not request reading metadata
+ * 
  * @note Metadata stored in register 18.
  *
  * @author Wesley Ebisuzaki @date 3/2018
@@ -253,11 +301,11 @@ int grb2_size_meta(void) {
 
     if (good == 0) {
         fprintf(stderr,"grb2_size_meta: last find did not work.\n");
-        return 0;
+        return -1;
     }
     if ((last_options & META) == 0) {
         fprintf(stderr,"grb2_size_meta: grb2_inq did not request reading metadata.\n");
-        return 0;
+        return -2;
     }
     size = (unsigned int) wgrib2_get_mem_buffer_size(18);
     if (size == 0) return 0;
@@ -267,10 +315,23 @@ int grb2_size_meta(void) {
 /**
  * Get memory-copy of metadata from RPN register.
  * 
+ * ### Program History Log
+ * Date | Programmer | Comments
+ * -----|------------|---------
+ * 3/2018 | W. Ebisuzaki | Initial
+ * 7/2026 | A. Stahl | New error codes for testing purposes
+ * 
  * @param meta Pointer to the metadata array.
  * @param nbytes Size of the metadata buffer.
  * 
- * @return 0 on success, error code otherwise.
+ * @return 
+ * - 0 :: success
+ * - 10 :: last find did not work
+ * - 11 :: grb2_inq did not request reading metadata
+ * - 12 :: grib format error
+ * - 13 :: size of metadata is too big
+ * 
+ * See documentation for wgrib2_get_mem_buffer() for additional error codes.
  * 
  * @note Metadata stored in register 18.
  * 
@@ -282,21 +343,21 @@ int grb2_get_meta(unsigned char *meta, int nbytes) {
 
     if (good == 0) {
         fprintf(stderr,"grb2_get_meta: last find did not work.\n");
-        return 1;
+        return 10;
     }
     if ((last_options & META) == 0) {
         fprintf(stderr,"grb2_get_meta: grb2_inq did not request reading metadata.\n");
-        return 1;
+        return 11;
     }
 
     size = wgrib2_get_mem_buffer_size(18);
     if (size == 0) {
         fprintf(stderr,"grb2_get_meta: size = 0, grib format error\n");
-        return 1;
+        return 12;
     }
     if (size > INT_MAX  || size+1 > (size_t) nbytes) {
         fprintf(stderr,"grb2_get_meta: size of metadata is too big.\n");
-        return 1;
+        return 13;
     }
     err = wgrib2_get_mem_buffer(meta, size, 18);
     if (err == 0) meta[size] = 0;	/* end the string */
@@ -306,7 +367,16 @@ int grb2_get_meta(unsigned char *meta, int nbytes) {
 /**
  * Get the size of the memory buffer for grid metadata stored in RPN register.
  *
- * @return Size of the memory buffer for grid metadata, or 0 if an error occurred.
+ * ### Program History Log
+ * Date | Programmer | Comments
+ * -----|------------|---------
+ * 3/2018 | W. Ebisuzaki | Initial
+ * 7/2026 | A. Stahl | New error codes for testing purposes + replaced META w/ GRIDMETA
+ * 
+ * @return Size of the memory buffer for grid metadata on success, error code otherwise
+ * - 0 :: Failure in wgrib2_get_mem_buffer_size()
+ * - -1 :: last find did not work
+ * - -2 :: grb2_inq did not request reading grid metadata
  *
  * @note Grid metadata stored in register 17.
  *
@@ -317,11 +387,11 @@ int grb2_size_gridmeta(void) {
 
     if (good == 0) {
         fprintf(stderr,"grb2_size_gridmeta: last find did not work.\n");
-        return 0;
+        return -1;
     }
-    if ((last_options & META) == 0) {
+    if ((last_options & GRIDMETA) == 0) {
         fprintf(stderr,"grb2_size_gridmeta: grb2_inq did not request reading gridmetadata\n");
-        return 0;
+        return -2;
     }
     size = (unsigned int) wgrib2_get_mem_buffer_size(17);
     if (size == 0) return 0;
@@ -331,10 +401,21 @@ int grb2_size_gridmeta(void) {
 /**
  * Get memory-copy of grid metadata from RPN register.
  * 
+ * ### Program History Log
+ * Date | Programmer | Comments
+ * -----|------------|---------
+ * 3/2018 | W. Ebisuzaki | Initial
+ * 7/2026 | A. Stahl | New error codes for testing purposes
+ * 
  * @param meta Pointer to the grid metadata array.
  * @param nbytes Size of the grid metadata buffer.
  * 
- * @return 0 on success, error code otherwise.
+ * @return 
+ * - 0 :: success
+ * - 10 :: last find did not work
+ * - 11 :: grb2_inq did not request reading grid metadata
+ * - 12 :: size of grid metadata = 0, grid problem?
+ * - 13 :: size of metadata is too big
  * 
  * @note Grid metadata stored in register 17.
  * 
@@ -346,23 +427,39 @@ int grb2_get_gridmeta(unsigned char *meta, int nbytes) {
 
     if (good == 0) {
         fprintf(stderr,"grb2_get_gridmeta: last find did not work.\n");
-        return 1;
+        return 10;
     }
     if ((last_options & GRIDMETA) == 0) {
         fprintf(stderr,"grb2_get_gridmeta: grb2_inq did not request reading metadata.\n");
-        return 1;
+        return 11;
     }
 
     size = wgrib2_get_mem_buffer_size(17);
     if (size == 0) {
         fprintf(stderr,"grb2_get_gridmeta: size of gridmeta = 0, grid problem?.\n");
-        return 1;
+        return 12;
     }
     if (size > INT_MAX  || size+1 > (size_t) nbytes) {
         fprintf(stderr,"grb2_get_gridmeta: size of metadata is too big.\n");
-        return 1;
+        return 13;
     }
     err = wgrib2_get_mem_buffer(meta, size, 17);
     if (err == 0) meta[size] = 0;	/* end the string */
     return err;
 }
+
+/**
+ * For testing purposes only. Set the state of the static variables last_options, good, and npnts.
+ *
+ * @param last_options_val The value to set for last_options. Bitwise OR of option flags used in last inquiry.
+ * options = SEQUENTIAL | DATA | LATLON | WENS | RAW_ORDER | META | GRIDMETA | REGEX
+ * @param good_val The value to set for good. It is a flag indicating if last inquiry was successful. (0 = failure, otherwise success)
+ * @param npnts_val The value to set for npnts. It represents the number of data points in the last inquiry.
+ * 
+ * @author Alyson Stahl @date 7/2026
+ */
+void grb2_inq_set_state(int last_options_val, int good_val, int npnts_val) {
+    last_options = last_options_val;
+    good = good_val;
+    npnts = npnts_val;
+}

tests/CMakeLists.txt

@@ -241,6 +241,7 @@ if (BUILD_LIB)
     build_c_api_test(test_grb2_cmd)
   endif()
   build_c_api_test(test_grb2_mk_inv)
+  build_c_api_test(test_grb2_inq)
   build_test(test_string2time_unit)
   build_test(test_read_latlon)
   build_test(test_pdt_len)