Merge remote-tracking branch 'origin/main' into dev/storage

Author: Artem Titov

common/connectors/storageconn/connector.go

@@ -27,6 +27,7 @@ func (s *Connector) Download(request *Request) *FileResponse {
 	response := NewFileResponse(*request)
 	if request.StorageFilename == "" {
 		response.Error = fmt.Errorf("storage filename not specified")
+		return response
 	}
 
 	if err := os.MkdirAll(request.BaseFolder, 0775); err != nil {
@@ -99,10 +100,6 @@ func (s *Connector) Download(request *Request) *FileResponse {
 
 func (s *Connector) Upload(request *Request) *Response {
 	response := &Response{R: *request}
-	if request.StorageFilename == "" {
-		response.Error = fmt.Errorf("storage filename not specified")
-		return response
-	}
 
 	if request.File == nil {
 		response.Error = fmt.Errorf("file for upload is not specified")
@@ -121,6 +118,8 @@ func (s *Connector) Upload(request *Request) *Response {
 	r.SetFormData(map[string]string{
 		"request": string(requestJSON),
 	})
+
+	// request.StorageFilename can be empty
 	r.SetFileReader("file", request.StorageFilename, request.File)
 
 	resp, err := r.Post(path)
@@ -153,7 +152,7 @@ func (s *Connector) Delete(request *Request) *Response {
 		return response
 	}
 
-	r.SetQueryParams(map[string]string{
+	r.SetFormData(map[string]string{
 		"request": string(requestJSON),
 	})
 

common/connectors/storageconn/structs.go

@@ -34,7 +34,7 @@ type Request struct {
 	// For uploads, File should be specified
 	File io.Reader `json:"-"`
 
-	// StorageFilename should be always specified
+	// If StorageFilename is not specified, Storage tries to get the filename automatically
 	StorageFilename string `json:"storageFilename"`
 }
 

common/constants/resource/resource_type.go

@@ -17,6 +17,7 @@ const (
 	CheckerOutput
 	Interactor
 	// Will be increased
+	// Don't forget to add a new type to storage/helpers.go
 )
 
 type DataType int

main.go

@@ -34,7 +34,7 @@ func main() {
 	if ts.Config.Storage != nil {
 		err := storage.SetupStorage(ts)
 		if err != nil {
-			logger.Panic(err.Error())
+			logger.Panic("Can not setup storage, error: %v", err.Error())
 		}
 	} else {
 		logger.Info("storage is not configured, skipping storage component")

storage/filesystem/filesystem.go

@@ -5,6 +5,7 @@ import (
 	"mime/multipart"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"testing_system/common/config"
 	"testing_system/lib/logger"
@@ -22,17 +23,16 @@ func NewFilesystem(storageConfig *config.StorageConfig) IFilesystem {
 }
 
 func (filesystem *Filesystem) generatePathFromID(prefix string, id string) string {
-	var parts []string
-	parts = append(parts, prefix)
+	parts := []string{prefix}
 	for i := 0; i < len(id); i += int(filesystem.BlockSize) {
 		end := min(i+int(filesystem.BlockSize), len(id))
 		parts = append(parts, id[i:end])
 	}
 	return filepath.Join(parts...)
 }
 
-func (filesystem *Filesystem) SaveFile(c *gin.Context, prefix string, id string, filename string, file *multipart.FileHeader) error {
-	fullPath, err := filesystem.GetFilePath(prefix, id, filename)
+func (filesystem *Filesystem) SaveFile(c *gin.Context, resourceInfo *ResourceInfo, file *multipart.FileHeader) error {
+	fullPath, err := filesystem.GetFilePath(resourceInfo)
 	if err != nil {
 		return err
 	}
@@ -49,8 +49,8 @@ func (filesystem *Filesystem) SaveFile(c *gin.Context, prefix string, id string,
 	return c.SaveUploadedFile(file, fullPath)
 }
 
-func (filesystem *Filesystem) RemoveFile(prefix string, id string, filename string) error {
-	fullPath, err := filesystem.GetFilePath(prefix, id, filename)
+func (filesystem *Filesystem) RemoveFile(resourceInfo *ResourceInfo) error {
+	fullPath, err := filesystem.GetFilePath(resourceInfo)
 	if err != nil {
 		return err
 	}
@@ -82,14 +82,10 @@ func (filesystem *Filesystem) RemoveFile(prefix string, id string, filename stri
 	return nil
 }
 
-func (filesystem *Filesystem) GetFilePath(prefix, id, filename string) (string, error) {
-	if prefix == "" || id == "" || filename == "" {
-		return "", fmt.Errorf("prefix, id, and filename cannot be empty")
-	}
-
-	cleanFilename := filepath.Base(filename)
+func (filesystem *Filesystem) GetFilePath(resourceInfo *ResourceInfo) (string, error) {
+	cleanFilename := filepath.Base(resourceInfo.Filepath)
 
-	subpath := filesystem.generatePathFromID(prefix, id)
+	subpath := filesystem.generatePathFromID(resourceInfo.DataType.String(), strconv.FormatUint(resourceInfo.ID, 10))
 	fullPath := filepath.Join(filesystem.Basepath, subpath, cleanFilename)
 
 	absBasepath, err := filepath.Abs(filesystem.Basepath)

storage/filesystem/interface.go

@@ -7,7 +7,7 @@ import (
 )
 
 type IFilesystem interface {
-	SaveFile(c *gin.Context, prefix string, id string, filename string, file *multipart.FileHeader) error
-	RemoveFile(prefix string, id string, filename string) error
-	GetFilePath(prefix string, id string, filename string) (string, error)
+	SaveFile(c *gin.Context, resourceInfo *ResourceInfo, file *multipart.FileHeader) error
+	RemoveFile(resourceInfo *ResourceInfo) error
+	GetFilePath(resourceInfo *ResourceInfo) (string, error)
 }

storage/filesystem/resource_info.go

@@ -0,0 +1,13 @@
+package filesystem
+
+import (
+	"testing_system/common/connectors/storageconn"
+	"testing_system/common/constants/resource"
+)
+
+type ResourceInfo struct {
+	Request *storageconn.Request
+	ID       uint64
+	Filepath string
+	DataType resource.DataType
+}

storage/handlers.go

@@ -4,15 +4,14 @@ import (
 	"mime"
 	"net/http"
 	"path/filepath"
-	"strconv"
 	"testing_system/lib/connector"
 	"testing_system/lib/logger"
 
 	"github.com/gin-gonic/gin"
 )
 
 func (s *Storage) HandleUpload(c *gin.Context) {
-	info, err := getInfoFromRequest(c)
+	resourceInfo, err := getInfoFromRequest(c)
 	if err != nil {
 		connector.RespErr(c, http.StatusBadRequest, "Invalid request parameters: %v", err)
 		logger.Error("Invalid request parameters in HandleUpload: %v", err)
@@ -26,14 +25,11 @@ func (s *Storage) HandleUpload(c *gin.Context) {
 		return
 	}
 
-	dataTypeStr := info.dataType.String()
-	idStr := strconv.FormatUint(info.id, 10)
-
-	err = s.filesystem.SaveFile(c, dataTypeStr, idStr, info.filepath, file)
+	err = s.filesystem.SaveFile(c, resourceInfo, file)
 	if err != nil {
 		connector.RespErr(c, http.StatusInternalServerError, "Failed to save file: %v", err)
-		logger.Error("Failed to save file: id=%s, dataType=%s, filepath=%s\n %v",
-			idStr, dataTypeStr, info.filepath, err)
+		logger.Error("Failed to save file: id=%d, dataType=%s, filepath=%s\n %v",
+			resourceInfo.ID, resourceInfo.DataType.String(), resourceInfo.Filepath, err)
 		return
 	}
 
@@ -42,27 +38,24 @@ func (s *Storage) HandleUpload(c *gin.Context) {
 		Filename string `json:"filename"`
 	}{
 		Message:  "File uploaded successfully",
-		Filename: filepath.Base(file.Filename),
+		Filename: filepath.Base(resourceInfo.Filepath),
 	}
 	connector.RespOK(c, &response)
 }
 
 func (s *Storage) HandleRemove(c *gin.Context) {
-	info, err := getInfoFromRequest(c)
+	resourceInfo, err := getInfoFromRequest(c)
 	if err != nil {
 		connector.RespErr(c, http.StatusBadRequest, "Invalid request parameters: %v", err)
 		logger.Error("Invalid request parameters in HandleRemove: %v", err)
 		return
 	}
 
-	dataTypeStr := info.dataType.String()
-	idStr := strconv.FormatUint(info.id, 10)
-
-	err = s.filesystem.RemoveFile(dataTypeStr, idStr, info.filepath)
+	err = s.filesystem.RemoveFile(resourceInfo)
 	if err != nil {
 		connector.RespErr(c, http.StatusInternalServerError, "Failed to remove file: %v", err)
-		logger.Error("Failed to remove file: id=%s, dataType=%s, filepath=%s\n %v",
-			idStr, dataTypeStr, info.filepath, err)
+		logger.Error("Failed to remove file: id=%d, dataType=%s, filepath=%s\n %v",
+			resourceInfo.ID, resourceInfo.DataType.String(), resourceInfo.Filepath, err)
 		return
 	}
 
@@ -71,27 +64,24 @@ func (s *Storage) HandleRemove(c *gin.Context) {
 		Filename string `json:"filename"`
 	}{
 		Message:  "File removed successfully",
-		Filename: info.filepath,
+		Filename: filepath.Base(resourceInfo.Filepath),
 	}
 	connector.RespOK(c, &response)
 }
 
 func (s *Storage) HandleGet(c *gin.Context) {
-	info, err := getInfoFromRequest(c)
+	resourceInfo, err := getInfoFromRequest(c)
 	if err != nil {
 		connector.RespErr(c, http.StatusBadRequest, "Invalid request parameters: %v", err)
 		logger.Error("Invalid request parameters in HandleGet: %v", err)
 		return
 	}
 
-	dataTypeStr := info.dataType.String()
-	idStr := strconv.FormatUint(info.id, 10)
-
-	fullPath, err := s.filesystem.GetFilePath(dataTypeStr, idStr, info.filepath)
+	fullPath, err := s.filesystem.GetFilePath(resourceInfo)
 	if err != nil {
 		connector.RespErr(c, http.StatusInternalServerError, "Failed to get file: %v", err)
-		logger.Error("Failed to get file: id=%s, dataType=%s, filePath=%s\n %v",
-			idStr, dataTypeStr, info.filepath, err)
+		logger.Error("Failed to get file: id=%d, dataType=%s, filePath=%s\n %v",
+			resourceInfo.ID, resourceInfo.DataType.String(), resourceInfo.Filepath, err)
 		return
 	}