version file, SaveFile, SaveFiles returns the saved file size and error

Author: jeevatkm

ahttp.go

@@ -11,9 +11,6 @@ import (
 	"net/http"
 )
 
-// Version no. of aah framework ahttp library
-const Version = "0.10-dev"
-
 // HTTP Method names
 const (
 	MethodGet     = http.MethodGet

content_type_test.go

@@ -97,7 +97,7 @@ func TestHTTPParseContentType(t *testing.T) {
 
 	req5 := createRawHTTPRequest(HeaderContentType, "text/html;charset")
 	contentType = ParseContentType(req5)
-	assert.Equal(t, "", contentType.Mime)
-	assert.Equal(t, "", contentType.String())
+	assert.True(t, (contentType.Mime == "" || contentType.Mime == "text/html"))
+	assert.True(t, (contentType.String() == "" || contentType.String() == "text/html"))
 	assert.Equal(t, "iso-8859-1", contentType.Charset("iso-8859-1"))
 }

request.go

@@ -209,18 +209,18 @@ func (r *Request) Unwrap() *http.Request {
 
 // SaveFile method saves an uploaded multipart file for given key from the HTTP
 // request into given destination
-func (r *Request) SaveFile(key, dstFile string) error {
+func (r *Request) SaveFile(key, dstFile string) (int64, error) {
 	if ess.IsStrEmpty(dstFile) || ess.IsStrEmpty(key) {
-		return errors.New("ahttp: key or dstFile is empty")
+		return 0, errors.New("ahttp: key or dstFile is empty")
 	}
 
 	if ess.IsDir(dstFile) {
-		return errors.New("ahttp: dstFile should not be a directory")
+		return 0, errors.New("ahttp: dstFile should not be a directory")
 	}
 
 	uploadedFile, _, err := r.FormFile(key)
 	if err != nil {
-		return err
+		return 0, err
 	}
 	defer ess.CloseQuietly(uploadedFile)
 
@@ -230,29 +230,32 @@ func (r *Request) SaveFile(key, dstFile string) error {
 // SaveFiles method saves an uploaded multipart file(s) for the given key
 // from the HTTP request into given destination directory. It uses the filename
 // as uploaded filename from the request
-func (r *Request) SaveFiles(key, dstPath string) []error {
+func (r *Request) SaveFiles(key, dstPath string) ([]int64, []error) {
 	if !ess.IsDir(dstPath) {
-		return []error{fmt.Errorf("ahttp: destination path, %s is not a directory", dstPath)}
+		return []int64{0}, []error{fmt.Errorf("ahttp: destination path, '%s' is not a directory", dstPath)}
 	}
 
 	if ess.IsStrEmpty(key) {
-		return []error{fmt.Errorf("ahttp: form file key, %s is empty", key)}
+		return []int64{0}, []error{fmt.Errorf("ahttp: form file key, '%s' is empty", key)}
 	}
 
 	var errs []error
+	var sizes []int64
 	for _, file := range r.Params.File[key] {
 		uploadedFile, err := file.Open()
 		if err != nil {
+			sizes = append(sizes, 0)
 			errs = append(errs, err)
 			continue
 		}
 
-		if err := saveFile(uploadedFile, filepath.Join(dstPath, file.Filename)); err != nil {
+		if size, err := saveFile(uploadedFile, filepath.Join(dstPath, file.Filename)); err != nil {
+			sizes = append(sizes, size)
 			errs = append(errs, err)
 		}
 		ess.CloseQuietly(uploadedFile)
 	}
-	return errs
+	return sizes, errs
 }
 
 // Reset method resets request instance for reuse.
@@ -415,13 +418,12 @@ func isGzipAccepted(req *Request, r *http.Request) bool {
 	return false
 }
 
-func saveFile(r io.Reader, destFile string) error {
+func saveFile(r io.Reader, destFile string) (int64, error) {
 	f, err := os.OpenFile(destFile, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0666)
 	if err != nil {
-		return err
+		return 0, fmt.Errorf("ahttp: %s", err)
 	}
 	defer ess.CloseQuietly(f)
 
-	_, err = io.Copy(f, r)
-	return err
+	return io.Copy(f, r)
 }

request_test.go

@@ -195,41 +195,14 @@ func TestRequestSchemeDerived(t *testing.T) {
 	assert.Equal(t, "http", scheme4)
 }
 
-func createRequestWithHost(host, remote string) *http.Request {
-	return &http.Request{Host: host, RemoteAddr: remote, Header: http.Header{}}
-}
-
-func setUpRequestSaveFile(t *testing.T) (*Request, string, func()) {
-	buf := new(bytes.Buffer)
-	multipartWriter := multipart.NewWriter(buf)
-	_, err := multipartWriter.CreateFormFile("framework", "aah")
-	assert.Nil(t, err)
-
-	ess.CloseQuietly(multipartWriter)
-
-	req, _ := http.NewRequest("POST", "http://localhost:8080", buf)
-	req.Header.Add(HeaderContentType, multipartWriter.FormDataContentType())
-	aahReq := AcquireRequest(req)
-	aahReq.Params.File = make(map[string][]*multipart.FileHeader)
-
-	_, header, err := req.FormFile("framework")
-	assert.Nil(t, err)
-
-	aahReq.Params.File["framework"] = []*multipart.FileHeader{header}
-
-	path := "testdata/aah.txt"
-
-	return aahReq, path, func() {
-		_ = os.Remove(path) //Teardown
-	}
-}
-
 func TestRequestSaveFile(t *testing.T) {
 	aahReq, path, teardown := setUpRequestSaveFile(t)
 	defer teardown()
 
-	assert.Nil(t, aahReq.SaveFile("framework", path))
-	_, err := os.Stat(path)
+	size, err := aahReq.SaveFile("framework", path)
+	assert.Nil(t, err)
+	assert.Equal(t, int64(0), size)
+	_, err = os.Stat(path)
 	assert.Nil(t, err)
 }
 
@@ -238,64 +211,46 @@ func TestRequestSaveFileFailsValidation(t *testing.T) {
 	defer teardown()
 
 	// Empty keys should error out
-	assert.NotNil(t, aahReq.SaveFile("", path))
+	_, err := aahReq.SaveFile("", path)
+	assert.NotNil(t, err)
+	assert.Equal(t, "ahttp: key or dstFile is empty", err.Error())
 
 	// Empty path should error out
-	assert.NotNil(t, aahReq.SaveFile("framework", ""))
+	_, err = aahReq.SaveFile("framework", "")
+	assert.NotNil(t, err)
+	assert.Equal(t, "ahttp: key or dstFile is empty", err.Error())
 
 	// If "path" is a directory, it should error out
-	assert.NotNil(t, aahReq.SaveFile("framework", "testdata"))
+	_, err = aahReq.SaveFile("framework", "testdata")
+	assert.NotNil(t, err)
+	assert.Equal(t, "ahttp: dstFile should not be a directory", err.Error())
 }
 
 func TestRequestSaveFileFailsForNotFoundFile(t *testing.T) {
 	aahReq, path, teardown := setUpRequestSaveFile(t)
 	defer teardown()
 
-	assert.NotNil(t, aahReq.SaveFile("unknown-key", path))
+	_, err := aahReq.SaveFile("unknown-key", path)
+	assert.NotNil(t, err)
+	assert.Equal(t, "ahttp: no such key/file: unknown-key", err.Error())
 }
 
 func TestRequestSaveFileCannotCreateFile(t *testing.T) {
 	aahReq, _, teardown := setUpRequestSaveFile(t)
 	defer teardown()
 
-	assert.NotNil(t, aahReq.SaveFile("framework", "/root/aah.txt"))
-}
-
-func setUpRequestSaveFiles(t *testing.T) (*Request, string, func()) {
-	buf := new(bytes.Buffer)
-	multipartWriter := multipart.NewWriter(buf)
-	_, err := multipartWriter.CreateFormFile("framework", "aah")
-	assert.Nil(t, err)
-	_, err = multipartWriter.CreateFormFile("framework2", "aah2")
-	assert.Nil(t, err)
-
-	ess.CloseQuietly(multipartWriter)
-
-	req, _ := http.NewRequest("POST", "http://localhost:8080", buf)
-	req.Header.Add(HeaderContentType, multipartWriter.FormDataContentType())
-	aahReq := AcquireRequest(req)
-	aahReq.Params.File = make(map[string][]*multipart.FileHeader)
-
-	_, header, err := req.FormFile("framework")
-	assert.Nil(t, err)
-	_, header2, err := req.FormFile("framework2")
-	assert.Nil(t, err)
-
-	aahReq.Params.File["framework"] = []*multipart.FileHeader{header, header2}
-
-	dir := "testdata/upload"
-
-	_ = ess.MkDirAll(dir, 0755)
-	return aahReq, dir, func() {
-		_ = os.RemoveAll(dir)
-	}
+	_, err := aahReq.SaveFile("framework", "/root/aah.txt")
+	assert.NotNil(t, err)
+	assert.True(t, strings.HasPrefix(err.Error(), "ahttp: open /root/aah.txt"))
 }
 
 func TestRequestSaveFiles(t *testing.T) {
 	aahReq, dir, teardown := setUpRequestSaveFiles(t)
 	defer teardown()
 
-	assert.Nil(t, aahReq.SaveFiles("framework", dir))
+	sizes, errs := aahReq.SaveFiles("framework", dir)
+	assert.Nil(t, errs)
+	assert.Nil(t, sizes)
 	_, err := os.Stat(dir + "/aah")
 	assert.Nil(t, err)
 	_, err = os.Stat(dir + "/aah2")
@@ -307,23 +262,99 @@ func TestRequestSaveFilesFailsVaildation(t *testing.T) {
 	defer teardown()
 
 	// Empty key
-	assert.NotNil(t, aahReq.SaveFiles("", dir))
+	sizes, errs := aahReq.SaveFiles("", dir)
+	assert.NotNil(t, errs)
+	assert.Equal(t, "ahttp: form file key, '' is empty", errs[0].Error())
+	assert.Equal(t, int64(0), sizes[0])
 
 	// Empty directory
-	assert.NotNil(t, aahReq.SaveFiles("key", ""))
+	sizes, errs = aahReq.SaveFiles("key", "")
+	assert.NotNil(t, errs)
+	assert.Equal(t, "ahttp: destination path, '' is not a directory", errs[0].Error())
+	assert.Equal(t, int64(0), sizes[0])
 }
 
 func TestRequestSaveFilesCannotCreateFile(t *testing.T) {
 	aahReq, _, teardown := setUpRequestSaveFiles(t)
 	defer teardown()
 
-	assert.NotNil(t, aahReq.SaveFiles("framework", "/root"))
+	sizes, errs := aahReq.SaveFiles("framework", "/root")
+	assert.NotNil(t, errs)
+	assert.Equal(t, int64(0), sizes[0])
+
+	errMsg := errs[0].Error()
+	assert.True(t, ("ahttp: open /root/aah: permission denied" == errMsg ||
+		"ahttp: destination path, '/root' is not a directory" == errMsg))
 }
 
-func TestRequestsaveFileForExistingFile(t *testing.T) {
+func TestRequestSaveFileForExistingFile(t *testing.T) {
 	var buf bytes.Buffer
 
-	err := saveFile(&buf, "testdata/file1.txt")
+	size, err := saveFile(&buf, "testdata/file1.txt")
 	assert.NotNil(t, err)
-	assert.Equal(t, "open testdata/file1.txt: file exists", err.Error())
+	assert.Equal(t, "ahttp: open testdata/file1.txt: file exists", err.Error())
+	assert.Equal(t, int64(0), size)
+}
+
+//‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
+// test unexported methods
+//___________________________________
+
+func createRequestWithHost(host, remote string) *http.Request {
+	return &http.Request{Host: host, RemoteAddr: remote, Header: http.Header{}}
+}
+
+func setUpRequestSaveFile(t *testing.T) (*Request, string, func()) {
+	buf := new(bytes.Buffer)
+	multipartWriter := multipart.NewWriter(buf)
+	_, err := multipartWriter.CreateFormFile("framework", "aah")
+	assert.Nil(t, err)
+
+	ess.CloseQuietly(multipartWriter)
+
+	req, _ := http.NewRequest("POST", "http://localhost:8080", buf)
+	req.Header.Add(HeaderContentType, multipartWriter.FormDataContentType())
+	aahReq := AcquireRequest(req)
+	aahReq.Params.File = make(map[string][]*multipart.FileHeader)
+
+	_, header, err := req.FormFile("framework")
+	assert.Nil(t, err)
+
+	aahReq.Params.File["framework"] = []*multipart.FileHeader{header}
+
+	path := "testdata/aah.txt"
+
+	return aahReq, path, func() {
+		_ = os.Remove(path) //Teardown
+	}
+}
+
+func setUpRequestSaveFiles(t *testing.T) (*Request, string, func()) {
+	buf := new(bytes.Buffer)
+	multipartWriter := multipart.NewWriter(buf)
+	_, err := multipartWriter.CreateFormFile("framework", "aah")
+	assert.Nil(t, err)
+	_, err = multipartWriter.CreateFormFile("framework2", "aah2")
+	assert.Nil(t, err)
+
+	ess.CloseQuietly(multipartWriter)
+
+	req, _ := http.NewRequest("POST", "http://localhost:8080", buf)
+	req.Header.Add(HeaderContentType, multipartWriter.FormDataContentType())
+	aahReq := AcquireRequest(req)
+	aahReq.Params.File = make(map[string][]*multipart.FileHeader)
+
+	_, header, err := req.FormFile("framework")
+	assert.Nil(t, err)
+	_, header2, err := req.FormFile("framework2")
+	assert.Nil(t, err)
+
+	aahReq.Params.File["framework"] = []*multipart.FileHeader{header, header2}
+
+	dir := "testdata/upload"
+
+	_ = ess.MkDirAll(dir, 0755)
+	return aahReq, dir, func() {
+		_ = os.RemoveAll(dir)
+	}
 }

version.go

@@ -0,0 +1,8 @@
+// Copyright (c) Jeevanandam M (https://github.com/jeevatkm)
+// go-aah/ahttp source code and usage is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package ahttp
+
+// Version no. of aah framework ahttp library
+const Version = "0.10"