feat(config): add .Files.Exists and .Files.IsDir Go template functions

Signed-off-by: Aleksei Igrychev <aleksei.igrychev@palark.com>

Author: nervgh

docs/_data/werf_giterminism_yaml.yml

@@ -45,8 +45,8 @@ directives:
           - name: allowUncommittedFiles
             value: "[ glob, ... ]"
             description:
-              en: Read the certain configuration files from the project directory despite the state in git repository and .gitignore rules (using .Files.Get and .Files.Glob functions)
-              ru: Читать определённые конфигурационные файлы из директории проекта, не сверяя контент с файлами текущего коммита и игнорируя исключения в .gitignore (используя функции .Files.Get и .Files.Glob)
+              en: Read the certain configuration files from the project directory despite the state in git repository and .gitignore rules (using .Files.Exists, .Files.Get, .Files.Glob, and .Files.IsDir functions)
+              ru: Читать определённые конфигурационные файлы из директории проекта, не сверяя контент с файлами текущего коммита и игнорируя исключения в .gitignore (используя функции .Files.Exists, .Files.Get, .Files.Glob и .Files.IsDir)
       - name: secrets
         description:
           en: The rules for using secret values

docs/pages_en/reference/werf_yaml_template_engine.md

@@ -223,6 +223,19 @@ __Syntax__:
 
 ### project files
 
+#### .Files.Exists
+
+The function `.Files.Exists` checks existence of a file (regular/directory) in project and returns the result `true` or `false`.
+
+__Syntax__:
+{% raw %}
+```yaml
+{{ .Files.Exists "<FILE_PATH>" }}
+```
+{% endraw %}
+
+> By default, the use of files that have non-committed changes is not allowed by giterminism (read more about it [here]({{ "usage/project_configuration/giterminism.html" | true_relative_url }}))
+
 #### .Files.Get
 
 The function `.Files.Get` gets a certain project file content.
@@ -336,6 +349,19 @@ ansible:
 ```
 {% endraw %}
 
+#### .Files.IsDir
+
+The function `.Files.IsDir` checks path is a directory and returns `true` or `false`.
+
+__Syntax__:
+{% raw %}
+```yaml
+{{ .Files.IsDir "<PATH>" }}
+```
+{% endraw %}
+
+> By default, the use of files that have non-committed changes is not allowed by giterminism (read more about it [here]({{ "usage/project_configuration/giterminism.html" | true_relative_url }}))
+
 ### others
 
 #### required

docs/pages_ru/reference/werf_yaml_template_engine.md

@@ -223,6 +223,19 @@ __Синтаксис__:
 
 ### Файлы проекта
 
+#### .Files.Exists
+
+Функция `.Files.Exists` проверят наличие файла/директории в рамках проекта и возвращает результат `true` или `false`.
+
+__Синтаксис__:
+{% raw %}
+```yaml
+{{ .Files.Exists "<FILE_PATH>" }}
+```
+{% endraw %}
+
+> По умолчанию, использование файлов, которые имеют незакоммиченные изменения, запрещено гитерминизмом (подробнее об этом в [статье]({{ "usage/project_configuration/giterminism.html" | true_relative_url }}))
+
 #### .Files.Get
 
 Функция `.Files.Get` получает содержимое определенного файла проекта.
@@ -336,6 +349,19 @@ ansible:
 ```
 {% endraw %}
 
+#### .Files.IsDir
+
+Функция `.Files.IsDir` проверят, является ли путь директорией и возвращает результат `true` или `false`.
+
+__Синтаксис__:
+{% raw %}
+```yaml
+{{ .Files.IsDir "<PATH>" }}
+```
+{% endraw %}
+
+> По умолчанию, использование файлов, которые имеют незакоммиченные изменения, запрещено гитерминизмом (подробнее об этом в [статье]({{ "usage/project_configuration/giterminism.html" | true_relative_url }}))
+
 ### Другие
 
 #### required

go.mod

@@ -75,6 +75,7 @@ require (
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.24.0
 	go.opentelemetry.io/otel/sdk v1.24.0
 	go.opentelemetry.io/otel/trace v1.24.0
+	go.uber.org/mock v0.5.0
 	golang.org/x/crypto v0.31.0
 	golang.org/x/net v0.33.0
 	golang.org/x/sys v0.28.0

go.sum

@@ -1578,6 +1578,8 @@ go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
 go.uber.org/goleak v1.1.10/go.mod h1:8a7PlsEVH3e/a/GLqe5IIrQx6GzcnRmZEufDUTk4A7A=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
 go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
+go.uber.org/mock v0.5.0 h1:KAMbZvZPyBPWgD14IrIQ38QCyjwpvVVV6K/bHl1IwQU=
+go.uber.org/mock v0.5.0/go.mod h1:ge71pBPLYDk7QIi1LupWxdAykm7KIEFchiOqd6z7qMM=
 go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
 go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4=
 go.uber.org/multierr v1.5.0/go.mod h1:FeouvMocqHpRaaGuG9EjoKcStLC43Zu/fmqdUMPcKYU=

pkg/config/parser.go

@@ -375,6 +375,22 @@ func (f files) Glob(pattern string) map[string]interface{} {
 	}
 }
 
