Merge pull request #8 from alexandreh2ag/add_prefix_on_program

add prefix in template files

Author: alexandreh2ag

assets/templates/supervisor.tmpl

@@ -1,12 +1,12 @@
 [group:{{ groupName }}]
-programs={{ programs . }}
+programs={{ programs .  }}
 
 {{ range . }}
-[program:{{ .Id }}]
+[program:{{ .PrefixedName }}]
 directory = {{ .Directory }}
 autorestart = true
 autostart = true
 user = {{ .User }}
 command = {{ .Command }}
-environment = {{ envs . groupName }}
+environment = {{ envs . }}
 {{ end }}

cli/worker/generate.go

@@ -55,7 +55,7 @@ func GetWorkerGenerateRunFn(ctx *context.Context) func(*cobra.Command, []string)
 			return fmt.Errorf("missing mandatory arguments (--%s, --%s)", OutputPath, flags.GroupName)
 		}
 
-		types.PrepareWorkerTasks(ctx.Config.Workers, user, workingDir)
+		types.PrepareWorkerTasks(ctx.Config.Workers, groupName, user, workingDir)
 		ctx.Logger.Info(fmt.Sprintf("Generate format type %s", generate.FormatSupervisor))
 
 		return generate.Generate(ctx, outputPath, format, groupName)

generate/generate.go

