github.com/Files-com/files-sdk-go/v2@v2.1.2/file/mockserver.go

package file

import (
	"context"
	"crypto/rand"
	"encoding/xml"
	"errors"
	"fmt"
	"io"
	"net/http"
	"net/http/httptest"
	"net/url"
	"path/filepath"
	"strconv"
	"strings"
	"sync"
	"testing"
	"time"

	files_sdk "github.com/Files-com/files-sdk-go/v2"
	"github.com/Files-com/files-sdk-go/v2/lib"
	"github.com/chilts/sid"
	"github.com/gin-gonic/gin"
	"github.com/samber/lo"
)

type randomReader struct {
	n int
}

func (r *randomReader) Read(p []byte) (int, error) {
	if r.n <= 0 {
		return 0, io.EOF
	}
	if len(p) > r.n {
		p = p[:r.n]
	}

	_, err := rand.Read(p)
	if err != nil {
		return 0, err
	}

	r.n -= len(p)
	return len(p), nil
}

type CustomResponse struct {
	Status      int
	Body        []byte
	ContentType string
}

type MockAPIServer struct {
	router *gin.Engine
	Addr   string
	*httptest.Server
	downloads       *lib.Map[download]
	MockFiles       map[string]mockFile
	customResponses map[string]func(ctx *gin.Context, model interface{}) bool
	*testing.T
	TrackRequest map[string][]string
	traceMutex   *sync.Mutex
}

type download struct {
	Id string
	mockFile
	Requests *lib.Map[files_sdk.ResponseError]
}

func (d download) init() download {
	d.Requests = &lib.Map[files_sdk.ResponseError]{}
	return d
}

type mockFile struct {
	files_sdk.File
	RealSize *int64
	SizeTrust
	ForceRequestStatus  string
	ForceRequestMessage string
	ServerBytesSent     *int64
	MaxConnections      int
	MaxConnectionsMutex *sync.Mutex
}

func (m mockFile) Completed() string {
	if m.ForceRequestStatus != "" {
		return m.ForceRequestStatus
	}
	return "completed"
}

type TestLogger struct {
	*testing.T
}

func (t TestLogger) Printf(format string, args ...any) {
	t.T.Logf(format, args...)
}

func (t TestLogger) Write(p []byte) (n int, err error) {
	t.T.Log(string(p))
	return len(p), nil
}

func (f *MockAPIServer) Do() *MockAPIServer {
	gin.SetMode(gin.TestMode)
	f.MockFiles = make(map[string]mockFile)
	f.customResponses = make(map[string]func(ctx *gin.Context, model interface{}) bool)
	f.TrackRequest = make(map[string][]string)
	f.traceMutex = &sync.Mutex{}
	f.downloads = &lib.Map[download]{}
	f.router = gin.New()
	f.router.Use(gin.LoggerWithWriter(TestLogger{f.T}))
	f.Routes()
	f.Server = httptest.NewServer(f.router)

	return f
}

func (f *MockAPIServer) MockRoute(path string, call func(ctx *gin.Context, model interface{}) bool) {
	f.customResponses[path] = call
}

func (f *MockAPIServer) Client() *Client {
	client := &Client{}
	httpClient := http.Client{}
	if u, err := url.Parse(f.Server.URL); err != nil {
		f.T.Fatal(err.Error())
	} else {
		httpClient.Transport = &CustomTransport{URL: u}
	}
	client.Config.SetHttpClient(&httpClient)
	client.Config.SetLogger(TestLogger{f.T})
	return client
}

func (f *MockAPIServer) GetFile(file mockFile) (r io.Reader, contentLengthOk bool, contentLength int64, realSize int64, err error) {
	if file.SizeTrust == NullSizeTrust || file.SizeTrust == TrustedSizeValue {
		contentLengthOk = true
	}

	contentLength = file.File.Size

	if file.RealSize != nil {
		realSize = *file.RealSize
	} else {
		realSize = contentLength
	}
	r = &randomReader{int(realSize)}
	return
}

