summaryrefslogtreecommitdiff
path: root/integrationtests/fileutils.go
blob: 064a08ae835e4f45d9a9e663094698ff81f93824 (plain)
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
package integrationtests

import (
	"bufio"
	"context"
	"crypto/sha256"
	"encoding/base64"
	"fmt"
	"os"
	"os/exec"
	"strings"
	"testing"
)

func mapFile(t *testing.T, file string) (map[string]int, error) {
	t.Log("Mapping", file)
	contents := make(map[string]int)
	fd, err := os.Open(file)
	if err != nil {
		return contents, err
	}
	defer fd.Close()

	scanner := bufio.NewScanner(fd)
	scanner.Split(bufio.ScanLines)
	for scanner.Scan() {
		line := scanner.Text()
		count := contents[line]
		contents[line] = count + 1
	}

	return contents, nil
}

// Checks whether both files have the same lines (order doesn't matter)
func compareFilesContents(t *testing.T, fileA, fileB string) error {
	compareMaps := func(a, b map[string]int) error {
		for line, countA := range a {
			countB, ok := b[line]
			if !ok {
				return fmt.Errorf("Files differ, line '%s' is missing in one of them", line)
			}
			if countA != countB {
				return fmt.Errorf("Files differ, count of line '%s' is %d in one but %d in another",
					line, countA, countB)
			}
		}
		return nil
	}

	// Read files into maps.
	a, err := mapFile(t, fileA)
	if err != nil {
		return err
	}
	b, err := mapFile(t, fileB)
	if err != nil {
		return err
	}

	// The mapreduce result can be in a different order each time (Golang maps are not sorted).
	t.Logf("Checking whether %s has same lines as file %s (ignoring line order)", fileA, fileB)
	if err := compareMaps(a, b); err != nil {
		return err
	}
	t.Logf("Checking whether %s has same lines as file %s (ignoring line order)", fileB, fileA)
	if err := compareMaps(b, a); err != nil {
		return err
	}

	return nil
}

func compareFiles(t *testing.T, fileA, fileB string) error {
	t.Log("Comparing files", fileA, fileB)
	shaFileA := shaOfFile(t, fileA)
	shaFileB := shaOfFile(t, fileB)

	if shaFileA != shaFileB {
		var sb strings.Builder
		sb.WriteString(fmt.Sprintf("Expected SHA %s but got %s:\n", shaFileA, shaFileB))
		if bytes, err := exec.Command("diff", "-u", fileA, fileB).Output(); err != nil {
			sb.Write(bytes)
		}
		return fmt.Errorf("%s", sb.String())
	}

	return nil
}

func fileContainsStr(t *testing.T, file, str string) error {
	t.Log("Checking if file contains string", file, str)
	m, err := mapFile(t, file)
	if err != nil {
		return err
	}

	for line := range m {
		if strings.Contains(line, str) {
			t.Log(line)
			return nil
		}
	}

	return fmt.Errorf("File %s does not contain string %s", file, str)
}

func shaOfFile(t *testing.T, file string) string {
	bytes, err := os.ReadFile(file)
	if err != nil {
		t.Error(err)
	}
	hasher := sha256.New()
	hasher.Write(bytes)
	sha := base64.URLEncoding.EncodeToString(hasher.Sum(nil))
	t.Log("SHA", file, sha)
	return sha
}

// compareFilesWithContext is a context-aware version of compareFiles that logs comparisons
func compareFilesWithContext(ctx context.Context, t *testing.T, fileA, fileB string) error {
	if logger := GetTestLogger(ctx); logger != nil {
		logger.LogFileComparison(fileA, fileB, "exact (SHA256)")
	}
	return compareFiles(t, fileA, fileB)
}

// compareFilesContentsWithContext is a context-aware version of compareFilesContents that logs comparisons
func compareFilesContentsWithContext(ctx context.Context, t *testing.T, fileA, fileB string) error {
	if logger := GetTestLogger(ctx); logger != nil {
		logger.LogFileComparison(fileA, fileB, "contents (order-independent)")
	}
	return compareFilesContents(t, fileA, fileB)
}

// fileContainsStrWithContext is a context-aware version of fileContainsStr that logs comparisons
func fileContainsStrWithContext(ctx context.Context, t *testing.T, file, str string) error {
	if logger := GetTestLogger(ctx); logger != nil {
		logger.LogFileComparison(file, fmt.Sprintf("string '%s'", str), "contains check")
	}
	return fileContainsStr(t, file, str)
}