add custom marshaller for env vars to hide them in the UI

pkg/job.go

@@ -40,7 +40,7 @@ type JobSpec struct {
 
 	Name             string            `json:"name"`
 	Retries          int               `yaml:"retries,omitempty" json:"retries,omitempty"`
-	Env              map[string]string `yaml:"env,omitempty"`
+	Env              map[string]secret `yaml:"env,omitempty"`
 	WorkingDirectory string            `yaml:"working_directory,omitempty" json:"working_directory,omitempty"`
 	globalSchedule   *Schedule
 	Runs             []JobRun `json:"runs" yaml:"-"`
@@ -50,6 +50,13 @@ type JobSpec struct {
 	cfg      Config
 }
 
+type secret string
+
+// custom marshaller to hide secrets
+func (secret) MarshalText() ([]byte, error) {
+	return []byte("***"), nil
+}
+
 // JobRun holds information about a job execution.
 type JobRun struct {
 	LogEntryId  int  `json:"id,omitempty" db:"id"`

pkg/job_test.go

@@ -2,6 +2,7 @@ package cheek
 
 import (
 	"bytes"
+	"encoding/json"
 	"fmt"
 	"io"
 	"log"
@@ -317,7 +318,7 @@ func TestJobWithBashEval(t *testing.T) {
 			"bash", "-c", "MY_VAR=$(date +%Y-%m); echo $MY_VAR $FOO",
 		},
 		// add random Env to check if it passes through
-		Env: map[string]string{
+		Env: map[string]secret{
 			"FOO": "BAR",
 		},
 		cfg: NewConfig(),
@@ -407,3 +408,19 @@ func TestExecCommandExitError(t *testing.T) {
 	assert.NotNil(t, result.Duration, "Expected duration to be set")
 	assert.GreaterOrEqual(t, result.Duration.Milliseconds(), int64(0), "Expected positive duration")
 }
+
+func TestMarshalSecret(t *testing.T) {
+	secrets := map[string]secret{"foo": "bar"}
+
+	yamlResult, err := yaml.Marshal(secrets)
+	if err != nil {
+		t.Fatal(err)
+	}
+	assert.Equal(t, string(yamlResult), "foo: '***'\n")
+
+	jsonResult, err := json.Marshal(secrets)
+	if err != nil {
+		t.Fatal(err)
+	}
+	assert.Equal(t, string(jsonResult), `{"foo":"***"}`)
+}