+func (f files) Exists(relPath string) bool {
+	exist, err := f.giterminismManager.FileReader().ConfigGoTemplateFilesExists(f.ctx, relPath)
+	if err != nil {
+		panic(err.Error())
+	}
+	return exist
+}
+
+func (f files) IsDir(relPath string) bool {
+	exist, err := f.giterminismManager.FileReader().ConfigGoTemplateFilesIsDir(f.ctx, relPath)
+	if err != nil {
+		panic(err.Error())
+	}
+	return exist
+}
+
 func splitContent(content []byte) (docsContents [][]byte) {
 	const (
 		stateLineBegin   = "stateLineBegin"

pkg/git_repo/git_repo.go

@@ -36,6 +36,8 @@ const (
 	DirectoryArchive ArchiveType = "directory"
 )
 
+//go:generate mockgen -source git_repo.go -package mock -destination ../../test/mock/git_repo.go
+
 type GitRepo interface {
 	String() string
 	GetName() string

pkg/giterminism_manager/file_reader/config.go

@@ -63,6 +63,8 @@ func (r FileReader) readConfig(ctx context.Context, customRelPath string) (strin
 	for _, configPath := range configRelPathList {
 		data, err := r.ReadAndCheckConfigurationFile(ctx, configPath, func(_ string) bool {
 			return r.giterminismConfig.IsUncommittedConfigAccepted()
+		}, func(path string) (bool, error) {
+			return r.IsRegularFileExist(ctx, path)
 		})
 		if err != nil {
 			if errors.As(err, &FileNotFoundInProjectDirectoryError{}) ||

pkg/giterminism_manager/file_reader/config_go_template.go

@@ -2,6 +2,7 @@ package file_reader
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"path/filepath"
 )
@@ -31,10 +32,56 @@ func (r FileReader) ConfigGoTemplateFilesGlob(ctx context.Context, glob string)
 }
 
 func (r FileReader) ConfigGoTemplateFilesGet(ctx context.Context, relPath string) ([]byte, error) {
-	data, err := r.ReadAndCheckConfigurationFile(ctx, relPath, r.giterminismConfig.UncommittedConfigGoTemplateRenderingFilePathMatcher().IsPathMatched)
+	data, err := r.ReadAndCheckConfigurationFile(ctx, relPath,
+		r.giterminismConfig.UncommittedConfigGoTemplateRenderingFilePathMatcher().IsPathMatched,
+		func(path string) (bool, error) {
+			return r.IsRegularFileExist(ctx, path)
+		})
 	if err != nil {
 		return nil, fmt.Errorf("{{ .Files.Get %q }}: %w", relPath, err)
 	}
 
 	return data, nil
 }
+
+func (r FileReader) ConfigGoTemplateFilesExists(ctx context.Context, relPath string) (bool, error) {
+	ok, err := r.CheckConfigurationFileExistenceAndAcceptance(ctx, relPath,
+		r.giterminismConfig.UncommittedConfigGoTemplateRenderingFilePathMatcher().IsPathMatched,
+		func(path string) (bool, error) {
+			return r.IsFileExist(ctx, path)
+		})
+	if err != nil {
+		switch {
+		case errors.As(err, &UntrackedFilesError{}),
+			errors.As(err, &UncommittedFilesError{}),
+			errors.As(err, &FileNotAcceptedError{}),
+			errors.As(err, &FileNotFoundInProjectDirectoryError{}),
+			errors.As(err, &FileNotFoundInProjectRepositoryError{}):
+			return false, nil
+		default:
+			return false, fmt.Errorf("{{ .Files.Exists %q }}: %w", relPath, err)
+		}
+	}
+	return ok, nil
+}
+
+func (r FileReader) ConfigGoTemplateFilesIsDir(ctx context.Context, relPath string) (bool, error) {
+	ok, err := r.CheckConfigurationFileExistenceAndAcceptance(ctx, relPath,
+		r.giterminismConfig.UncommittedConfigGoTemplateRenderingFilePathMatcher().IsPathMatched,
+		func(path string) (bool, error) {
+			return r.IsDirectoryExist(ctx, path)
+		})
+	if err != nil {
+		switch {
+		case errors.As(err, &UntrackedFilesError{}),
+			errors.As(err, &UncommittedFilesError{}),
+			errors.As(err, &FileNotAcceptedError{}),
+			errors.As(err, &FileNotFoundInProjectDirectoryError{}),
+			errors.As(err, &FileNotFoundInProjectRepositoryError{}):
+			return false, nil
+		default:
+			return false, fmt.Errorf("{{ .Files.IsDir %q }}: %w", relPath, err)
+		}
+	}
+	return ok, nil
+}