Update pki ca-cert-find for API v2

The CertServlet.listCerts() has modified to no longer
return the total certs found to allow future performance
optimization. Calculating the total certs found with Simple
Paged Results requires retrieving the full search results
from the database so it should be avoided.

The basic CA test has been updated to test pki ca-cert-find
with the default API and API v2 then verify the access logs
generated by these commands. The test-ca-certs.sh script is
no longer used so it has been removed.

.github/workflows/ca-basic-test.yml

@@ -365,7 +365,71 @@ jobs:
         run: |
           docker exec pki /usr/share/pki/tests/ca/bin/test-ca-signing-cert.sh
           docker exec pki /usr/share/pki/tests/ca/bin/test-subsystem-cert.sh
-          docker exec pki /usr/share/pki/tests/ca/bin/test-ca-certs.sh
+
+      - name: Check pki ca-cert-find with default API
+        run: |
+          docker exec pki pki ca-cert-find | tee output
+
+          # get certs returned
+          grep "Serial Number:" output | wc -l > actual
+
+          # there should be 6 certs returned
+          echo "6" > expected
+          diff expected actual
+
+          # get total certs found
+          sed -n "s/^\(\S*\) entries found$/\1/p" output > actual
+
+          # there should be 6 certs found
+          echo "6" > expected
+          diff expected actual
+
+          # check HTTP methods, paths, protocols, status, and authenticated users
+          docker exec pki find /var/log/pki/pki-tomcat \
+              -name "localhost_access_log.*" \
+              -exec cat {} \; \
+              | tail -2 \
+              | sed -e 's/^.* .* \(.*\) \[.*\] "\(.*\)" \(.*\) .*$/\2 \3 \1/' \
+              | tee output
+
+          cat > expected << EOF
+          GET /pki/v1/info HTTP/1.1 200 -
+          POST /ca/v1/certs/search HTTP/1.1 200 -
+          EOF
+
+          diff expected output
+
+      - name: Check pki ca-cert-find with API v2
+        run: |
+          docker exec pki pki --api v2 ca-cert-find | tee output
+
+          # get certs returned
+          grep "Serial Number:" output | wc -l > actual
+
+          # there should be 6 certs returned
+          echo "6" > expected
+          diff expected actual
+
+          # get total certs found
+          sed -n "s/^\(\S*\) entries found$/\1/p" output > actual
+
+          # there should be no total certs found
+          diff /dev/null actual
+
+          # check HTTP methods, paths, protocols, status, and authenticated users
+          docker exec pki find /var/log/pki/pki-tomcat \
+              -name "localhost_access_log.*" \
+              -exec cat {} \; \
+              | tail -2 \
+              | sed -e 's/^.* .* \(.*\) \[.*\] "\(.*\)" \(.*\) .*$/\2 \3 \1/' \
+              | tee output
+
+          cat > expected << EOF
+          GET /pki/v2/info HTTP/1.1 200 -
+          POST /ca/v2/certs/search HTTP/1.1 200 -
+          EOF
+
+          diff expected output
 
       - name: Test CA admin
         run: |

base/ca/src/main/java/org/dogtagpki/server/ca/rest/v2/CertServlet.java

@@ -220,7 +220,8 @@ private CertDataInfos listCerts(CertSearchRequest searchReq, int maxTime, int st
                 results.add(createCertDataInfo(rec));
             }
 
-            infos.setTotal(results.size());
+            // do not call infos.setTotal() in API v2
+
             logger.info("Search results: {}", results.size());
             infos.setEntries(results);
         } catch (Exception e) {

base/common/src/main/java/com/netscape/certsrv/base/DataCollection.java

@@ -20,20 +20,21 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Objects;
 
 /**
  * @author Endi S. Dewata
  */
 public class DataCollection<E> {
 
-    protected int total;
+    protected Integer total;
     protected Collection<E> entries = new ArrayList<>();
 
-    public int getTotal() {
+    public Integer getTotal() {
         return total;
     }
 
-    public void setTotal(int total) {
+    public void setTotal(Integer total) {
         this.total = total;
     }
 
@@ -57,11 +58,7 @@ public void removeEntry(E entry) {
 
     @Override
     public int hashCode() {
-        final int prime = 31;
-        int result = 1;
-        result = prime * result + ((entries == null) ? 0 : entries.hashCode());
-        result = prime * result + total;
-        return result;
+        return Objects.hash(entries, total);
     }
 
     @Override
@@ -72,14 +69,7 @@ public boolean equals(Object obj) {
             return false;
         if (getClass() != obj.getClass())
             return false;
-        DataCollection<E> other = (DataCollection<E>) obj;
-        if (entries == null) {
-            if (other.entries != null)
-                return false;
-        } else if (!entries.equals(other.entries))
-            return false;
-        if (total != other.total)
-            return false;
-        return true;
+        DataCollection other = (DataCollection) obj;
+        return Objects.equals(entries, other.entries) && Objects.equals(total, other.total);
     }
 }

base/tools/src/main/java/com/netscape/cmstools/ca/CACertFindCLI.java

@@ -227,8 +227,11 @@ public void execute(CommandLine cmd) throws Exception {
         CACertClient certClient = certCLI.getCertClient();
         CertDataInfos certs = certClient.findCerts(searchData, start, size);
 
-        MainCLI.printMessage(certs.getTotal() + " entries found");
-        if (certs.getTotal() == 0) return;
+        Integer total = certs.getTotal();
+        if (total != null) {
+            MainCLI.printMessage(total + " entries found");
+            if (total == 0) return;
+        }
 
         boolean first = true;