Merge pull request #28 from Bible-Translation-Tools/jbs-plugin-paths

Jbs plugin paths

Author: jsarabia

assets/src/main/resources/plugins/ocenaudio.yaml

@@ -4,7 +4,13 @@
     canEdit: true
     canRecord: true
     executable:
-        macos: /Applications/ocenaudio.app/Contents/MacOS/ocenaudio
-        linux: /usr/bin/ocenaudio
-        windows: C:\Program Files (x86)\ocenaudio\ocenaudio.exe
+        macos:
+            - /Applications/ocenaudio.app/Contents/MacOS/ocenaudio
+        linux:
+            - /usr/bin/ocenaudio
+        windows:
+            - C:\Program Files (x86)\ocenaudio\ocenaudio.exe
+            - C:\Program Files\ocenaudio\ocenaudio.exe
+            - C:\Users\${user.name}\AppData\Local\ocenaudio\ocenaudio.exe
+            - C:\Users\${user.name}\AppData\Roaming\ocenaudio\ocenaudio.exe
     args: []

jvm/workbookapp/src/main/kotlin/org/wycliffeassociates/otter/jvm/workbookapp/audioplugin/parser/ParsedAudioPluginDataMapper.kt

@@ -14,11 +14,7 @@ class ParsedAudioPluginDataMapper(osName: String? = null) {
      */
     fun mapToAudioPluginData(parsedAudioPlugin: ParsedAudioPluginData, sourceFile: File): AudioPluginData {
         // Get the executable for the system we are running on
-        val executable = when {
-            osName.contains("WIN") -> parsedAudioPlugin.executable.windows
-            osName.contains("MAC") -> parsedAudioPlugin.executable.macos
-            else -> parsedAudioPlugin.executable.linux
-        }
+        val executable = selectExecutable(parsedAudioPlugin)
 
         return AudioPluginData(
             0,
@@ -31,4 +27,27 @@ class ParsedAudioPluginDataMapper(osName: String? = null) {
             sourceFile
         )
     }
+
+    private fun selectExecutable(parsedAudioPlugin: ParsedAudioPluginData): String? {
+        val options = when {
+            osName.contains("WIN") -> parsedAudioPlugin.executable.windows
+            osName.contains("MAC") -> parsedAudioPlugin.executable.macos
+            else -> parsedAudioPlugin.executable.linux
+        }?.map {
+            insertArguments(it)
+        }
+        return options?.let {
+            selectValid(it)
+        }
+    }
+
+    private fun insertArguments(filename: String): String {
+        return filename.replace("\${user.name}", System.getProperty("user.name"))
+    }
+
+    private fun selectValid(paths: List<String>): String? {
+        return paths.map { File(it) }.firstOrNull {
+            it.exists() && it.canExecute()
+        }?.absolutePath
+    }
 }

jvm/workbookapp/src/main/kotlin/org/wycliffeassociates/otter/jvm/workbookapp/audioplugin/parser/ParsedExecutable.kt

@@ -2,7 +2,7 @@ package org.wycliffeassociates.otter.jvm.workbookapp.audioplugin.parser
 
 data class ParsedExecutable(
     // nullable since executable might not exist for a platform
-    var macos: String?,
-    var windows: String?,
-    var linux: String?
+    var macos: List<String>?,
+    var windows: List<String>?,
+    var linux: List<String>?
 )

jvm/workbookapp/src/test/kotlin/org/wycliffeassociates/otter/jvm/workbookapp/audioplugin/AudioPluginTest.kt

@@ -6,25 +6,31 @@ import org.wycliffeassociates.otter.common.data.config.AudioPluginData
 import java.io.File
 
 class AudioPluginTest {
+
+    var exe = File.createTempFile("test", ".exe").apply {
+        setExecutable(true)
+        deleteOnExit()
+    }
+
     var inputAudioPluginData = AudioPluginData(
-            0,
-            "Beethoven",
-            "3.4.2",
-            true,
-            false,
-            "bash",
-            listOf("-c", "echo hello"),
-            File("some/fake/file/path.yaml")
+        0,
+        "Beethoven",
+        "3.4.2",
+        true,
+        false,
+        "bash",
+        listOf("-c", "echo hello"),
+        exe
     )
     var missingExecutablePlugin = AudioPluginData(
-            0,
-            "Beethoven",
-            "3.4.2",
-            true,
-            false,
-            "./my-missing-executable",
-            listOf("hello"),
-            File("some/fake/file/path.yaml")
+        0,
+        "Beethoven",
+        "3.4.2",
+        true,
+        false,
+        "./my-missing-executable",
+        listOf("hello"),
+        File("some/fake/file/path.yaml")
     )
     val inputFile = File("somefile.wav")
 
@@ -33,8 +39,8 @@ class AudioPluginTest {
         // Create the plugin
         val audioPlugin = AudioPlugin(inputAudioPluginData)
         audioPlugin
-                .launch(inputFile)
-                .blockingAwait()
+            .launch(inputFile)
+            .blockingAwait()
         // Test only finishes if completable finishes
     }
 
@@ -44,8 +50,8 @@ class AudioPluginTest {
         val audioPlugin = AudioPlugin(missingExecutablePlugin)
         try {
             audioPlugin
-                    .launch(inputFile)
-                    .blockingAwait()
+                .launch(inputFile)
+                .blockingAwait()
             Assert.fail()
         } catch (e: RuntimeException) {
             // IOException thrown as RuntimeException

jvm/workbookapp/src/test/kotlin/org/wycliffeassociates/otter/jvm/workbookapp/audioplugin/parser/ParsedAudioPluginDataMapperTest.kt

@@ -6,18 +6,32 @@ import org.wycliffeassociates.otter.common.data.config.AudioPluginData
 import java.io.File
 
 class ParsedAudioPluginDataMapperTest {
+
+    var win = File.createTempFile("windows", ".exe").apply {
+        setExecutable(true)
+        deleteOnExit()
+    }
+    var linux = File.createTempFile("linux", ".exe").apply {
+        setExecutable(true)
+        deleteOnExit()
+    }
+    var mac = File.createTempFile("mac", ".exe").apply {
+        setExecutable(true)
+        deleteOnExit()
+    }
+
     val PLUGIN_PLATFORM_TABLE = listOf(
         mapOf(
             "os.name" to "Mac OS X",
-            "expectedExecutable" to "/Applications/Audacity.workbookapp/Contents/MacOS/Audacity"
+            "expectedExecutable" to mac.absolutePath
         ),
         mapOf(
             "os.name" to "Windows 10",
-            "expectedExecutable" to "C:\\Program Files (x86)\\Audacity\\audacity.exe"
+            "expectedExecutable" to win.absolutePath
         ),
         mapOf(
             "os.name" to "Linux",
-            "expectedExecutable" to "audacity"
+            "expectedExecutable" to linux.absolutePath
         )
     )
 
@@ -31,9 +45,9 @@ class ParsedAudioPluginDataMapperTest {
             true,
             false,
             ParsedExecutable(
-                "/Applications/Audacity.workbookapp/Contents/MacOS/Audacity",
-                "C:\\Program Files (x86)\\Audacity\\audacity.exe",
-                "audacity"
+                listOf(mac.absolutePath),
+                listOf(win.absolutePath),
+                listOf(linux.absolutePath)
             ),
             listOf("-t value")
         )
@@ -107,9 +121,9 @@ class ParsedAudioPluginDataMapperTest {
             true,
             false,
             ParsedExecutable(
-                "/Applications/Audacity.workbookapp/Contents/MacOS/Audacity",
-                "C:\\Program Files (x86)\\Audacity\\audacity.exe",
-                "audacity"
+                listOf(mac.absolutePath),
+                listOf(win.absolutePath),
+                listOf(linux.absolutePath)
             ),
             listOf("-t value")
         )
@@ -124,7 +138,7 @@ class ParsedAudioPluginDataMapperTest {
             inputPluginData.version,
             inputPluginData.canEdit,
             inputPluginData.canRecord,
-            "audacity",
+            linux.absolutePath,
             inputPluginData.args,
             inputPluginFile
         )