server: Move all the top level files into cmd folder. (#2490)

This change brings a change which was done for the 'mc'
package to allow for clean repo and have a cleaner
github drop in experience.

cmd/posix-list-dir_test.go

@@ -0,0 +1,225 @@
+/*
+ * Minio Cloud Storage, (C) 2016 Minio, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package cmd
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"runtime"
+	"sort"
+	"testing"
+)
+
+// Test to check for different input arguments.
+func TestReadDirFail(t *testing.T) {
+	// Check non existent directory.
+	if _, err := readDir("/tmp/non-existent-directory"); err != errFileNotFound {
+		t.Fatalf("expected = %s, got: %s", errFileNotFound, err)
+	}
+
+	// Check if file is given.
+	if _, err := readDir("/etc/issue/mydir"); err != errFileNotFound {
+		t.Fatalf("expected = %s, got: %s", errFileNotFound, err)
+	}
+
+	// Only valid for linux.
+	if runtime.GOOS == "linux" {
+		// Check if permission denied.
+		if _, err := readDir("/proc/1/fd"); err == nil {
+			t.Fatalf("expected = an error, got: nil")
+		}
+	}
+}
+
+// Represents data type for all the test results.
+type result struct {
+	dir     string
+	entries []string
+}
+
+func mustSetupDir(t *testing.T) string {
+	// Create unique test directory.
+	dir, err := ioutil.TempDir("", "minio-posix-list-dir")
+	if err != nil {
+		t.Fatalf("Unable to setup directory, %s", err)
+	}
+	return dir
+}
+
+// Test to read empty directory.
+func setupTestReadDirEmpty(t *testing.T) (testResults []result) {
+	// Add empty entry slice for this test directory.
+	testResults = append(testResults, result{mustSetupDir(t), []string{}})
+	return testResults
+}
+
+// Test to read empty directory with only reserved names.
+func setupTestReadDirReserved(t *testing.T) (testResults []result) {
+	dir := mustSetupDir(t)
+	entries := []string{}
+	// Create a file with reserved name.
+	for _, reservedName := range posixReservedPrefix {
+		if err := ioutil.WriteFile(filepath.Join(dir, reservedName), []byte{}, os.ModePerm); err != nil {
+			// For cleanup, its required to add these entries into test results.
+			testResults = append(testResults, result{dir, entries})
+			t.Fatalf("Unable to create file, %s", err)
+		}
+		// entries = append(entries, reservedName) - reserved files are skipped.
+	}
+	sort.Strings(entries)
+
+	// Add entries slice for this test directory.
+	testResults = append(testResults, result{dir, entries})
+	return testResults
+}
+
+// Test to read non-empty directory with only files.
+func setupTestReadDirFiles(t *testing.T) (testResults []result) {
+	dir := mustSetupDir(t)
+	entries := []string{}
+	for i := 0; i < 10; i++ {
+		name := fmt.Sprintf("file-%d", i)
+		if err := ioutil.WriteFile(filepath.Join(dir, name), []byte{}, os.ModePerm); err != nil {
+			// For cleanup, its required to add these entries into test results.
+			testResults = append(testResults, result{dir, entries})
+			t.Fatalf("Unable to create file, %s", err)
+		}
+		entries = append(entries, name)
+	}
+
+	// Keep entries sorted for easier comparison.
+	sort.Strings(entries)
+
+	// Add entries slice for this test directory.
+	testResults = append(testResults, result{dir, entries})
+	return testResults
+}
+
+// Test to read non-empty directory with directories and files.
+func setupTestReadDirGeneric(t *testing.T) (testResults []result) {
+	dir := mustSetupDir(t)
+	if err := os.MkdirAll(filepath.Join(dir, "mydir"), 0777); err != nil {
+		t.Fatalf("Unable to create prefix directory \"mydir\", %s", err)
+	}
+	entries := []string{"mydir/"}
+	for i := 0; i < 10; i++ {
+		name := fmt.Sprintf("file-%d", i)
+		if err := ioutil.WriteFile(filepath.Join(dir, "mydir", name), []byte{}, os.ModePerm); err != nil {
+			// For cleanup, its required to add these entries into test results.
+			testResults = append(testResults, result{dir, entries})
+			t.Fatalf("Unable to write file, %s", err)
+		}
+	}
+	// Keep entries sorted for easier comparison.
+	sort.Strings(entries)
+
+	// Add entries slice for this test directory.
+	testResults = append(testResults, result{dir, entries})
+	return testResults
+}
+
+// Test to read non-empty directory with symlinks.
+func setupTestReadDirSymlink(t *testing.T) (testResults []result) {
+	dir := mustSetupDir(t)
+	entries := []string{}
+	for i := 0; i < 10; i++ {
+		name1 := fmt.Sprintf("file-%d", i)
+		name2 := fmt.Sprintf("file-%d", i+10)
+		if err := ioutil.WriteFile(filepath.Join(dir, name1), []byte{}, os.ModePerm); err != nil {
+			// For cleanup, its required to add these entries into test results.
+			testResults = append(testResults, result{dir, entries})
+			t.Fatalf("Unable to create a file, %s", err)
+		}
+		// Symlink will not be added to entries.
+		if err := os.Symlink(filepath.Join(dir, name1), filepath.Join(dir, name2)); err != nil {
+			t.Fatalf("Unable to create a symlink, %s", err)
+		}
+		// Add to entries.
+		entries = append(entries, name1)
+		entries = append(entries, name2)
+	}
+	if err := os.MkdirAll(filepath.Join(dir, "mydir"), 0777); err != nil {
+		t.Fatalf("Unable to create \"mydir\", %s", err)
+	}
+	entries = append(entries, "mydir/")
+
+	// Keep entries sorted for easier comparison.
+	sort.Strings(entries)
+
+	// Add entries slice for this test directory.
+	testResults = append(testResults, result{dir, entries})
+	return testResults
+}
+
+// checkResult - checks whether entries are got are same as expected entries.
+func checkResult(expected []string, got []string) bool {
+	// If length of expected and got slice are different, the test actually failed.
+	if len(expected) != len(got) {
+		return false
+	}
+
+	for i := range expected {
+		// If entry in expected is not same as entry it got, the test is failed.
+		if expected[i] != got[i] {
+			return false
+		}
+	}
+
+	// expected and got have same entries.
+	return true
+}
+
+// teardown - cleans up test directories.
+func teardown(testResults []result) {
+	for _, r := range testResults {
+		os.RemoveAll(r.dir)
+	}
+}
+
+// TestReadDir - test function to run various readDir() tests.
+func TestReadDir(t *testing.T) {
+	var testResults []result
+
+	// Setup and capture test results for empty directory.
+	testResults = append(testResults, setupTestReadDirEmpty(t)...)
+	// Setup and capture test results for reserved files.
+	testResults = append(testResults, setupTestReadDirReserved(t)...)
+	// Setup and capture test results for directory with only files.
+	testResults = append(testResults, setupTestReadDirFiles(t)...)
+	// Setup and capture test results for directory with files and directories.
+	testResults = append(testResults, setupTestReadDirGeneric(t)...)
+	// Setup and capture test results for directory with files and symlink.
+	testResults = append(testResults, setupTestReadDirSymlink(t)...)
+
+	// Remove all dirs once tests are over.
+	defer teardown(testResults)
+
+	// Validate all the results.
+	for _, r := range testResults {
+		if entries, err := readDir(r.dir); err != nil {
+			t.Fatal("failed to run test.", err)
+		} else {
+			// Keep entries sorted for easier comparison.
+			sort.Strings(entries)
+			if !checkResult(r.entries, entries) {
+				t.Fatalf("expected = %s, got: %s", r.entries, entries)
+			}
+		}
+	}
+}