/
reporthelper.go
208 lines (161 loc) · 5.89 KB
/
reporthelper.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
204
205
206
207
208
package globalhelper
import (
"encoding/json"
"fmt"
"io"
"os"
"path"
"path/filepath"
"strings"
"github.com/golang/glog"
"github.com/test-network-function/cnfcert-tests-verification/tests/globalparameters"
"github.com/test-network-function/test-network-function-claim/pkg/claim"
)
// OpenClaimReport opens claim.json file and returns struct.
func OpenClaimReport(reportDir string) (*claim.Root, error) {
dataClaim, err := os.Open(path.Join(reportDir, globalparameters.DefaultClaimFileName))
if err != nil {
return nil, fmt.Errorf("error opening %s report file: %w", globalparameters.DefaultClaimFileName, err)
}
byteValueClaim, err := io.ReadAll(dataClaim)
if err != nil {
return nil, fmt.Errorf("error reading %s report file: %w", globalparameters.DefaultClaimFileName, err)
}
var claimRootReport claim.Root
err = json.Unmarshal(byteValueClaim, &claimRootReport)
if err != nil {
return nil, fmt.Errorf("error unmarshalling %s report file: %w", globalparameters.DefaultClaimFileName, err)
}
return &claimRootReport, nil
}
// IsTestCasePassedInClaimReport tests if test case is passed as expected in claim.json file.
func IsTestCasePassedInClaimReport(testCaseName string, claimReport claim.Root) (bool, error) {
return isTestCaseInExpectedStatusInClaimReport(testCaseName, claimReport, globalparameters.TestCasePassed)
}
// IsTestCaseFailedInClaimReport test if test case is failed as expected in claim.json file.
func IsTestCaseFailedInClaimReport(testCaseName string, claimReport claim.Root) (bool, error) {
return isTestCaseInExpectedStatusInClaimReport(testCaseName, claimReport, globalparameters.TestCaseFailed)
}
// IsTestCaseSkippedInClaimReport test if test case is failed as expected in claim.json file.
func IsTestCaseSkippedInClaimReport(testCaseName string, claimReport claim.Root) (bool, error) {
return isTestCaseInExpectedStatusInClaimReport(testCaseName, claimReport, globalparameters.TestCaseSkipped)
}
// RemoveContentsFromReportDir removes all files from report dir.
func RemoveContentsFromReportDir(reportDir string) error {
glog.V(5).Info(fmt.Sprintf("removing all files from %s directory", reportDir))
tnfReportDir, err := os.Open(reportDir)
if err != nil {
return fmt.Errorf("failed to open report directory: %w", err)
}
defer tnfReportDir.Close()
names, err := tnfReportDir.Readdirnames(-1)
if err != nil {
return err
}
for _, name := range names {
err = os.RemoveAll(filepath.Join(reportDir, name))
if err != nil {
return fmt.Errorf("failed to remove content from report directory: %w", err)
}
glog.V(5).Info(fmt.Sprintf("file %s removed from %s directory",
name,
reportDir))
}
// Delete the report directory
err = os.Remove(reportDir)
if err != nil {
return fmt.Errorf("failed to remove report directory: %w", err)
}
return nil
}
func RemoveContentsFromConfigDir(configDir string) error {
tnfConfigDir, err := os.Open(configDir)
if err != nil {
return fmt.Errorf("failed to open config directory: %w", err)
}
defer tnfConfigDir.Close()
names, err := tnfConfigDir.Readdirnames(-1)
if err != nil {
return err
}
for _, name := range names {
err = os.RemoveAll(filepath.Join(configDir, name))
if err != nil {
return fmt.Errorf("failed to remove content from config directory: %w", err)
}
glog.V(5).Info(fmt.Sprintf("file %s removed from %s directory",
name,
configDir))
}
// Delete the config directory
err = os.Remove(configDir)
if err != nil {
return fmt.Errorf("failed to remove config directory: %w", err)
}
return nil
}
// ConvertSpecNameToFileName converts given spec name to file name.
func ConvertSpecNameToFileName(specName string) string {
formatString := specName
for _, symbol := range []string{" ", ", ", "-", "/"} {
formatString = strings.ReplaceAll(formatString, symbol, "_")
}
return strings.ToLower(removeCharactersFromString(formatString, []string{","}))
}
func isTestCaseInExpectedStatusInClaimReport(
testCaseName string,
claimReport claim.Root,
expectedStatus string) (bool, error) {
for testCaseClaim := range claimReport.Claim.Results {
if formatTestCaseName(testCaseClaim) == formatTestCaseName(testCaseName) {
var testCaseResult *claim.Result
encodedTestResult, err := json.Marshal(claimReport.Claim.Results[testCaseClaim])
if err != nil {
return false, err
}
err = json.Unmarshal(encodedTestResult, &testCaseResult)
if err != nil {
return false, err
}
if testCaseResult.State == expectedStatus {
glog.V(5).Info("claim report test case status passed")
return true, nil
}
return false, fmt.Errorf("invalid test status %s instead expected %s",
testCaseResult.State,
expectedStatus)
}
}
return false, fmt.Errorf("test case is not found in the claim report")
}
func removeCharactersFromString(stringToFormat string, charactersToRemove []string) string {
var formattedString string
for index, element := range charactersToRemove {
if index == 0 {
formattedString = strings.ReplaceAll(stringToFormat, element, "")
}
formattedString = strings.ReplaceAll(formattedString, element, "")
}
return formattedString
}
func formatTestCaseName(tcName string) string {
return removeCharactersFromString(tcName, []string{"-", "_", " ", "online,"})
}
func CopyClaimFileToTcFolder(tcName, formattedTcName, reportDir string) {
srcClaim := path.Join(reportDir, globalparameters.DefaultClaimFileName)
dstDir := path.Join(GetConfiguration().General.ReportDirAbsPath, "Debug", getTestSuiteName(tcName), formattedTcName)
dstClaim := path.Join(dstDir, globalparameters.DefaultClaimFileName)
_, err := os.Stat(srcClaim)
if err != nil {
glog.Error("file does not exist ", srcClaim)
}
// create destination folder
err = os.MkdirAll(dstDir, os.ModePerm)
if err != nil {
glog.Error("could not create dest directory= %s, err=%s", dstDir, err)
}
err = CopyFiles(srcClaim, dstClaim)
if err != nil {
glog.Fatalf("failed to copy %s to %s", srcClaim, dstClaim)
}
}