-
Notifications
You must be signed in to change notification settings - Fork 138
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: introduced liveness and readiness probes
Signed-off-by: RealAnna <[email protected]>
- Loading branch information
Showing
9 changed files
with
261 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package probes | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/arttor/helmify/pkg/helmify" | ||
| yamlformat "github.com/arttor/helmify/pkg/yaml" | ||
| "github.com/iancoleman/strcase" | ||
| "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
| "sigs.k8s.io/yaml" | ||
| ) | ||
|
|
||
| const livenessProbe = "livenessProbe" | ||
| const readinessProbe = "readinessProbe" | ||
|
|
||
| const livenessProbeTemplate = "{{- if .Values.%[1]s.%[2]s.livenessProbe }}\n" + | ||
| "livenessProbe: {{- include \"tplvalues.render\" (dict \"value\" .Values.%[1]s.%[2]s.livenessProbe \"context\" $) | nindent 10 }}\n" + | ||
| " {{- else }}\n" + | ||
| "livenessProbe:\n%[3]s" + | ||
| "\n{{- end }}" | ||
|
|
||
| const readinessProbeTemplate = "\n{{- if .Values.%[1]s.%[2]s.readinessProbe }}\n" + | ||
| "readinessProbe: {{- include \"tplvalues.render\" (dict \"value\" .Values.%[1]s.%[2]s.readinessProbe \"context\" $) | nindent 10 }}\n" + | ||
| " {{- else }}\n" + | ||
| "readinessProbe:\n%[3]s" + | ||
| "\n{{- end }}" | ||
|
|
||
| // ProcessSpecMap adds 'probes' to the Containers in specMap, if they are defined | ||
| func ProcessSpecMap(name string, specMap map[string]interface{}, values *helmify.Values) error { | ||
|
|
||
| cs, _, err := unstructured.NestedSlice(specMap, "containers") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| strContainers := make([]interface{}, len(cs)) | ||
| for i, c := range cs { | ||
| castedContainer := c.(map[string]interface{}) | ||
| strContainers[i], err = setProbesTemplates(name, castedContainer, values) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return unstructured.SetNestedSlice(specMap, strContainers, "containers") | ||
|
|
||
| } | ||
|
|
||
| func setProbesTemplates(name string, castedContainer map[string]interface{}, values *helmify.Values) (string, error) { | ||
|
|
||
| var ready, live string | ||
| var err error | ||
| if _, defined := castedContainer[livenessProbe]; defined { | ||
| live, err = setProbe(name, castedContainer, values, livenessProbe) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| delete(castedContainer, livenessProbe) | ||
| } | ||
| if _, defined := castedContainer[readinessProbe]; defined { | ||
| ready, err = setProbe(name, castedContainer, values, readinessProbe) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| delete(castedContainer, readinessProbe) | ||
| } | ||
| return setMap(name, castedContainer, live, ready) | ||
|
|
||
| } | ||
|
|
||
| func setMap(name string, castedContainer map[string]interface{}, live string, ready string) (string, error) { | ||
| containerName := strcase.ToLowerCamel(castedContainer["name"].(string)) | ||
| content, err := yaml.Marshal(castedContainer) | ||
|
|
||
| if err != nil { | ||
| return "", err | ||
| } | ||
| strContainer := string(content) | ||
| if live != "" { | ||
| strContainer = strContainer + fmt.Sprintf(livenessProbeTemplate, name, containerName, live) | ||
| } | ||
| if ready != "" { | ||
| strContainer = strContainer + fmt.Sprintf(readinessProbeTemplate, name, containerName, ready) | ||
| } | ||
| return strContainer, nil | ||
| } | ||
|
|
||
| func setProbe(name string, castedContainer map[string]interface{}, values *helmify.Values, probe string) (string, error) { | ||
| containerName := strcase.ToLowerCamel(castedContainer["name"].(string)) | ||
| live, err := yamlformat.Marshal(castedContainer[probe], 1) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| return live, unstructured.SetNestedField(*values, castedContainer[probe], name, containerName, probe) | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| package probes | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/arttor/helmify/pkg/helmify" | ||
| "github.com/stretchr/testify/require" | ||
| "sigs.k8s.io/yaml" | ||
| ) | ||
|
|
||
| func Test_setProbesTemplates(t *testing.T) { | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| deploymentName string | ||
| container map[string]interface{} | ||
| wantMap string | ||
| wantValue string | ||
| wantErr bool | ||
| }{ | ||
| { | ||
| name: "no probe no data generated", | ||
| deploymentName: "test", | ||
| container: map[string]interface{}{ | ||
| "name": "mycontainer", | ||
| }, | ||
| wantMap: "", | ||
| wantErr: false, | ||
| }, | ||
| { | ||
| name: "readinessProbe probe", | ||
| deploymentName: "test", | ||
| container: map[string]interface{}{ | ||
| "name": "mycontainer", | ||
| readinessProbe: map[string]interface{}{ | ||
| "timeoutSeconds": "1", | ||
| "periodSeconds": "20", | ||
| }, | ||
| }, | ||
| wantMap: "\n{{- if .Values.test.mycontainer.readinessProbe }}\n" + | ||
| "readinessProbe: {{- include \"tplvalues.render\" (dict \"value\" .Values.test.mycontainer.readinessProbe \"context\" $) | nindent 10 }}\n {{- else }}\n" + | ||
| "readinessProbe:\n" + | ||
| " periodSeconds: \"20\"\n" + | ||
| " timeoutSeconds: \"1\"\n" + | ||
| "{{- end }}", | ||
| wantValue: "readinessProbe:\n periodSeconds: \"20\"\n timeoutSeconds: \"1\"\n", | ||
| wantErr: false, | ||
| }, | ||
| { | ||
| name: "add livenessProbe probe", | ||
| deploymentName: "test", | ||
| container: map[string]interface{}{ | ||
| "name": "mycontainer", | ||
| livenessProbe: map[string]interface{}{ | ||
| "timeoutSeconds": "14", | ||
| "periodSeconds": "2", | ||
| }, | ||
| }, | ||
| wantMap: "{{- if .Values.test.mycontainer.livenessProbe }}\n" + | ||
| "livenessProbe: {{- include \"tplvalues.render\" (dict \"value\" .Values.test.mycontainer.livenessProbe \"context\" $) | nindent 10 }}\n" + | ||
| " {{- else }}\nlivenessProbe:\n" + | ||
| " periodSeconds: \"2\"\n" + | ||
| " timeoutSeconds: \"14\"\n" + | ||
| "{{- end }}", | ||
| wantValue: "livenessProbe:\n periodSeconds: \"2\"\n timeoutSeconds: \"14\"\n", | ||
| wantErr: false, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| v := make(helmify.Values) | ||
| res, err := setProbesTemplates(tt.deploymentName, tt.container, &v) | ||
| require.True(t, (err != nil) == tt.wantErr) | ||
|
|
||
| require.Contains(t, res, tt.wantMap) | ||
| if tt.wantValue != "" { | ||
| val := (v)["test"].(map[string]interface{})["mycontainer"] | ||
| t.Log("VAL", val) | ||
| b, err := yaml.Marshal(val) | ||
| require.Nil(t, err) | ||
| require.Contains(t, string(b), tt.wantValue) | ||
| } else { | ||
| require.Empty(t, v) | ||
| } | ||
| }) | ||
| } | ||
| } |