Allow override of Task and Template git_branch

.dredd/hooks/capabilities.go

@@ -125,6 +125,7 @@ func resolveCapability(caps []string, resolved []string, uid string) {
 		case "template":
 			args := "[]"
 			desc := "Hello, World!"
+			branch := "main"
 			res, err := store.CreateTemplate(db.Template{
 				ProjectID:               userProject.ID,
 				InventoryID:             &inventoryID,
@@ -137,6 +138,7 @@ func resolveCapability(caps []string, resolved []string, uid string) {
 				Description:             &desc,
 				ViewID:                  &view.ID,
 				App:                     db.AppAnsible,
+				GitBranch:               &branch,
 			})
 
 			printError(err)

api-docs.yml

@@ -652,6 +652,11 @@ definitions:
         type: string
       limit:
         type: string
+      git_branch:
+        type:
+          - string
+          - 'null'
+
   TaskOutput:
     type: object
     properties:
@@ -711,6 +716,9 @@ definitions:
       app:
         type: string
         example: ansible
+      git_branch:
+        type: string
+        example: main
       survey_vars:
         type: array
         items:
@@ -754,6 +762,9 @@ definitions:
         type: boolean
       app:
         type: string
+      git_branch:
+        type: string
+        example: main
   TemplateSurveyVar:
     type: object
     properties:
@@ -2164,6 +2175,8 @@ paths:
                 type: string
               limit:
                 type: string
+              git_branch:
+                type: string
       responses:
         201:
           description: Task queued

db/Migration.go

@@ -73,6 +73,7 @@ func GetMigrations() []Migration {
 		{Version: "2.10.16"},
 		{Version: "2.10.24"},
 		{Version: "2.10.26"},
+		{Version: "2.10.28"},
 	}
 }
 

db/Task.go

@@ -27,6 +27,7 @@ type Task struct {
 	Limit       string  `db:"hosts_limit" json:"limit"`
 	Secret      string  `db:"-" json:"secret"`
 	Arguments   *string `db:"arguments" json:"arguments"`
+	GitBranch   *string `db:"git_branch" json:"git_branch"`
 
 	UserID        *int `db:"user_id" json:"user_id"`
 	IntegrationID *int `db:"integration_id" json:"integration_id"`

db/Template.go

@@ -88,6 +88,9 @@ type Template struct {
 
 	Autorun bool `db:"autorun" json:"autorun"`
 
+	// override variables
+	GitBranch *string `db:"git_branch" json:"git_branch"`
+
 	// SurveyVarsJSON used internally for read from database.
 	// It is not used for store survey vars to database.
 	// Do not use it in your code. Use SurveyVars instead.

db/sql/migrations/v2.10.28.sql

@@ -0,0 +1,3 @@
+alter table task add git_branch varchar(255);
+
+alter table project__template add git_branch varchar(255);

db/sql/template.go

@@ -18,8 +18,8 @@ func (d *SqlDb) CreateTemplate(template db.Template) (newTemplate db.Template, e
 		"id",
 		"insert into project__template (project_id, inventory_id, repository_id, environment_id, "+
 			"name, playbook, arguments, allow_override_args_in_task, description, `type`, start_version,"+
-			"build_template_id, view_id, autorun, survey_vars, suppress_success_alerts, app)"+
-			"values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
+			"build_template_id, view_id, autorun, survey_vars, suppress_success_alerts, app, git_branch)"+
+			"values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
 		template.ProjectID,
 		template.InventoryID,
 		template.RepositoryID,
@@ -36,7 +36,8 @@ func (d *SqlDb) CreateTemplate(template db.Template) (newTemplate db.Template, e
 		template.Autorun,
 		db.ObjectToJSON(template.SurveyVars),
 		template.SuppressSuccessAlerts,
-		template.App)
+		template.App,
+		template.GitBranch)
 
 	if err != nil {
 		return
@@ -82,7 +83,8 @@ func (d *SqlDb) UpdateTemplate(template db.Template) error {
 		"autorun=?, "+
 		"survey_vars=?, "+
 		"suppress_success_alerts=?, "+
-		"app=? "+
+		"app=?, "+
+		"`git_branch`=? "+
 		"where id=? and project_id=?",
 		template.InventoryID,
 		template.RepositoryID,
@@ -100,6 +102,7 @@ func (d *SqlDb) UpdateTemplate(template db.Template) error {
 		db.ObjectToJSON(template.SurveyVars),
 		template.SuppressSuccessAlerts,
 		template.App,
+		template.GitBranch,
 		template.ID,
 		template.ProjectID,
 	)
@@ -127,13 +130,15 @@ func (d *SqlDb) GetTemplates(projectID int, filter db.TemplateFilter, params db.
 		"pt.repository_id",
 		"pt.environment_id",
 		"pt.name",
+		"pt.description",
 		"pt.playbook",
 		"pt.arguments",
 		"pt.allow_override_args_in_task",
 		"pt.build_template_id",
 		"pt.start_version",
 		"pt.view_id",
 		"pt.`app`",
+		"pt.`git_branch`",
 		"pt.survey_vars",
 		"pt.start_version",
 		"pt.`type`",

services/tasks/LocalJob.go

@@ -465,6 +465,16 @@ func (t *LocalJob) prepareRun() error {
 		return err
 	}
 
+	// Override git branch from template if set
+	if t.Template.GitBranch != nil && *t.Template.GitBranch != "" {
+		t.Repository.GitBranch = *t.Template.GitBranch
+	}
+
+	// Override git branch from task if set
+	if t.Task.GitBranch != nil && *t.Task.GitBranch != "" {
+		t.Repository.GitBranch = *t.Task.GitBranch
+	}
+
 	if t.Repository.GetType() == db.RepositoryLocal {
 		if _, err := os.Stat(t.Repository.GitURL); err != nil {
 			t.Log("Failed in finding static repository at " + t.Repository.GitURL + ": " + err.Error())