/
check_conformance_test_requirements.go
155 lines (138 loc) · 4.03 KB
/
check_conformance_test_requirements.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
/*
Copyright 2019 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// This tool is for checking conformance e2e tests follow the requirements
// which is https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md#conformance-test-requirements
package main
import (
"bufio"
"bytes"
"errors"
"fmt"
"os"
"regexp"
"github.com/spf13/cobra"
)
const (
//e.g. framework.ConformanceIt("should provide secure master service ", func() {
patternStartConformance = `framework.ConformanceIt\(.*, func\(\) {$`
patternEndConformance = `}\)$`
patternSkip = `e2eskipper.Skip.*\(`
)
// This function checks the requirement: it works for all providers (e.g., no SkipIfProviderIs/SkipUnlessProviderIs calls)
func checkAllProviders(e2eFile string) error {
checkFailed := false
inConformanceCode := false
regStartConformance := regexp.MustCompile(patternStartConformance)
regEndConformance := regexp.MustCompile(patternEndConformance)
regSkip := regexp.MustCompile(patternSkip)
fileInput, err := os.ReadFile(e2eFile)
if err != nil {
return fmt.Errorf("Failed to read file %s: %w", e2eFile, err)
}
scanner := bufio.NewScanner(bytes.NewReader(fileInput))
scanner.Split(bufio.ScanLines)
for scanner.Scan() {
line := scanner.Text()
if regStartConformance.MatchString(line) {
if inConformanceCode {
return errors.New("Missed the end of previous conformance test. There might be a bug in this script.")
}
inConformanceCode = true
}
if inConformanceCode {
if regSkip.MatchString(line) {
// To list all invalid places in a single operation of this tool, here doesn't return error and continues checking.
fmt.Fprintf(os.Stderr, "%v: Conformance test should not call any e2eskipper.Skip*()\n", e2eFile)
checkFailed = true
}
if regEndConformance.MatchString(line) {
inConformanceCode = false
}
}
}
if inConformanceCode {
return errors.New("Missed the end of previous conformance test. There might be a bug in this script.")
}
if checkFailed {
return errors.New("We need to fix the above errors.")
}
return nil
}
func processFile(e2ePath string) error {
regGoFile := regexp.MustCompile(`.*\.go`)
files, err := os.ReadDir(e2ePath)
if err != nil {
return fmt.Errorf("Failed to read dir %s: %w", e2ePath, err)
}
for _, file := range files {
if file.IsDir() {
continue
}
if !regGoFile.MatchString(file.Name()) {
continue
}
e2eFile := fmt.Sprintf("%s/%s", e2ePath, file.Name())
err = checkAllProviders(e2eFile)
if err != nil {
return err
}
}
return nil
}
func processDir(e2ePath string) error {
err := processFile(e2ePath)
if err != nil {
return err
}
// Search sub directories if exist
files, err := os.ReadDir(e2ePath)
if err != nil {
return fmt.Errorf("Failed to read dir %s: %w", e2ePath, err)
}
for _, file := range files {
if !file.IsDir() {
continue
}
err = processDir(fmt.Sprintf("%s/%s", e2ePath, file.Name()))
if err != nil {
return err
}
}
return nil
}
func newCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "check_conformance_test_requirements [e2e-test-path]",
Short: "Check conformance test code follows the requirements",
Run: func(cmd *cobra.Command, args []string) {
if len(args) != 1 {
cmd.Help()
os.Exit(1)
}
e2eRootPath := args[0]
err := processDir(e2eRootPath)
if err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(1)
}
os.Exit(0)
},
}
return cmd
}
func main() {
command := newCommand()
if err := command.Execute(); err != nil {
os.Exit(1)
}
}