tests function listing script

Author: kaoudis

scripts/ghidra/PatchestryListFunctions.java

@@ -44,7 +44,16 @@
 import java.util.Collections;
 
 public class PatchestryListFunctions extends GhidraScript {
-    private List<Function> getAllFunctions() {
+    /* For test setup purposes, we don't want to control this script from the command line. */
+    protected void setProgram(Program program) throws RuntimeException {
+        if (program != null && getCurrentProgram() == null) {
+            currentProgram = program;
+        } else {
+            currentProgram = getCurrentProgram();
+        }
+    }
+
+    protected List<Function> getAllFunctions() {
         if (currentProgram == null || currentProgram.getFunctionManager() == null) {
             return Collections.emptyList();
         }
@@ -56,16 +65,21 @@ private List<Function> getAllFunctions() {
         return functions;
     }
 
-    private void serializeToFile(Path file, List<Function> functions) throws Exception { 
-        if (file == null || functions == null || functions.isEmpty()) {
-            throw new IllegalArgumentException("Invalid file path or empty function list");
+    protected void serializeToFile(Path file, List<Function> functions) throws Exception { 
+        if (file == null) {
+            throw new IllegalArgumentException("Invalid file writer");
+        }
+
+        if (functions == null || functions.isEmpty()) {
+            throw new IllegalArgumentException("Empty function list");
         }
 
         final var serializer = new FunctionSerializer(Files.newBufferedWriter(file), currentProgram);
-        serializer.serialize(functions).close();
+        serializer.serialize(functions);
+        serializer.close();
     }
 
-    private void runHeadless() throws Exception {
+    protected void runHeadless() throws Exception {
         if (getScriptArgs().length != 1) {
             throw new IllegalArgumentException("Output file is not specified");
         }

test/scripts/ghidra/PatchestryListFunctionsTest.java

@@ -9,7 +9,70 @@
 
 import org.junit.jupiter.api.*;
 
+import ghidra.program.model.listing.Function;
+
+import java.lang.reflect.Field;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import java.util.Collections;
+import java.util.List;
+
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 public class PatchestryListFunctionsTest extends BaseTest {
     private PatchestryListFunctions listingScript = new PatchestryListFunctions();
+    private Path outputFile;
+
+    @BeforeAll
+    public void setUp() throws Exception {
+        super.setUp();
+
+        Field monitorField = findFieldInHierarchy(listingScript.getClass(), "monitor");
+        monitorField.setAccessible(true);
+        monitorField.set(listingScript, fakeMonitor);
+    }
+
+    @BeforeEach 
+    protected void finalizeSetUp() throws Exception {
+        outputFile = Files.createTempFile("test-list-and-serialize", ".json");
+        String[] args = {
+            outputFile.toString()
+        };
+        listingScript.setScriptArgs(args);
+        listingScript.setProgram(program);
+        assertEquals(listingScript.getScriptArgs(), args);
+        assertNotNull(listingScript.getCurrentProgram());
+        assertFalse(listingScript.getCurrentProgram().isClosed());
+    }
+
+    @Test 
+    public void testGetAllFunctions() throws Exception {
+        List<Function> functions = listingScript.getAllFunctions();
+        assertNotNull(functions);
+        assertFalse(functions.isEmpty());
+
+        // should match with testGetAllFunctions in the PatchestryDecompileFunctionsTest.
+        assertEquals(functions.size(), 262);
+    }
+
+    @Test 
+    public void testSerializeToFile() throws Exception {
+        List<Function> functions = listingScript.getAllFunctions();
+        assertEquals(functions.size(), 262);
+
+        assertThrows(IllegalArgumentException.class, () -> {
+            listingScript.serializeToFile((Path) null, functions);
+        });
+
+        assertThrows(IllegalArgumentException.class, () -> {
+            listingScript.serializeToFile(outputFile, (List<Function>) null);
+        });
+
+        assertThrows(IllegalArgumentException.class, () -> {
+            listingScript.serializeToFile(outputFile, Collections.emptyList());
+        });
+
+        listingScript.serializeToFile(outputFile, functions);
+    }
 }