fix(functions): use functions inside a pipe (#168)

* fix(functions): use fn inside a pipe venom test

* fix(functions): use fn inside a pipe

* fix(functions): update changelog

Author: adrienaury

CHANGELOG.md

@@ -16,11 +16,12 @@ Types of changes
 
 ## [1.15.0]
 
+- `Security` in PIMO Play : disallow usage of mask Command in `masks` property
 - `Added` functions section in masking configuration
 - `Added` possibility to use masks as template functions (most mask are available as `Mask<mask_name>` : MaskRandDate, MaskRegex, ...)
-- `Fixed` preserve notInCache enum in the jsonschema
-- `Security` in PIMO Play : disallow usage of mask Command in `masks` property
 - `Added` in PIMO Play: adds a tab to visualize a mermaid graph flow of the masking
+- `Fixed` preserve notInCache enum in the jsonschema
+- `Fixed` functions call from a pipe mask crash pipeline
 
 ## [1.14.1]
 

internal/app/pimo/pimo.go

@@ -141,7 +141,7 @@ func (ctx *Context) Configure(cfg Config) error {
 	model.InjectConfig(cfg.SkipLineOnError, cfg.SkipFieldOnError)
 
 	var err error
-	ctx.pipeline, ctx.caches, err = model.BuildPipeline(ctx.pipeline, ctx.pdef, nil)
+	ctx.pipeline, ctx.caches, err = model.BuildPipeline(ctx.pipeline, ctx.pdef, nil, nil)
 	if err != nil {
 		return fmt.Errorf("Cannot build pipeline: %w", err)
 	}

pkg/functions/build.go

@@ -93,8 +93,11 @@ func (d Definition) AsCall(name string, args ...interface{}) string {
 }
 
 // Build returns a FuncMap (map[string]interface{}) that can be used in Go Template API, with all functions.
-func (b Builder) Build() (template.FuncMap, error) {
-	funcMap := make(template.FuncMap, len(b.Definitions))
+func (b Builder) Build(fns template.FuncMap) (template.FuncMap, error) {
+	funcMap := fns
+	if fns == nil {
+		funcMap = make(template.FuncMap, len(b.Definitions))
+	}
 
 	if len(b.Definitions) == 0 {
 		return funcMap, nil

pkg/model/pipeline.go

@@ -66,7 +66,7 @@ func BuildCaches(caches map[string]CacheDefinition, existing map[string]Cache) m
 	return existing
 }
 
-func BuildFuncMap(funcs map[string]Function) (tmpl.FuncMap, error) {
+func BuildFuncMap(funcs map[string]Function, fns tmpl.FuncMap) (tmpl.FuncMap, error) {
 	b := functions.Builder{
 		Definitions: map[string]functions.Definition{},
 	}
@@ -83,12 +83,12 @@ func BuildFuncMap(funcs map[string]Function) (tmpl.FuncMap, error) {
 		}
 	}
 
-	return b.Build()
+	return b.Build(fns)
 }
 
-func BuildPipeline(pipeline Pipeline, conf Definition, caches map[string]Cache) (Pipeline, map[string]Cache, error) {
+func BuildPipeline(pipeline Pipeline, conf Definition, caches map[string]Cache, functions tmpl.FuncMap) (Pipeline, map[string]Cache, error) {
 	caches = BuildCaches(conf.Caches, caches)
-	functions, err := BuildFuncMap(conf.Functions)
+	functions, err := BuildFuncMap(conf.Functions, functions)
 	if err != nil {
 		return nil, nil, err
 	}

pkg/pipe/pipe.go

@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"hash/fnv"
 	"regexp"
+	"text/template"
 
 	over "github.com/Trendyol/overlog"
 	"github.com/cgi-fr/pimo/pkg/model"
@@ -36,7 +37,7 @@ type MaskEngine struct {
 }
 
 // NewMask return a MaskEngine from a value
-func NewMask(seed int64, injectParent string, injectRoot string, caches map[string]model.Cache, filename string, masking ...model.Masking) (MaskEngine, error) {
+func NewMask(seed int64, injectParent string, injectRoot string, caches map[string]model.Cache, fns template.FuncMap, filename string, masking ...model.Masking) (MaskEngine, error) {
 	var definition model.Definition
 	var err error
 	if len(filename) > 0 {
@@ -50,7 +51,7 @@ func NewMask(seed int64, injectParent string, injectRoot string, caches map[stri
 		definition = model.Definition{Seed: seed + 1, Masking: masking}
 	}
 	pipeline := model.NewPipeline(nil)
-	pipeline, _, err = model.BuildPipeline(pipeline, definition, caches)
+	pipeline, _, err = model.BuildPipeline(pipeline, definition, caches, fns)
 	return MaskEngine{"", pipeline, injectParent, injectRoot}, err
 }
 
@@ -119,7 +120,7 @@ func Factory(conf model.MaskFactoryConfiguration) (model.MaskContextEngine, bool
 		h := fnv.New64a()
 		h.Write([]byte(conf.Masking.Selector.Jsonpath))
 		conf.Seed += int64(h.Sum64())
-		mask, err := NewMask(conf.Seed, conf.Masking.Mask.Pipe.InjectParent, conf.Masking.Mask.Pipe.InjectRoot, conf.Cache, conf.Masking.Mask.Pipe.DefinitionFile, conf.Masking.Mask.Pipe.Masking...)
+		mask, err := NewMask(conf.Seed, conf.Masking.Mask.Pipe.InjectParent, conf.Masking.Mask.Pipe.InjectRoot, conf.Cache, conf.Functions, conf.Masking.Mask.Pipe.DefinitionFile, conf.Masking.Mask.Pipe.Masking...)
 		if err != nil {
 			return mask, true, err
 		}

pkg/pipe/pipe_test.go

@@ -40,7 +40,7 @@ func TestMaskEngineShouldMaskNestedArray(t *testing.T) {
 	var result []model.Dictionary
 
 	model.InjectMaskFactories([]model.MaskFactory{templatemask.Factory})
-	pipe, err := pipe.NewMask(42, "parent", "root", map[string]model.Cache{}, "",
+	pipe, err := pipe.NewMask(42, "parent", "root", map[string]model.Cache{}, nil, "",
 		model.Masking{
 			Selector: model.SelectorType{Jsonpath: "name"},
 			Mask: model.MaskType{

test/suites/functions.yml

@@ -99,3 +99,39 @@ testcases:
     - result.systemout ShouldEqual {"addValue":"15","subValue":"5"}
     - result.systemerr ShouldBeEmpty
 
+
+- name: using function inside a pipe
+  steps:
+  - script: rm -f masking.yml
+  - script: |-
+      cat > masking.yml <<EOF
+      version: "1"
+      functions:
+        clespi:
+          params:
+            - name: i
+          body: |-
+            k = i % 511
+            if k <= 10 {
+              return "00"+ k
+            } else if k <= 100 {
+              return "0"+ k
+            }
+            return k
+      masking:
+      - selector:
+          jsonpath: "personne"
+        mask:
+          pipe:
+            masking:
+              - selector:
+                  jsonpath: "spi"
+                mask:
+                  template: "{{ clespi .spi}}"
+      EOF
+  - script: |-
+      echo '{"personne":[{ "spi":"158178940"},{"spi":"4588574950"}]}' | pimo
+    assertions:
+    - result.code ShouldEqual 0
+    - result.systemout ShouldEqual {"personne":[{"spi":"423"},{"spi":"372"}]}
+    - result.systemerr ShouldBeEmpty