tests/reverse/TestExcludeTestFs: improve comments & code style

No functional changes.

1 files changed, 48 insertions, 79 deletions

diff --git a/tests/reverse/exclude_test.go b/tests/reverse/exclude_test.go
index c493d95..8587c22 100644
--- a/tests/reverse/exclude_test.go
+++ b/tests/reverse/exclude_test.go
@@ -10,43 +10,6 @@ import (
 	"github.com/rfjakob/gocryptfs/tests/test_helpers"
 )
 
-const xxx = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-
-/*
-tree exclude_test_fs
-exclude_test_fs/
-├── bkp1~
-├── dir1
-│   ├── file1
-│   ├── file2
-│   ├── exclude
-│   ├── longbkp1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx~
-│   ├── longfile1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-│   ├── longfile2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-│   ├── longfile3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-│   └── subdir1
-│       ├── exclude
-│       └── subdir2
-│           └── exclude
-├── dir2
-│   ├── file
-│   ├── longdir1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-│   │   └── file
-│   ├── longfile.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-│   └── subdir
-│       └── file
-├── file1
-├── file2
-├── longdir1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-│   └── file1
-├── longdir2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-│   ├── bkp~
-│   └── file
-├── longfile1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-├── longfile2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-└── longfile3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-*/
-
 func ctlsockEncryptPath(t *testing.T, sock string, path string) string {
 	req := ctlsock.RequestStruct{EncryptPath: path}
 	response := test_helpers.QueryCtlSock(t, sock, req)
@@ -56,48 +19,53 @@ func ctlsockEncryptPath(t *testing.T, sock string, path string) string {
 	return response.Result
 }
 
-func testExclude(t *testing.T, flag string) {
-	pPatterns := []string{
-		"file1",                      // matches file1 anywhere
-		"!longdir1" + xxx + "/file1", // ! includes an otherwise file
-		"file2/",                     // a trailing slash matches only a directory
-		"dir1/file2",                 // matches file2 inside dir1 anywhere
-		"#file2",                     // comments are ignored
-		"dir2",                       // excludes the whole directory
-		"longfile2" + xxx,            // matches longfile2 anywhere
-		"/longfile3" + xxx,           // a leading / anchors the match at the root
-		"*~",                         // wildcards are supported
-		"dir1/**/exclude",            // ** matches any number of directories
+// doTestExcludeTestFs runs exclude tests against the exclude_test_fs folder
+func doTestExcludeTestFs(t *testing.T, flag string) {
+	// --exclude-wildcard patterns, gitignore syntax
+	patterns := []string{
+		"file1",                       // matches file1 anywhere
+		"!longdir1" + x240 + "/file1", // ! includes an otherwise file
+		"file2/",                      // a trailing slash matches only a directory
+		"dir1/file2",                  // matches file2 inside dir1 anywhere
+		"#file2",                      // comments are ignored
+		"dir2",                        // excludes the whole directory
+		"longfile2" + x240,            // matches longfile2 anywhere
+		"/longfile3" + x240,           // a leading / anchors the match at the root
+		"*~",                          // wildcards are supported
+		"dir1/**/exclude",             // ** matches any number of directories
 	}
-	pOk := []string{
+	// pVisible are plaintext paths that should be visible in the encrypted view
+	pVisible := []string{
 		"file2",
-		"dir1/longfile1" + xxx,
-		"dir1/longfile3" + xxx,
-		"longdir1" + xxx,
-		"longdir1" + xxx + "/file1",
-		"longdir2" + xxx + "/file",
-		"longfile1" + xxx,
+		"dir1/longfile1" + x240,
+		"dir1/longfile3" + x240,
+		"longdir1" + x240,
+		"longdir1" + x240 + "/file1",
+		"longdir2" + x240 + "/file",
+		"longfile1" + x240,
 	}
-	pExclude := []string{
+	// pHidden are plaintext paths that should be hidden in the encrypted view
+	pHidden := []string{
 		"bkp1~",
 		"dir1/file1",
 		"dir1/file2",
 		"dir1/exclude",
-		"dir1/longbkp1" + xxx + "~",
-		"dir1/longfile2" + xxx,
+		"dir1/longbkp1" + x240 + "~",
+		"dir1/longfile2" + x240,
 		"dir1/subdir1/exclude",
 		"dir1/subdir1/subdir2/exclude",
 		"dir2",
 		"dir2/file",
-		"dir2/longdir1" + xxx + "/file",
-		"dir2/longfile." + xxx,
+		"dir2/longdir1" + x240 + "/file",
+		"dir2/longfile." + x240,
 		"dir2/subdir",
 		"dir2/subdir/file",
 		"file1",
-		"longdir2" + xxx + "/bkp~",
-		"longfile2" + xxx,
-		"longfile3" + xxx,
+		"longdir2" + x240 + "/bkp~",
+		"longfile2" + x240,
+		"longfile3" + x240,
 	}
+
 	// Mount reverse fs
 	mnt, err := ioutil.TempDir(test_helpers.TmpDir, "TestExclude")
 	if err != nil {
@@ -105,7 +73,7 @@ func testExclude(t *testing.T, flag string) {
 	}
 	sock := mnt + ".sock"
 	cliArgs := []string{"-reverse", "-extpass", "echo test", "-ctlsock", sock}
-	for _, v := range pPatterns {
+	for _, v := range patterns {
 		cliArgs = append(cliArgs, flag, v)
 	}
 	if plaintextnames {
@@ -113,28 +81,28 @@ func testExclude(t *testing.T, flag string) {
 	}
 	test_helpers.MountOrFatal(t, "exclude_test_fs", mnt, cliArgs...)
 	defer test_helpers.UnmountPanic(mnt)
-	// Get encrypted version of "ok" and "excluded" paths
-	cOk := encryptExcludeTestPaths(t, sock, pOk)
-	cExclude := encryptExcludeTestPaths(t, sock, pExclude)
-	// Check that "excluded" paths are not there and "ok" paths are there
-	for _, v := range cExclude {
-		t.Logf("File %q should be invisible", v)
+
+	// Get encrypted version of visible and hidden paths
+	cVisible := encryptExcludeTestPaths(t, sock, pVisible)
+	cHidden := encryptExcludeTestPaths(t, sock, pHidden)
+
+	// Check that hidden paths are not there and visible paths are there
+	for _, v := range cHidden {
 		if test_helpers.VerifyExistence(t, mnt+"/"+v) {
-			t.Errorf("File %q is visible, but should be excluded", v)
+			t.Errorf("File %q is visible, but should be hidden", v)
 		}
 		if nametransform.IsLongContent(filepath.Base(v)) {
-
+			// TODO ???
 		}
 	}
-	for _, v := range cOk {
-		t.Logf("File %q should be visible", v)
+	for _, v := range cVisible {
 		if !test_helpers.VerifyExistence(t, mnt+"/"+v) {
 			t.Errorf("File %q is hidden, but should be visible", v)
 		}
 	}
 }
 
-// encryptExcludeTestPaths is used by testExclude() to encrypt the lists of
+// encryptExcludeTestPaths is used by doTestExcludeTestFs() to encrypt the lists of
 // testcase paths
 func encryptExcludeTestPaths(t *testing.T, socket string, pRelPaths []string) (out []string) {
 	for _, pRelPath := range pRelPaths {
@@ -151,7 +119,8 @@ func encryptExcludeTestPaths(t *testing.T, socket string, pRelPaths []string) (o
 	return out
 }
 
-func TestExclude(t *testing.T) {
-	testExclude(t, "-exclude-wildcard")
-	testExclude(t, "-ew")
+// TestExcludeTestFs runs exclude tests against the exclude_test_fs folder.
+func TestExcludeTestFs(t *testing.T) {
+	doTestExcludeTestFs(t, "-exclude-wildcard")
+	doTestExcludeTestFs(t, "-ew")
 }