cmd/age: replace tests with testscript

cmd/age/age.go

@@ -103,7 +103,7 @@ func main() {
 
 	if len(os.Args) == 1 {
 		flag.Usage()
-		os.Exit(1)
+		exit(1)
 	}
 
 	var (

cmd/age/age_test.go

@@ -5,93 +5,29 @@
 package main
 
 import (
-	"errors"
-	"io"
 	"os"
-	"path/filepath"
-	"strings"
 	"testing"
 
-	"filippo.io/age"
+	"github.com/rogpeppe/go-internal/testscript"
 )
 
-func TestVectors(t *testing.T) {
-	var defaultIDs []age.Identity
-
-	password, err := os.ReadFile("testdata/default_password.txt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	p := strings.TrimSpace(string(password))
-	i, err := age.NewScryptIdentity(p)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defaultIDs = append(defaultIDs, i)
-
-	ids, err := parseIdentitiesFile("testdata/default_key.txt")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defaultIDs = append(defaultIDs, ids...)
-
-	files, _ := filepath.Glob("testdata/*.age")
-	for _, f := range files {
-		_, name := filepath.Split(f)
-		name = strings.TrimSuffix(name, ".age")
-		expectPass := strings.HasPrefix(name, "good_")
-		expectFailure := strings.HasPrefix(name, "fail_")
-		expectNoMatch := strings.HasPrefix(name, "nomatch_")
-		t.Run(name, func(t *testing.T) {
-			identities := defaultIDs
-			ids, err := parseIdentitiesFile("testdata/" + name + "_key.txt")
-			if err == nil {
-				identities = ids
-			}
-			password, err := os.ReadFile("testdata/" + name + "_password.txt")
-			if err == nil {
-				p := strings.TrimSpace(string(password))
-				i, err := age.NewScryptIdentity(p)
-				if err != nil {
-					t.Fatal(err)
+func TestMain(m *testing.M) {
+	os.Exit(testscript.RunMain(m, map[string]func() int{
+		"age": func() (exitCode int) {
+			testOnlyPanicInsteadOfExit = true
+			defer func() {
+				if testOnlyDidExit {
+					exitCode = recover().(int)
 				}
-				identities = []age.Identity{i}
-			}
+			}()
+			main()
+			return 0
+		},
+	}))
+}
 
-			in, err := os.Open("testdata/" + name + ".age")
-			if err != nil {
-				t.Fatal(err)
-			}
-			r, err := age.Decrypt(in, identities...)
-			if expectFailure {
-				if err == nil {
-					_, err = io.ReadAll(r)
-				}
-				if err == nil {
-					t.Fatal("expected Decrypt or Read failure")
-				}
-				if e := new(age.NoIdentityMatchError); errors.As(err, &e) {
-					t.Errorf("got ErrIncorrectIdentity, expected more specific error")
-				}
-			} else if expectNoMatch {
-				if err == nil {
-					t.Fatal("expected Decrypt failure")
-				}
-				if e := new(age.NoIdentityMatchError); !errors.As(err, &e) {
-					t.Errorf("expected ErrIncorrectIdentity, got %v", err)
-				}
-			} else if expectPass {
-				if err != nil {
-					t.Fatal(err)
-				}
-				out, err := io.ReadAll(r)
-				if err != nil {
-					t.Fatal(err)
-				}
-				t.Logf("%s", out)
-			} else {
-				t.Fatal("invalid test vector: missing prefix")
-			}
-		})
-	}
+func TestScript(t *testing.T) {
+	testscript.Run(t, testscript.Params{
+		Dir: "testdata",
+	})
 }

cmd/age/testdata/default_key.txt

@@ -1,6 +0,0 @@
-# created: 2021-02-02T13:09:43+01:00
-# public key: age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef
-AGE-SECRET-KEY-1EGTZVFFV20835NWYV6270LXYVK2VKNX2MMDKWYKLMGR48UAWX40Q2P2LM0
-
-# TODO: regenerate empty_recipient_body.age
-AGE-SECRET-KEY-1TRYTV7PQS5XPUYSTAQZCD7DQCWC7Q77YJD7UVFJRMW4J82Q6930QS70MRX

cmd/age/testdata/default_password.txt

@@ -1 +0,0 @@
-now-major-idea-author-clerk-bronze-all-soul-uncover-glad

cmd/age/testdata/ed25519.txt

@@ -0,0 +1,29 @@
+# encrypt and decrypt a file with -R
+age -R key.pem.pub -o test.age input
+age -d -i key.pem test.age
+stdout test
+
+# encrypt and decrypt a file with -i
+age -e -i key.pem -o test.age input
+age -d -i key.pem test.age
+stdout test
+
+# encrypt and decrypt a file with the wrong key
+age -R otherkey.pem.pub -o test.age input
+! age -d -i key.pem test.age
+stderr 'no identity matched any of the recipients'
+
+-- input --
+test
+-- key.pem --
+-----BEGIN OPENSSH PRIVATE KEY-----
+b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW
+QyNTUxOQAAACB/aTuac9tiWRGrKEtixFlryYlGCPTOpdbmXN9RRmDF2gAAAKDgV/GC4Ffx
+ggAAAAtzc2gtZWQyNTUxOQAAACB/aTuac9tiWRGrKEtixFlryYlGCPTOpdbmXN9RRmDF2g
+AAAECvFoQXQzXgJLQ+Gz4PfEcfyZwC2gUjOiWTD//mTPyD8H9pO5pz22JZEasoS2LEWWvJ
+iUYI9M6l1uZc31FGYMXaAAAAG2ZpbGlwcG9AQmlzdHJvbWF0aC1NMS5sb2NhbAEC
+-----END OPENSSH PRIVATE KEY-----
+-- key.pem.pub --
+ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIH9pO5pz22JZEasoS2LEWWvJiUYI9M6l1uZc31FGYMXa
+-- otherkey.pem.pub --
+ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJFlMdZUMrWjJ3hh60MLALXSqUdAjBo/qEMJzvpekpoM

cmd/age/testdata/good_ed25519.age

@@ -1,5 +0,0 @@
-age-encryption.org/v1
--> ssh-ed25519 cp09gQ Kf5JDNFFDUaOvups2MDfP47PlrpJthnmz0WNMfGj+C8
-hQ76lMAsG2pjR8GHTU+XU0giePyzE3prVmAw5MbMxSk
---- CjO8qf3vd83otqHSflgWP5gQoe2Roo9tf/zgWEy9t0U
-èÙ®Ò%JðÇnj<bÖ: %UgZ4#™±àNÂ韟

cmd/age/testdata/good_ed25519_key.txt

@@ -1,7 +0,0 @@
------BEGIN OPENSSH PRIVATE KEY-----
-b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW
-QyNTUxOQAAACB/aTuac9tiWRGrKEtixFlryYlGCPTOpdbmXN9RRmDF2gAAAKDgV/GC4Ffx
-ggAAAAtzc2gtZWQyNTUxOQAAACB/aTuac9tiWRGrKEtixFlryYlGCPTOpdbmXN9RRmDF2g
-AAAECvFoQXQzXgJLQ+Gz4PfEcfyZwC2gUjOiWTD//mTPyD8H9pO5pz22JZEasoS2LEWWvJ
-iUYI9M6l1uZc31FGYMXaAAAAG2ZpbGlwcG9AQmlzdHJvbWF0aC1NMS5sb2NhbAEC
------END OPENSSH PRIVATE KEY-----

cmd/age/testdata/good_ed25519_key.txt.pub

@@ -1 +0,0 @@
-ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIH9pO5pz22JZEasoS2LEWWvJiUYI9M6l1uZc31FGYMXa

cmd/age/testdata/good_rsa.age

@@ -1,13 +0,0 @@
-age-encryption.org/v1
--> ssh-rsa jw/33g
-xv12FD3f2d7snIcuXBznTOWAlgCovW1Dqttk9uljWKy3GtRZ3t8jEWkQEOYkOk0M
-EHA6sHWfdPLdlS3DjQYjcaLFvwh3+XVKYNzP9MhLg8P8xvxVkn4aiCKd8ivEisp0
-bKGi4g/TJz/JKUg1SGbqDg966to0P5AWrkwAD7OMykQToqo56flrKXgFPleSWVWu
-umiwbxFYs7ltbRYvjzdpIj9l30lXkzrADP3RrrvTu/qT0IN3PMi3bOqm0kKz0vkd
-p4NpxKmfqQXavU+YZiyQL637V3cbKIAEJ1qmpkd2Tr2oUhfD5IgAoT1nC5tCIzRb
-DkPwM4k2FJgVX0KKvW3i0+k5tve4XWg82vq2OCj8+sl3A8cLX3g5zhh53DovUBVm
-qDU2HWf++3q9kUy1al0sFb2es4ih+tK74nPjBJZtX0n+4lMngz557+XuYnzZ2OkW
-QEq3b7Trdidw7Ak9S14tdXhj8oy7J1jdHsQ8/wehAc1v8MuBb1O7LxVIFxzBEBCA
-
---- QdCY4BN4vwp5jb+AFsyoHkvKW+EneZsZjPURH2tCF18
-«)KVMARsS‘M’ÚëûØ‚Kí>›ÕÕ«`¤~T0n·

cmd/age/testdata/good_rsa_key.txt.pub

@@ -1 +0,0 @@
-ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDULTit0KUehbigbhsQaZo2oXLgMug8nTfnzDhcf5cEzdOJZyF6i5aRQbqbXIOYeTS3Shpp/iE6d60qi93JBBfveAZqr76tK7lVK8fstvAAGgbo9L9Ru5nhWX0HTlZUOodUT2E0rgAeoFzfvcZTaajzPmikrESmuaJLcdJ3crbCIyovkTxc85KbSn+Ky5grntdVR7GXve0HuIgwuSXGNyO0/hEQyhCEco4w53LZDXl3Dlxgb52u0QCsFFiQJmZ3RWnbCz2mNjM9Vo5KRt2pJ4u74lVsfXCvAqG4GsDd5WXCNRNaQ7gUdw1eSnvvcy3hxeEqLNN9tHaFCjEuyPfXfTVd3t0SlXreyoNbV75rYvZ2F6aLxyMMys+5bpnX0tu2LSq4Bvj5xIsBokjgEd3UXyj1eErsQdUJ0gghAMpXOjVbISwPAGMvUsH2unGbjvfaxnK57S7KAXOYznjhBf5ayIleAc+4LVD/KeMtGbpkyXXozC9jwH9cZBbGU4BtElAbzh8=

cmd/age/testdata/good_simple.age

@@ -1,6 +0,0 @@
-age-encryption.org/v1
--> X25519 kx2RzHNfNuts0I131KwMCyYclZzKCGMzPUaMkH9J4z4
-9qEzjtIF4NsLFnxv8EEtCwOQiXj5WHl+HWaDKNeAk+4
---- N+7l3M/ofCyzZVlPJ33CTHH8AddF0itK70QV+IIvXXA
-³]Ú	 É+zAIÉúçê¸Ç�éLüü“ªžà
-Hˆ%Ñ¥£

cmd/age/testdata/nomatch_scrypt.age

@@ -1,5 +0,0 @@
-age-encryption.org/v1
--> scrypt X6oOTRAjCR1xid0PlnNMFA 10
-hszKAHhyFVpUgt9niYpdYXVhhN+r+oiCLPZukDdQZBQ
---- 7BRJPVjbIC1JntvHrA13PQrnsa3lkwhnNF/Pbo4BPs4
-4|)ÆS|Û‹Ò¿D�÷§}
’Í2è%�e�=óœ6˜»ÇZ

cmd/age/testdata/nomatch_x25519.age

@@ -1,5 +0,0 @@
-age-encryption.org/v1
--> X25519 Rp86RQ3LgUJpQy4X2RMUhURlBP28tCaLQ2ssysJfRhg
-83YXad/lj3/wFM4n7vlGIiBSgfhG8lfiP5U7ajjK3HM
---- O2+UpzetsP2+7BPyGQ4C6VMTY6zwp5TiNpVcFy4qdyM
-璇漡�(擔Q:|c蔑鞮蓤�=f�6b坿!

cmd/age/testdata/rsa.txt

@@ -1,3 +1,21 @@
+# encrypt and decrypt a file with -R
+age -R key.pem.pub -o test.age input
+age -d -i key.pem test.age
+stdout test
+
+# encrypt and decrypt a file with -i
+age -e -i key.pem -o test.age input
+age -d -i key.pem test.age
+stdout test
+
+# encrypt and decrypt a file with the wrong key
+age -R otherkey.pem.pub -o test.age input
+! age -d -i key.pem test.age
+stderr 'no identity matched any of the recipients'
+
+-- input --
+test
+-- key.pem --
 -----BEGIN OPENSSH PRIVATE KEY-----
 b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn
 NhAAAAAwEAAQAAAYEA1C04rdClHoW4oG4bEGmaNqFy4DLoPJ0358w4XH+XBM3TiWcheouW
@@ -36,3 +54,7 @@ EX0mNDXOlKOP2YAIMrDt5CkPdEh6qQG21LCZXTWmwheZ9iN2vOl/fKqUW9lqd/kTe6WsON
 hIpZhs2+oz54Riq1ZwzO9NkcYrvZoDKbDopL1r2ibw0mkgCJrxpWi0Yt2Iooh4GXXqP5C9
 T8hrZCbrVJkjKd5QAAABtmaWxpcHBvQEJpc3Ryb21hdGgtTTEubG9jYWwBAgMEBQY=
 -----END OPENSSH PRIVATE KEY-----
+-- key.pem.pub --
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDULTit0KUehbigbhsQaZo2oXLgMug8nTfnzDhcf5cEzdOJZyF6i5aRQbqbXIOYeTS3Shpp/iE6d60qi93JBBfveAZqr76tK7lVK8fstvAAGgbo9L9Ru5nhWX0HTlZUOodUT2E0rgAeoFzfvcZTaajzPmikrESmuaJLcdJ3crbCIyovkTxc85KbSn+Ky5grntdVR7GXve0HuIgwuSXGNyO0/hEQyhCEco4w53LZDXl3Dlxgb52u0QCsFFiQJmZ3RWnbCz2mNjM9Vo5KRt2pJ4u74lVsfXCvAqG4GsDd5WXCNRNaQ7gUdw1eSnvvcy3hxeEqLNN9tHaFCjEuyPfXfTVd3t0SlXreyoNbV75rYvZ2F6aLxyMMys+5bpnX0tu2LSq4Bvj5xIsBokjgEd3UXyj1eErsQdUJ0gghAMpXOjVbISwPAGMvUsH2unGbjvfaxnK57S7KAXOYznjhBf5ayIleAc+4LVD/KeMtGbpkyXXozC9jwH9cZBbGU4BtElAbzh8=
+-- otherkey.pem.pub --
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDF0OPu95EY25O5KmYFLIkiZZFKUlfvaRgmfIT6OcZvPRXBzo0MS/lcrYvAc0RsUVbZ1B3Y9oWmKt/IMXTztCXiza70rO1NI7ciayv5svY/wGMoveutddhA64IjrQKs4m+6Qmjs/dYTnfsk1BzmXrdRKUSqH6c4Id7pRLC1ySLu+4og3nTTpBRBpg+uSkc4Ua6ce6A6RX14PPJ+TAXMfZyKNyaubQhgzLB/CfdXxZqWdAnyooiE7fb6CEB5uppnA5BpPdcWAkSixbwxRHbRC+OSCqMOV6+z+NlO/qSOKJcXfCQnJP/qjJTJde0dYhXG4RILOzIkGVieGJJONDXvj61mMj568IhJz0AEf/UMhvEL79iJ6yZW82Go/zcYkDDfd3KRE3pW+6p9Onu3XqOiQABS+9rEVRBnqYsPajiHBIanBeXpWKGbjznakvxhdRifhOWwAsQDfLmGzh+JnV1vOUjyxKtLNv9zi/oeuYCaIyF7F6en8LMbYSz8YONMZygGxMU=

cmd/age/testdata/usage.txt

@@ -0,0 +1,20 @@
+# -help
+age -p -help
+! stdout .
+stderr 'Usage:'
+
+# -h
+age -p -h
+! stdout .
+stderr 'Usage:'
+
+# unknown flag
+! age -p -this-flag-does-not-exist
+! stdout .
+stderr 'flag provided but not defined'
+stderr 'Usage:'
+
+# no arguments
+! age
+! stdout .
+stderr 'Usage:'

cmd/age/testdata/x25519.txt

@@ -0,0 +1,21 @@
+# encrypt and decrypt a file with -r
+age -r age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef -o test.age input
+age -d -i key.txt test.age
+stdout test
+
+# encrypt and decrypt a file with -i
+age -e -i key.txt -o test.age input
+age -d -i key.txt test.age
+stdout test
+
+# encrypt and decrypt a file with the wrong key
+age -r age12phkzssndd5axajas2h74vtge62c86xjhd6u9anyanqhzvdg6sps0xthgl -o test.age input
+! age -d -i key.txt test.age
+stderr 'no identity matched any of the recipients'
+
+-- input --
+test
+-- key.txt --
+# created: 2021-02-02T13:09:43+01:00
+# public key: age1xmwwc06ly3ee5rytxm9mflaz2u56jjj36s0mypdrwsvlul66mv4q47ryef
+AGE-SECRET-KEY-1EGTZVFFV20835NWYV6270LXYVK2VKNX2MMDKWYKLMGR48UAWX40Q2P2LM0

cmd/age/tui.go

@@ -34,7 +34,8 @@ func printf(format string, v ...interface{}) {
 
 func errorf(format string, v ...interface{}) {
 	l.Printf("age: error: "+format, v...)
-	l.Fatalf("age: report unexpected or unhelpful errors at https://filippo.io/age/report")
+	l.Printf("age: report unexpected or unhelpful errors at https://filippo.io/age/report")
+	exit(1)
 }
 
 func warningf(format string, v ...interface{}) {
@@ -46,7 +47,22 @@ func errorWithHint(error string, hints ...string) {
 	for _, hint := range hints {
 		l.Printf("age: hint: %s", hint)
 	}
-	l.Fatalf("age: report unexpected or unhelpful errors at https://filippo.io/age/report")
+	l.Printf("age: report unexpected or unhelpful errors at https://filippo.io/age/report")
+	exit(1)
+}
+
+// If testOnlyPanicInsteadOfExit is true, exit will set testOnlyDidExit and
+// panic instead of calling os.Exit. This way, the wrapper in TestMain can
+// recover the panic and return the exit code only if it was originated in exit.
+var testOnlyPanicInsteadOfExit bool
+var testOnlyDidExit bool
+
+func exit(code int) {
+	if testOnlyPanicInsteadOfExit {
+		testOnlyDidExit = true
+		panic(code)
+	}
+	os.Exit(code)
 }
 
 // clearLine clears the current line on the terminal, or opens a new line if