Implement PlatformNative (except for getAllEnvVars), add deleteFile to Filesystem interface

Author: lauzadis

runtime/runtime-core/common/src/aws/smithy/kotlin/runtime/util/Filesystem.kt

@@ -31,6 +31,12 @@ public interface Filesystem {
      */
     public suspend fun writeFile(path: String, data: ByteArray)
 
+    /**
+     * Delete the file, if it exists.
+     * @param path fully qualified path encoded specifically to the target platform's filesystem
+     */
+    public suspend fun deleteFile(path: String)
+
     /**
      * Check if a file exists at the [path].
      * @param path fully qualified path encoded specifically to the target platform's filesystem
@@ -54,5 +60,7 @@ internal class MapFilesystem(
     override suspend fun writeFile(path: String, data: ByteArray) {
         memFs[path] = data
     }
+
+    override suspend fun deleteFile(path: String) { memFs.remove(path) }
     override fun fileExists(path: String): Boolean = memFs[path] != null
 }

runtime/runtime-core/common/src/aws/smithy/kotlin/runtime/util/Platform.kt

@@ -43,6 +43,7 @@ internal expect object SystemDefaultProvider : PlatformProvider {
     override fun getenv(key: String): String?
     override suspend fun readFileOrNull(path: String): ByteArray?
     override suspend fun writeFile(path: String, data: ByteArray)
+    override suspend fun deleteFile(path: String)
     override val isJvm: Boolean
     override val isAndroid: Boolean
     override val isBrowser: Boolean

runtime/runtime-core/common/test/aws/smithy/kotlin/runtime/util/PlatformTest.kt

@@ -0,0 +1,45 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.smithy.kotlin.runtime.util
+
+import kotlinx.coroutines.test.runTest
+import kotlin.test.Test
+import kotlin.test.assertContentEquals
+import kotlin.test.assertNotEquals
+import kotlin.test.assertNotNull
+import kotlin.test.assertNull
+import kotlin.test.assertTrue
+
+class PlatformTest {
+    @Test
+    fun testReadWriteFile() = runTest {
+        val ps = PlatformProvider.System
+        val path = "file.txt"
+        val expected = "Hello, File!".encodeToByteArray()
+
+        try {
+            ps.writeFile(path, expected)
+
+            assertTrue(ps.fileExists(path))
+
+            val actual = ps.readFileOrNull(path)
+            assertContentEquals(expected, actual)
+        } finally {
+            ps.deleteFile(path)
+        }
+    }
+
+    @Test
+    fun testGetEnv() = runTest {
+        assertNotNull(PlatformProvider.System.getenv("PATH"))
+        assertNull(PlatformProvider.System.getenv("THIS_ENV_VAR_IS_NOT_SET"))
+    }
+
+    @Test
+    fun testOsInfo() = runTest {
+        val osInfo = PlatformProvider.System.osInfo()
+        assertNotEquals(OsFamily.Unknown, osInfo.family)
+    }
+}

runtime/runtime-core/jvm/src/aws/smithy/kotlin/runtime/util/PlatformJVM.kt

@@ -48,6 +48,12 @@ internal actual object SystemDefaultProvider : PlatformProvider {
         }
     }
 
+    actual override suspend fun deleteFile(path: String) {
+        withContext(Dispatchers.IO) {
+            File(path).delete()
+        }
+    }
+
     actual override fun fileExists(path: String): Boolean = File(path).exists()
 
     public suspend fun readFileOrNull(path: Path): ByteArray? = readFileOrNull(path.toAbsolutePath().toString())

runtime/runtime-core/native/src/aws/smithy/kotlin/runtime/util/PlatformNative.kt

@@ -4,50 +4,90 @@
  */
 package aws.smithy.kotlin.runtime.util
 
+import aws.smithy.kotlin.runtime.io.IOException
+import kotlinx.cinterop.*
+import platform.posix.*
+
 internal actual object SystemDefaultProvider : PlatformProvider {
-    actual override fun getAllEnvVars(): Map<String, String> {
-        TODO("Not yet implemented")
-    }
+    // FIXME How to get all environment variables on Native?
+    // See if it's possible to get extern char **environ loaded... is not available by default in platform.posix.*
+    // https://man7.org/linux/man-pages/man7/environ.7.html
+    actual override fun getAllEnvVars(): Map<String, String> = mapOf<String, String>()
 
-    actual override fun getenv(key: String): String? {
-        TODO("Not yet implemented")
-    }
+    actual override fun getenv(key: String): String? = platform.posix.getenv(key)?.toKString()
 
     actual override val filePathSeparator: String
-        get() = TODO("Not yet implemented")
+        get() = "/" // Unix-style separator is used in Native
 
     actual override suspend fun readFileOrNull(path: String): ByteArray? {
-        TODO("Not yet implemented")
+        return try {
+            val file = fopen(path, "rb") ?: return null
+
+            try {
+                // Get file size
+                fseek(file, 0L, SEEK_END)
+                val size = ftell(file)
+                fseek(file, 0L, SEEK_SET)
+
+                // Read file content
+                val buffer = ByteArray(size.toInt()).pin()
+                val rc = fread(buffer.addressOf(0), 1.toULong(), size.toULong(), file)
+                if (rc == size.toULong()) buffer.get() else null
+            } finally {
+                fclose(file)
+            }
+        } catch (e: Exception) {
+            null
+        }
     }
 
     actual override suspend fun writeFile(path: String, data: ByteArray) {
-        TODO("Not yet implemented")
+        val file = fopen(path, "wb") ?: throw IOException("Cannot open file for writing: $path")
+        try {
+            val wc = fwrite(data.refTo(0), 1.toULong(), data.size.toULong(), file)
+            if (wc != data.size.toULong()) {
+                throw IOException("Failed to write all bytes to file $path, expected ${data.size.toLong()}, wrote $wc")
+            }
+        } finally {
+            fclose(file)
+        }
     }
 
-    actual override fun fileExists(path: String): Boolean {
-        TODO("Not yet implemented")
-    }
+    actual override suspend fun deleteFile(path: String) { remove(path) }
 
-    actual override fun osInfo(): OperatingSystem {
-        TODO("Not yet implemented")
-    }
+    actual override fun fileExists(path: String): Boolean = access(path, F_OK) == 0
 
-    actual override val isJvm: Boolean
-        get() = TODO("Not yet implemented")
-    actual override val isAndroid: Boolean
-        get() = TODO("Not yet implemented")
-    actual override val isBrowser: Boolean
-        get() = TODO("Not yet implemented")
-    actual override val isNode: Boolean
-        get() = TODO("Not yet implemented")
-    actual override val isNative: Boolean
-        get() = TODO("Not yet implemented")
-
-    actual override fun getAllProperties(): Map<String, String> {
-        TODO("Not yet implemented")
-    }
+    actual override fun osInfo(): OperatingSystem = memScoped {
+        val utsname = alloc<utsname>()
+        uname(utsname.ptr)
+
+        val sysName = utsname.sysname.toKString().lowercase()
+        val version = utsname.release.toKString()
+        val machine = utsname.machine.toKString() // Helps differentiate iOS/macOS
 
-    actual override fun getProperty(key: String): String? {
-        TODO("Not yet implemented")
+        val family = when {
+            sysName.contains("darwin") -> {
+                if (machine.startsWith("iPhone") || machine.startsWith("iPad")) {
+                    OsFamily.Ios
+                } else {
+                    OsFamily.MacOs
+                }
+            }
+            sysName.contains("linux") -> OsFamily.Linux
+            sysName.contains("windows") -> OsFamily.Windows
+            else -> OsFamily.Unknown
+        }
+
+        return OperatingSystem(family, version)
     }
+
+    actual override val isJvm: Boolean = false
+    actual override val isAndroid: Boolean = false
+    actual override val isBrowser: Boolean = false
+    actual override val isNode: Boolean = false
+    actual override val isNative: Boolean = true
+
+    // Kotlin/Native doesn't have system properties
+    actual override fun getAllProperties(): Map<String, String> = emptyMap()
+    actual override fun getProperty(key: String): String? = null
 }