@@ -80,17 +80,17 @@ func templateSupervisorFile(ctx *context.Context, writer io.Writer, groupName st
 func generateProgramList(workers types.WorkerTasks) string {
 	programs := []string{}
 	for _, task := range workers {
-		programs = append(programs, task.Id)
+		programs = append(programs, task.PrefixedName())
 	}
 	return strings.Join(programs, ",")
 }
 
-func generateEnvVars(worker types.WorkerTask, groupName string) string {
+func generateEnvVars(worker types.WorkerTask) string {
 	envVars := []string{}
-	envVars = append(envVars, fmt.Sprintf(`%s="%s"`, types.GtaskGroupNameKey, groupName))
+	envVars = append(envVars, fmt.Sprintf(`%s="%s"`, types.GtaskGroupNameKey, worker.GroupName))
 	envVars = append(envVars, fmt.Sprintf(`%s="%s"`, types.GtaskDirKey, worker.Directory))
 	envVars = append(envVars, fmt.Sprintf(`%s="%s"`, types.GtaskUserKey, worker.User))
-	envVars = append(envVars, fmt.Sprintf(`%s="%s"`, types.GtaskIDKey, worker.Id))
+	envVars = append(envVars, fmt.Sprintf(`%s="%s"`, types.GtaskIDKey, worker.PrefixedName()))
 
 	return strings.Join(envVars, ",")
 }

generate/generate_test.go

@@ -154,39 +154,40 @@ func TestGenerate_OK(t *testing.T) {
 
 func TestTemplateSupervisorFile_OK(t *testing.T) {
 	ctx := context.TestContext(io.Discard)
-
+	groupName := "test-group"
 	workers := types.WorkerTasks{
 		{
 			Id:        "test",
 			Command:   "fake",
+			GroupName: groupName,
 			User:      "toto",
 			Directory: "/tmp/dir",
 		},
 		{
 			Id:        "test2",
 			Command:   "fake",
+			GroupName: groupName,
 			User:      "toto",
 			Directory: "/tmp/dir",
 		},
 	}
-	groupName := "test-group"
 
 	expectedOutput := "[group:test-group]\n" +
-		"programs=test,test2\n\n\n" +
-		"[program:test]\n" +
+		"programs=test-group-test,test-group-test2\n\n\n" +
+		"[program:test-group-test]\n" +
 		"directory = /tmp/dir\n" +
 		"autorestart = true\n" +
 		"autostart = true\n" +
 		"user = toto\n" +
 		"command = fake\n" +
-		"environment = GTASK_GROUP_NAME=\"test-group\",GTASK_DIR=\"/tmp/dir\",GTASK_USER=\"toto\",GTASK_ID=\"test\"\n\n" +
-		"[program:test2]\n" +
+		"environment = GTASK_GROUP_NAME=\"test-group\",GTASK_DIR=\"/tmp/dir\",GTASK_USER=\"toto\",GTASK_ID=\"test-group-test\"\n\n" +
+		"[program:test-group-test2]\n" +
 		"directory = /tmp/dir\n" +
 		"autorestart = true\n" +
 		"autostart = true\n" +
 		"user = toto\n" +
 		"command = fake\n" +
-		"environment = GTASK_GROUP_NAME=\"test-group\",GTASK_DIR=\"/tmp/dir\",GTASK_USER=\"toto\",GTASK_ID=\"test2\"\n"
+		"environment = GTASK_GROUP_NAME=\"test-group\",GTASK_DIR=\"/tmp/dir\",GTASK_USER=\"toto\",GTASK_ID=\"test-group-test2\"\n"
 
 	ctx.Config.Workers = workers
 
@@ -199,22 +200,26 @@ func TestTemplateSupervisorFile_OK(t *testing.T) {
 }
 
 func TestGenerateProgramList(t *testing.T) {
+	prefix := "pref"
 	workers := types.WorkerTasks{
 		{
 			Id:        "test",
 			Command:   "fake",
 			User:      "toto",
 			Directory: "/tmp/dir",
+			GroupName: prefix,
 		},
 		{
 			Id:        "test2",
 			Command:   "fake",
 			User:      "toto",
 			Directory: "/tmp/dir",
+			GroupName: prefix,
 		},
 	}
+
 	output := generateProgramList(workers)
-	assert.Equal(t, output, "test,test2")
+	assert.Equal(t, output, prefix+"-test,"+prefix+"-test2")
 }
 
 func TestDeleteFile_OK(t *testing.T) {
@@ -276,16 +281,18 @@ func TestGenerate_NoErrorDeleteFile(t *testing.T) {
 }
 
 func TestGenerateEnvVars(t *testing.T) {
+	groupName := "group"
+
 	worker := types.WorkerTask{
 		Id:        "test2",
 		Command:   "fake",
 		User:      "toto",
+		GroupName: groupName,
 		Directory: "/tmp/dir",
 	}
-	groupName := "group"
-	output := generateEnvVars(worker, groupName)
+	output := generateEnvVars(worker)
 
 	assert.Equal(t,
-		fmt.Sprintf("GTASK_GROUP_NAME=\"%s\",GTASK_DIR=\"%s\",GTASK_USER=\"%s\",GTASK_ID=\"%s\"", groupName, worker.Directory, worker.User, worker.Id),
+		fmt.Sprintf("GTASK_GROUP_NAME=\"%s\",GTASK_DIR=\"%s\",GTASK_USER=\"%s\",GTASK_ID=\"%s\"", groupName, worker.Directory, worker.User, worker.PrefixedName()),
 		output)
 }

types/worker_task.go

@@ -1,16 +1,21 @@
 package types
 
+import "fmt"
+
 type WorkerTasks = []*WorkerTask
 
 type WorkerTask struct {
 	Id        string `mapstructure:"id" validate:"required,excludesall=!@#$ "`
 	Command   string `mapstructure:"command" validate:"required"`
+	GroupName string
 	User      string `mapstructure:"user" validate:"omitempty,required,alphanum"`
 	Directory string `mapstructure:"directory" validate:"omitempty,required,dirpath"`
 }
 
-func PrepareWorkerTasks(tasks WorkerTasks, user, workingDir string) {
+func PrepareWorkerTasks(tasks WorkerTasks, groupName, user, workingDir string) {
 	for _, task := range tasks {
+		task.GroupName = groupName
+
 		if task.User == "" {
 			task.User = user
 		}
@@ -20,3 +25,7 @@ func PrepareWorkerTasks(tasks WorkerTasks, user, workingDir string) {
 		}
 	}
 }
+
+func (w *WorkerTask) PrefixedName() string {
+	return fmt.Sprintf("%s-%s", w.GroupName, w.Id)
+}

types/worker_task_test.go

@@ -88,6 +88,7 @@ func TestPrepareWorkerTasks(t *testing.T) {
 		tasks      WorkerTasks
 		user       string
 		workingDir string
+		groupName  string
 	}
 	tests := []struct {
 		name string
@@ -99,6 +100,7 @@ func TestPrepareWorkerTasks(t *testing.T) {
 			args: args{
 				tasks:      WorkerTasks{},
 				user:       "foo",
+				groupName:  "bar",
 				workingDir: "/app/foo/",
 			},
 			want: WorkerTasks{},
@@ -107,22 +109,34 @@ func TestPrepareWorkerTasks(t *testing.T) {
 			name: "SuccessMultipleTasks",
 			args: args{
 				tasks: WorkerTasks{
-					&WorkerTask{Id: "test", Command: "cmd"},
-					&WorkerTask{Id: "test2", Command: "cmd", User: "bar", Directory: "/app/bar/"},
+					&WorkerTask{Id: "test", Command: "cmd", GroupName: "bar"},
+					&WorkerTask{Id: "test2", Command: "cmd", GroupName: "bar", User: "bar", Directory: "/app/bar/"},
 				},
 				user:       "foo",
+				groupName:  "bar",
 				workingDir: "/app/foo/",
 			},
 			want: WorkerTasks{
-				&WorkerTask{Id: "test", Command: "cmd", User: "foo", Directory: "/app/foo/"},
-				&WorkerTask{Id: "test2", Command: "cmd", User: "bar", Directory: "/app/bar/"},
+				&WorkerTask{Id: "test", Command: "cmd", GroupName: "bar", User: "foo", Directory: "/app/foo/"},
+				&WorkerTask{Id: "test2", Command: "cmd", GroupName: "bar", User: "bar", Directory: "/app/bar/"},
 			},
 		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			PrepareWorkerTasks(tt.args.tasks, tt.args.user, tt.args.workingDir)
+			PrepareWorkerTasks(tt.args.tasks, tt.args.groupName, tt.args.user, tt.args.workingDir)
 			assert.Equal(t, tt.want, tt.args.tasks)
 		})
 	}
 }
+
+func TestPrefixedName(t *testing.T) {
+	prefix := "group"
+	worker := WorkerTask{
+		Id:        "test",
+		Command:   "fake",
+		GroupName: prefix,
+	}
+
+	assert.Equal(t, worker.PrefixedName(), prefix+"-"+worker.Id)
+}