Add test to detect memory leak

Author: edewata

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

@@ -46,6 +46,9 @@ jobs:
               --network-alias=pki.example.com \
               pki
 
+          docker exec pki rpm -qa | grep openjdk
+          docker exec pki dnf install -y java-25-openjdk-devel
+
       - name: Get Fedora version
         run: |
           FEDORA_VERSION=$(docker exec pki sed -n 's/^VERSION_ID=//p' /etc/os-release)
@@ -549,6 +552,62 @@ jobs:
       - name: Restart PKI server
         run: |
           docker exec pki pki-server restart --wait
+          docker exec pki ps ax
+
+          PID=$(docker exec pki ps -C java -o pid --no-headers | awk '{print $1;}')
+          echo "PID=$PID"
+          echo "$PID" > java.pid
+
+      - name: Check heap before load test
+        run: |
+          PID=$(cat java.pid)
+
+          docker exec pki jhsdb jmap --histo --pid $PID \
+              | tail -n +9 \
+              | grep -E 'org.dogtagpki|org.mozilla' \
+              | awk '{print $4, $2}' \
+              | sort \
+              | tee heap.before
+
+      - name: Run load test
+        run: |
+          for i in $(seq 1 100); do
+              docker exec pki pki info
+          done
+
+      - name: Run garbage collection
+        run: |
+          PID=$(cat java.pid)
+
+          docker exec pki jcmd $PID GC.run
+
+      - name: Check heap after load test
+        run: |
+          PID=$(cat java.pid)
+
+          # get object class names and number of instances
+          docker exec pki jhsdb jmap --histo --pid $PID \
+              | tail -n +9 \
+              | grep -E 'org.dogtagpki|org.mozilla' \
+              | awk '{print $4, $2}' \
+              | sort \
+              | tee heap.after
+
+      - name: Check heap growth
+        run: |
+          tests/bin/compare-heap-snapshots.py heap.before heap.after
+
+      - name: Check heap info
+        run: |
+          PID=$(cat java.pid)
+
+          docker exec pki jhsdb jmap --heap --pid $PID
+
+      - name: Check class loader statistics
+        run: |
+          PID=$(cat java.pid)
+
+          docker exec pki jmap -clstats $PID
 
       - name: Check pki info with default API
         run: |

tests/bin/compare-heap-snapshots.py

@@ -44,8 +44,8 @@ def calculate_growth(snapshot1: Dict[str, int], snapshot2: Dict[str, int]) -> Li
     all_classes = set(snapshot1.keys()) | set(snapshot2.keys())
 
     for class_name in all_classes:
-        count1 = snapshot1.get(class_name, 0)
-        count2 = snapshot2.get(class_name, 0)
+        original_count = snapshot1.get(class_name, 0)
+        growth = snapshot2.get(class_name, 0) - original_count
 
         # Calculate percentage growth
         if count1 == 0:
@@ -55,11 +55,11 @@ def calculate_growth(snapshot1: Dict[str, int], snapshot2: Dict[str, int]) -> Li
             else:
                 continue
         else:
-            growth_pct = ((count2 - count1) / count1) * 100
+            growth_pct = (growth / original_count) * 100
 
         # Only include classes that have grown
-        if count2 > count1:
-            growth_data.append((class_name, count1, count2, growth_pct))
+        if growth > 0:
+            growth_data.append((class_name, original_count, growth, growth_pct))
 
     return growth_data
 
@@ -70,31 +70,21 @@ def main():
     )
     parser.add_argument('snapshot1', help='First heap snapshot file')
     parser.add_argument('snapshot2', help='Second heap snapshot file')
-    parser.add_argument('-n', '--top', type=int, default=10,
-                       help='Number of top growing classes to display (default: 10)')
 
     args = parser.parse_args()
 
-    print(f"Comparing heap snapshots:")
-    print(f"  Snapshot 1: {args.snapshot1}")
-    print(f"  Snapshot 2: {args.snapshot2}")
-    print()
-
     # Parse both snapshots
     snapshot1 = parse_snapshot(args.snapshot1)
     snapshot2 = parse_snapshot(args.snapshot2)
 
     if not snapshot1:
         print("Error: First snapshot is empty or invalid", file=sys.stderr)
         sys.exit(1)
+
     if not snapshot2:
         print("Error: Second snapshot is empty or invalid", file=sys.stderr)
         sys.exit(1)
 
-    print(f"Classes in snapshot 1: {len(snapshot1)}")
-    print(f"Classes in snapshot 2: {len(snapshot2)}")
-    print()
-
     # Calculate growth
     growth_data = calculate_growth(snapshot1, snapshot2)
 
@@ -105,13 +95,11 @@ def main():
     # Sort by growth percentage (descending)
     growth_data.sort(key=lambda x: (x[3] != float('inf'), x[3]), reverse=True)
 
-    # Display top N classes
-    print(f"Top {args.top} classes with highest growth:")
-    print()
-    print(f"{'Class Name':<60} {'Count 1':>12} {'Count 2':>12} {'Growth':>12}")
+    # Display growth
+    print(f"{'Class Name':<60} {'Original':>12} {'Growth':>12} {'Percentage':>12}")
     print("=" * 100)
 
-    for i, (class_name, count1, count2, growth_pct) in enumerate(growth_data[:args.top]):
+    for i, (class_name, original_count, growth, growth_pct) in enumerate(growth_data):
         if growth_pct == float('inf'):
             growth_str = "NEW"
         else:
@@ -120,7 +108,7 @@ def main():
         # Truncate long class names
         display_name = class_name[:60] if len(class_name) <= 60 else class_name[:57] + "..."
 
-        print(f"{display_name:<60} {count1:>12,} {count2:>12,} {growth_str:>12}")
+        print(f"{display_name:<60} {original_count:>12,} {growth:>12,} {growth_str:>12}")
 
 
 if __name__ == '__main__':