#154 hotfix saved config paths are not multiplatform (#157)

* Hotfix path gen

* Hotfix path gen, check for escape characters

* Added tests for new function

* Removed unecessary cases

* Removed unecessary cases and updated tests

* Adding fix

* Adding fix

* Removed unrelated changes

* Removed unrelated changes

* updating test

* updating test

* test push

* test push

* Push fix Different os returning different results

* use filepath instead of path

* fixed path uniformize method

* fixed error display

---------

Co-authored-by: Rayan MARMAR <[email protected]>

cmd/model/add.go

@@ -37,6 +37,7 @@ func init() {
 func runAdd(cmd *cobra.Command, args []string) {
 	err := addController.Run(args, customArgs)
 	if err != nil {
+		app.UI().Error().Println(err.Error())
 		os.Exit(1)
 	}
 }

internal/config/models_test.go

@@ -10,7 +10,6 @@ import (
 	"github.com/easy-model-fusion/emf-cli/test/mock"
 	"gopkg.in/yaml.v3"
 	"os"
-	"path"
 	"path/filepath"
 	"testing"
 
@@ -579,9 +578,9 @@ func TestValidate_DownloadedAndBinaryFalse_ConfirmFalse(t *testing.T) {
 	test.AssertEqual(t, err, nil, "Error while loading configuration file.")
 
 	// Create a temporary directory representing the model base path
-	modelName := path.Join("microsoft", "phi-2")
-	modelDirectory := path.Join(app.DownloadDirectoryPath, modelName)
-	modelPath := path.Join(modelDirectory, "model")
+	modelName := filepath.Join("microsoft", "phi-2")
+	modelDirectory := filepath.Join(app.DownloadDirectoryPath, modelName)
+	modelPath := filepath.Join(modelDirectory, "model")
 	err = os.MkdirAll(modelPath, 0750)
 	if err != nil {
 		t.Fatal(err)
@@ -617,9 +616,9 @@ func TestValidate_DownloadedAndBinaryFalse_ConfirmTrueAndRemove(t *testing.T) {
 	test.AssertEqual(t, err, nil, "Error while loading configuration file.")
 
 	// Create a temporary directory representing the model base path
-	modelName := path.Join("microsoft", "phi-2")
-	modelDirectory := path.Join(app.DownloadDirectoryPath, modelName)
-	modelPath := path.Join(modelDirectory, "model")
+	modelName := filepath.Join("microsoft", "phi-2")
+	modelDirectory := filepath.Join(app.DownloadDirectoryPath, modelName)
+	modelPath := filepath.Join(modelDirectory, "model")
 	err = os.MkdirAll(modelPath, 0750)
 	if err != nil {
 		t.Fatal(err)
@@ -660,9 +659,9 @@ func TestValidate_Downloaded_ConfirmFalse(t *testing.T) {
 	test.AssertEqual(t, err, nil, "Error while loading configuration file.")
 
 	// Create a temporary directory representing the model base path
-	modelName := path.Join("microsoft", "phi-2")
-	modelDirectory := path.Join(app.DownloadDirectoryPath, modelName)
-	modelPath := path.Join(modelDirectory, "model")
+	modelName := filepath.Join("microsoft", "phi-2")
+	modelDirectory := filepath.Join(app.DownloadDirectoryPath, modelName)
+	modelPath := filepath.Join(modelDirectory, "model")
 	err = os.MkdirAll(modelPath, 0750)
 	if err != nil {
 		t.Fatal(err)
@@ -698,9 +697,9 @@ func TestValidate_Downloaded_ConfirmTrue(t *testing.T) {
 	test.AssertEqual(t, err, nil, "Error while loading configuration file.")
 
 	// Create a temporary directory representing the model base path
-	modelName := path.Join("microsoft", "phi-2")
-	modelDirectory := path.Join(app.DownloadDirectoryPath, modelName)
-	modelPath := path.Join(modelDirectory, "model")
+	modelName := filepath.Join("microsoft", "phi-2")
+	modelDirectory := filepath.Join(app.DownloadDirectoryPath, modelName)
+	modelPath := filepath.Join(modelDirectory, "model")
 	err = os.MkdirAll(modelPath, 0750)
 	if err != nil {
 		t.Fatal(err)

internal/controller/build.go

@@ -17,7 +17,7 @@ import (
 	"os"
 	"os/exec"
 	"os/signal"
-	"path"
+	"path/filepath"
 	"strings"
 	"syscall"
 	"time"
@@ -193,7 +193,7 @@ func (bc BuildController) Build(libraryPath string) (err error) {
 func (bc BuildController) createModelsSymbolicLink() error {
 	// Create symbolic link to models
 	modelsPath := "models"
-	distPath := path.Join(bc.DestinationDir, "models")
+	distPath := filepath.Join(bc.DestinationDir, "models")
 
 	app.UI().Info().Println(fmt.Sprintf("Creating symbolic link from %s to %s", modelsPath, distPath))
 

internal/controller/model/add.go

@@ -34,7 +34,6 @@ func (ac AddController) Run(args []string, customArgs downloadermodel.Args) erro
 	var result resultutil.ExecutionResult
 	warnings, err := ac.processAdd(selectedModel, customArgs)
 	result.AddWarnings(warnings)
-	result.SetError(err)
 	result.Display("Operation succeeded", "Operation failed")
 
 	return err

internal/model/generation.go

@@ -3,6 +3,7 @@ package model
 import (
 	"fmt"
 	"github.com/easy-model-fusion/emf-cli/internal/codegen"
+	"github.com/easy-model-fusion/emf-cli/internal/utils/stringutil"
 	"github.com/easy-model-fusion/emf-cli/pkg/huggingface"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
@@ -87,7 +88,7 @@ func (m *Model) GenFile() *codegen.File {
 // GenModelPath returns the model path to be used in the code generation
 func (m *Model) GenModelPath() string {
 	if m.IsDownloaded {
-		return m.Path
+		return stringutil.PathUniformize(m.Path)
 	}
 	return m.Name
 }

internal/model/model.go

@@ -5,7 +5,7 @@ import (
 	"github.com/easy-model-fusion/emf-cli/internal/utils/dotenv"
 	"github.com/easy-model-fusion/emf-cli/internal/utils/stringutil"
 	"github.com/easy-model-fusion/emf-cli/pkg/huggingface"
-	"path"
+	"path/filepath"
 	"strings"
 )
 
@@ -194,7 +194,7 @@ func (m Models) FilterWithAddToBinaryFileTrue() Models {
 
 // GetBasePath return the base path to the model
 func (m *Model) GetBasePath() string {
-	return path.Join(app.DownloadDirectoryPath, m.Name)
+	return filepath.Join(app.DownloadDirectoryPath, m.Name)
 }
 
 // UpdatePaths to update the model's path to elements accordingly to its configuration.
@@ -203,9 +203,9 @@ func (m *Model) UpdatePaths() {
 		basePath := m.GetBasePath()
 		modelPath := basePath
 		if m.Module == huggingface.TRANSFORMERS {
-			modelPath = path.Join(modelPath, "model")
+			modelPath = filepath.Join(modelPath, "model")
 			for i, tokenizer := range m.Tokenizers {
-				m.Tokenizers[i].Path = path.Join(basePath, tokenizer.Class)
+				m.Tokenizers[i].Path = filepath.Join(basePath, tokenizer.Class)
 			}
 		}
 		m.Path = modelPath

internal/model/model_test.go

@@ -5,7 +5,7 @@ import (
 	"github.com/easy-model-fusion/emf-cli/internal/app"
 	"github.com/easy-model-fusion/emf-cli/pkg/huggingface"
 	"github.com/easy-model-fusion/emf-cli/test"
-	"path"
+	"path/filepath"
 	"testing"
 )
 
@@ -289,7 +289,7 @@ func TestGetBasePath(t *testing.T) {
 	basePath := model.GetBasePath()
 
 	// Assert
-	test.AssertEqual(t, basePath, path.Join(app.DownloadDirectoryPath, model.Name))
+	test.AssertEqual(t, basePath, filepath.Join(app.DownloadDirectoryPath, model.Name))
 }
 
 // TestUpdatePaths_Default tests the Model.UpdatePaths for a default model.
@@ -301,7 +301,7 @@ func TestUpdatePaths_Default(t *testing.T) {
 	model.UpdatePaths()
 
 	// Assert
-	test.AssertEqual(t, model.Path, path.Join(app.DownloadDirectoryPath, model.Name))
+	test.AssertEqual(t, model.Path, filepath.Join(app.DownloadDirectoryPath, model.Name))
 }
 
 // TestUpdatePaths_Transformers tests the Model.UpdatePaths for a transformers model.
@@ -314,7 +314,7 @@ func TestUpdatePaths_Transformers(t *testing.T) {
 	model.UpdatePaths()
 
 	// Assert
-	test.AssertEqual(t, model.Path, path.Join(app.DownloadDirectoryPath, model.Name, "model"))
+	test.AssertEqual(t, model.Path, filepath.Join(app.DownloadDirectoryPath, model.Name, "model"))
 }
 
 // TestUpdatePaths_TransformersTokenizers tests the Model.UpdatePaths for a transformers model.
@@ -328,7 +328,7 @@ func TestUpdatePaths_TransformersTokenizers(t *testing.T) {
 	model.UpdatePaths()
 
 	// Assert
-	test.AssertEqual(t, model.Tokenizers[0].Path, path.Join(app.DownloadDirectoryPath, model.Name, "tokenizer"))
+	test.AssertEqual(t, model.Tokenizers[0].Path, filepath.Join(app.DownloadDirectoryPath, model.Name, "tokenizer"))
 }
 
 // TestFilterWithClass_Success tests the Tokenizers.FilterWithClass function to return the correct models.

internal/model/utils.go

@@ -8,7 +8,6 @@ import (
 	"github.com/easy-model-fusion/emf-cli/internal/utils/stringutil"
 	"github.com/easy-model-fusion/emf-cli/pkg/huggingface"
 	"os"
-	"path"
 	"path/filepath"
 	"strings"
 )
@@ -118,7 +117,7 @@ func BuildModelsFromDevice(accessToken string) Models {
 		}
 
 		// Get all the models for the provider
-		providerPath := path.Join(app.DownloadDirectoryPath, provider.Name())
+		providerPath := filepath.Join(app.DownloadDirectoryPath, provider.Name())
 		providerModels, err := os.ReadDir(providerPath)
 		if err != nil {
 			continue
@@ -133,8 +132,8 @@ func BuildModelsFromDevice(accessToken string) Models {
 			}
 
 			// Model info
-			modelName := path.Join(provider.Name(), providerModel.Name())
-			modelPath := path.Join(providerPath, providerModel.Name())
+			modelName := filepath.Join(provider.Name(), providerModel.Name())
+			modelPath := filepath.Join(providerPath, providerModel.Name())
 
 			// Fetching model from huggingface
 			huggingfaceModel, err := app.H().GetModelById(modelName, accessToken)
@@ -181,15 +180,15 @@ func BuildModelsFromDevice(accessToken string) Models {
 
 					// Model folder exists : meaning the model is downloaded
 					if directory.Name() == "model" {
-						modelMapped.Path = path.Join(modelPath, "model")
+						modelMapped.Path = filepath.Join(modelPath, "model")
 						modelMapped.AddToBinaryFile = true
 						modelMapped.IsDownloaded = true
 						continue
 					}
 
 					// Otherwise : directory is considered as a tokenizer
 					tokenizer := Tokenizer{
-						Path:  path.Join(modelPath, directory.Name()),
+						Path:  filepath.Join(modelPath, directory.Name()),
 						Class: directory.Name(),
 					}
 					modelMapped.Tokenizers = append(modelMapped.Tokenizers, tokenizer)

internal/model/utils_test.go

@@ -10,7 +10,6 @@ import (
 	"github.com/easy-model-fusion/emf-cli/test/mock"
 	"github.com/pterm/pterm"
 	"os"
-	"path"
 	"path/filepath"
 	"testing"
 
@@ -83,9 +82,9 @@ func TestDownloadedOnDevice_True(t *testing.T) {
 // TestModelDownloadedOnDevice_UseBasePath_True tests the ModelDownloadedOnDevice function to return true.
 func TestModelDownloadedOnDevice_UseBasePath_True(t *testing.T) {
 	// Create a temporary directory representing the model base path
-	modelName := path.Join("microsoft", "phi-2")
-	modelDirectory := path.Join(app.DownloadDirectoryPath, modelName)
-	modelPath := path.Join(modelDirectory, "model")
+	modelName := filepath.Join("microsoft", "phi-2")
+	modelDirectory := filepath.Join(app.DownloadDirectoryPath, modelName)
+	modelPath := filepath.Join(modelDirectory, "model")
 	err := os.MkdirAll(modelPath, 0750)
 	if err != nil {
 		t.Fatal(err)
@@ -243,7 +242,7 @@ func TestGetTokenizersNotDownloadedOnDevice_NotMissing(t *testing.T) {
 // TestBuildModelsFromDevice_Custom tests the BuildModelsFromDevice function to work for custom configured models.
 func TestBuildModelsFromDevice_Custom(t *testing.T) {
 	// Create a temporary directory representing the path to the custom model
-	modelPath := path.Join(app.DownloadDirectoryPath, "custom-provider", "custom-model")
+	modelPath := filepath.Join(app.DownloadDirectoryPath, "custom-provider", "custom-model")
 	modelPath = filepath.ToSlash(modelPath)
 	err := os.MkdirAll(modelPath, 0750)
 	if err != nil {
@@ -267,7 +266,7 @@ func TestBuildModelsFromDevice_Custom(t *testing.T) {
 // TestBuildModelsFromDevice_HuggingfaceEmpty tests the BuildModelsFromDevice function to work for huggingface empty models.
 func TestBuildModelsFromDevice_HuggingfaceEmpty(t *testing.T) {
 	// Create a temporary directory representing the path to the model which is empty
-	modelDirectoryPath := path.Join(app.DownloadDirectoryPath, "stabilityai", "sdxl-turbo")
+	modelDirectoryPath := filepath.Join(app.DownloadDirectoryPath, "stabilityai", "sdxl-turbo")
 	err := os.MkdirAll(modelDirectoryPath, 0750)
 	if err != nil {
 		t.Fatal(err)
@@ -285,9 +284,9 @@ func TestBuildModelsFromDevice_HuggingfaceEmpty(t *testing.T) {
 // TestBuildModelsFromDevice_HuggingfaceDiffusers tests the BuildModelsFromDevice function to work for huggingface diffusers models.
 func TestBuildModelsFromDevice_HuggingfaceDiffusers(t *testing.T) {
 	// Create a temporary directory representing the path to the diffusers model which is not empty
-	modelName := path.Join("stabilityai", "sdxl-turbo")
-	modelDirectory := path.Join(app.DownloadDirectoryPath, modelName)
-	err := os.MkdirAll(path.Join(modelDirectory, "not-empty"), 0750)
+	modelName := filepath.Join("stabilityai", "sdxl-turbo")
+	modelDirectory := filepath.Join(app.DownloadDirectoryPath, modelName)
+	err := os.MkdirAll(filepath.Join(modelDirectory, "not-empty"), 0750)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -311,9 +310,9 @@ func TestBuildModelsFromDevice_HuggingfaceDiffusers(t *testing.T) {
 // TestBuildModelsFromDevice_HuggingfaceTransformers tests the BuildModelsFromDevice function to work for huggingface transformers models.
 func TestBuildModelsFromDevice_HuggingfaceTransformers(t *testing.T) {
 	// Create a temporary directory representing the path to the transformers model
-	modelName := path.Join("microsoft", "phi-2")
-	modelDirectory := path.Join(app.DownloadDirectoryPath, modelName)
-	modelPath := path.Join(modelDirectory, "model")
+	modelName := filepath.Join("microsoft", "phi-2")
+	modelDirectory := filepath.Join(app.DownloadDirectoryPath, modelName)
+	modelPath := filepath.Join(modelDirectory, "model")
 	err := os.MkdirAll(modelPath, 0750)
 	if err != nil {
 		t.Fatal(err)

internal/utils/stringutil/string.go

@@ -30,17 +30,30 @@ func SplitPath(path string) []string {
 	return elements
 }
 
-// PathUniformize returns uniformized path regarding the device OS.
-func PathUniformize(path string) string {
-	// Replace backslashes with forward slashes
-	path = strings.ReplaceAll(path, "\\", "/")
+// PathRemoveSpecialCharacter adds a slash before a special character
+func PathRemoveSpecialCharacter(path string) string {
+	//List of special characters that need to be escaped
+	specialChars := map[string]string{
+		"\\": "/",
+	}
 
-	// Resolve dots and double slashes
-	path = filepath.Clean(path)
+	// Replace special characters with their escaped form
+	for oldChar, newChar := range specialChars {
+		if strings.Contains(path, oldChar) {
+			path = strings.ReplaceAll(path, oldChar, newChar)
+		}
+	}
 
 	return path
 }
 
+// PathUniformize returns uniformized path regarding the device OS.
+func PathUniformize(path string) string {
+	path = filepath.Clean(path)
+	// Replace backslashes with forward slashes
+	return filepath.ToSlash(path)
+}
+
 // ParseOptions parses a string containing options in various formats
 // Returns a slice of strings where each string represents an option.
 func ParseOptions(input string) []string {

internal/utils/stringutil/string_test.go

@@ -2,7 +2,6 @@ package stringutil
 
 import (
 	"github.com/easy-model-fusion/emf-cli/test"
-	"path/filepath"
 	"testing"
 )
 
@@ -48,24 +47,24 @@ func TestPathUniformize_Success(t *testing.T) {
 		input    string
 		expected string
 	}{
-		{"C:\\path\\to\\file", "C:/path/to/file"},
-		{"C:\\path\\to\\..\\file", "C:/path/file"},
-		{"C:\\path\\to\\dir\\..\\file", "C:/path/to/file"},
-		{"C:\\path\\with\\double\\\\slashes", "C:/path/with/double/slashes"},
-		{"C:\\path\\with\\dots\\..", "C:/path/with"},
-		{"C:\\path\\with\\dots\\..\\..", "C:/path"},
-		{"C:\\path\\with\\dots\\.", "C:/path/with/dots"},
-		{"C:\\path\\with\\dots\\.\\.", "C:/path/with/dots"},
-		{"C:\\path\\with\\dots\\.\\.\\..", "C:/path/with"},
-		{"C:\\path\\with\\dots\\.\\.\\..\\file", "C:/path/with/file"},
+		{"C:/path/to/file", "C:/path/to/file"},
+		{"C:/path/to/../file", "C:/path/file"},
+		{"C:/path/to/dir/../file", "C:/path/to/file"},
+		{"C:/path/with/double/slashes", "C:/path/with/double/slashes"},
+		{"C:/path/with/dots/..", "C:/path/with"},
+		{"C:/path/with/dots/../..", "C:/path"},
+		{"C:/path/with/dots/.", "C:/path/with/dots"},
+		{"C:/path/with/dots/./.", "C:/path/with/dots"},
+		{"C:/path/with/dots/././..", "C:/path/with"},
+		{"C:/path/with/dots/././../file", "C:/path/with/file"},
 	}
 
 	for _, item := range items {
 		// Execute
 		result := PathUniformize(item.input)
 
 		// Assert
-		test.AssertEqual(t, result, filepath.Clean(item.expected))
+		test.AssertEqual(t, result, item.expected)
 	}
 }
 
@@ -162,3 +161,14 @@ func TestOptionsMapToSlice(t *testing.T) {
 	test.AssertEqual(t, SliceContainsItem(optionsSlice, "key3=module.value"), true)
 	test.AssertEqual(t, SliceContainsItem(optionsSlice, "key4='text'"), true)
 }
+
+func TestPathRemoveSpecialCharacter(t *testing.T) {
+	// Init
+	testPath := "models\\FredZhang7\\anime-anything-promptgen-v2\\model"
+
+	// Execute
+	updatedPath := PathRemoveSpecialCharacter(testPath)
+	expectedPath := "models/FredZhang7/anime-anything-promptgen-v2/model"
+
+	test.AssertEqual(t, updatedPath, expectedPath)
+}