func (f *MockAPIServer) trackRequest(c *gin.Context) {
	f.traceMutex.Lock()
	defer f.traceMutex.Unlock()
	f.TrackRequest[c.FullPath()] = append(f.TrackRequest[c.FullPath()], c.Request.URL.String())
}

func (f *MockAPIServer) GetRouter() *gin.Engine {
	return f.router
}

func (f *MockAPIServer) Routes() {
	//Download Context
	f.router.GET("/api/rest/v1/files/*path", func(c *gin.Context) {
		f.trackRequest(c)
		path := strings.TrimPrefix(c.Param("path"), "/")
		if f.customResponse(c, nil) {
			return
		}
		file, ok := f.MockFiles[path]
		if ok {
			if file.Path == "" {
				file.Path = path
				file.DisplayName = filepath.Base(path)
			}
			downloadId := sid.IdHex()
			f.downloads.Store(downloadId, download{Id: downloadId, mockFile: file}.init())
			file.DownloadUri = lib.UrlJoinNoEscape("http://localhost:8080/download", downloadId)

			if file.MaxConnections != 0 {
				file.MaxConnectionsMutex = &sync.Mutex{}
			}

			c.JSON(http.StatusOK, file.File)
		} else {
			c.JSON(http.StatusNotFound, nil)
		}
	})
	f.router.GET("/api/rest/v1/folders/*path", func(c *gin.Context) {
		f.trackRequest(c)
		path := strings.TrimPrefix(c.Param("path"), "/")

		if f.customResponse(c, nil) {
			return
		}

		var files []files_sdk.File
		for k, v := range f.MockFiles {
			dir, _ := filepath.Split(k)
			if lib.NormalizeForComparison(filepath.Clean(path)) == lib.NormalizeForComparison(filepath.Clean(dir)) {
				if v.Path == "" {
					v.Path = k
					v.DisplayName = filepath.Base(k)
				}
				files = append(files, v.File)
			}
		}

		if len(files) > 0 {
			c.JSON(http.StatusOK, files)
		} else {
			c.JSON(http.StatusNotFound, nil)
		}
	})
	f.router.GET("/api/rest/v1/file_actions/metadata/*path", func(c *gin.Context) {
		f.trackRequest(c)
		path := strings.TrimPrefix(c.Param("path"), "/")

		if f.customResponse(c, nil) {
			return
		}

		file, ok := f.MockFiles[path]
		if ok {
			if file.Path == "" {
				file.Path = path
				file.DisplayName = filepath.Base(path)
			}
			c.JSON(http.StatusOK, file.File)
		} else {
			c.JSON(http.StatusNotFound, nil)
		}
	})
	f.router.GET("/download/:download_id/:download_request_id", func(c *gin.Context) {
		f.trackRequest(c)
		downloadId := c.Param("download_id")
		downloadJob, downloadOk := f.downloads.Load(downloadId)
		if !downloadOk {
			c.JSON(http.StatusNotFound, nil)
			return
		}
		downloadRequestJob, requestOk := downloadJob.Requests.Load(c.Param("download_request_id"))
		if requestOk {
			c.JSON(http.StatusOK, downloadRequestJob)
		} else {
			c.JSON(http.StatusNotFound, nil)
		}

	})
	f.router.GET("/download/:download_id", func(c *gin.Context) {
		f.trackRequest(c)
		downloadJob, ok := f.downloads.Load(c.Param("download_id"))
		if !ok {
			c.JSON(http.StatusNotFound, nil)
			return
		}

		if downloadJob.mockFile.MaxConnectionsMutex != nil {
			downloadJob.mockFile.MaxConnectionsMutex.Lock()
		}

		start, end, okRange := rangeValue(c.Request.Header)

		reader, contentLengthOk, contentLength, realSize, err := f.GetFile(downloadJob.mockFile)
		if err != nil {
			panic(err)
		}
		status := http.StatusOK
		if okRange {
			if realSize < int64(start) {
				reader = &randomReader{0}
			} else {
				reader = &randomReader{(lo.Min[int]([]int{int(realSize - 1), end}) - start) + 1}
			}
			status = http.StatusPartialContent
		}
		downloadRequestId := sid.IdHex()
		if downloadJob.mockFile.MaxConnections == 0 {
			c.Header("X-Files-Max-Connections", "*")
		} else {
			c.Header("X-Files-Max-Connections", fmt.Sprintf("%v", downloadJob.mockFile.MaxConnections))
		}

		c.Header("X-Files-Download-Request-Id", downloadRequestId)
		responseError := files_sdk.ResponseError{ErrorMessage: downloadJob.ForceRequestMessage}
		extraHeaders := map[string]string{}
		if contentLengthOk {
			if okRange && contentLength < int64(end) {
				c.Status(http.StatusBadRequest)
			}

			if okRange {
				extraHeaders["Content-Range"] = fmt.Sprintf("%v-%v/%v", start, end, contentLength)
				contentLength = int64(end-start) + 1
			}

			c.DataFromReader(status, contentLength, "application/zip, application/octet-stream", reader, extraHeaders)
			downloadJob.Requests.Store(downloadRequestId, responseError)
			if downloadJob.mockFile.MaxConnectionsMutex != nil {
				downloadJob.mockFile.MaxConnectionsMutex.Unlock()
			}
		} else {
			finish := func() {
				if downloadJob.ServerBytesSent != nil {
					responseError.Data.BytesTransferred = *downloadJob.ServerBytesSent
				}
				downloadJob.Requests.Store(downloadRequestId, responseError)
				if downloadJob.mockFile.MaxConnectionsMutex != nil {
					downloadJob.mockFile.MaxConnectionsMutex.Unlock()
				}
			}
			if okRange {
				c.Header("Content-Range", fmt.Sprintf("%v-%v/*", start, end))
			}
			c.Status(status)
			c.Stream(func(w io.Writer) bool {
				buf := make([]byte, 1024*1024)

				n, err := reader.Read(buf)
				if err == io.EOF {
					responseError.Data.Status = downloadJob.Completed()
					finish()
					return false
				}
				if err != nil && err != io.EOF {
					responseError.Data.Status = "errored"
					finish()
					return false
				}

				wn, err := w.Write(buf[:n])
				if err != nil {
					responseError.Data.Status = "errored"
					finish()
					return false
				}

				responseError.Data.BytesTransferred += int64(wn)

				if err == io.EOF {
					responseError.Data.Status = "errored"
					finish()
					return false
				}

				return true
			})
		}
	})
	f.router.HEAD("/download/:download_id", func(c *gin.Context) {
		f.trackRequest(c)
		downloadJob, ok := f.downloads.Load(c.Param("download_id"))
		if !ok {
			c.JSON(http.StatusNotFound, nil)
			return
		}
		_, contentLengthOk, contentLength, _, err := f.GetFile(downloadJob.mockFile)
		if err != nil {
			panic(err)
		}
		if contentLengthOk {
			c.Header("Content-Length", fmt.Sprintf("%v", contentLength))
		}
		if downloadJob.mockFile.MaxConnections == 0 {
			c.Header("X-Files-Max-Connections", "*")
		} else {
			c.Header("X-Files-Max-Connections", fmt.Sprintf("%v", downloadJob.mockFile.MaxConnections))
		}
		c.Status(http.StatusOK)
	})
	//	Upload Context
	f.router.POST("/api/rest/v1/files/*path", func(c *gin.Context) {
		f.trackRequest(c)
		path := strings.TrimPrefix(c.Param("path"), "/")

		var fileCreate files_sdk.FileCreateParams

		if err := c.BindJSON(&fileCreate); err != nil {
			c.JSON(http.StatusBadRequest, map[string]interface{}{"message": err.Error()})
		}

		if f.customResponse(c, fileCreate) {
			return
		}

		file, ok := f.MockFiles[path]
		if ok {
			if file.Path == "" {
				file.Path = path
				file.DisplayName = filepath.Base(path)
			}
			c.JSON(http.StatusOK, file)
		} else {
			c.JSON(http.StatusNotFound, nil)
		}
	})
	f.router.POST("/api/rest/v1/file_actions/begin_upload/*path", func(c *gin.Context) {
		f.trackRequest(c)
		path := strings.TrimPrefix(c.Param("path"), "/")

		var beginUpload files_sdk.FileBeginUploadParams

		if err := c.BindJSON(&beginUpload); err != nil {
			c.JSON(http.StatusBadRequest, map[string]interface{}{"message": err.Error()})
		}

		beginUpload.Path = path

		if f.customResponse(c, beginUpload) {
			return
		}

		_, ok := f.MockFiles[path]
		_, parentOk := f.MockFiles[filepath.Dir(path)]

		if !ok && (filepath.Dir(path) == "." || parentOk || *beginUpload.MkdirParents == true) {
			f.MockFiles[path] = mockFile{File: files_sdk.File{Path: path, DisplayName: filepath.Base(path), Size: beginUpload.Size}}
			ok = true
		}

		if ok {
			c.JSON(http.StatusOK, files_sdk.FileUploadPartCollection{
				files_sdk.FileUploadPart{
					HttpMethod:    "POST",
					Path:          path,
					UploadUri:     lib.UrlJoinNoEscape(f.Server.URL, "upload", path),
					ParallelParts: lib.Bool(true),
					Expires:       time.Now().Add(time.Hour).Format(time.RFC3339),
				},
			})
		} else {
			c.JSON(http.StatusNotFound, nil)
		}
	})
	f.router.POST("upload/*path", func(c *gin.Context) {
		f.trackRequest(c)
		path := strings.TrimPrefix(c.Param("path"), "/")

		if f.customResponse(c, nil) {
			return
		}

		_, ok := f.MockFiles[path]
		if ok {
			ctx, cancel := context.WithTimeout(c, time.Millisecond*100)
			defer cancel()

			b, err := io.Copy(io.Discard, &readerCtx{r: c.Request.Body, ctx: ctx})
			if err != nil {
				if errors.Is(err, context.DeadlineExceeded) {
					c.XML(http.StatusBadRequest, lib.S3Error{
						XMLName: xml.Name{Local: "Error"},
						Message: "Your socket connection to the server was not read from or written to within the timeout period. Idle connections will be closed.",
						Code:    "RequestTimeout",
					},
					)
				} else {
					c.Data(http.StatusBadRequest, "text", []byte(err.Error()))
				}
			}
			if c.Request.ContentLength != b {
				c.JSON(http.StatusBadRequest, map[string]interface{}{"message": "Content-Length did not match body"})
			}
			c.Header("Etag", sid.IdBase64())
			c.Status(http.StatusOK)
		} else {
			c.JSON(http.StatusNotFound, nil)
		}
	})
	f.router.GET("/ping", func(c *gin.Context) {
		c.Status(http.StatusOK)
	})
}

type readerCtx struct {
	ctx context.Context
	r   io.Reader
}

func (r *readerCtx) Read(p []byte) (n int, err error) {
	if err := r.ctx.Err(); err != nil {
		return 0, err
	}
	return r.r.Read(p)
}

func (f *MockAPIServer) customResponse(c *gin.Context, model interface{}) bool {
	if mock, ok := f.customResponses[c.Request.URL.Path]; ok {
		return mock(c, model)
	}
	return false
}

func (f *MockAPIServer) Shutdown() {
	f.Server.Close()
}

type CustomTransport struct {
	http.Transport
	*url.URL
}

func (t *CustomTransport) RoundTrip(req *http.Request) (*http.Response, error) {
	req.URL.Host = t.URL.Host
	req.URL.Scheme = "http"

	return t.Transport.RoundTrip(req)
}

func rangeValue(header http.Header) (start, end int, ok bool) {
	r := header.Get("Range")
	if r == "" {
		return
	}

	r = strings.SplitN(r, "=", 2)[1]
	ranges := strings.Split(r, "-")
	var err error
	start, err = strconv.Atoi(ranges[0])
	if err != nil {
		return
	}
	end, err = strconv.Atoi(ranges[1])
	if err != nil {
		return
	}

	ok = true

	return
}