feat: add helm_lib_module_image_digest template

charts/helm_lib/Chart.yaml

@@ -1,5 +1,5 @@
 apiVersion: v2
 type: library
 name: deckhouse_lib_helm
-version: 1.44.4
+version: 1.44.5
 description: "Helm utils template definitions for Deckhouse modules."

charts/helm_lib/README.md

@@ -35,6 +35,8 @@
 | [helm_lib_module_image_no_fail](#helm_lib_module_image_no_fail) |
 | [helm_lib_module_common_image](#helm_lib_module_common_image) |
 | [helm_lib_module_common_image_no_fail](#helm_lib_module_common_image_no_fail) |
+| [helm_lib_module_image_digest](#helm_lib_module_image_digest) |
+| [helm_lib_module_image_digest_no_fail](#helm_lib_module_image_digest_no_fail) |
 | **Module Ingress Class** |
 | [helm_lib_module_ingress_class](#helm_lib_module_ingress_class) |
 | **Module Init Container** |
@@ -415,6 +417,36 @@ list:
 -  Template context with .Values, .Chart, etc 
 -  Container name 
 
+
+### helm_lib_module_image_digest
+
+ returns image digest 
+
+#### Usage
+
+`{{ include "helm_lib_module_image_digest" (list . "<container-name>" "<module-name>(optional)") }} `
+
+#### Arguments
+
+list:
+-  Template context with .Values, .Chart, etc 
+-  Container name 
+
+
+### helm_lib_module_image_digest_no_fail
+
+ returns image digest if found 
+
+#### Usage
+
+`{{ include "helm_lib_module_image_digest_no_fail" (list . "<container-name>" "<module-name>(optional)") }} `
+
+#### Arguments
+
+list:
+-  Template context with .Values, .Chart, etc 
+-  Container name 
+
 ## Module Ingress Class
 
 ### helm_lib_module_ingress_class

charts/helm_lib/templates/_module_image.tpl

@@ -75,4 +75,37 @@
   {{- if $imageDigest }}
   {{- printf "%s@%s" $context.Values.global.modulesImages.registry.base $imageDigest }}
   {{- end }}
-{{- end }}
+{{- end }}
+
+{{- /* Usage: {{ include "helm_lib_module_image_digest" (list . "<container-name>" "<module-name>(optional)") }} */ -}}
+{{- /* returns image digest */ -}}
+{{- define "helm_lib_module_image_digest" }}
+  {{- $context := index . 0 }} {{- /* Template context with .Values, .Chart, etc */ -}}
+  {{- $containerName := index . 1 | trimAll "\"" }} {{- /* Container name */ -}}
+  {{- $rawModuleName := $context.Chart.Name }}
+  {{- if ge (len .) 3 }}
+  {{- $rawModuleName = (index . 2) }} {{- /* Optional module name */ -}}
+  {{- end }}
+  {{- $moduleName := (include "helm_lib_module_camelcase_name" $rawModuleName) }}
+  {{- $moduleMap := index $context.Values.global.modulesImages.digests $moduleName | default dict }}
+  {{- $imageDigest := index $moduleMap $containerName | default "" }}
+  {{- if not $imageDigest }}
+  {{- $error := (printf "Image %s.%s has no digest" $moduleName $containerName ) }}
+  {{- fail $error }}
+  {{- end }}
+  {{- printf "%s" $imageDigest }}
+{{- end }}
+
+{{- /* Usage: {{ include "helm_lib_module_image_digest_no_fail" (list . "<container-name>" "<module-name>(optional)") }} */ -}}
+{{- /* returns image digest if found */ -}}
+{{- define "helm_lib_module_image_digest_no_fail" }}
+  {{- $context := index . 0 }} {{- /* Template context with .Values, .Chart, etc */ -}}
+  {{- $containerName := index . 1 | trimAll "\"" }} {{- /* Container name */ -}}
+  {{- $moduleName := (include "helm_lib_module_camelcase_name" $context) }}
+  {{- if ge (len .) 3 }}
+  {{- $moduleName = (include "helm_lib_module_camelcase_name" (index . 2)) }} {{- /* Optional module name */ -}}
+  {{- end }}
+  {{- $moduleMap := index $context.Values.global.modulesImages.digests $moduleName | default dict }}
+  {{- $imageDigest := index $moduleMap $containerName | default "" }}
+  {{- printf "%s" $imageDigest }}
+{{- end }}

tests/templates/helm_lib_module_image.yaml

@@ -3,4 +3,15 @@ embeddedModuleWithOptionalName: {{ include "helm_lib_module_image" (list . "test
 ---
 externalModuleImage: {{ include "helm_lib_module_image" (list . "externalContainer") }}
 externalModuleImageWithOptionalName: {{ include "helm_lib_module_image" (list . "externalContainer" "someModule") }}
-externalModuleKebabImageWithOptionalName: {{ include "helm_lib_module_image" (list . "externalContainer" "some-module") }}
+externalModuleKebabImageWithOptionalName: {{ include "helm_lib_module_image" (list . "externalContainer" "some-module") }}
+---
+externalModuleImageDigest: {{ include "helm_lib_module_image_digest" (list . "externalContainer") }}
+externalModuleImageDigestWithOptionalName: {{ include "helm_lib_module_image_digest" (list . "externalContainer" "someModule") }}
+externalModuleImageDigestWithOptionalNameTestModule: {{ include "helm_lib_module_image_digest" (list . "externalContainer" "testModule") }}
+---
+externalModuleImageDigestNoFail: {{ include "helm_lib_module_image_digest_no_fail" (list . "externalContainer") }}
+externalModuleImageDigestWithOptionalNameNoFail: {{ include "helm_lib_module_image_digest_no_fail" (list . "externalContainer" "someModule") }}
+externalModuleImageDigestWithOptionalNameTestModuleNoFail: {{ include "helm_lib_module_image_digest_no_fail" (list . "externalContainer" "testModule") }}
+---
+externalModuleImageDigestWithOptionalNameContainerNotExistNoFail: {{ include "helm_lib_module_image_digest_no_fail" (list . "externalContainer2NoFail") }}
+externalModuleImageDigestWithOptionalNameModuleNotExistNoFail: {{ include "helm_lib_module_image_digest_no_fail" (list . "externalContainer" "moduleNotExist") }}

tests/tests/helm_lib_module_image_test.yaml

@@ -57,4 +57,39 @@ tests:
     asserts:
       - equal:
           path: "externalModuleImage"
-          value: "registry.deckhouse.io/modules/test-module@sha321"
+          value: "registry.deckhouse.io/modules/test-module@sha321"
+
+  - it: should render external module image digest
+    documentIndex: 2
+    asserts:
+      - equal:
+          path: "externalModuleImageDigest"
+          value: "sha321"
+      - equal:
+          path: "externalModuleImageDigestWithOptionalName"
+          value: "sha543"
+      - equal:
+          path: "externalModuleImageDigestWithOptionalNameTestModule"
+          value: "sha321"
+
+  - it: should render external module image digest no fail
+    documentIndex: 3
+    asserts:
+      - equal:
+          path: "externalModuleImageDigestNoFail"
+          value: "sha321"
+      - equal:
+          path: "externalModuleImageDigestWithOptionalNameNoFail"
+          value: "sha543"
+      - equal:
+          path: "externalModuleImageDigestWithOptionalNameTestModuleNoFail"
+          value: "sha321"
+  - it: should render external module image digest no fail with null
+    documentIndex: 4
+    asserts:
+      - equal:
+          path: "externalModuleImageDigestWithOptionalNameModuleNotExistNoFail"
+          value: null
+      - equal:
+          path: "externalModuleImageDigestWithOptionalNameContainerNotExistNoFail"
+          value: null