From 8edefb9d6330a25f19db6b78249e87fe6f985748 Mon Sep 17 00:00:00 2001
From: Michael Davidsaver <mdavidsaver@gmail.com>
Date: Thu, 6 Apr 2017 20:27:03 -0400
Subject: [PATCH] dbUnitTest: add testdbGetArrFieldEqual()

---
 src/ioc/db/dbUnitTest.c | 65 +++++++++++++++++++++++++++++++++++++++++
 src/ioc/db/dbUnitTest.h | 17 +++++++++++
 2 files changed, 82 insertions(+)

diff --git a/src/ioc/db/dbUnitTest.c b/src/ioc/db/dbUnitTest.c
index 48d92a7fd..374a3eb51 100644
--- a/src/ioc/db/dbUnitTest.c
+++ b/src/ioc/db/dbUnitTest.c
@@ -190,6 +190,71 @@ void testdbVGetFieldEqual(const char* pv, short dbrType, va_list ap)
     }
 }
 
+void testdbGetArrFieldEqual(const char* pv, short dbfType, long nRequest, unsigned long cnt, const void *pbuf)
+{
+    DBADDR addr;
+    const long vSize = dbValueSize(dbfType);
+    const long nStore = vSize * nRequest;
+    long status;
+    void *gbuf, *gstore;
+
+    if(dbNameToAddr(pv, &addr)) {
+        testFail("Missing PV \"%s\"", pv);
+        return;
+    }
+
+    gbuf = gstore = malloc(nStore);
+    if(!gbuf && nStore!=0) { /* note that malloc(0) is allowed to return NULL on success */
+        testFail("Allocation failed esize=%ld total=%ld", vSize, nStore);
+        return;
+    }
+
+    status = dbGetField(&addr, dbfType, gbuf, NULL, &nRequest, NULL);
+    if (status) {
+        testFail("dbGetField(\"%s\", %d, ...) -> %#lx", pv, dbfType, status);
+
+    } else {
+        unsigned match = nRequest==cnt;
+        long n, N = nRequest < cnt ? nRequest : cnt;
+
+        if(!match)
+            testDiag("Length mis-match.  expected=%lu actual=%lu", cnt, nRequest);
+
+        for(n=0; n<N; n++, gbuf+=vSize, pbuf+=vSize) {
+
+            switch(dbfType) {
+            case DBR_STRING: {
+                const char *expect = (const char*)pbuf,
+                           *actual = (const char*)gbuf;
+                /* expected (pbuf) is allowed to omit storage for trailing nils for last element */
+                unsigned int eq = strncmp(expect, actual, MAX_STRING_SIZE)==0 && actual[MAX_STRING_SIZE-1]=='\0';
+                match &= eq;
+                if(!eq)
+                    testDiag("[%lu] = expected=\"%s\" actual=\"%s\"", n, expect, actual);
+                break;
+            }
+#define OP(DBR,Type,pat) case DBR: {Type expect = *(Type*)pbuf, actual = *(Type*)gbuf; assert(vSize==sizeof(Type)); match &= expect==actual; \
+    if(expect!=actual) testDiag("[%lu] expected=" pat " actual=" pat, n, expect, actual); break;}
+
+            OP(DBR_CHAR, char, "%c");
+            OP(DBR_UCHAR, unsigned char, "%u");
+            OP(DBR_SHORT, short, "%d");
+            OP(DBR_USHORT, unsigned short, "%u");
+            OP(DBR_LONG, int, "%d");
+            OP(DBR_ULONG, unsigned int, "%u");
+            OP(DBR_FLOAT, float, "%e");
+            OP(DBR_DOUBLE, double, "%e");
+            OP(DBR_ENUM, int, "%d");
+#undef OP
+            }
+        }
+
+        testOk(match, "dbGetField(\"%s\", dbrType=%d, nRequest=%ld ...) match", pv, dbfType, nRequest);
+    }
+
+    free(gstore);
+}
+
 dbCommon* testdbRecordPtr(const char* pv)
 {
     DBADDR addr;
diff --git a/src/ioc/db/dbUnitTest.h b/src/ioc/db/dbUnitTest.h
index 80867dc9d..0c78500d5 100644
--- a/src/ioc/db/dbUnitTest.h
+++ b/src/ioc/db/dbUnitTest.h
@@ -55,6 +55,23 @@ epicsShareFunc long testdbVPutField(const char* pv, short dbrType, va_list ap);
 epicsShareFunc void testdbGetFieldEqual(const char* pv, short dbrType, ...);
 epicsShareFunc void testdbVGetFieldEqual(const char* pv, short dbrType, va_list ap);
 
+/**
+ * @param pv PV name string
+ * @param dbfType One of the DBF_* macros from dbAccess.h
+ * @param nRequest Number of elements to request from pv
+ * @param pbufcnt  Number of elements pointed to be pbuf
+ * @param pbuf     Expected value buffer
+ *
+ * Execute dbGet() of nRequest elements and compare the result with
+ * pbuf (pbufcnt is an element count).
+ * Element size is derived from dbfType.
+ *
+ * nRequest > pbufcnt will detect truncation.
+ * nRequest < pbufcnt always fails.
+ * nRequest ==pbufcnt checks prefix (actual may be longer than expected)
+ */
+epicsShareFunc void testdbGetArrFieldEqual(const char* pv, short dbfType, long nRequest, unsigned long pbufcnt, const void *pbuf);
+
 epicsShareFunc dbCommon* testdbRecordPtr(const char* pv);
 
 #ifdef __cplusplus