wip

Author: CalamarBicefalo

internal/fileupload/client_test.go

@@ -0,0 +1,108 @@
+//go:generate go run github.com/golang/mock/mockgen -package=mocks -destination=./mocks/mock_http_client.go github.com/snyk/cli-extension-os-flows/internal/fileupload/lowlevel SealableClient
+package fileupload
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/google/uuid"
+	"github.com/snyk/cli-extension-os-flows/internal/fileupload/lowlevel"
+	"github.com/snyk/cli-extension-os-flows/internal/fileupload/mocks"
+	"github.com/stretchr/testify/require"
+)
+
+type File struct {
+	filename string
+	content  string
+}
+
+type FileUploadClient struct {
+}
+
+func (c FileUploadClient) UploadDir(dir os.File) (RevisionID, error) {
+	return uuid.Nil, nil
+}
+
+func NewFileUploadClient(sealableClientMock lowlevel.SealableClient) *FileUploadClient {
+	return &FileUploadClient{}
+}
+
+func Test_uploadingADirectory(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+	sealableClientMock := mocks.NewMockSealableClient(ctrl)
+	client := NewFileUploadClient(sealableClientMock)
+	orgID := uuid.New()
+	dir, files, cleanup := createFlatDirWithFiles([]File{{
+		filename: "file1",
+		content:  "content1",
+	}})
+	defer cleanup()
+
+	expectedRevID := expectRevisionUploaded(sealableClientMock, orgID, files)
+
+	revID, err := client.UploadDir(*dir)
+
+	require.NoError(t, err)
+	require.Equal(t, expectedRevID, revID)
+}
+
+func expectRevisionUploaded(sealableClientMock *mocks.MockSealableClient, orgID uuid.UUID, files []lowlevel.UploadFile) RevisionID {
+	revID := uuid.New()
+	crResp := lowlevel.UploadRevisionResponseBody{
+		Data: lowlevel.UploadRevisionResponseData{
+			ID: revID,
+		},
+	}
+	sealableClientMock.EXPECT().CreateRevision(gomock.Any(), gomock.Eq(orgID)).Return(
+		&crResp,
+		nil,
+	)
+	sealableClientMock.EXPECT().UploadFiles(gomock.Any(), gomock.Eq(orgID), gomock.Eq(revID), gomock.Eq(files))
+	sealableClientMock.EXPECT().SealRevision(gomock.Any(), gomock.Eq(orgID), gomock.Eq(revID))
+
+	return revID
+}
+
+func createFlatDirWithFiles(filesContent []File) (dir *os.File, files []lowlevel.UploadFile, cleanup func()) {
+	tempDir, err := os.MkdirTemp("", "cliuploadtest*")
+	if err != nil {
+		panic(err)
+	}
+
+	dir, err = os.Open(tempDir)
+	if err != nil {
+		panic(err)
+	}
+	for _, file := range filesContent {
+		f, err := os.Create(tempDir + "/" + file.filename)
+		if err != nil {
+			panic(err)
+		}
+		files = append(files, lowlevel.UploadFile{
+			Path: file.filename,
+			File: f,
+		})
+	}
+
+	cleanup = func() {
+		// Close all opened files first
+		if dir != nil {
+			dir.Close()
+		}
+		for _, file := range files {
+			if file.File != nil {
+				file.File.Close()
+			}
+		}
+		// Remove the temporary directory and all its contents
+		if err := os.RemoveAll(tempDir); err != nil {
+			// Log error but don't panic in cleanup
+			fmt.Printf("failed to cleanup temp directory: %s\n", err.Error())
+		}
+	}
+
+	return dir, files, cleanup
+}

internal/fileupload/lowlevel/client.go

