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
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2015-2018 Canonical Ltd
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package testutil
import (
"bytes"
"fmt"
"os"
"regexp"
"strings"
"gopkg.in/check.v1"
)
type fileContentChecker struct {
*check.CheckerInfo
exact bool
}
// FileEquals verifies that the given file's content is equal to the string (or
// fmt.Stringer), []byte provided, or the contents referred by a FileContentRef.
var FileEquals check.Checker = &fileContentChecker{
CheckerInfo: &check.CheckerInfo{Name: "FileEquals", Params: []string{"filename", "contents"}},
exact: true,
}
// FileContains verifies that the given file's content contains
// the string (or fmt.Stringer) or []byte provided.
var FileContains check.Checker = &fileContentChecker{
CheckerInfo: &check.CheckerInfo{Name: "FileContains", Params: []string{"filename", "contents"}},
}
// FileMatches verifies that the given file's content matches
// the string provided.
var FileMatches check.Checker = &fileContentChecker{
CheckerInfo: &check.CheckerInfo{Name: "FileMatches", Params: []string{"filename", "regex"}},
}
// FileContentRef refers to the content of file by its name, to use in
// conjunction with FileEquals.
type FileContentRef string
func (c *fileContentChecker) Check(params []any, names []string) (result bool, error string) {
filename, ok := params[0].(string)
if !ok {
return false, "Filename must be a string"
}
if names[1] == "regex" {
regexpr, ok := params[1].(string)
if !ok {
return false, "Regex must be a string"
}
rx, err := regexp.Compile(regexpr)
if err != nil {
return false, fmt.Sprintf("Cannot compile regexp %q: %v", regexpr, err)
}
params[1] = rx
}
return fileContentCheck(filename, params[1], c.exact)
}
func fileContentCheck(filename string, content any, exact bool) (result bool, error string) {
buf, err := os.ReadFile(filename)
if err != nil {
return false, fmt.Sprintf("Cannot read file %q: %v", filename, err)
}
presentableBuf := string(buf)
if exact {
switch content := content.(type) {
case string:
result = presentableBuf == content
case []byte:
result = bytes.Equal(buf, content)
presentableBuf = "<binary data>"
case fmt.Stringer:
result = presentableBuf == content.String()
case FileContentRef:
referenceFilename := string(content)
reference, err := os.ReadFile(referenceFilename)
if err != nil {
return false, fmt.Sprintf("Cannot read reference file %q: %v", referenceFilename, err)
}
result = bytes.Equal(buf, reference)
if !result {
error = fmt.Sprintf("Failed to match contents with reference file %q:\n%v", referenceFilename, presentableBuf)
}
default:
error = fmt.Sprintf("Cannot compare file contents with something of type %T", content)
}
} else {
switch content := content.(type) {
case string:
result = strings.Contains(presentableBuf, content)
case []byte:
result = bytes.Contains(buf, content)
presentableBuf = "<binary data>"
case *regexp.Regexp:
result = content.Match(buf)
case fmt.Stringer:
result = strings.Contains(presentableBuf, content.String())
case FileContentRef:
error = "Non-exact match with reference file is not supported"
default:
error = fmt.Sprintf("Cannot compare file contents with something of type %T", content)
}
}
if !result {
if error == "" {
error = fmt.Sprintf("Failed to match with file contents:\n%v", presentableBuf)
}
return result, error
}
return result, ""
}
|
