Address code quality issues (#19)

* Address code quality issues
* Post processing work is offloaded to goroutine, happens in background after newly generated ID is returned
* Added overwrite functionality to post endpoint
* Job status is stored in the Photo struct
* Channels are used to return required content from processing
* Sync WaitGroup is utilized for syncing of processing routines
* Using 3 separate buffers instead of copying on write with pipe
* Remove unnecessary debug info
* Fix JSON naming
* Add testing for Photo structure marshaling/unmarshaling
* Add testing for Photo Processing
* Create testing for request helper functions; mock out Storm functionality
* Shouldn't 500 on empty database
* Fix for go test -race

Author: warrn

cmd/pusher.go

@@ -20,7 +20,7 @@ var pusherCmd = &cobra.Command{
 
 		_, err := config.New()
 		if err != nil {
-			log.WithError(err).Error("Unable to create config")
+			log.WithError(err).Error("unable to create config")
 			return
 		}
 	},

cmd/server.go

@@ -22,14 +22,14 @@ var serverCmd = &cobra.Command{
 
 		config, err := config.New()
 		if err != nil {
-			log.WithError(err).Error("Unable to create config")
+			log.WithError(err).Error("unable to create config")
 			return
 		}
 		runner := runner.New()
 
 		server, err := server.New(config)
 		if err != nil {
-			log.WithError(err).Error("Unable to create server")
+			log.WithError(err).Error("unable to create server")
 			return
 		}
 		runner.Add(server)

config/config.go

@@ -19,6 +19,11 @@ func New() (*Config, error) {
 		c.PhotosDirectory = dir
 	}
 
+	listen, ok := os.LookupEnv("HOTSHOTS_LISTEN_URL")
+	if ok {
+		c.ListenURL = listen
+	}
+
 	return c, nil
 }
 

server/_testdata/emptyFile.jpg

@@ -5,6 +5,8 @@ import (
 	"math"
 	"net/http"
 	"strconv"
+	"sync"
+	"time"
 
 	"github.com/asdine/storm"
 	"github.com/asdine/storm/index"
@@ -48,21 +50,35 @@ func GetPaginateValues(r *http.Request) (func(*index.Options), func(*index.Optio
 }
 
 func WriteError(s string, status int, w http.ResponseWriter) {
-	w.WriteHeader(status)
 	v := ErrorResponse{
 		Success: false,
 		Error:   s,
 	}
-	WriteJsonResponse(v, w)
+	WriteJsonResponse(v, status, w)
 }
 
-func WriteJsonResponse(v interface{}, w http.ResponseWriter) {
+func WriteJsonResponse(v interface{}, status int, w http.ResponseWriter) {
 	js, err := json.Marshal(v)
 	if err != nil {
 		http.Error(w, err.Error(), http.StatusInternalServerError)
 		return
 	}
 
 	w.Header().Set("Content-Type", "application/json")
+	w.WriteHeader(status)
 	w.Write(js)
 }
+
+func waitTimeout(wg *sync.WaitGroup, timeout time.Duration) bool {
+	c := make(chan struct{})
+	go func() {
+		wg.Wait()
+		close(c)
+	}()
+	select {
+	case <-c:
+		return false // compl eted normally
+	case <-time.After(timeout):
+		return true // timed out
+	}
+}