os.#File: simplify API

Signed-off-by: Solomon Hykes <solomon@dagger.io>

docs/reference/universe/os.md

@@ -34,7 +34,7 @@ _No output._
 
 ## os.#File
 
-Built-in file implementation, using buildkit
+Built-in file implementation, using buildkit A single file
 
 ### os.#File Inputs
 

stdlib/.dagger/env/os/.gitignore

@@ -0,0 +1,2 @@
+# dagger state
+state/**

stdlib/.dagger/env/os/plan/main.cue

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"dagger.io/os"
+	"dagger.io/alpine"
+)
+
+// Write a file to an empty dir
+EmptyDir: {
+	f: os.#File & {
+		path: "/foo.txt"
+		write: data: "hello world!"
+	}
+	f: contents: "hello world!"
+}
+
+// Read from a pre-existing file
+Read: {
+	f: os.#File & {
+		from: alpine.#Image & {
+			version: "3.13.4"
+		}
+		path: "/etc/alpine-release"
+	}
+	f: contents: "3.13.4\n"
+}

stdlib/.dagger/env/os/values.yaml

@@ -0,0 +1,21 @@
+name: os
+sops:
+    kms: []
+    gcp_kms: []
+    azure_kv: []
+    hc_vault: []
+    age:
+        - recipient: age1gxwmtwahzwdmrskhf90ppwlnze30lgpm056kuesrxzeuyclrwvpsupwtpk
+          enc: |
+            -----BEGIN AGE ENCRYPTED FILE-----
+            YWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IFgyNTUxOSA0bDM5blE0cC9LNHkxZmEy
+            bitYcjhMOHhrWE5pRm90Qyt4S200ZTN0Q1d3Clh2VmdKQjdGUGdKaThmaktwN1F6
+            aXZpellwbHpkb3pMb1NMNXVJYnFUMmMKLS0tIFNiZGlBNjE3UjlXWnBjZ3hwSWto
+            STlrbFNHZGFRUVQ1S1RIaGVyWktNV0kKo9AFURi/BKI+JuGYVuOrsw3eJU3s66Im
+            FCc5YCzrsjX+Y26Su+XW81fTWkcC910e/g+tlZbEFWKZYa8qu1VkqA==
+            -----END AGE ENCRYPTED FILE-----
+    lastmodified: "2021-06-09T18:19:29Z"
+    mac: ENC[AES256_GCM,data:G/D+9UqwJXhqVHAq8rXP7YxubzGKNxjguUVuVpnxKN7awzYaAD2E5plBFDqCw++5qFSZ7HMlWZUseyKOfaOxtkT0CTRAZf8cYLXHIjzKKCFP632nLN0zCPQCMqdrhOLtWkLovtHJ94Xvd3C3Mb+bVi1YmOC6nQHhpglwTVjDw9I=,iv:0GN4vAO5QMXUTODDKYpPD/UmxjfI+RyCdYz9UXQNCso=,tag:RacQNrAUhJHtKeu5ugUadA==,type:str]
+    pgp: []
+    encrypted_suffix: secret
+    version: 3.7.1

stdlib/aws/ecr/ecr.cue

@@ -28,5 +28,5 @@ import (
 				from: ctr
 				path: "/out"
 			}
-	}.read.data @dagger(output)
+	}.contents @dagger(output)
 }

stdlib/dagger/op/op.cue

@@ -108,6 +108,7 @@ package op
 
 #WriteFile: {
 	do: "write-file"
+	// FIXME: "contents" to follow english convention
 	content: string | bytes
 	dest:    string
 	mode:    int | *0o644

stdlib/netlify/netlify.cue

@@ -40,7 +40,7 @@ import (
 				from: ctr
 				path: "/netlify/url"
 			}
-	}.read.data @dagger(output)
+	}.contents @dagger(output)
 
 	// Unique Deploy URL
 	deployUrl: {
@@ -48,7 +48,7 @@ import (
 				from: ctr
 				path: "/netlify/deployUrl"
 			}
-	}.read.data @dagger(output)
+	}.contents @dagger(output)
 
 	// Logs URL for this deployment
 	logsUrl: {
@@ -56,7 +56,7 @@ import (
 				from: ctr
 				path: "/netlify/logsUrl"
 			}
-	}.read.data @dagger(output)
+	}.contents @dagger(output)
 
 	ctr: os.#Container & {
 		image: alpine.#Image & {

stdlib/os/file.cue

@@ -7,30 +7,36 @@ import (
 )
 
 // Built-in file implementation, using buildkit
+// A single file
 #File: {
-	from: dagger.#Artifact
+	from: dagger.#Artifact | *[op.#Mkdir & {dir: "/", path: "/"}]
 	path: string
 
-	read: {
+	// Optionally write data to the file
-		// FIXME: support different data schemas for different formats
+	write: *null | {
-		format: "string"
+		data: string
-		data: {
+		// FIXME: append
-			string
+		// FIXME: create + mode
-			#up: [
-				op.#Load & {"from":   from},
-				op.#Export & {source: path, "format": format},
-			]
-		}
 	}
 
-	write: *null | {
+	// The contents of the file
-		// FIXME: support encoding in different formats
+	// If a write operation is specified, it is applied first.
-		data: string
+	contents: {
+		string
+
 		#up: [
-			op.#Load & {"from": from},
+			op.#Load & {
+				"from": from
+			},
+			if write != null {
 				op.#WriteFile & {
 					dest:    path
-				contents: data
+					content: write.data
+				}
+			},
+			op.#Export & {
+				source: path
+				format: "string"
 			},
 		]
 	}

stdlib/universe.bats

@@ -4,6 +4,11 @@ setup() {
     common_setup
 }
 
+
+@test "os" {
+    dagger -e os up
+}
+
 @test "go" {
     dagger -e go up
 }