Added convenient methods for uploading files. (#15) go-aah/aah#82

Author: adelowo

request.go

@@ -5,11 +5,15 @@
 package ahttp
 
 import (
+	"errors"
 	"fmt"
+	"io"
 	"mime/multipart"
 	"net"
 	"net/http"
 	"net/url"
+	"os"
+	"path/filepath"
 	"strings"
 	"sync"
 
@@ -196,6 +200,52 @@ func (r *Request) Unwrap() *http.Request {
 	return r.Raw
 }
 
+// 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 {
+	if ess.IsStrEmpty(dstFile) || ess.IsStrEmpty(key) {
+		return errors.New("ahttp: key or dstFile is empty")
+	}
+
+	if ess.IsDir(dstFile) {
+		return errors.New("ahttp: dstFile should not be a directory")
+	}
+
+	uploadedFile, _, err := r.FormFile(key)
+	if err != nil {
+		return err
+	}
+	defer ess.CloseQuietly(uploadedFile)
+
+	return saveFile(uploadedFile, dstFile)
+}
+
+// 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 {
+	if !ess.IsDir(dstPath) {
+		return []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)}
+	}
+
+	var errs []error
+	for _, file := range r.Params.File[key] {
+		uploadedFile, err := file.Open()
+		if err != nil {
+			errs = append(errs, err)
+			continue
+		}
+
+		if err := saveFile(uploadedFile, filepath.Join(dstPath, file.Filename)); err != nil {
+			errs = append(errs, err)
+		}
+		ess.CloseQuietly(uploadedFile)
+	}
+	return errs
+}
+
 // Reset method resets request instance for reuse.
 func (r *Request) Reset() {
 	r.Scheme = ""
@@ -356,3 +406,14 @@ func isGzipAccepted(req *Request, r *http.Request) bool {
 	}
 	return false
 }
+
+func saveFile(r io.Reader, destFile string) error {
+	f, err := os.OpenFile(destFile, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0666)
+	if err != nil {
+		return err
+	}
+	defer ess.CloseQuietly(f)
+
+	_, err = io.Copy(f, r)
+	return err
+}

request_test.go

@@ -5,11 +5,13 @@
 package ahttp
 
 import (
+	"bytes"
 	"crypto/tls"
 	"mime/multipart"
 	"net/http"
 	"net/http/httptest"
 	"net/url"
+	"os"
 	"strings"
 	"testing"
 
@@ -193,3 +195,124 @@ func TestRequestSchemeDerived(t *testing.T) {
 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)
+
+	multipartWriter.Close()
+
+	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)
+	assert.Nil(t, err)
+}
+
+func TestRequestSaveFileFailsValidation(t *testing.T) {
+	aahReq, path, teardown := setUpRequestSaveFile(t)
+	defer teardown()
+
+	// Empty keys should error out
+	assert.NotNil(t, aahReq.SaveFile("", path))
+
+	// Empty path should error out
+	assert.NotNil(t, aahReq.SaveFile("framework", ""))
+
+	// If "path" is a directory, it should error out
+	assert.NotNil(t, aahReq.SaveFile("framework", "testdata"))
+}
+
+func TestRequestSaveFileFailsForNotFoundFile(t *testing.T) {
+	aahReq, path, teardown := setUpRequestSaveFile(t)
+	defer teardown()
+
+	assert.NotNil(t, aahReq.SaveFile("unknown-key", path))
+}
+
+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)
+
+	multipartWriter.Close()
+
+	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"
+
+	os.Mkdir(dir, 0755)
+	return aahReq, dir, func() {
+		os.RemoveAll(dir)
+	}
+}
+
+func TestRequestSaveFiles(t *testing.T) {
+	aahReq, dir, teardown := setUpRequestSaveFiles(t)
+	defer teardown()
+
+	assert.Nil(t, aahReq.SaveFiles("framework", dir))
+	_, err := os.Stat(dir + "/aah")
+	assert.Nil(t, err)
+	_, err = os.Stat(dir + "/aah2")
+	assert.Nil(t, err)
+}
+
+func TestRequestSaveFilesFailsVaildation(t *testing.T) {
+	aahReq, dir, teardown := setUpRequestSaveFiles(t)
+	defer teardown()
+
+	// Empty key
+	assert.NotNil(t, aahReq.SaveFiles("", dir))
+
+	// Empty directory
+	assert.NotNil(t, aahReq.SaveFiles("key", ""))
+}
+
+func TestRequestSaveFilesCannotCreateFile(t *testing.T) {
+	aahReq, _, teardown := setUpRequestSaveFiles(t)
+	defer teardown()
+
+	assert.NotNil(t, aahReq.SaveFiles("framework", "/root"))
+}