tests: split example_filesystems into its own package

Running these tests from integration_tests' TestMain() was awkward
because they were run twice with unchanged settings.
integration_tests tests everything with OpenSSL and with native
Go crypto, but this does not take affect for the example filesystems.

To make this work, test_helpers is also split into its own package.

3 files changed, 690 insertions, 0 deletions

diff --git a/tests/integration_tests/cli_test.go b/tests/integration_tests/cli_test.go
new file mode 100644
index 0000000..15bd063
--- /dev/null
+++ b/tests/integration_tests/cli_test.go
@@ -0,0 +1,120 @@
+package integration_tests
+
+// Test CLI operations like "-init", "-password" etc
+
+import (
+	"os"
+	"os/exec"
+	"testing"
+
+	"github.com/rfjakob/gocryptfs/internal/configfile"
+	"github.com/rfjakob/gocryptfs/internal/nametransform"
+
+	"github.com/rfjakob/gocryptfs/tests/test_helpers"
+)
+
+// Test -init flag
+func TestInit(t *testing.T) {
+	dir := test_helpers.TmpDir + "TestInit/"
+	err := os.Mkdir(dir, 0777)
+	if err != nil {
+		t.Fatal(err)
+	}
+	cmd := exec.Command(test_helpers.GocryptfsBinary, "-init", "-extpass", "echo test", "-scryptn=10", dir)
+	if testing.Verbose() {
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+	}
+	err = cmd.Run()
+	if err != nil {
+		t.Fatal(err)
+	}
+	_, err = os.Stat(dir + configfile.ConfDefaultName)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// Test -passwd
+	cmd2 := exec.Command(test_helpers.GocryptfsBinary, "-passwd", "-extpass", "echo test", dir)
+	if testing.Verbose() {
+		cmd2.Stdout = os.Stdout
+		cmd2.Stderr = os.Stderr
+	}
+	err = cmd2.Run()
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+// Test -init & -config flag
+func TestInitConfig(t *testing.T) {
+	dir := test_helpers.TmpDir + "TestInitConfig/"
+	config := test_helpers.TmpDir + "TestInitConfig.conf"
+	err := os.Mkdir(dir, 0777)
+	if err != nil {
+		t.Fatal(err)
+	}
+	cmd := exec.Command(test_helpers.GocryptfsBinary, "-init", "-extpass", "echo test",
+		"-config", config, "-scryptn=10", dir)
+	if testing.Verbose() {
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+	}
+	err = cmd.Run()
+	if err != nil {
+		t.Fatal(err)
+	}
+	_, err = os.Stat(config)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// Test -passwd & -config
+	cmd2 := exec.Command(test_helpers.GocryptfsBinary, "-passwd", "-extpass", "echo test",
+		"-config", config, dir)
+	if testing.Verbose() {
+		cmd2.Stdout = os.Stdout
+		cmd2.Stderr = os.Stderr
+	}
+	err = cmd2.Run()
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+// Test -init -plaintextnames
+func TestInitPlaintextNames(t *testing.T) {
+	dir := test_helpers.TmpDir + "TestInitPlaintextNames/"
+	err := os.Mkdir(dir, 0777)
+	if err != nil {
+		t.Fatal(err)
+	}
+	cmd := exec.Command(test_helpers.GocryptfsBinary, "-init", "-extpass", "echo test",
+		"-scryptn=10", "-plaintextnames", dir)
+	if testing.Verbose() {
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+	}
+	err = cmd.Run()
+	if err != nil {
+		t.Fatal(err)
+	}
+	_, err = os.Stat(dir + configfile.ConfDefaultName)
+	if err != nil {
+		t.Fatal(err)
+	}
+	_, err = os.Stat(dir + nametransform.DirIVFilename)
+	if err == nil {
+		t.Errorf("gocryptfs.diriv should not have been created with -plaintextnames")
+	}
+	_, cf, err := configfile.LoadConfFile(dir+configfile.ConfDefaultName, "test")
+	if err != nil {
+		t.Fatal(err)
+	}
+	if !cf.IsFeatureFlagSet(configfile.FlagPlaintextNames) {
+		t.Error("PlaintextNames flag should be set but isnt")
+	}
+	if cf.IsFeatureFlagSet(configfile.FlagEMENames) || cf.IsFeatureFlagSet(configfile.FlagDirIV) {
+		t.Error("FlagEMENames and FlagDirIV should be not set")
+	}
+}
diff --git a/tests/integration_tests/main_test.go b/tests/integration_tests/main_test.go
new file mode 100644
index 0000000..b6cb8ca
--- /dev/null
+++ b/tests/integration_tests/main_test.go
@@ -0,0 +1,439 @@
+package integration_tests
+
+// File reading, writing, modification, truncate
+
+import (
+	"bytes"
+	"crypto/md5"
+	"encoding/hex"
+	"flag"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"runtime"
+	"sync"
+	"syscall"
+	"testing"
+
+	"github.com/rfjakob/gocryptfs/tests/test_helpers"
+)
+
+var plaintextNames bool
+
+// This is the entry point for the tests
+func TestMain(m *testing.M) {
+	var defaultonly bool
+	flag.BoolVar(&defaultonly, "defaultonly", false, "Only test default configuration (openssl=true, plaintextnames=false)")
+	flag.Parse()
+
+	if testing.Verbose() {
+		fmt.Println("***** Testing with OpenSSL")
+	}
+	test_helpers.ResetTmpDir(false) // <- this also create gocryptfs.diriv
+	test_helpers.MountOrExit(test_helpers.DefaultCipherDir, test_helpers.DefaultPlainDir, "--zerokey")
+	r := m.Run()
+	test_helpers.Unmount(test_helpers.DefaultPlainDir)
+
+	if r != 0 {
+		os.Exit(r)
+	}
+
+	if defaultonly {
+		os.Exit(r)
+	}
+
+	if testing.Verbose() {
+		fmt.Println("***** Testing with native Go crypto")
+	}
+	test_helpers.ResetTmpDir(false)
+	test_helpers.MountOrExit(test_helpers.DefaultCipherDir, test_helpers.DefaultPlainDir, "--zerokey", "--openssl=false")
+	r = m.Run()
+	test_helpers.Unmount(test_helpers.DefaultPlainDir)
+
+	if r != 0 {
+		os.Exit(r)
+	}
+
+	if testing.Verbose() {
+		fmt.Println("***** Testing \"--plaintextnames\"")
+	}
+	test_helpers.ResetTmpDir(true) // do not create gocryptfs.diriv
+	test_helpers.MountOrExit(test_helpers.DefaultCipherDir, test_helpers.DefaultPlainDir, "--zerokey", "--plaintextnames")
+	plaintextNames = true
+	r = m.Run()
+	test_helpers.Unmount(test_helpers.DefaultPlainDir)
+
+	if r != 0 {
+		os.Exit(r)
+	}
+
+	os.Exit(r)
+}
+
+// Write "n" zero bytes to filename "fn", read again, compare hash
+func testWriteN(t *testing.T, fn string, n int) string {
+	file, err := os.Create(test_helpers.DefaultPlainDir + fn)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	d := make([]byte, n)
+	written, err := file.Write(d)
+	if err != nil || written != len(d) {
+		t.Errorf("err=\"%s\", written=%d", err, written)
+	}
+	err = file.Close()
+	if err != nil {
+		t.Error(err)
+	}
+
+	test_helpers.VerifySize(t, test_helpers.DefaultPlainDir+fn, n)
+
+	bin := md5.Sum(d)
+	hashWant := hex.EncodeToString(bin[:])
+
+	hashActual := test_helpers.Md5fn(test_helpers.DefaultPlainDir + fn)
+
+	if hashActual != hashWant {
+		t.Errorf("Wrong content, hashWant=%s hashActual=%s", hashWant, hashActual)
+	}
+
+	return hashActual
+}
+
+func TestWrite10(t *testing.T) {
+	testWriteN(t, "10", 10)
+}
+
+func TestWrite100(t *testing.T) {
+	testWriteN(t, "100", 100)
+}
+
+func TestWrite1M(t *testing.T) {
+	testWriteN(t, "1M", 1024*1024)
+}
+
+func TestWrite1Mx100(t *testing.T) {
+	hashWant := testWriteN(t, "1Mx100", 1024*1024)
+	// Read and check 100 times to catch race conditions
+	var i int
+	for i = 0; i < 100; i++ {
+		hashActual := test_helpers.Md5fn(test_helpers.DefaultPlainDir + "1M")
+		if hashActual != hashWant {
+			fmt.Printf("Read corruption in loop # %d\n", i)
+			t.FailNow()
+		} else {
+			//fmt.Print(".")
+		}
+	}
+}
+
+func TestTruncate(t *testing.T) {
+	fn := test_helpers.DefaultPlainDir + "truncate"
+	file, err := os.Create(fn)
+	if err != nil {
+		t.FailNow()
+	}
+	// Grow to two blocks
+	file.Truncate(7000)
+	test_helpers.VerifySize(t, fn, 7000)
+	if test_helpers.Md5fn(fn) != "95d4ec7038e3e4fdbd5f15c34c3f0b34" {
+		t.Errorf("wrong content")
+	}
+	// Shrink - needs RMW
+	file.Truncate(6999)
+	test_helpers.VerifySize(t, fn, 6999)
+	if test_helpers.Md5fn(fn) != "35fd15873ec6c35380064a41b9b9683b" {
+		t.Errorf("wrong content")
+	}
+	// Shrink to one partial block
+	file.Truncate(465)
+	test_helpers.VerifySize(t, fn, 465)
+	if test_helpers.Md5fn(fn) != "a1534d6e98a6b21386456a8f66c55260" {
+		t.Errorf("wrong content")
+	}
+	// Grow to exactly one block
+	file.Truncate(4096)
+	test_helpers.VerifySize(t, fn, 4096)
+	if test_helpers.Md5fn(fn) != "620f0b67a91f7f74151bc5be745b7110" {
+		t.Errorf("wrong content")
+	}
+}
+
+func TestAppend(t *testing.T) {
+	fn := test_helpers.DefaultPlainDir + "append"
+	file, err := os.Create(fn)
+	if err != nil {
+		t.FailNow()
+	}
+	data := []byte("testdata123456789") // length 17
+	var buf bytes.Buffer
+	var hashWant string
+	for i := 0; i <= 500; i++ {
+		file.Write(data)
+		buf.Write(data)
+		bin := md5.Sum(buf.Bytes())
+		hashWant = hex.EncodeToString(bin[:])
+		hashActual := test_helpers.Md5fn(fn)
+		if hashWant != hashActual {
+			t.FailNow()
+		}
+	}
+
+	// Overwrite with the same data
+	// Hash must stay the same
+	file.Seek(0, 0)
+	for i := 0; i <= 500; i++ {
+		file.Write(data)
+		hashActual := test_helpers.Md5fn(fn)
+		if hashWant != hashActual {
+			t.FailNow()
+		}
+	}
+}
+
+// Create a file with holes by writing to offset 0 (block #0) and
+// offset 4096 (block #1).
+func TestFileHoles(t *testing.T) {
+	fn := test_helpers.DefaultPlainDir + "fileholes"
+	file, err := os.Create(fn)
+	if err != nil {
+		t.Errorf("file create failed")
+	}
+	foo := []byte("foo")
+	file.Write(foo)
+	file.WriteAt(foo, 4096)
+	_, err = ioutil.ReadFile(fn)
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+// sContains - does the slice of strings "haystack" contain "needle"?
+func sContains(haystack []string, needle string) bool {
+	for _, element := range haystack {
+		if element == needle {
+			return true
+		}
+	}
+	return false
+}
+
+func TestRmwRace(t *testing.T) {
+
+	runtime.GOMAXPROCS(10)
+
+	fn := test_helpers.DefaultPlainDir + "rmwrace"
+	f1, err := os.Create(fn)
+	if err != nil {
+		t.Fatalf("file create failed")
+	}
+	f2, err := os.Create(fn)
+	if err != nil {
+		t.Fatalf("file create failed")
+	}
+
+	oldBlock := bytes.Repeat([]byte("o"), 4096)
+
+	newBlock := bytes.Repeat([]byte("n"), 4096)
+
+	shortBlock := bytes.Repeat([]byte("s"), 16)
+
+	mergedBlock := make([]byte, 4096)
+	copy(mergedBlock, newBlock)
+	copy(mergedBlock[4080:], shortBlock)
+
+	goodMd5 := make(map[string]int)
+
+	for i := 0; i < 1000; i++ {
+		// Reset to [ooooooooo]
+		_, err = f1.WriteAt(oldBlock, 0)
+		if err != nil {
+			t.Fatalf("Write failed")
+		}
+
+		var wg sync.WaitGroup
+		wg.Add(2)
+
+		// Write to the end of the file, [....ssss]
+		go func() {
+			f1.WriteAt(shortBlock, 4080)
+			wg.Done()
+		}()
+
+		// Overwrite to [nnnnnnn]
+		go func() {
+			f2.WriteAt(newBlock, 0)
+			wg.Done()
+		}()
+
+		wg.Wait()
+
+		// The file should be either:
+		// [nnnnnnnnnn] (md5: 6c1660fdabccd448d1359f27b3db3c99) or
+		// [nnnnnnssss] (md5: da885006a6a284530a427c73ce1e5c32)
+		// but it must not be
+		// [oooooossss]
+
+		buf, _ := ioutil.ReadFile(fn)
+		m := test_helpers.Md5hex(buf)
+		goodMd5[m] = goodMd5[m] + 1
+
+		/*
+			if m == "6c1660fdabccd448d1359f27b3db3c99" {
+				fmt.Println(hex.Dump(buf))
+				t.FailNow()
+			}
+		*/
+	}
+	if testing.Verbose() {
+		fmt.Println(goodMd5)
+	}
+}
+
+// With "--plaintextnames", the name "/gocryptfs.conf" is reserved.
+// Otherwise there should be no restrictions.
+func TestFiltered(t *testing.T) {
+	filteredFile := test_helpers.DefaultPlainDir + "gocryptfs.conf"
+	file, err := os.Create(filteredFile)
+	if plaintextNames == true && err == nil {
+		t.Errorf("should have failed but didn't")
+	} else if plaintextNames == false && err != nil {
+		t.Error(err)
+	}
+	file.Close()
+
+	err = os.Remove(filteredFile)
+	if plaintextNames == true && err == nil {
+		t.Errorf("should have failed but didn't")
+	} else if plaintextNames == false && err != nil {
+		t.Error(err)
+	}
+}
+
+func TestFilenameEncryption(t *testing.T) {
+	file, err := os.Create(test_helpers.DefaultPlainDir + "TestFilenameEncryption.txt")
+	file.Close()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	_, err = os.Stat(test_helpers.DefaultCipherDir + "TestFilenameEncryption.txt")
+	if plaintextNames == true && err != nil {
+		t.Errorf("plaintextnames not working: %v", err)
+	} else if plaintextNames == false && err == nil {
+		t.Errorf("file name encryption not working")
+	}
+}
+
+// Test Mkdir and Rmdir
+func testMkdirRmdir(t *testing.T) {
+	test_helpers.TestMkdirRmdir(t, test_helpers.DefaultPlainDir)
+}
+
+// Test Rename
+func testRename(t *testing.T) {
+	test_helpers.TestRename(t, test_helpers.DefaultPlainDir)
+}
+
+// Overwrite an empty directory with another directory
+func TestDirOverwrite(t *testing.T) {
+	dir1 := test_helpers.DefaultPlainDir + "DirOverwrite1"
+	dir2 := test_helpers.DefaultPlainDir + "DirOverwrite2"
+	err := os.Mkdir(dir1, 0777)
+	if err != nil {
+		t.Fatal(err)
+	}
+	err = os.Mkdir(dir2, 0777)
+	if err != nil {
+		t.Fatal(err)
+	}
+	err = os.Rename(dir1, dir2)
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestLongNames(t *testing.T) {
+	fi, err := ioutil.ReadDir(test_helpers.DefaultCipherDir)
+	if err != nil {
+		t.Fatal(err)
+	}
+	cnt1 := len(fi)
+	wd := test_helpers.DefaultPlainDir
+	// Create file with long name
+	n255x := string(bytes.Repeat([]byte("x"), 255))
+	f, err := os.Create(wd + n255x)
+	if err != nil {
+		t.Fatalf("Could not create n255x: %v", err)
+	}
+	f.Close()
+	if !test_helpers.VerifyExistence(wd + n255x) {
+		t.Errorf("n255x is not in directory listing")
+	}
+	// Rename long to long
+	n255y := string(bytes.Repeat([]byte("y"), 255))
+	err = os.Rename(wd+n255x, wd+n255y)
+	if err != nil {
+		t.Fatalf("Could not rename n255x to n255y: %v", err)
+	}
+	if !test_helpers.VerifyExistence(wd + n255y) {
+		t.Errorf("n255y is not in directory listing")
+	}
+	// Rename long to short
+	err = os.Rename(wd+n255y, wd+"short")
+	if err != nil {
+		t.Fatalf("Could not rename n255y to short: %v", err)
+	}
+	if !test_helpers.VerifyExistence(wd + "short") {
+		t.Errorf("short is not in directory listing")
+	}
+	// Rename short to long
+	err = os.Rename(wd+"short", wd+n255x)
+	if err != nil {
+		t.Fatalf("Could not rename short to n255x: %v", err)
+	}
+	if !test_helpers.VerifyExistence(wd + n255x) {
+		t.Errorf("255x is not in directory listing II")
+	}
+	// Unlink
+	err = syscall.Unlink(wd + n255x)
+	if err != nil {
+		t.Fatalf("Could not unlink n255x: %v", err)
+	}
+	if test_helpers.VerifyExistence(wd + n255x) {
+		t.Errorf("n255x still there after unlink")
+	}
+	// Long symlink
+	n255s := string(bytes.Repeat([]byte("s"), 255))
+	err = os.Symlink("/etc/motd", wd+n255s)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if !test_helpers.VerifyExistence(wd + n255s) {
+		t.Errorf("n255s is not in directory listing")
+	}
+	err = syscall.Unlink(wd + n255s)
+	if err != nil {
+		t.Error(err)
+	}
+	// Long dir
+	n255d := string(bytes.Repeat([]byte("d"), 255))
+	err = os.Mkdir(wd+n255d, 0777)
+	if err != nil {
+		t.Fatal(err)
+	}
+	err = syscall.Rmdir(wd + n255d)
+	if err != nil {
+		t.Error(err)
+	}
+	// Check for orphaned files
+	fi, err = ioutil.ReadDir(test_helpers.DefaultCipherDir)
+	if err != nil {
+		t.Fatal(err)
+	}
+	cnt2 := len(fi)
+	if cnt1 != cnt2 {
+		t.Errorf("Leftover files, cnt1=%d cnt2=%d", cnt1, cnt2)
+	}
+}
diff --git a/tests/integration_tests/performance_test.go b/tests/integration_tests/performance_test.go
new file mode 100644
index 0000000..67f0b28
--- /dev/null
+++ b/tests/integration_tests/performance_test.go
@@ -0,0 +1,131 @@
+package integration_tests
+
+// Benchmarks
+
+import (
+	"fmt"
+	"io"
+	"io/ioutil"
+	"os"
+	"testing"
+
+	"github.com/rfjakob/gocryptfs/tests/test_helpers"
+)
+
+func BenchmarkStreamWrite(t *testing.B) {
+	buf := make([]byte, 1024*1024)
+	t.SetBytes(int64(len(buf)))
+
+	file, err := os.Create(test_helpers.DefaultPlainDir + "BenchmarkWrite")
+	if err != nil {
+		t.FailNow()
+	}
+
+	t.ResetTimer()
+	var i int
+	for i = 0; i < t.N; i++ {
+		written, err := file.Write(buf)
+		if err != nil {
+			fmt.Printf("err=\"%s\", written=%d\n", err.Error(), written)
+			t.FailNow()
+		}
+	}
+	file.Close()
+}
+
+func BenchmarkStreamRead(t *testing.B) {
+	buf := make([]byte, 1024*1024)
+	t.SetBytes(int64(len(buf)))
+
+	fn := test_helpers.DefaultPlainDir + "BenchmarkWrite"
+	fi, err := os.Stat(fn)
+	if err != nil {
+		t.Fatal(err)
+	}
+	mb := int(fi.Size() / 1024 / 1024)
+
+	if t.N > mb {
+		// Grow file so we can satisfy the test
+		//fmt.Printf("Growing file to %d MB... ", t.N)
+		var f2 *os.File
+		f2, err = os.OpenFile(fn, os.O_WRONLY|os.O_APPEND, 0666)
+		if err != nil {
+			fmt.Println(err)
+			t.FailNow()
+		}
+		for h := 0; h < t.N-mb; h++ {
+			_, err = f2.Write(buf)
+			if err != nil {
+				fmt.Println(err)
+				t.FailNow()
+			}
+		}
+		f2.Close()
+	}
+
+	file, err := os.Open(fn)
+	if err != nil {
+		t.FailNow()
+	}
+	t.ResetTimer()
+	var i int
+	for i = 0; i < t.N; i++ {
+		_, err := file.Read(buf)
+		if err == io.EOF {
+			fmt.Println("Test file too small")
+			t.SkipNow()
+		} else if err != nil {
+			fmt.Println(err)
+			t.FailNow()
+		}
+	}
+	file.Close()
+}
+
+// createFiles - create "count" files of size "size" bytes each
+func createFiles(t *testing.B, count int, size int) {
+	dir := fmt.Sprintf("%s/createFiles_%d_%d", test_helpers.DefaultPlainDir, count, size)
+	err := os.Mkdir(dir, 0777)
+	if err != nil {
+		t.Fatal(err)
+	}
+	buf := make([]byte, size)
+	t.SetBytes(int64(len(buf)))
+	t.ResetTimer()
+	var i int
+	for i = 0; i < count; i++ {
+		file := fmt.Sprintf("%s/%d", dir, i)
+		if size > 0 {
+			err = ioutil.WriteFile(file, buf, 0666)
+		} else {
+			var fh *os.File
+			fh, err = os.Create(file)
+			fh.Close()
+		}
+		if err != nil {
+			t.Fatal(err)
+		}
+	}
+	t.StopTimer()
+	os.RemoveAll(dir)
+}
+
+func BenchmarkCreate0B(t *testing.B) {
+	createFiles(t, t.N, 0)
+}
+
+func BenchmarkCreate1B(t *testing.B) {
+	createFiles(t, t.N, 1)
+}
+
+func BenchmarkCreate100B(t *testing.B) {
+	createFiles(t, t.N, 100)
+}
+
+func BenchmarkCreate4kB(t *testing.B) {
+	createFiles(t, t.N, 4*1024)
+}
+
+func BenchmarkCreate10kB(t *testing.B) {
+	createFiles(t, t.N, 10*1024)
+}