address feedback

builtin/audit/file/backend_test.go

@@ -1,78 +1,75 @@
-package file
-
-import (
-	"os"
-	"strconv"
-	"testing"
-
-	"github.com/hashicorp/vault/audit"
-	"github.com/hashicorp/vault/helper/salt"
-)
-
-func TestAuditFile_fileModeNew(t *testing.T) {
-	salter, _ := salt.NewSalt(nil, nil)
-	
-	modeStr := "0777"
-	mode, err := strconv.ParseUint(modeStr, 8, 32)
-	
-	file := "auditTest.txt"
-	
-	config := map[string]string{
-		"path": file,
-		"mode": modeStr,
-	}
-
-	_, err = Factory(&audit.BackendConfig{
-		Salt:   salter,
-		Config: config,
-	})
-	
-	if err != nil {
-		t.Fatalf("%v", err)
-	}
-
-    info,_ := os.Stat(file)
-    createdMode := info.Mode()
-	if createdMode != os.FileMode(mode) {
-		t.Fatalf("File Mode does not match.")
-	}
-	
-	err = os.Remove(file)
-}
-
-func TestAuditFile_fileModeExisting(t *testing.T) {
-	salter, _ := salt.NewSalt(nil, nil)
-	
-	modeStr := "0600"
-	m, err := strconv.ParseUint(modeStr, 8, 32)
-	mode := os.FileMode(m)
-	
-	file := "auditTest.txt"
-	
-	f, err := os.OpenFile(file, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0777)
-	err = f.Close()
-	if err != nil {
-		t.Fatalf("Failure to close the file.")
-	}
-	
-	config := map[string]string{
-		"path": file,
-	}
-
-	_, err = Factory(&audit.BackendConfig{
-		Salt:   salter,
-		Config: config,
-	})
-	
-	if err != nil {
-		t.Fatalf("%v", err)
-	}
-
-    info,_ := os.Stat(file)
-    createdMode := info.Mode()
-	if createdMode != mode {
-		t.Fatalf("File Mode does not match.")
-	}
-	
-	err = os.Remove(file)
-}
+package file
+
+import (
+	"os"
+	"strconv"
+	"testing"
+
+	"github.com/hashicorp/vault/audit"
+	"github.com/hashicorp/vault/helper/salt"
+)
+
+func TestAuditFile_fileModeNew(t *testing.T) {
+	salter, _ := salt.NewSalt(nil, nil)
+
+	modeStr := "0777"
+	mode, err := strconv.ParseUint(modeStr, 8, 32)
+
+	file := "auditTest.txt"
+
+	config := map[string]string{
+		"path": file,
+		"mode": modeStr,
+	}
+
+	_, err = Factory(&audit.BackendConfig{
+		Salt:   salter,
+		Config: config,
+	})
+	if err != nil {
+		t.Fatalf(err)
+	}
+	defer os.Remove(file)
+
+	info, _ := os.Stat(file)
+	createdMode := info.Mode()
+	if createdMode != os.FileMode(mode) {
+		t.Fatalf("File Mode does not match.")
+	}
+}
+
+func TestAuditFile_fileModeExisting(t *testing.T) {
+	salter, _ := salt.NewSalt(nil, nil)
+
+	mode := os.FileMode(0600)
+
+	file := "auditTest.txt"
+
+	f, err := os.OpenFile(file, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0777)
+	err = f.Close()
+	if err != nil {
+		t.Fatalf("Failure to close the file.")
+	}
+	defer os.Remove(file)
+
+	config := map[string]string{
+		"path": file,
+	}
+
+	_, err = Factory(&audit.BackendConfig{
+		Salt:   salter,
+		Config: config,
+	})
+	if err != nil {
+		t.Fatalf(err)
+	}
+
+	info, err := os.Stat(file)
+	if err != nil {
+		t.Fatalf("cannot retrieve file mode from `Stat`")
+	}
+	createdMode := info.Mode()
+	if createdMode != mode {
+		t.Fatalf("File Mode does not match.")
+	}
+}

website/source/docs/audit/file.html.md

@@ -73,8 +73,9 @@ Following are the configuration options available for the backend.
 	  <li>
         <span class="param">mode</span>
         <span class="param-flags">optional</span>
-            An unsigned integer, if provided, represents the file mode and
-            permissions. This option defaults to `0600`.
+            A string containing an octal number representing the bit pattern
+            for the file mode, similar to `chmod`. This option defaults to
+            `0600`.
       </li>
       <li>
         <span class="param">format</span>