feat: option to name test cases

pkg/hooks/connection/factory.go

@@ -133,7 +133,7 @@ func capture(db platform.TestCaseDB, req *http.Request, resp *http.Response, log
 	// err = db.Insert(httpMock, getDeps())
 	err = db.WriteTestcase(&models.TestCase{
 		Version: models.V1Beta2,
-		Name:    "",
+		Name:    pkg.ToYamlHttpHeader(req.Header)["Keploy-Test-Name"],
 		Kind:    models.HTTP,
 		Created: time.Now().Unix(),
 		HttpReq: models.HttpReq{

pkg/platform/yaml/yaml.go

@@ -42,18 +42,22 @@
 // createYamlFile is used to create the yaml file along with the path directory (if does not exists)
 func createYamlFile(path string, fileName string, Logger *zap.Logger) (bool, error) {
 	// checks id the yaml exists
-	if _, err := os.Stat(filepath.Join(path, fileName+".yaml")); err != nil {
+	yamlPath, err := ValidatePath(filepath.Join(path, fileName + ".yaml"))
+	if err != nil {
+		return false, err
+	}
+	if _, err := os.Stat(yamlPath); err != nil {
 		// creates the path director if does not exists
 		err = os.MkdirAll(filepath.Join(path), fs.ModePerm)
 		if err != nil {
-			Logger.Error("failed to create a directory for the yaml file", zap.Error(err), zap.Any("path directory", path), zap.Any("yaml", fileName))
+			Logger.Error("failed to create a directory for the yaml file", zap.Error(err), zap.Any("path directory", path), zap.Any("yaml", fileName)) // lgtm [go/clear-text-logging]
 			return false, err
 		}
 
 		// create the yaml file
-		_, err := os.Create(filepath.Join(path, fileName+".yaml"))
+		_, err := os.Create(yamlPath)
 		if err != nil {
-			Logger.Error("failed to create a yaml file", zap.Error(err), zap.Any("path directory", path), zap.Any("yaml", fileName))
+			Logger.Error("failed to create a yaml file", zap.Error(err), zap.Any("path directory", path), zap.Any("yaml", fileName)) // lgtm [go/clear-text-logging]
 			return false, err
 		}
 
@@ -122,9 +126,15 @@
 	if err != nil {
 		return err
 	}
-	file, err := os.OpenFile(filepath.Join(path, fileName+".yaml"), os.O_CREATE|os.O_WRONLY|os.O_APPEND, os.ModePerm)
+
+	yamlPath, err := ValidatePath(filepath.Join(path, fileName+".yaml"))
+	if err != nil {
+		return err 
+	}
+
+	file, err := os.OpenFile(yamlPath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, os.ModePerm)
 	if err != nil {
-		ys.Logger.Error("failed to open the created yaml file", zap.Error(err), zap.Any("yaml file name", fileName))
+		ys.Logger.Error("failed to open the created yaml file", zap.Error(err), zap.Any("yaml file name", fileName)) // lgtm [go/clear-text-logging]
 		return err
 	}
 
@@ -134,14 +144,14 @@
 	}
 	d, err := yamlLib.Marshal(&doc)
 	if err != nil {
-		ys.Logger.Error("failed to marshal the recorded calls into yaml", zap.Error(err), zap.Any("yaml file name", fileName))
+		ys.Logger.Error("failed to marshal the recorded calls into yaml", zap.Error(err), zap.Any("yaml file name", fileName)) // lgtm [go/clear-text-logging]
 		return err
 	}
 	data = append(data, d...)
 
 	_, err = file.Write(data)
 	if err != nil {
-		ys.Logger.Error("failed to write the yaml document", zap.Error(err), zap.Any("yaml file name", fileName))
+		ys.Logger.Error("failed to write the yaml document", zap.Error(err), zap.Any("yaml file name", fileName)) // lgtm [go/clear-text-logging]
 		return err
 	}
 	defer file.Close()
@@ -159,7 +169,11 @@
 		if err != nil {
 			return err
 		}
-		tcsName = fmt.Sprintf("test-%v", lastIndx)
+		if tc.Name == "" {
+			tcsName = fmt.Sprintf("test-%v", lastIndx)
+		} else {
+			tcsName = tc.Name
+		}
 	} else {
 		tcsName = ys.TcsName
 	}
@@ -178,7 +192,7 @@
 		ys.Logger.Error("failed to write testcase yaml file", zap.Error(err))
 		return err
 	}
-	ys.Logger.Info("🟠 Keploy has captured test cases for the user's application.", zap.String("path", ys.TcsPath), zap.String("testcase name", tcsName))
+	ys.Logger.Info("🟠 Keploy has captured test cases for the user's application.", zap.String("path", ys.TcsPath), zap.String("testcase name", tcsName)) // lgtm [go/clear-text-logging]
 
 	// write the mock yamls
 	// mockName := fmt.Sprintf("mock-%v", lastIndx)
@@ -374,4 +388,4 @@
 
 	return configMocks, tcsMocks, nil
 
-}
+}