Adds catches for errors when sending report

Author: haroon-sheikh

reportserver.go

@@ -135,14 +135,15 @@ func SendReport(stop chan bool) {
 		logger.Printf("Could not remove archive '%s'.", ArchiveDestination())
 	}
 	if err := zipper.ZipDir(ArchiveOrigin(), ArchiveDestination()); err != nil {
+		logger.Printf("error archiving the reports directory.\n%s", err.Error())
 		return
 	}
 	reportPath := env.GetReportServerUrl()
 	err := sender.SendArchive(reportPath, ArchiveDestination())
 	if err != nil {
-		logger.Printf(fmt.Sprintf("Could not send the archive from '%s' to '%s'\n %s", ArchiveDestination(), reportPath, err))
+		logger.Printf(fmt.Sprintf("Could not send the archive from '%s' to '%s'\n%s", ArchiveDestination(), reportPath, err.Error()))
 	} else {
-		fmt.Printf("Successfully sent html-report to reportserver => %s", reportPath+"/report.html\n")
+		fmt.Printf("Successfully sent html-report to reportserver => %s", reportPath+"/report.html")
 	}
 }
 

sender/sender.go

@@ -15,41 +15,34 @@ func SendArchive(url, filePath string) (err error) {
 	writer := multipart.NewWriter(&b)
 	// Add your image file
 	file, err := os.Open(filePath)
+	defer func() {
+		err := file.Close()
+		if err != nil {
+			return
+		}
+	}()
 	if err != nil {
-		return
+		return fmt.Errorf("error opening the file '%s'", filePath)
 	}
-	fi, err := file.Stat()
+	fileStat, err := file.Stat()
 	if err != nil {
-		return err
+		return fmt.Errorf("could not get file information")
 	}
-
-	defer file.Close()
-
-	fw, err := writer.CreateFormFile("file", fi.Name())
+	formWriter, err := writer.CreateFormFile("file", fileStat.Name())
 	if err != nil {
-		return err
+		return fmt.Errorf("error create a form writer")
 	}
-	if _, err = io.Copy(fw, file); err != nil {
-		return err
+	if _, err = io.Copy(formWriter, file); err != nil {
+		return fmt.Errorf("error copying file '%s' to form writer", file.Name())
 	}
-
-	// Add the other fields
-
-	//if fw, err = w.CreateFormField("key"); err != nil {
-	//	return
-	//}
-	//if _, err = fw.Write([]byte("KEY")); err != nil {
-	//	return
-	//}
-
+	// add auto unzip param to request
 	_ = writer.WriteField("unzip", "true")
 
-	// Don't forget to close the multipart writer.
+	// close the multipart writer.
 	// If you don't close it, your request will be missing the terminating boundary.
 	if err = writer.Close(); err != nil {
 		return err
 	}
-
 	// Now that you have a form, you can submit it to your handler.
 	req, err := http.NewRequest("POST", url, &b)
 	if err != nil {
@@ -67,16 +60,7 @@ func SendArchive(url, filePath string) (err error) {
 
 	// Check the response
 	if res.StatusCode != http.StatusOK {
-		err = fmt.Errorf("bad status: %s", res.Status)
+		return fmt.Errorf("bad status: %s", res.Status)
 	}
-
-	RemoveArchive(filePath)
-
 	return
 }
-
-func RemoveArchive(filePath string) {
-	if err := os.Remove(filePath); err != nil {
-		return
-	}
-}

zipper/zipper.go

@@ -2,6 +2,7 @@ package zipper
 
 import (
 	"archive/zip"
+	"fmt"
 	"io"
 	"os"
 	"path/filepath"
@@ -12,14 +13,14 @@ func ZipDir(source, target string) error {
 
 	// check if sourceDir exists
 	if _, err := os.Stat(source); os.IsNotExist(err) {
-		return err
+		return fmt.Errorf("source directory '%s' does not exist", source)
 	}
-
+	// get absolute path of source directory
 	source, err := filepath.Abs(source)
 	if err != nil {
-		return err
+		return fmt.Errorf("could not get absolute path for the source directory '%s'", source)
 	}
-
+	// create a zip file at target
 	zipFile, err := os.Create(target)
 	defer func() {
 		err := zipFile.Close()
@@ -28,32 +29,29 @@ func ZipDir(source, target string) error {
 		}
 	}()
 	if err != nil {
-		return err
+		return fmt.Errorf("could not create the target archive at '%s'", target)
 	}
-
+	// create a new writer for writing into zip
 	archive := zip.NewWriter(zipFile)
 	defer func() {
 		err := archive.Close()
 		if err != nil {
 			return
 		}
 	}()
-
+	// list of files to ignore when adding to zip
 	ignoreFiles := []string{
 		"html-report",
 		".DS_Store",
-		"report.html",
 	}
-
 	err = filepath.Walk(source, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
 			return err
 		}
-
+		// check file isn't in the ignored list
 		if contains(ignoreFiles, info.Name()) {
 			return nil
 		}
-
 		header, err := zip.FileInfoHeader(info)
 		if err != nil {
 			return err
@@ -70,7 +68,7 @@ func ZipDir(source, target string) error {
 		if err != nil {
 			return err
 		}
-
+		// skip if it's a directory
 		if info.IsDir() {
 			return nil
 		}

zipper/zipper_test.go

@@ -0,0 +1,20 @@
+package zipper
+
+import (
+	"testing"
+)
+
+func TestContains(t *testing.T) {
+	test := []string{
+		"hello",
+		"world",
+	}
+	exists := contains(test, "hello")
+	if !exists {
+		t.Errorf("contains was incorrect")
+	}
+	exists = contains(test, "invalid")
+	if exists {
+		t.Errorf("contains was incorrect")
+	}
+}