@@ -1,4 +1,4 @@
-package lowlevel_fileupload //nolint:revive // underscore naming is intentional for this internal package
+package lowlevel
 
 import (
 	"bytes"
@@ -14,23 +14,23 @@ import (
 	"github.com/snyk/error-catalog-golang-public/snyk_errors"
 )
 
-// Client defines the interface for file upload API operations.
-type Client interface {
+// SealableClient defines the interface for file upload API operations.
+type SealableClient interface {
 	CreateRevision(ctx context.Context, orgID OrgID) (*UploadRevisionResponseBody, error)
 	UploadFiles(ctx context.Context, orgID OrgID, revisionID RevisionID, files []UploadFile) error
 	SealRevision(ctx context.Context, orgID OrgID, revisionID RevisionID) (*SealUploadRevisionResponseBody, error)
 }
 
 // This will force go to complain if the type doesn't satisfy the interface.
-var _ Client = (*HTTPClient)(nil)
+var _ SealableClient = (*HTTPSealableClient)(nil)
 
 // Config contains configuration for the file upload client.
 type Config struct {
 	BaseURL string
 }
 
-// HTTPClient implements the Client interface for file upload operations via HTTP API.
-type HTTPClient struct {
+// HTTPSealableClient implements the SealableClient interface for file upload operations via HTTP API.
+type HTTPSealableClient struct {
 	cfg        Config
 	httpClient *http.Client
 }
@@ -48,8 +48,8 @@ const FileCountLimit = 100 // arbitrary number, will need to be re-evaluated
 const ContentType = "Content-Type"
 
 // NewClient creates a new file upload client with the given configuration and options.
-func NewClient(cfg Config, opts ...Opt) *HTTPClient {
-	c := HTTPClient{cfg, http.DefaultClient}
+func NewClient(cfg Config, opts ...Opt) *HTTPSealableClient {
+	c := HTTPSealableClient{cfg, http.DefaultClient}
 
 	for _, opt := range opts {
 		opt(&c)
@@ -59,7 +59,7 @@ func NewClient(cfg Config, opts ...Opt) *HTTPClient {
 }
 
 // CreateRevision creates a new upload revision for the specified organization.
-func (c *HTTPClient) CreateRevision(ctx context.Context, orgID OrgID) (*UploadRevisionResponseBody, error) {
+func (c *HTTPSealableClient) CreateRevision(ctx context.Context, orgID OrgID) (*UploadRevisionResponseBody, error) {
 	if orgID == uuid.Nil {
 		return nil, ErrEmptyOrgID
 	}
@@ -103,7 +103,7 @@ func (c *HTTPClient) CreateRevision(ctx context.Context, orgID OrgID) (*UploadRe
 }
 
 // UploadFiles uploads the provided files to the specified revision. It will not close the file descriptors.
-func (c *HTTPClient) UploadFiles(ctx context.Context, orgID OrgID, revisionID RevisionID, files []UploadFile) error {
+func (c *HTTPSealableClient) UploadFiles(ctx context.Context, orgID OrgID, revisionID RevisionID, files []UploadFile) error {
 	if orgID == uuid.Nil {
 		return ErrEmptyOrgID
 	}
@@ -165,7 +165,7 @@ func (c *HTTPClient) UploadFiles(ctx context.Context, orgID OrgID, revisionID Re
 	return nil
 }
 
-func (c *HTTPClient) streamFilesToPipe(pWriter *io.PipeWriter, mpartWriter *multipart.Writer, files []UploadFile) {
+func (c *HTTPSealableClient) streamFilesToPipe(pWriter *io.PipeWriter, mpartWriter *multipart.Writer, files []UploadFile) {
 	var streamError error
 	defer func() {
 		pWriter.CloseWithError(streamError)
@@ -189,7 +189,7 @@ func (c *HTTPClient) streamFilesToPipe(pWriter *io.PipeWriter, mpartWriter *mult
 }
 
 // SealRevision seals the specified upload revision, marking it as complete.
-func (c *HTTPClient) SealRevision(ctx context.Context, orgID OrgID, revisionID RevisionID) (*SealUploadRevisionResponseBody, error) {
+func (c *HTTPSealableClient) SealRevision(ctx context.Context, orgID OrgID, revisionID RevisionID) (*SealUploadRevisionResponseBody, error) {
 	if orgID == uuid.Nil {
 		return nil, ErrEmptyOrgID
 	}
@@ -237,7 +237,7 @@ func (c *HTTPClient) SealRevision(ctx context.Context, orgID OrgID, revisionID R
 	return &respBody, nil
 }
 
-func (c *HTTPClient) handleUnexpectedStatusCodes(body io.ReadCloser, statusCode int, status, operation string) error {
+func (c *HTTPSealableClient) handleUnexpectedStatusCodes(body io.ReadCloser, statusCode int, status, operation string) error {
 	bts, err := io.ReadAll(body)
 	if err != nil {
 		return fmt.Errorf("failed to read response body: %w", err)