Multiplatform support and fixes - part II.

Author: aartiPl

TODO.md

@@ -0,0 +1,11 @@
+# kscript 4.1 features:
+
+* Multiplatform tests for different OS-es
+* Windows console support requires @argfiles as kotlin/kotlinc command line is too long to execute it from console.
+
+* Fix for IntelliJ projects consisting of files with the same names + re-enable tests
+* Fix for packaging + re-enable tests
+* Cleanup of ENV variables (CUSTOM_KSCRIPT_PREAMBLE -> KSCRIPT_PREAMBLE, KSCRIPT_IDEA_COMMAND -> KSCRIPT_COMMAND_IDEA, KSCRIPT_GRADLE_COMMAND -> KSCRIPT_COMMAND_GRADLE)
+* Depreciation of @MavenRepository -> @Repository is Kotlin standard
+* Depreciation of some old features with WARN (comment based annotations, referencing script by $HOME and by '/' - those references won't work for web scripts)
+* Improve Unit tests

src/kscript.bat

@@ -0,0 +1,8 @@
+@echo off
+
+for /f %%i in ('where kscript.bat') do set ABS_KSCRIPT_PATH=%%i
+set JAR_PATH=%ABS_KSCRIPT_PATH:~0,-4%.jar
+
+rem kotlin -classpath %JAR_PATH% kscript.app.KscriptKt "windows" %*
+FOR /F "tokens=* USEBACKQ" %%O IN (`kotlin -classpath %JAR_PATH% kscript.app.KscriptKt "windows" %*`) DO (SET RESULT=%%O)
+%RESULT%

src/main/kotlin/kscript/app/model/ConfigBuilder.kt

@@ -24,18 +24,18 @@ class ConfigBuilder internal constructor() {
     var repositoryPasswordEnvVariable: String? = null
 
     fun build(): Config {
-        //Java resolved env variables paths are always in native format; All paths should be stored in Config as native.
+        //Java resolved env variables paths are always in native format; All paths should be stored in Config as native,
+        //and then converted as needed to shell format.
 
-        //TODO: can it be read from: System.getProperty("os.name"); what about cygwin and msys?
         val osType = OsType.findOrThrow(requireNotNull(osType))
         val classPathSeparator = classPathSeparator ?: if (osType.isWindowsLike() || osType.isUnixHostedOnWindows()) ';' else ':'
         val hostPathSeparatorChar = hostPathSeparatorChar ?: File.separatorChar
         val shellPathSeparatorChar = shellPathSeparatorChar ?: if (osType.isUnixHostedOnWindows()) '/' else hostPathSeparatorChar
         val selfName = selfName ?: System.getenv("KSCRIPT_NAME") ?: "kscript"
         val kscriptDir = kscriptDir ?: Paths.get(System.getenv("KSCRIPT_DIR") ?: (System.getProperty("user.home")!! + "/.kscript"))
-        val customPreamble = customPreamble ?: System.getenv("KSCRIPT_PREAMBLE") ?: ""
-        val intellijCommand = intellijCommand ?: System.getenv("KSCRIPT_COMMAND_IDEA") ?: "idea"
-        val gradleCommand = gradleCommand ?: System.getenv("KSCRIPT_COMMAND_GRADLE") ?: "gradle"
+        val customPreamble = customPreamble ?: System.getenv("CUSTOM_KSCRIPT_PREAMBLE") ?: ""
+        val intellijCommand = intellijCommand ?: System.getenv("KSCRIPT_IDEA_COMMAND") ?: "idea"
+        val gradleCommand = gradleCommand ?: System.getenv("KSCRIPT_GRADLE_COMMAND") ?: "gradle"
         val kotlinHome = kotlinHome ?: (System.getenv("KOTLIN_HOME") ?: ShellUtils.guessKotlinHome(osType))?.let { Paths.get(it).absolute() }
         val homeDir = homeDir ?: Paths.get(System.getProperty("user.home")!!)
         val kotlinOptsEnvVariable = kotlinOptsEnvVariable ?: System.getenv("KSCRIPT_KOTLIN_OPTS") ?: ""

src/main/kotlin/kscript/app/resolver/CommandResolver.kt

@@ -19,17 +19,28 @@ class CommandResolver(private val config: Config, private val script: Script) {
     //WINDOWS:  C:\Users\Admin\.sdkman\candidates\kotlin\current\bin\kotlin  -classpath "C:\Users\Admin;C:\Users\Admin\.kscript\cache\jar_2ccd53e06b0355d3573a4ae8698398fe\scriplet.jar;C:\Users\Admin\.sdkman\candidates\kotlin\current\lib\kotlin-script-runtime.jar" Main_Scriplet
     //MACOS:
 
+
+    //<command_path>kotlinc -classpath "p1:p2"
+    //OS Conversion matrix
+    //              command_path    command_quoting     classpath_path  classpath_separator     classpath_quoting       files_path      files_quoting   main_class_quoting
+    //LINUX         native          no                  native          :                       "                       ?
+    //GIT-BASH      shell           no                  native          ;                       "                       ?
+    //CYGWIN        shell           no                  native          ;                       "
+    //WINDOWS       native          no                  native          ;                       "
+    //MACOS         ?               ?                   ?               ?                       ?
+
+
     //Path conversion (Cygwin/mingw): cygpath -u "c:\Users\Admin"; /cygdrive/c/ - Cygwin; /c/ - Mingw
     //uname --> CYGWIN_NT-10.0 or MINGW64_NT-10.0-19043
     //How to find if mingw/cyg/win (second part): https://stackoverflow.com/questions/40877323/quickly-find-if-java-was-launched-from-windows-cmd-or-cygwin-terminal
 
     fun compileKotlin(jar: Path, dependencies: Set<Path>, filePaths: Set<Path>): String {
         val compilerOptsStr = resolveCompilerOpts(script.compilerOpts)
         val classpath = resolveClasspath(dependencies)
-        val files = filePaths.joinToString(" ") { "'${it.absolutePathString()}'" }
+        val files = filePaths.joinToString(" ") { "\"${it.absolutePathString()}\"" }
         val kotlinc = resolveKotlinBinary("kotlinc")
 
-        return "'$kotlinc' $compilerOptsStr $classpath -d '${jar.absolutePathString()}' $files"
+        return "$kotlinc $compilerOptsStr $classpath -d \"${jar.absolutePathString()}\" $files"
     }
 
     fun executeKotlin(jarArtifact: JarArtifact, dependencies: Set<Path>, userArgs: List<String>): String {

test/resources/custom_dsl/mydsl

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-export KSCRIPT_PREAMBLE='
+export CUSTOM_KSCRIPT_PREAMBLE='
 // declare dependencies
 @file:DependsOn("com.github.holgerbrandl:kutils:0.12")