|
| 1 | +// SPDX-License-Identifier: Apache-2.0 |
| 2 | + |
| 3 | +package executor |
| 4 | + |
| 5 | +import ( |
| 6 | + "strings" |
| 7 | + "testing" |
| 8 | + |
| 9 | + "github.com/mendixlabs/mxcli/mdl/ast" |
| 10 | + "github.com/mendixlabs/mxcli/mdl/backend/mock" |
| 11 | + "github.com/mendixlabs/mxcli/mdl/types" |
| 12 | + "github.com/mendixlabs/mxcli/model" |
| 13 | + "github.com/mendixlabs/mxcli/sdk/pages" |
| 14 | +) |
| 15 | + |
| 16 | +// mkSnippetWithParam creates a snippet that declares one entity-typed parameter. |
| 17 | +func mkSnippetWithParam(containerID model.ID, snippetName, paramName string) *pages.Snippet { |
| 18 | + snp := mkSnippet(containerID, snippetName) |
| 19 | + snp.Parameters = []*pages.SnippetParameter{ |
| 20 | + { |
| 21 | + BaseElement: model.BaseElement{ID: nextID("sp")}, |
| 22 | + ContainerID: snp.ID, |
| 23 | + Name: paramName, |
| 24 | + EntityName: "Mod.Asset", |
| 25 | + }, |
| 26 | + } |
| 27 | + return snp |
| 28 | +} |
| 29 | + |
| 30 | +// newPageBuilder returns a pageBuilder wired to the given mock backend and hierarchy. |
| 31 | +func newPageBuilder(mb *mock.MockBackend, h *ContainerHierarchy, moduleName string) *pageBuilder { |
| 32 | + var modID model.ID |
| 33 | + for id, name := range h.moduleNames { |
| 34 | + if name == moduleName { |
| 35 | + modID = id |
| 36 | + break |
| 37 | + } |
| 38 | + } |
| 39 | + cache := &executorCache{hierarchy: h} |
| 40 | + return &pageBuilder{ |
| 41 | + backend: mb, |
| 42 | + moduleID: modID, |
| 43 | + moduleName: moduleName, |
| 44 | + widgetScope: make(map[string]model.ID), |
| 45 | + paramScope: make(map[string]model.ID), |
| 46 | + paramEntityNames: make(map[string]string), |
| 47 | + execCache: cache, |
| 48 | + widgetBackend: mb, |
| 49 | + } |
| 50 | +} |
| 51 | + |
| 52 | +// TestSnippetCall_MissingParam_ReturnsError verifies that placing a SNIPPETCALL |
| 53 | +// without the required Params yields a validation error (issue #291 — guard). |
| 54 | +func TestSnippetCall_MissingParam_ReturnsError(t *testing.T) { |
| 55 | + mod := mkModule("Mod") |
| 56 | + snp := mkSnippetWithParam(mod.ID, "MySnippet", "Asset") |
| 57 | + |
| 58 | + h := mkHierarchy(mod) |
| 59 | + withContainer(h, snp.ContainerID, mod.ID) |
| 60 | + |
| 61 | + mb := &mock.MockBackend{ |
| 62 | + IsConnectedFunc: func() bool { return true }, |
| 63 | + ListModulesFunc: func() ([]*model.Module, error) { return []*model.Module{mod}, nil }, |
| 64 | + ListFoldersFunc: func() ([]*types.FolderInfo, error) { return nil, nil }, |
| 65 | + ListSnippetsFunc: func() ([]*pages.Snippet, error) { return []*pages.Snippet{snp}, nil }, |
| 66 | + } |
| 67 | + |
| 68 | + pb := newPageBuilder(mb, h, "Mod") |
| 69 | + w := &ast.WidgetV3{ |
| 70 | + Type: "SNIPPETCALL", |
| 71 | + Name: "sc1", |
| 72 | + Properties: map[string]any{"Snippet": "Mod.MySnippet"}, |
| 73 | + } |
| 74 | + |
| 75 | + _, err := pb.buildSnippetCallV3(w) |
| 76 | + if err == nil { |
| 77 | + t.Fatal("expected validation error for missing snippet parameter, got nil") |
| 78 | + } |
| 79 | + if !strings.Contains(err.Error(), "Asset") { |
| 80 | + t.Errorf("error should mention missing parameter 'Asset', got: %v", err) |
| 81 | + } |
| 82 | +} |
| 83 | + |
| 84 | +// TestSnippetCall_WithParam_Succeeds verifies that a SNIPPETCALL with correct |
| 85 | +// Params mapping passes validation and produces a SnippetCallWidget with mappings. |
| 86 | +func TestSnippetCall_WithParam_Succeeds(t *testing.T) { |
| 87 | + mod := mkModule("Mod") |
| 88 | + snp := mkSnippetWithParam(mod.ID, "MySnippet", "Asset") |
| 89 | + |
| 90 | + h := mkHierarchy(mod) |
| 91 | + withContainer(h, snp.ContainerID, mod.ID) |
| 92 | + |
| 93 | + mb := &mock.MockBackend{ |
| 94 | + IsConnectedFunc: func() bool { return true }, |
| 95 | + ListModulesFunc: func() ([]*model.Module, error) { return []*model.Module{mod}, nil }, |
| 96 | + ListFoldersFunc: func() ([]*types.FolderInfo, error) { return nil, nil }, |
| 97 | + ListSnippetsFunc: func() ([]*pages.Snippet, error) { return []*pages.Snippet{snp}, nil }, |
| 98 | + } |
| 99 | + |
| 100 | + pb := newPageBuilder(mb, h, "Mod") |
| 101 | + w := &ast.WidgetV3{ |
| 102 | + Type: "SNIPPETCALL", |
| 103 | + Name: "sc1", |
| 104 | + Properties: map[string]any{ |
| 105 | + "Snippet": "Mod.MySnippet", |
| 106 | + "Params": []ast.SnippetCallParam{{ParamName: "Asset", Variable: "$Asset"}}, |
| 107 | + }, |
| 108 | + } |
| 109 | + |
| 110 | + sc, err := pb.buildSnippetCallV3(w) |
| 111 | + if err != nil { |
| 112 | + t.Fatalf("unexpected error: %v", err) |
| 113 | + } |
| 114 | + if len(sc.ParameterMappings) != 1 { |
| 115 | + t.Fatalf("ParameterMappings: want 1, got %d", len(sc.ParameterMappings)) |
| 116 | + } |
| 117 | + if sc.ParameterMappings[0].ParamName != "Asset" { |
| 118 | + t.Errorf("ParamName: want Asset, got %q", sc.ParameterMappings[0].ParamName) |
| 119 | + } |
| 120 | + if sc.ParameterMappings[0].Argument != "$Asset" { |
| 121 | + t.Errorf("Argument: want $Asset, got %q", sc.ParameterMappings[0].Argument) |
| 122 | + } |
| 123 | +} |
| 124 | + |
| 125 | +// TestSnippetCall_NoParam_NoSnippetParams_Succeeds verifies that a parameterless |
| 126 | +// snippet call against a snippet with no declared parameters works (no regression). |
| 127 | +func TestSnippetCall_NoParam_NoSnippetParams_Succeeds(t *testing.T) { |
| 128 | + mod := mkModule("Mod") |
| 129 | + snp := mkSnippet(mod.ID, "Footer") // no parameters declared |
| 130 | + |
| 131 | + h := mkHierarchy(mod) |
| 132 | + withContainer(h, snp.ContainerID, mod.ID) |
| 133 | + |
| 134 | + mb := &mock.MockBackend{ |
| 135 | + IsConnectedFunc: func() bool { return true }, |
| 136 | + ListModulesFunc: func() ([]*model.Module, error) { return []*model.Module{mod}, nil }, |
| 137 | + ListFoldersFunc: func() ([]*types.FolderInfo, error) { return nil, nil }, |
| 138 | + ListSnippetsFunc: func() ([]*pages.Snippet, error) { return []*pages.Snippet{snp}, nil }, |
| 139 | + } |
| 140 | + |
| 141 | + pb := newPageBuilder(mb, h, "Mod") |
| 142 | + w := &ast.WidgetV3{ |
| 143 | + Type: "SNIPPETCALL", |
| 144 | + Name: "sc1", |
| 145 | + Properties: map[string]any{"Snippet": "Mod.Footer"}, |
| 146 | + } |
| 147 | + |
| 148 | + sc, err := pb.buildSnippetCallV3(w) |
| 149 | + if err != nil { |
| 150 | + t.Fatalf("unexpected error for parameterless snippet: %v", err) |
| 151 | + } |
| 152 | + if len(sc.ParameterMappings) != 0 { |
| 153 | + t.Errorf("expected empty ParameterMappings, got %d", len(sc.ParameterMappings)) |
| 154 | + } |
| 155 | +} |
| 156 | + |
| 157 | +// TestSnippetCall_DollarPrefixParam_Succeeds verifies that param names with $ |
| 158 | +// prefix (as the user might write $Asset: $var) are matched correctly. |
| 159 | +func TestSnippetCall_DollarPrefixParam_Succeeds(t *testing.T) { |
| 160 | + mod := mkModule("Mod") |
| 161 | + snp := mkSnippetWithParam(mod.ID, "MySnippet", "Asset") |
| 162 | + |
| 163 | + h := mkHierarchy(mod) |
| 164 | + withContainer(h, snp.ContainerID, mod.ID) |
| 165 | + |
| 166 | + mb := &mock.MockBackend{ |
| 167 | + IsConnectedFunc: func() bool { return true }, |
| 168 | + ListModulesFunc: func() ([]*model.Module, error) { return []*model.Module{mod}, nil }, |
| 169 | + ListFoldersFunc: func() ([]*types.FolderInfo, error) { return nil, nil }, |
| 170 | + ListSnippetsFunc: func() ([]*pages.Snippet, error) { return []*pages.Snippet{snp}, nil }, |
| 171 | + } |
| 172 | + |
| 173 | + pb := newPageBuilder(mb, h, "Mod") |
| 174 | + // User writes $Asset: $Asset (dollar-prefixed param name) |
| 175 | + w := &ast.WidgetV3{ |
| 176 | + Type: "SNIPPETCALL", |
| 177 | + Name: "sc1", |
| 178 | + Properties: map[string]any{ |
| 179 | + "Snippet": "Mod.MySnippet", |
| 180 | + "Params": []ast.SnippetCallParam{{ParamName: "$Asset", Variable: "$Asset"}}, |
| 181 | + }, |
| 182 | + } |
| 183 | + |
| 184 | + sc, err := pb.buildSnippetCallV3(w) |
| 185 | + if err != nil { |
| 186 | + t.Fatalf("unexpected error with $-prefixed param name: %v", err) |
| 187 | + } |
| 188 | + if len(sc.ParameterMappings) != 1 { |
| 189 | + t.Fatalf("ParameterMappings: want 1, got %d", len(sc.ParameterMappings)) |
| 190 | + } |
| 191 | + if sc.ParameterMappings[0].ParamName != "Asset" { |
| 192 | + t.Errorf("ParamName: want Asset (stripped), got %q", sc.ParameterMappings[0].ParamName) |
| 193 | + } |
| 194 | +} |
0 commit comments