Merge pull request #1846 from tothakos-code/develop

Add secret survey var type, for passwords

api-docs.yml

@@ -644,6 +644,8 @@ definitions:
  type: string
  environment:
  type: string
+ secret:
+ type: string
  limit:
  type: string
  TaskOutput:

db/Task.go

@@ -24,6 +24,7 @@ type Task struct {
  Playbook string `db:"playbook" json:"playbook"`
  Environment string `db:"environment" json:"environment"`
  Limit string `db:"hosts_limit" json:"limit"`
+ Secret string `db:"-" json:"secret"`
 
  UserID *int `db:"user_id" json:"user_id"`
 

services/tasks/LocalJob.go

@@ -5,6 +5,7 @@ import (
  "fmt"
  "os"
  "strconv"
+ "maps"
 
  "github.com/ansible-semaphore/semaphore/db"
  "github.com/ansible-semaphore/semaphore/db_lib"
@@ -19,6 +20,7 @@ type LocalJob struct {
  Inventory db.Inventory
  Repository db.Repository
  Environment db.Environment
+ Secret string
  Logger task_logger.Logger
 
  App db_lib.LocalApp
@@ -90,13 +92,23 @@ func (t *LocalJob) getEnvironmentExtraVars(username string, incomingVersion *str
 
 func (t *LocalJob) getEnvironmentExtraVarsJSON(username string, incomingVersion *string) (str string, err error) {
  extraVars := make(map[string]interface{})
+ extraSecretVars := make(map[string]interface{})
 
  if t.Environment.JSON != "" {
  err = json.Unmarshal([]byte(t.Environment.JSON), &extraVars)
  if err != nil {
  return
  }
  }
+ if t.Secret != "" {
+ err = json.Unmarshal([]byte(t.Secret), &extraSecretVars)
+ if err != nil {
+ return
+ }
+ }
+ t.Secret = "{}"
+
+ maps.Copy(extraVars, extraSecretVars)
 
  taskDetails := make(map[string]interface{})
 

services/tasks/TaskPool.go

@@ -318,6 +318,8 @@ func (p *TaskPool) AddTask(taskObj db.Task, userID *int, projectID int) (newTask
  taskObj.Status = task_logger.TaskWaitingStatus
  taskObj.UserID = userID
  taskObj.ProjectID = projectID
+ extraSecretVars := taskObj.Secret
+ taskObj.Secret = "{}"
 
  tpl, err := p.store.GetTemplate(projectID, taskObj.TemplateID)
  if err != nil {
@@ -375,6 +377,7 @@ func (p *TaskPool) AddTask(taskObj db.Task, userID *int, projectID int) (newTask
  Inventory: taskRunner.Inventory,
  Repository: taskRunner.Repository,
  Environment: taskRunner.Environment,
+ Secret: extraSecretVars,
  Logger: app.SetLogger(&taskRunner),
  App: app,
  }

web/src/components/SurveyVars.vue

@@ -180,6 +180,9 @@ export default {
  }, {
  id: 'int',
  name: 'Integer',
+ }, {
+ id: 'secret',
+ name: 'Secret',
  }, {
  id: 'enum',
  name: 'Enum',

web/src/components/TaskForm.vue

@@ -46,9 +46,22 @@
  />
 
  <div v-for="(v) in template.survey_vars || []" :key="v.name">
+
+ <v-text-field
+ v-if="v.type === 'secret'"
+ :label="v.title"
+ :hint="v.description"
+ v-model="editedSecretEnvironment[v.name]"
+ :required="v.required"
+ type="password"
+ :rules="[
+ val => !v.required || !!val || v.title + $t('isRequired'),
+ ]"
+ />
+
  <v-select
  clearable
- v-if="v.type === 'enum'"
+ v-else-if="v.type === 'enum'"
  :label="v.title + (v.required ? ' *' : '')"
  :hint="v.description"
  v-model="editedEnvironment[v.name]"
@@ -60,6 +73,7 @@
  item-text="name"
  item-value="value"
  />
+
  <v-text-field
  v-else
  :label="v.title + (v.required ? ' *' : '')"
@@ -169,6 +183,7 @@ export default {
  buildTasks: null,
  commitAvailable: null,
  editedEnvironment: null,
+ editedSecretEnvironment: null,
  cmOptions: {
  tabSize: 2,
  mode: 'application/json',
@@ -228,6 +243,7 @@ export default {
  });
 
  this.editedEnvironment = JSON.parse(v.environment || '{}');
+ this.editedSecretEnvironment = JSON.parse(v.secret || '{}');
  this.commitAvailable = v.commit_hash != null;
  },
 
@@ -239,6 +255,7 @@ export default {
 
  beforeSave() {
  this.item.environment = JSON.stringify(this.editedEnvironment);
+ this.item.secret = JSON.stringify(this.editedSecretEnvironment);
  },
 
  async afterLoadData() {