Separate Python test runner from MainActivity so it can be run from a…

… JUnit test suite
python · freakboy3742 · Aug 16, 2024 · Jul 10, 2024 · Jul 10, 2024 · Jul 10, 2024
commit fb1b54ab13f9d802ec69a7e1175b9be085257442
@@ -38,6 +38,8 @@ android {
         externalNativeBuild.cmake.arguments(
             "-DPYTHON_CROSS_DIR=$PYTHON_CROSS_DIR",
             "-DPYTHON_VERSION=$PYTHON_VERSION")
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
     }
 
     externalNativeBuild.cmake {
@@ -61,6 +63,8 @@ dependencies {
     implementation("androidx.appcompat:appcompat:1.6.1")
     implementation("com.google.android.material:material:1.11.0")
     implementation("androidx.constraintlayout:constraintlayout:2.1.4")
+    androidTestImplementation("androidx.test.ext:junit:1.1.5")
+    androidTestImplementation("androidx.test:rules:1.5.0")
 }
 
 

@@ -0,0 +1,23 @@
+package org.python.testbed
+
+import androidx.test.annotation.UiThreadTest
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+
+@RunWith(AndroidJUnit4::class)
+class PythonSuite {
+    @Test
+    @UiThreadTest
+    fun testPython() {
+        val context = InstrumentationRegistry.getInstrumentation().targetContext
+        val args = InstrumentationRegistry.getArguments().getString("pythonArgs", "")
+        val status = PythonTestRunner(context).run(args)
+        assertEquals(0, status)
+    }
+}
@@ -84,7 +84,7 @@ static char *redirect_stream(StreamInfo *si) {
     return 0;
 }
 
-JNIEXPORT void JNICALL Java_org_python_testbed_MainActivity_redirectStdioToLogcat(
+JNIEXPORT void JNICALL Java_org_python_testbed_PythonTestRunner_redirectStdioToLogcat(
     JNIEnv *env, jobject obj
 ) {
     for (StreamInfo *si = STREAMS; si->file; si++) {
@@ -115,7 +115,7 @@ static void throw_status(JNIEnv *env, PyStatus status) {
     throw_runtime_exception(env, status.err_msg ? status.err_msg : "");
 }
 
-JNIEXPORT void JNICALL Java_org_python_testbed_MainActivity_runPython(
+JNIEXPORT int JNICALL Java_org_python_testbed_PythonTestRunner_runPython(
     JNIEnv *env, jobject obj, jstring home, jstring runModule
 ) {
     PyConfig config;
@@ -125,13 +125,13 @@ JNIEXPORT void JNICALL Java_org_python_testbed_MainActivity_runPython(
     status = set_config_string(env, &config, &config.home, home);
     if (PyStatus_Exception(status)) {
         throw_status(env, status);
-        return;
+        return 1;
     }
 
     status = set_config_string(env, &config, &config.run_module, runModule);
     if (PyStatus_Exception(status)) {
         throw_status(env, status);
-        return;
+        return 1;
     }
 
     // Some tests generate SIGPIPE and SIGXFSZ, which should be ignored.
@@ -140,8 +140,8 @@ JNIEXPORT void JNICALL Java_org_python_testbed_MainActivity_runPython(
     status = Py_InitializeFromConfig(&config);
     if (PyStatus_Exception(status)) {
         throw_status(env, status);
-        return;
+        return 1;
     }
 
-    Py_RunMain();
+    return Py_RunMain();
 }
@@ -1,38 +1,56 @@
 package org.python.testbed
 
+import android.content.Context
 import android.os.*
 import android.system.Os
 import android.widget.TextView
 import androidx.appcompat.app.*
 import java.io.*
 
+
+// Launching the tests from an activity is OK for a quick check, but for
+// anything more complicated it'll be more use `android.py test` to launch the
+// tests via PythonSuite.
 class MainActivity : AppCompatActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
+        val status = PythonTestRunner(this).run()
+        findViewById<TextView>(R.id.tvHello).text = "Exit status $status"
+    }
+}
+
+
+class PythonTestRunner(val context: Context) {
+    /** @param args Extra arguments for `python -m test`.
+     * @return The Python exit status: zero if the tests passed, nonzero if
+     * they failed. */
+    fun run(args: String = "") : Int {
+        Os.setenv("PYTHON_ARGS", args, true)
 
         // Python needs this variable to help it find the temporary directory,
         // but Android only sets it on API level 33 and later.
-        Os.setenv("TMPDIR", cacheDir.toString(), false)
+        Os.setenv("TMPDIR", context.cacheDir.toString(), false)
 
         val pythonHome = extractAssets()
         System.loadLibrary("main_activity")
         redirectStdioToLogcat()
-        runPython(pythonHome.toString(), "main")
-        findViewById<TextView>(R.id.tvHello).text = "Python complete"
+
+        // The main module is in src/main/python/main.py.
+        return runPython(pythonHome.toString(), "main")
     }
 
     private fun extractAssets() : File {
-        val pythonHome = File(filesDir, "python")
+        val pythonHome = File(context.filesDir, "python")
         if (pythonHome.exists() && !pythonHome.deleteRecursively()) {
             throw RuntimeException("Failed to delete $pythonHome")
         }
-        extractAssetDir("python", filesDir)
+        extractAssetDir("python", context.filesDir)
         return pythonHome
     }
 
     private fun extractAssetDir(path: String, targetDir: File) {
-        val names = assets.list(path)
+        val names = context.assets.list(path)
             ?: throw RuntimeException("Failed to list $path")
         val targetSubdir = File(targetDir, path)
         if (!targetSubdir.mkdirs()) {
@@ -43,7 +61,7 @@ class MainActivity : AppCompatActivity() {
             val subPath = "$path/$name"
             val input: InputStream
             try {
-                input = assets.open(subPath)
+                input = context.assets.open(subPath)
             } catch (e: FileNotFoundException) {
                 extractAssetDir(subPath, targetDir)
                 continue
@@ -57,5 +75,5 @@ class MainActivity : AppCompatActivity() {
     }
 
     private external fun redirectStdioToLogcat()
-    private external fun runPython(home: String, runModule: String)
+    private external fun runPython(home: String, runModule: String) : Int
 }
@@ -1,4 +1,6 @@
+import os
 import runpy
+import shlex
 import signal
 import sys
 
@@ -8,10 +10,10 @@
 # profile save"), so disabling it should not weaken the tests.
 signal.pthread_sigmask(signal.SIG_UNBLOCK, [signal.SIGUSR1])
 
-# To run specific tests, or pass any other arguments to the test suite, edit
-# this command line.
 sys.argv[1:] = [
-    "--use", "all,-cpu",
-    "--verbose3",
-]
+    "-uall",  # Enable all resources
+    "-W",  # Display test output on failure
+] + shlex.split(os.environ["PYTHON_ARGS"])
+
+# The test module will call sys.exit to indicate whether the tests passed.
 runpy.run_module("test")