Performance Testing Infrastructure Bits

doc/sphinx-guides/requirements.txt

@@ -4,7 +4,7 @@ Sphinx==7.4.0
 sphinx-icon==0.1.2
 
 # Markdown support
-myst-parser==2.0.0
+myst-parser==4.0.0
 
 # tabs
 sphinx-tabs==3.4.5

doc/sphinx-guides/source/_static/developers/testing/SamplePerformanceIT.java

@@ -0,0 +1,64 @@
+package edu.harvard.iq.dataverse.somepackage;
+
+import edu.harvard.iq.dataverse.util.testing.performance.JpaEntityManagerService;
+import edu.harvard.iq.dataverse.util.testing.performance.JpaPerformanceTest;
+import net.ttddyy.dsproxy.QueryCount;
+import net.ttddyy.dsproxy.QueryCountHolder;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
+import jakarta.persistence.EntityManager;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+// Single annotation for automatic setup of
+//     1) basic tags for JUnit groups,
+//     2) shared PostgreSQL server via Testcontainers, and
+//     3) creation and injection of JPA entity manager service.
+@JpaPerformanceTest
+class SamplePerformanceIT {
+
+    static JpaEntityManagerService jpa;
+
+    @BeforeAll
+    static void setUp() {
+        // A manual start is necessary to allow you to selectively enable service features as necessary
+        jpa.start();
+
+        // inTransactionVoid: Use this when you only need to execute database operations
+        // (e.g., persisting test fixtures) without returning a value.
+        jpa.inTransactionVoid(em -> {
+            // EntityManager em is provided here.
+            // em.persist(myEntity);
+        });
+    }
+
+    @Test
+    void shouldMeasureOperationPerformance() {
+        // Clear any previous query statistics
+        QueryCountHolder.clear();
+        Instant start = Instant.now();
+
+        // inTransaction: Use this when your operation returns a result that needs
+        // to be asserted or measured.
+        Object result = jpa.inTransaction(em -> {
+            // Execute your performance-critical operation using the EntityManager.
+            // return result;
+            return null; // Placeholder
+        });
+
+        Instant end = Instant.now();
+        assertNotNull(result);
+
+        // Retrieve and log ORM statistics
+        QueryCount count = QueryCountHolder.getGrandTotal();
+        System.out.println("Elapsed ms: " + start.until(end, ChronoUnit.MILLIS));
+        System.out.println("Total queries: " + count.getTotal());
+        System.out.println("Select queries: " + count.getSelect());
+        System.out.println("Insert queries: " + count.getInsert());
+        System.out.println("Update queries: " + count.getUpdate());
+        System.out.println("Delete queries: " + count.getDelete());
+    }
+}

doc/sphinx-guides/source/conf.py

@@ -53,7 +53,10 @@
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'

doc/sphinx-guides/source/developers/index.rst

@@ -47,4 +47,6 @@ Developer Guide
    fontcustom
    classic-dev-env
    search-services
+   testing/fixtures.md
+   testing/performance.md