forked from getgauge/gauge
-
Notifications
You must be signed in to change notification settings - Fork 0
/
specFilter.go
203 lines (177 loc) · 6.3 KB
/
specFilter.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
// Copyright 2015 ThoughtWorks, Inc.
// This file is part of Gauge.
// Gauge is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Gauge is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Gauge. If not, see <http://www.gnu.org/licenses/>.
package main
import (
"errors"
"github.com/getgauge/gauge/logger"
"golang.org/x/tools/go/exact"
"golang.org/x/tools/go/types"
"os"
"regexp"
"strconv"
"strings"
)
type scenarioIndexFilterToRetain struct {
indexToNotFilter int
currentScenarioIndex int
}
type ScenarioFilterBasedOnTags struct {
specTags []string
tagExpression string
}
func newScenarioIndexFilterToRetain(index int) *scenarioIndexFilterToRetain {
return &scenarioIndexFilterToRetain{index, 0}
}
func (filter *scenarioIndexFilterToRetain) filter(item item) bool {
if item.kind() == scenarioKind {
if filter.currentScenarioIndex != filter.indexToNotFilter {
filter.currentScenarioIndex++
return true
} else {
filter.currentScenarioIndex++
return false
}
}
return false
}
func newScenarioFilterBasedOnTags(specTags []string, tagExp string) *ScenarioFilterBasedOnTags {
return &ScenarioFilterBasedOnTags{specTags, tagExp}
}
func (filter *ScenarioFilterBasedOnTags) filter(item item) bool {
if item.kind() == scenarioKind {
tags := item.(*scenario).tags
if tags == nil {
return !filter.filterTags(filter.specTags)
}
return !filter.filterTags(append(tags.values, filter.specTags...))
}
return true
}
func (filter *ScenarioFilterBasedOnTags) filterTags(stags []string) bool {
tagsMap := make(map[string]bool, 0)
for _, tag := range stags {
tagsMap[strings.Replace(tag, " ", "", -1)] = true
}
filter.replaceSpecialChar()
value, _ := filter.formatAndEvaluateExpression(tagsMap, filter.isTagPresent)
return value
}
func (filter *ScenarioFilterBasedOnTags) replaceSpecialChar() {
filter.tagExpression = strings.Replace(strings.Replace(strings.Replace(strings.Replace(filter.tagExpression, " ", "", -1), ",", "&", -1), "&&", "&", -1), "||", "|", -1)
}
func (filter *ScenarioFilterBasedOnTags) formatAndEvaluateExpression(tagsMap map[string]bool, isTagQualified func(tagsMap map[string]bool, tagName string) bool) (bool, error) {
_, tags := filter.getOperatorsAndOperands()
expToBeEvaluated := filter.tagExpression
for _, tag := range tags {
expToBeEvaluated = strings.Replace(expToBeEvaluated, strings.TrimSpace(tag), strconv.FormatBool(isTagQualified(tagsMap, strings.TrimSpace(tag))), -1)
}
return filter.evaluateExp(filter.handleNegation(expToBeEvaluated))
}
func (filter *ScenarioFilterBasedOnTags) handleNegation(tagExpression string) string {
tagExpression = strings.Replace(strings.Replace(tagExpression, "!true", "false", -1), "!false", "true", -1)
for strings.Contains(tagExpression, "!(") {
tagExpression = filter.evaluateBrackets(tagExpression)
}
return tagExpression
}
func (filter *ScenarioFilterBasedOnTags) evaluateBrackets(tagExpression string) string {
if strings.Contains(tagExpression, "!(") {
innerText := filter.resolveBracketExpression(tagExpression)
return strings.Replace(tagExpression, "!("+innerText+")", filter.evaluateBrackets(innerText), -1)
}
value, _ := filter.evaluateExp(tagExpression)
return strconv.FormatBool(!value)
}
func (filter *ScenarioFilterBasedOnTags) resolveBracketExpression(tagExpression string) string {
indexOfOpenBracket := strings.Index(tagExpression, "!(") + 1
bracketStack := make([]string, 0)
i := indexOfOpenBracket
for ; i < len(tagExpression); i++ {
if tagExpression[i] == '(' {
bracketStack = append(bracketStack, "(")
} else if tagExpression[i] == ')' {
bracketStack = append(bracketStack[:len(bracketStack)-1])
}
if len(bracketStack) == 0 {
break
}
}
return tagExpression[indexOfOpenBracket+1 : i]
}
func (filter *ScenarioFilterBasedOnTags) evaluateExp(tagExpression string) (bool, error) {
tre := regexp.MustCompile("true")
fre := regexp.MustCompile("false")
s := fre.ReplaceAllString(tre.ReplaceAllString(tagExpression, "1"), "0")
val, err := types.Eval(s, nil, nil)
if err != nil {
return false, errors.New("Invalid Expression.\n" + err.Error())
}
res, _ := exact.Uint64Val(val.Value)
var final bool
if res == 1 {
final = true
} else {
final = false
}
return final, nil
}
func (filter *ScenarioFilterBasedOnTags) isTagPresent(tagsMap map[string]bool, tagName string) bool {
_, ok := tagsMap[tagName]
return ok
}
func (filter *ScenarioFilterBasedOnTags) getOperatorsAndOperands() ([]string, []string) {
listOfOperators := make([]string, 0)
listOfTags := strings.FieldsFunc(filter.tagExpression, func(r rune) bool {
isValidOperator := r == '&' || r == '|' || r == '(' || r == ')' || r == '!'
if isValidOperator {
operator, _ := strconv.Unquote(strconv.QuoteRuneToASCII(r))
listOfOperators = append(listOfOperators, operator)
return isValidOperator
}
return false
})
return listOfOperators, listOfTags
}
func filterSpecsItems(specs []*specification, filter specFilter) []*specification {
filteredSpecs := make([]*specification, 0)
for _, spec := range specs {
spec.filter(filter)
if len(spec.scenarios) != 0 {
filteredSpecs = append(filteredSpecs, spec)
}
}
return filteredSpecs
}
func filterSpecsByTags(specs []*specification, tagExpression string) []*specification {
filteredSpecs := make([]*specification, 0)
for _, spec := range specs {
tagValues := make([]string, 0)
if spec.tags != nil {
tagValues = spec.tags.values
}
spec.filter(newScenarioFilterBasedOnTags(tagValues, tagExpression))
if len(spec.scenarios) != 0 {
filteredSpecs = append(filteredSpecs, spec)
}
}
return filteredSpecs
}
func validateTagExpression(tagExpression string) {
filter := &ScenarioFilterBasedOnTags{tagExpression: tagExpression}
filter.replaceSpecialChar()
_, err := filter.formatAndEvaluateExpression(make(map[string]bool, 0), func(a map[string]bool, b string) bool { return true })
if err != nil {
logger.Log.Critical(err.Error())
os.Exit(1)
}
}