Merge pull request #504 from samalba/inputs-test

Inputs tests + description from cue doc string

cmd/dagger/cmd/input/list.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"strings"
 	"text/tabwriter"
 
 	"go.dagger.io/dagger/client"
@@ -49,7 +50,7 @@ var listCmd = &cobra.Command{
 			inputs := env.ScanInputs(ctx)
 
 			w := tabwriter.NewWriter(os.Stdout, 0, 4, 2, ' ', 0)
-			fmt.Fprintln(w, "Input\tType\tValue\tSet by user")
+			fmt.Fprintln(w, "Input\tType\tValue\tSet by user\tDescription")
 
 			for _, inp := range inputs {
 				isConcrete := (inp.IsConcreteR() == nil)
@@ -69,11 +70,12 @@ var listCmd = &cobra.Command{
 					}
 				}
 
-				fmt.Fprintf(w, "%s\t%s\t%s\t%t\n",
+				fmt.Fprintf(w, "%s\t%s\t%s\t%t\t%s\n",
 					inp.Path(),
 					getType(inp),
 					valStr,
 					isUserSet(st, inp),
+					getDocString(inp),
 				)
 			}
 
@@ -108,6 +110,34 @@ func getType(val *compiler.Value) string {
 	return val.Cue().IncompleteKind().String()
 }
 
+func getDocString(val *compiler.Value) string {
+	docs := []string{}
+	for _, c := range val.Cue().Doc() {
+		docs = append(docs, strings.TrimSpace(c.Text()))
+	}
+	doc := strings.Join(docs, " ")
+
+	lines := strings.Split(doc, "\n")
+
+	// Strip out FIXME, TODO, and INTERNAL comments
+	docs = []string{}
+	for _, line := range lines {
+		if strings.HasPrefix(line, "FIXME: ") ||
+			strings.HasPrefix(line, "TODO: ") ||
+			strings.HasPrefix(line, "INTERNAL: ") {
+			continue
+		}
+		if len(line) == 0 {
+			continue
+		}
+		docs = append(docs, line)
+	}
+	if len(docs) == 0 {
+		return "-"
+	}
+	return strings.Join(docs, " ")
+}
+
 func init() {
 	listCmd.Flags().BoolP("all", "a", false, "List all inputs (include non-overridable)")
 

examples/simple-s3/main.cue

@@ -14,6 +14,7 @@ awsConfig: aws.#Config & {
 // Name of the S3 bucket to use
 bucket: *"dagger-io-examples" | string @dagger(input)
 
+// Source code to deploy
 source: dagger.#Artifact @dagger(input)
 url:    "\(deploy.url)index.html"
 

stdlib/aws/cloudformation/cloudformation.cue

@@ -14,22 +14,24 @@ import (
 	config: aws.#Config
 
 	// Source is the Cloudformation template (JSON/YAML string)
-	source: string
+	source: string @dagger(input)
 
 	// Stackname is the cloudformation stack
-	stackName: string
+	stackName: string @dagger(input)
 
 	// Stack parameters
-	parameters: [string]: _
+	parameters: {
+		...
+	}
 
 	// Behavior when failure to create/update the Stack
-	onFailure: *"DO_NOTHING" | "ROLLBACK" | "DELETE"
+	onFailure: *"DO_NOTHING" | "ROLLBACK" | "DELETE" @dagger(input)
 
 	// Timeout for waiting for the stack to be created/updated (in minutes)
-	timeout: *10 | uint
+	timeout: *10 | uint @dagger(input)
 
 	// Never update the stack if already exists
-	neverUpdate: *false | bool
+	neverUpdate: *false | bool @dagger(input)
 
 	#files: {
 		"/entrypoint.sh":     #Code
@@ -44,7 +46,9 @@ import (
 		}
 	}
 
-	outputs: [string]: string
+	outputs: {
+		[string]: string @dagger(output)
+	}
 
 	outputs: #up: [
 		op.#Load & {

stdlib/aws/ecr/ecr.cue

@@ -15,7 +15,7 @@ import (
 	// ECR credentials
 	username: "AWS"
 
-	secret: out
+	secret: out @dagger(output)
 
 	aws.#Script & {
 		always:   true

stdlib/aws/ecs/run-task.cue

@@ -11,22 +11,24 @@ import (
 	config: aws.#Config
 
 	// ECS cluster name
-	cluster: string
+	cluster: string @dagger(input)
 
 	// Arn of the task to run
-	taskArn: string
+	taskArn: string @dagger(input)
 
 	// Environment variables of the task
-	containerEnvironment: [string]: string
+	containerEnvironment: {
+		[string]: string @dagger(input)
+	}
 
 	// Container name
-	containerName: string
+	containerName: string @dagger(input)
 
 	// Container command to give
-	containerCommand: [...string]
+	containerCommand: [...string] @dagger(input)
 
 	// Task role ARN
-	roleArn: string | *""
+	roleArn: string | *"" @dagger(input)
 
 	containerOverrides: {
 		containerOverrides: [{

stdlib/aws/eks/eks.cue

@@ -11,10 +11,10 @@ import (
 	config: aws.#Config
 
 	// EKS cluster name
-	clusterName: string
+	clusterName: string @dagger(input)
 
 	// Kubectl version
-	version: *"v1.19.9" | string
+	version: *"v1.19.9" | string @dagger(input)
 
 	// kubeconfig is the generated kube configuration file
 	kubeconfig: {
@@ -62,5 +62,5 @@ import (
 				format: "string"
 			},
 		]
-	}
+	} @dagger(output)
 }

stdlib/aws/elb/elb.cue

@@ -10,12 +10,14 @@ import (
 	config: aws.#Config
 
 	// ListenerArn
-	listenerArn: string
+	listenerArn: string @dagger(input)
 
 	// Optional vhost for reusing priorities
-	vhost?: string
+	vhost?: string @dagger(input)
 
 	// exported priority
+	priority: out @dagger(output)
+
 	out: string
 
 	aws.#Script & {

stdlib/aws/rds/rds.cue

@@ -11,18 +11,18 @@ import (
 	config: aws.#Config
 
 	// DB name
-	name: string
+	name: string @dagger(input)
 
 	// ARN of the database instance
-	dbArn: string
+	dbArn: string @dagger(input)
 
 	// ARN of the database secret (for connecting via rds api)
-	secretArn: string
+	secretArn: string @dagger(input)
 
-	dbType: "mysql" | "postgres"
+	dbType: "mysql" | "postgres" @dagger(input)
 
 	// Name of the DB created
-	out: string
+	out: string @dagger(output)
 
 	aws.#Script & {
 		"config": config

stdlib/docker/docker.cue

@@ -7,7 +7,7 @@ import (
 
 // Build a Docker image from source, using included Dockerfile
 #Build: {
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
 	#up: [
 		op.#DockerBuild & {
@@ -20,7 +20,7 @@ import (
 // Pull a docker container
 #Pull: {
 	// Remote ref (example: "index.docker.io/alpine:latest")
-	from: string
+	from: string @dagger(input)
 
 	#up: [
 		op.#FetchContainer & {ref: from},
@@ -30,10 +30,10 @@ import (
 // Push a docker image
 #Push: {
 	// Remote ref (example: "index.docker.io/alpine:latest")
-	ref: string
+	ref: string @dagger(input)
 
 	// Image
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
 	#up: [
 		op.#Load & {from:           source},
@@ -46,8 +46,8 @@ import (
 // Build a Docker image from the provided Dockerfile contents
 // FIXME: incorporate into #Build
 #ImageFromDockerfile: {
-	dockerfile: string
+	dockerfile: string           @dagger(input)
-	context:    dagger.#Artifact
+	context:    dagger.#Artifact @dagger(input)
 
 	#up: [
 		op.#DockerBuild & {

stdlib/file/file.cue

@@ -7,9 +7,9 @@ import (
 )
 
 #Create: {
-	filename:    !=""
+	filename:    !=""           @dagger(input)
-	permissions: int | *0o644
+	permissions: int | *0o644   @dagger(input)
-	contents:    string | bytes
+	contents:    string | bytes @dagger(input)
 
 	#up: [
 		op.#WriteFile & {dest: filename, content: contents, mode: permissions},
@@ -17,12 +17,12 @@ import (
 }
 
 #Append: {
-	filename:    !=""
+	filename:    !=""             @dagger(input)
-	permissions: int | *0o644
+	permissions: int | *0o644     @dagger(input)
-	contents:    string | bytes
+	contents:    string | bytes   @dagger(input)
-	from:        dagger.#Artifact
+	from:        dagger.#Artifact @dagger(input)
 
-	orig: (#read & {path: filename, "from": from}).data
+	orig: (#read & {path: filename, "from": from}).data @dagger(output)
 
 	#up: [
 		op.#WriteFile & {dest: filename, content: "\(orig)\(contents)", mode: permissions},
@@ -30,30 +30,30 @@ import (
 }
 
 #Read: {
-	filename: !=""
+	filename: !=""             @dagger(input)
-	from:     dagger.#Artifact
+	from:     dagger.#Artifact @dagger(input)
-	contents: (#read & {path: filename, "from": from}).data
+	contents: (#read & {path:  filename, "from": from}).data @dagger(output)
 }
 
 #read: {
-	path: !=""
+	path: !=""             @dagger(input)
-	from: dagger.#Artifact
+	from: dagger.#Artifact @dagger(input)
 	data: {
 		string
 		#up: [
 			op.#Load & {"from":   from},
 			op.#Export & {source: path},
 		]
-	}
+	} @dagger(output)
 }
 
 #Glob: {
-	glob: !=""
+	glob: !="" @dagger(input)
-	filenames: [...string]
+	filenames: [...string] @dagger(input)
-	from:  dagger.#Artifact
+	from:  dagger.#Artifact   @dagger(input)
-	files: (_#glob & {"glob": glob, "from": from}).data
+	files: (_#glob & {"glob": glob, "from": from}).data @dagger(output)
 	// trim suffix because ls always ends with newline
-	filenames: strings.Split(strings.TrimSuffix(files, "\n"), "\n")
+	filenames: strings.Split(strings.TrimSuffix(files, "\n"), "\n") @dagger(output)
 }
 
 _#glob: {

stdlib/gcp/gcp.cue

@@ -7,9 +7,9 @@ import (
 // Base Google Cloud Config
 #Config: {
 	// GCP region
-	region: string
+	region: string @dagger(input)
 	// GCP projcet
-	project: string
+	project: string @dagger(input)
 	// GCP service key
-	serviceKey: dagger.#Secret
+	serviceKey: dagger.#Secret @dagger(input)
 }

stdlib/gcp/gcr/gcr.cue

@@ -40,5 +40,5 @@ import (
 				source: "/token.txt"
 			},
 		]
-	}
+	} @dagger(output)
 }

stdlib/gcp/gke/gke.cue

@@ -11,10 +11,10 @@ import (
 	config: gcp.#Config
 
 	// GKE cluster name
-	clusterName: string
+	clusterName: string @dagger(input)
 
 	// Kubectl version
-	version: *"v1.19.9" | string
+	version: *"v1.19.9" | string @dagger(input)
 
 	// kubeconfig is the generated kube configuration file
 	kubeconfig: {
@@ -54,7 +54,7 @@ import (
 				format: "string"
 			},
 		]
-	}
+	} @dagger(output)
 }
 
 #Code: #"""

stdlib/git/git.cue

@@ -7,9 +7,9 @@ import (
 // A git repository
 #Repository: {
 
-	remote: string
+	remote: string       @dagger(input)
-	ref:    string
+	ref:    string       @dagger(input)
-	subdir: string | *""
+	subdir: string | *"" @dagger(input)
 
 	#up: [
 		op.#FetchGit & {

stdlib/go/go.cue

@@ -11,8 +11,8 @@ import (
 // A standalone go environment
 #Container: {
 	// Go version to use
-	version: *"1.16" | string
+	version: *"1.16" | string @dagger(input)
-	source:  dagger.#Artifact
+	source:  dagger.#Artifact @dagger(input)
 
 	os.#Container & {
 		env: CGO_ENABLED: "0"
@@ -38,16 +38,18 @@ import (
 
 #Go: {
 	// Go version to use
-	version: *"1.16" | string
+	version: *"1.16" | string @dagger(input)
 
 	// Arguments to the Go binary
-	args: [...string]
+	args: [...string] @dagger(input)
 
 	// Source Directory to build
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
 	// Environment variables
-	env: [string]: string
+	env: {
+		[string]: string @dagger(input)
+	}
 
 	#up: [
 		op.#FetchContainer & {
@@ -70,30 +72,32 @@ import (
 
 #Build: {
 	// Go version to use
-	version: *#Go.version | string
+	version: *#Go.version | string @dagger(input)
 
 	// Source Directory to build
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
 	// Packages to build
-	packages: *"." | string
+	packages: *"." | string @dagger(input)
 
 	// Target architecture
-	arch: *"amd64" | string
+	arch: *"amd64" | string @dagger(input)
 
 	// Target OS
-	os: *"linux" | string
+	os: *"linux" | string @dagger(input)
 
 	// Build tags to use for building
-	tags: *"" | string
+	tags: *"" | string @dagger(input)
 
 	// LDFLAGS to use for linking
-	ldflags: *"" | string
+	ldflags: *"" | string @dagger(input)
 
 	// Specify the targeted binary name
-	output: string
+	output: string @dagger(output)
 
-	env: [string]: string
+	env: {
+		[string]: string @dagger(input)
+	}
 
 	#up: [
 		op.#Copy & {
@@ -111,13 +115,13 @@ import (
 
 #Test: {
 	// Go version to use
-	version: *#Go.version | string
+	version: *#Go.version | string @dagger(input)
 
 	// Source Directory to build
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
 	// Packages to test
-	packages: *"." | string
+	packages: *"." | string @dagger(input)
 
 	#Go & {
 		"version": version

stdlib/js/yarn/yarn.cue

@@ -13,26 +13,28 @@ import (
 // A Yarn package.
 #Package: {
 	// Application source code
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
 	// Environment variables
-	env: [string]: string
+	env: {
+		[string]: string @dagger(input)
+	}
 
 	// Write the contents of `environment` to this file,
 	// in the "envfile" format.
-	writeEnvFile: string | *""
+	writeEnvFile: string | *"" @dagger(input)
 
 	// Read build output from this directory
 	// (path must be relative to working directory).
-	buildDir: string | *"build"
+	buildDir: string | *"build" @dagger(input)
 
 	// Run this yarn script
-	script: string | *"build"
+	script: string | *"build" @dagger(input)
 
 	build: os.#Dir & {
 		from: ctr
 		path: "/build"
-	}
+	} @dagger(output)
 
 	ctr: os.#Container & {
 		image: alpine.#Image & {

stdlib/kubernetes/helm/helm.cue

@@ -11,47 +11,47 @@ import (
 // Install a Helm chart
 #Chart: {
 	// Helm deployment name
-	name: string
+	name: string @dagger(input)
 
 	// Helm chart to install from source
-	chartSource: dagger.#Artifact
+	chartSource: dagger.#Artifact @dagger(input)
 
 	// Helm chart to install from repository
-	chart?: string
+	chart?: string @dagger(input)
 
 	// Helm chart repository (defaults to stable)
-	repository: *"https://charts.helm.sh/stable" | string
+	repository: *"https://charts.helm.sh/stable" | string @dagger(input)
 
 	// Helm values (either a YAML string or a Cue structure)
-	values?: string
+	values?: string @dagger(input)
 
 	// Kubernetes Namespace to deploy to
-	namespace: string
+	namespace: string @dagger(input)
 
 	// Helm action to apply
-	action: *"installOrUpgrade" | "install" | "upgrade"
+	action: *"installOrUpgrade" | "install" | "upgrade" @dagger(input)
 
 	// time to wait for any individual Kubernetes operation (like Jobs for hooks)
-	timeout: string | *"5m"
+	timeout: string | *"5m" @dagger(input)
 
 	// if set, will wait until all Pods, PVCs, Services, and minimum number of
 	// Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state
 	// before marking the release as successful.
 	// It will wait for as long as timeout
-	wait: *true | bool
+	wait: *true | bool @dagger(input)
 
 	// if set, installation process purges chart on fail.
 	// The wait option will be set automatically if atomic is used
-	atomic: *true | bool
+	atomic: *true | bool @dagger(input)
 
 	// Kube config file
-	kubeconfig: dagger.#Secret
+	kubeconfig: dagger.#Secret @dagger(input)
 
 	// Helm version
-	version: *"3.5.2" | string
+	version: *"3.5.2" | string @dagger(input)
 
 	// Kubectl version
-	kubectlVersion: *"v1.19.9" | string
+	kubectlVersion: *"v1.19.9" | string @dagger(input)
 
 	#up: [
 		op.#Load & {

stdlib/kubernetes/kubernetes.cue

@@ -47,19 +47,19 @@ import (
 #Apply: {
 
 	// Kubernetes config to deploy
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
 	// Kubernetes config to deploy inlined in a string
-	sourceInline?: string
+	sourceInline?: string @dagger(input)
 
 	// Kubernetes Namespace to deploy to
-	namespace: string
+	namespace: string @dagger(input)
 
 	// Version of kubectl client
-	version: *"v1.19.9" | string
+	version: *"v1.19.9" | string @dagger(input)
 
 	// Kube config file
-	kubeconfig: dagger.#Secret
+	kubeconfig: dagger.#Secret @dagger(input)
 
 	#code: #"""
 		kubectl create namespace "$KUBE_NAMESPACE" || true

stdlib/kubernetes/kustomize/kustomization.cue

@@ -8,7 +8,7 @@ import (
 
 #Kustomization: {
 	// Kustomize binary version
-	version: *"v3.8.7" | string
+	version: *"v3.8.7" | string @dagger(input)
 
 	#code: #"""
 		[ -e /usr/local/bin/kubectl ] || {
@@ -46,13 +46,13 @@ import (
 // Apply a Kubernetes Kustomize folder
 #Kustomize: {
 	// Kubernetes source
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
 	// Optional Kustomization file
-	kustomization: string
+	kustomization: string @dagger(input)
 
 	// Kustomize binary version
-	version: *"v3.8.7" | string
+	version: *"v3.8.7" | string @dagger(input)
 
 	#code: #"""
 		cp /kustomization.yaml /source | true

stdlib/netlify/netlify.cue

@@ -10,10 +10,10 @@ import (
 #Account: {
 	// Use this Netlify account name
 	// (also referred to as "team" in the Netlify docs)
-	name: string | *""
+	name: string | *"" @dagger(input)
 
 	// Netlify authentication token
-	token: dagger.#Secret
+	token: dagger.#Secret @dagger(input)
 }
 
 // A Netlify site
@@ -22,16 +22,16 @@ import (
 	account: #Account
 
 	// Contents of the application to deploy
-	contents: dagger.#Artifact
+	contents: dagger.#Artifact @dagger(input)
 
 	// Deploy to this Netlify site
-	name: string
+	name: string @dagger(input)
 
 	// Host the site at this address
-	customDomain?: string
+	customDomain?: string @dagger(input)
 
 	// Create the Netlify site if it doesn't exist?
-	create: bool | *true
+	create: bool | *true @dagger(input)
 
 	// Website url
 	url: {
@@ -39,7 +39,7 @@ import (
 				from: ctr
 				path: "/netlify/url"
 			}
-	}.read.data
+	}.read.data @dagger(output)
 
 	// Unique Deploy URL
 	deployUrl: {
@@ -47,7 +47,7 @@ import (
 				from: ctr
 				path: "/netlify/deployUrl"
 			}
-	}.read.data
+	}.read.data @dagger(output)
 
 	// Logs URL for this deployment
 	logsUrl: {
@@ -55,7 +55,7 @@ import (
 				from: ctr
 				path: "/netlify/logsUrl"
 			}
-	}.read.data
+	}.read.data @dagger(output)
 
 	ctr: os.#Container & {
 		image: alpine.#Image & {

stdlib/terraform/terraform.cue

@@ -8,13 +8,17 @@ import (
 )
 
 #Configuration: {
-	version: string | *"latest"
+	version: string | *"latest" @dagger(input)
 
-	source: dagger.#Artifact
+	source: dagger.#Artifact @dagger(input)
 
-	tfvars?: [string]: _
+	tfvars?: {
+		...
+	}
 
-	env: [string]: string
+	env: {
+		[string]: string @dagger(input)
+	}
 
 	state: #up: [
 		op.#FetchContainer & {
@@ -61,5 +65,5 @@ import (
 			},
 		]
 		...
-	}
+	} @dagger(output)
 }

tests/cli.bats

@@ -285,3 +285,38 @@ setup() {
   "foo": "bar"
 }'
 }
+
+@test "dagger input list" {
+    "$DAGGER" init
+
+    dagger_new_with_plan list "$TESTDIR"/cli/input/list
+    "$DAGGER" input text cfg.str "foobar" -e "list"
+
+    out="$("$DAGGER" input list -e "list")"
+    outAll="$("$DAGGER" input list --all -e "list")"
+
+    #note: this is the recommended way to use pipes with bats
+    run bash -c "echo \"$out\" | grep awsConfig.accessKey | grep '#Secret' | grep false"
+    assert_success
+
+    run bash -c "echo \"$out\" | grep cfgInline.source | grep '#Artifact' | grep false | grep 'source dir'"
+    assert_success
+
+    run bash -c "echo \"$outAll\" | grep cfg2"
+    assert_failure
+
+    run bash -c "echo \"$out\" | grep cfgInline.strDef | grep string | grep 'yolo (default)' | grep false"
+    assert_success
+
+    run bash -c "echo \"$out\" | grep cfg.num"
+    assert_failure
+
+    run bash -c "echo \"$outAll\" | grep cfg.num | grep int"
+    assert_success
+
+    run bash -c "echo \"$out\" | grep cfg.strSet"
+    assert_failure
+
+    run bash -c "echo \"$outAll\" | grep cfg.strSet | grep string | grep pipo"
+    assert_success
+}

tests/cli/input/list/main.cue

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"dagger.io/dagger"
+	"dagger.io/aws"
+)
+
+awsConfig: aws.#Config & {
+	// force region
+	region: "us-east-1"
+}
+
+#A: {
+	// source dir
+	source:         dagger.#Artifact @dagger(input)
+	sourceNotInput: dagger.#Artifact
+
+	// a secret
+	key:         dagger.#Secret @dagger(input)
+	keyNotInput: dagger.#Secret
+
+	// a string
+	str:    string           @dagger(input)
+	strSet: "pipo"           @dagger(input)
+	strDef: *"yolo" | string @dagger(input)
+
+	// a number
+	num:         int | *42 @dagger(input)
+	numNotInput: int
+
+	// aws config
+	cfg: awsConfig
+}
+
+cfgInline: {
+	#A
+}
+
+cfg: #A & {
+	// force this key
+	num: 21
+}
+
+cfg2: cfg

tests/cli/input/scan/main.cue

@@ -1,50 +0,0 @@
-package main
-
-foo: string
-
-name:    string | *"world"
-message: "Hello, \(name)!"
-
-optional?: string
-
-missing: [string]: string
-
-bar: {
-	a:  string
-	#c: string
-	b:  int @dagger(computed)
-}
-
-// may be missing
-#inputs: {
-	hello:   string
-	missing: *"" | string
-}
-
-// substitute
-let A = string
-let B = bar.a
-
-//let Ba = bar.a
-//let Bb = bar.b
-let D = "hello"
-
-refd: {
-	a: string
-	b: {
-		ref1: a
-		ref2: A
-		aa:   B
-		bb:   D
-	}
-	#c: C: string
-}
-
-#fld1: string
-
-exec: {
-	cmd: string
-	#up: [{foo: string}]
-}
-
-list: [...string]