|
| 1 | +/* |
| 2 | + * Copyright (c) Meta Platforms, Inc. and affiliates. |
| 3 | + * All rights reserved. |
| 4 | + * |
| 5 | + * This source code is licensed under the BSD-style license found in the |
| 6 | + * LICENSE file in the root directory of this source tree. |
| 7 | + */ |
| 8 | +package org.pytorch.executorch |
| 9 | + |
| 10 | +import androidx.test.ext.junit.runners.AndroidJUnit4 |
| 11 | +import java.io.File |
| 12 | +import java.io.IOException |
| 13 | +import org.apache.commons.io.FileUtils |
| 14 | +import org.junit.Assert.assertEquals |
| 15 | +import org.junit.Assert.assertFalse |
| 16 | +import org.junit.Assert.assertTrue |
| 17 | +import org.junit.Assert.fail |
| 18 | +import org.junit.Assume.assumeNotNull |
| 19 | +import org.junit.Test |
| 20 | +import org.junit.runner.RunWith |
| 21 | +import org.pytorch.executorch.TestFileUtils.getTestFilePath |
| 22 | +import org.pytorch.executorch.extension.asr.AsrCallback |
| 23 | +import org.pytorch.executorch.extension.asr.AsrModule |
| 24 | +import org.pytorch.executorch.extension.asr.AsrTranscribeConfig |
| 25 | + |
| 26 | +/** |
| 27 | + * Instrumentation tests for [AsrModule], [AsrTranscribeConfig], and [AsrCallback]. |
| 28 | + * |
| 29 | + * Tests cover: |
| 30 | + * - Constructor validation (invalid model/tokenizer/preprocessor paths) |
| 31 | + * - AsrTranscribeConfig builder and validation |
| 32 | + * - Lifecycle (close idempotency, use-after-close) |
| 33 | + * - Transcribe validation (invalid WAV path) |
| 34 | + * |
| 35 | + * The test fixture is the TinyStories-110M LLM model, NOT an ASR model, so functional transcription |
| 36 | + * tests are not possible. Tests that require a valid AsrModule instance handle the case where |
| 37 | + * nativeCreate fails (stories.pte lacks encoder/text_decoder methods). |
| 38 | + */ |
| 39 | +@RunWith(AndroidJUnit4::class) |
| 40 | +class AsrModuleInstrumentationTest { |
| 41 | + |
| 42 | + // ─── Constructor validation ───────────────────────────────────────────────── |
| 43 | + |
| 44 | + @Test(timeout = 30_000) |
| 45 | + fun testInvalidModelPathThrows() { |
| 46 | + try { |
| 47 | + AsrModule("/nonexistent/model.pte", "/nonexistent/tokenizer") |
| 48 | + fail("Should throw for invalid model path") |
| 49 | + } catch (_: IllegalArgumentException) { |
| 50 | + // Expected: require(modelFile.canRead() && modelFile.isFile) |
| 51 | + } |
| 52 | + } |
| 53 | + |
| 54 | + @Test(timeout = 30_000) |
| 55 | + fun testInvalidTokenizerPathThrows() { |
| 56 | + val modelFile = provisionModelFile() |
| 57 | + assumeNotNull("Test resource $MODEL_FILE_NAME not available", modelFile) |
| 58 | + try { |
| 59 | + AsrModule(modelFile!!.absolutePath, "/nonexistent/tokenizer") |
| 60 | + fail("Should throw for invalid tokenizer path") |
| 61 | + } catch (_: IllegalArgumentException) { |
| 62 | + // Expected: require(tokenizerFile.exists()) |
| 63 | + } |
| 64 | + } |
| 65 | + |
| 66 | + @Test(timeout = 30_000) |
| 67 | + fun testInvalidPreprocessorPathThrows() { |
| 68 | + val modelFile = provisionModelFile() |
| 69 | + val tokenizerFile = provisionTokenizerFile() |
| 70 | + assumeNotNull("Test resource $MODEL_FILE_NAME not available", modelFile) |
| 71 | + assumeNotNull("Test resource $TOKENIZER_FILE_NAME not available", tokenizerFile) |
| 72 | + try { |
| 73 | + AsrModule( |
| 74 | + modelFile!!.absolutePath, |
| 75 | + tokenizerFile!!.absolutePath, |
| 76 | + preprocessorPath = "/nonexistent/preprocessor.pte", |
| 77 | + ) |
| 78 | + fail("Should throw for invalid preprocessor path") |
| 79 | + } catch (_: IllegalArgumentException) { |
| 80 | + // Expected: require(preprocessorFile.canRead() && preprocessorFile.isFile) |
| 81 | + } |
| 82 | + } |
| 83 | + |
| 84 | + @Test(timeout = 30_000) |
| 85 | + fun testNonAsrModelFailsGracefully() { |
| 86 | + val modelFile = provisionModelFile() |
| 87 | + val tokenizerFile = provisionTokenizerFile() |
| 88 | + assumeNotNull("Test resource $MODEL_FILE_NAME not available", modelFile) |
| 89 | + assumeNotNull("Test resource $TOKENIZER_FILE_NAME not available", tokenizerFile) |
| 90 | + try { |
| 91 | + val module = AsrModule(modelFile!!.absolutePath, tokenizerFile!!.absolutePath) |
| 92 | + // If construction succeeds (model was accepted), verify basic state |
| 93 | + assertTrue("Module should be valid after construction", module.isValid) |
| 94 | + module.close() |
| 95 | + } catch (_: ExecutorchRuntimeException) { |
| 96 | + // Expected: nativeCreate returns 0 for non-ASR model |
| 97 | + } catch (_: RuntimeException) { |
| 98 | + // Also acceptable: native layer rejects the model |
| 99 | + } |
| 100 | + } |
| 101 | + |
| 102 | + // ─── Lifecycle ────────────────────────────────────────────────────────────── |
| 103 | + |
| 104 | + @Test(timeout = 30_000) |
| 105 | + fun testCloseIsIdempotent() { |
| 106 | + val module = tryCreateAsrModule() ?: return |
| 107 | + module.close() |
| 108 | + module.close() |
| 109 | + module.close() |
| 110 | + assertFalse("isValid must be false after close", module.isValid) |
| 111 | + } |
| 112 | + |
| 113 | + @Test(timeout = 30_000) |
| 114 | + fun testLoadAfterCloseThrows() { |
| 115 | + val module = tryCreateAsrModule() ?: return |
| 116 | + module.close() |
| 117 | + try { |
| 118 | + module.load() |
| 119 | + fail("load() after close() must throw IllegalStateException") |
| 120 | + } catch (_: IllegalStateException) { |
| 121 | + // Expected |
| 122 | + } |
| 123 | + } |
| 124 | + |
| 125 | + @Test(timeout = 30_000) |
| 126 | + fun testTranscribeAfterCloseThrows() { |
| 127 | + val module = tryCreateAsrModule() ?: return |
| 128 | + module.close() |
| 129 | + try { |
| 130 | + module.transcribe("/some/audio.wav") |
| 131 | + fail("transcribe() after close() must throw IllegalStateException") |
| 132 | + } catch (_: IllegalStateException) { |
| 133 | + // Expected |
| 134 | + } |
| 135 | + } |
| 136 | + |
| 137 | + @Test(timeout = 30_000) |
| 138 | + fun testIsValidAndIsLoadedState() { |
| 139 | + val module = tryCreateAsrModule() ?: return |
| 140 | + assertTrue("Module should be valid after construction", module.isValid) |
| 141 | + module.close() |
| 142 | + assertFalse("Module should not be valid after close", module.isValid) |
| 143 | + assertFalse("Module should not be loaded after close", module.isLoaded) |
| 144 | + } |
| 145 | + |
| 146 | + // ─── Transcribe validation ────────────────────────────────────────────────── |
| 147 | + |
| 148 | + @Test(timeout = 30_000) |
| 149 | + fun testTranscribeInvalidWavPathThrows() { |
| 150 | + val module = tryCreateAsrModule() ?: return |
| 151 | + try { |
| 152 | + module.transcribe("/nonexistent/audio.wav") |
| 153 | + fail("transcribe() with invalid WAV path must throw") |
| 154 | + } catch (_: IllegalArgumentException) { |
| 155 | + // Expected: require(wavFile.canRead() && wavFile.isFile) |
| 156 | + } finally { |
| 157 | + module.close() |
| 158 | + } |
| 159 | + } |
| 160 | + |
| 161 | + // ─── AsrTranscribeConfig ──────────────────────────────────────────────────── |
| 162 | + |
| 163 | + @Test |
| 164 | + fun testConfigDefaults() { |
| 165 | + val config = AsrTranscribeConfig() |
| 166 | + assertEquals(128L, config.maxNewTokens) |
| 167 | + assertEquals(0.0f, config.temperature, 0.0f) |
| 168 | + assertEquals(0L, config.decoderStartTokenId) |
| 169 | + } |
| 170 | + |
| 171 | + @Test |
| 172 | + fun testConfigBuilder() { |
| 173 | + val config = |
| 174 | + AsrTranscribeConfig.Builder() |
| 175 | + .setMaxNewTokens(256) |
| 176 | + .setTemperature(0.7f) |
| 177 | + .setDecoderStartTokenId(50258) |
| 178 | + .build() |
| 179 | + assertEquals(256L, config.maxNewTokens) |
| 180 | + assertEquals(0.7f, config.temperature, 0.001f) |
| 181 | + assertEquals(50258L, config.decoderStartTokenId) |
| 182 | + } |
| 183 | + |
| 184 | + @Test |
| 185 | + fun testConfigCustomValues() { |
| 186 | + val config = AsrTranscribeConfig(maxNewTokens = 64, temperature = 0.5f, decoderStartTokenId = 1) |
| 187 | + assertEquals(64L, config.maxNewTokens) |
| 188 | + assertEquals(0.5f, config.temperature, 0.001f) |
| 189 | + assertEquals(1L, config.decoderStartTokenId) |
| 190 | + } |
| 191 | + |
| 192 | + @Test(expected = IllegalArgumentException::class) |
| 193 | + fun testConfigZeroMaxNewTokensThrows() { |
| 194 | + AsrTranscribeConfig(maxNewTokens = 0) |
| 195 | + } |
| 196 | + |
| 197 | + @Test(expected = IllegalArgumentException::class) |
| 198 | + fun testConfigNegativeMaxNewTokensThrows() { |
| 199 | + AsrTranscribeConfig(maxNewTokens = -1) |
| 200 | + } |
| 201 | + |
| 202 | + @Test(expected = IllegalArgumentException::class) |
| 203 | + fun testConfigNegativeTemperatureThrows() { |
| 204 | + AsrTranscribeConfig(temperature = -0.1f) |
| 205 | + } |
| 206 | + |
| 207 | + @Test(expected = IllegalArgumentException::class) |
| 208 | + fun testConfigBuilderZeroMaxNewTokensThrows() { |
| 209 | + AsrTranscribeConfig.Builder().setMaxNewTokens(0).build() |
| 210 | + } |
| 211 | + |
| 212 | + @Test(expected = IllegalArgumentException::class) |
| 213 | + fun testConfigBuilderNegativeTemperatureThrows() { |
| 214 | + AsrTranscribeConfig.Builder().setTemperature(-1.0f).build() |
| 215 | + } |
| 216 | + |
| 217 | + @Test |
| 218 | + fun testConfigDataClassEquality() { |
| 219 | + val a = AsrTranscribeConfig(maxNewTokens = 100, temperature = 0.5f, decoderStartTokenId = 42) |
| 220 | + val b = AsrTranscribeConfig(maxNewTokens = 100, temperature = 0.5f, decoderStartTokenId = 42) |
| 221 | + assertEquals(a, b) |
| 222 | + assertEquals(a.hashCode(), b.hashCode()) |
| 223 | + } |
| 224 | + |
| 225 | + // ─── Helpers ──────────────────────────────────────────────────────────────── |
| 226 | + |
| 227 | + @Throws(IOException::class) |
| 228 | + private fun provisionModelFile(): File? { |
| 229 | + val pteFile = File(getTestFilePath(MODEL_FILE_NAME)) |
| 230 | + val stream = javaClass.getResourceAsStream(MODEL_FILE_NAME) ?: return null |
| 231 | + stream.use { FileUtils.copyInputStreamToFile(it, pteFile) } |
| 232 | + return pteFile |
| 233 | + } |
| 234 | + |
| 235 | + @Throws(IOException::class) |
| 236 | + private fun provisionTokenizerFile(): File? { |
| 237 | + val tokenizerFile = File(getTestFilePath(TOKENIZER_FILE_NAME)) |
| 238 | + val stream = javaClass.getResourceAsStream(TOKENIZER_FILE_NAME) ?: return null |
| 239 | + stream.use { FileUtils.copyInputStreamToFile(it, tokenizerFile) } |
| 240 | + return tokenizerFile |
| 241 | + } |
| 242 | + |
| 243 | + private fun tryCreateAsrModule(): AsrModule? { |
| 244 | + val modelFile = provisionModelFile() |
| 245 | + val tokenizerFile = provisionTokenizerFile() |
| 246 | + assumeNotNull("Test resource $MODEL_FILE_NAME not available", modelFile) |
| 247 | + assumeNotNull("Test resource $TOKENIZER_FILE_NAME not available", tokenizerFile) |
| 248 | + return try { |
| 249 | + AsrModule(modelFile!!.absolutePath, tokenizerFile!!.absolutePath) |
| 250 | + } catch (_: RuntimeException) { |
| 251 | + // nativeCreate may reject non-ASR models — skip lifecycle tests in that case |
| 252 | + null |
| 253 | + } |
| 254 | + } |
| 255 | + |
| 256 | + companion object { |
| 257 | + private const val MODEL_FILE_NAME = "/stories.pte" |
| 258 | + private const val TOKENIZER_FILE_NAME = "/tokenizer.bin" |
| 259 | + } |
| 260 | +} |
0 commit comments