File: main_test.go

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (172 lines) | stat: -rw-r--r-- 4,256 bytes parent folder | download
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
package main

import (
	"archive/zip"
	"bytes"
	"encoding/base64"
	"io"
	"os"
	"sync"
	"testing"
)

func TestRun(t *testing.T) {
	tests := createTestCases()

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			runTest(t, tt)
		})
	}
}

func createTestCases() map[string]struct {
	archiveContent          string
	fileName                string
	expectedOutput          string
	expectedError           string
	missingArchiveEnv       bool
	missingEncodingEnv      bool
	overrideEncodedFileName string
} {
	return map[string]struct {
		archiveContent          string
		fileName                string
		expectedOutput          string
		expectedError           string
		missingArchiveEnv       bool
		missingEncodingEnv      bool
		overrideEncodedFileName string
	}{
		"successful case": {
			archiveContent: "sample content",
			fileName:       "testfile.txt",
			expectedOutput: "14\nsample content",
			expectedError:  "",
		},
		"missing archive path": {
			archiveContent:    "sample content",
			fileName:          "testfile.txt",
			expectedOutput:    "",
			expectedError:     "usage: gitlab-zip-cat\nEnv: ARCHIVE_PATH=https://path.to/archive.zip or /path/to/archive.zip\nEnv: ENCODED_FILE_NAME=base64-encoded-file-name",
			missingArchiveEnv: true,
		},
		"missing encoding name": {
			archiveContent:     "sample content",
			fileName:           "testfile.txt",
			expectedOutput:     "",
			expectedError:      "usage: gitlab-zip-cat\nEnv: ARCHIVE_PATH=https://path.to/archive.zip or /path/to/archive.zip\nEnv: ENCODED_FILE_NAME=base64-encoded-file-name",
			missingEncodingEnv: true,
		},
	}
}

func runTest(t *testing.T, tt struct {
	archiveContent          string
	fileName                string
	expectedOutput          string
	expectedError           string
	missingArchiveEnv       bool
	missingEncodingEnv      bool
	overrideEncodedFileName string
}) {
	archivePath := createTempZipWithFile(tt.fileName, tt.archiveContent)
	encodedFileName := base64.StdEncoding.EncodeToString([]byte(tt.fileName))

	setupEnvironment(tt.missingArchiveEnv, tt.missingEncodingEnv, archivePath, tt.overrideEncodedFileName, encodedFileName)

	stdoutBuf, _, err := captureOutput(run)

	verifyResults(t, tt.expectedError, err, tt.expectedOutput, stdoutBuf)

	unsetEnvironment()
}

func setupEnvironment(missingArchiveEnv, missingEncodingEnv bool, archivePath, overrideEncodedFileName, encodedFileName string) {
	if !missingArchiveEnv {
		os.Setenv("ARCHIVE_PATH", archivePath)
	}
	if !missingEncodingEnv {
		if overrideEncodedFileName != "" {
			encodedFileName = base64.StdEncoding.EncodeToString([]byte(overrideEncodedFileName))
		}
		os.Setenv("ENCODED_FILE_NAME", encodedFileName)
	}
	os.Args = []string{"gitlab-zip-cat"}
}

func captureOutput(fn func() (error, error)) (stdoutBuf, stderrBuf bytes.Buffer, err error) {
	stdoutPipe, stdoutWriter, _ := os.Pipe()
	stderrPipe, stderrWriter, _ := os.Pipe()
	defer stdoutPipe.Close()
	defer stderrPipe.Close()

	oldStdout := os.Stdout
	oldStderr := os.Stderr
	os.Stdout = stdoutWriter
	os.Stderr = stderrWriter
	defer func() {
		os.Stdout = oldStdout
		os.Stderr = oldStderr
	}()

	wg := sync.WaitGroup{}
	wg.Add(2)

	go func() {
		defer wg.Done()
		io.Copy(&stdoutBuf, stdoutPipe)
	}()

	go func() {
		defer wg.Done()
		io.Copy(&stderrBuf, stderrPipe)
	}()

	err, _ = fn()

	stdoutWriter.Close()
	stderrWriter.Close()

	wg.Wait()

	return stdoutBuf, stderrBuf, err
}

func verifyResults(t *testing.T, expectedError string, err error, expectedOutput string, stdoutBuf bytes.Buffer) {
	if expectedError == "" && err != nil {
		t.Fatalf("Expected no error, got %v", err)
	}

	if got := stdoutBuf.String(); got != expectedOutput {
		t.Errorf("Expected %q, got %q", expectedOutput, got)
	}
}

func unsetEnvironment() {
	os.Unsetenv("ARCHIVE_PATH")
	os.Unsetenv("ENCODED_FILE_NAME")
}

func createTempZipWithFile(fileName, content string) string {
	zipFile, err := os.CreateTemp("", "test-archive-*.zip")
	if err != nil {
		panic(err)
	}
	defer zipFile.Close()

	archive := zip.NewWriter(zipFile)
	defer archive.Close()

	w, err := archive.Create(fileName)
	if err != nil {
		panic(err)
	}

	_, err = io.Copy(w, bytes.NewReader([]byte(content)))
	if err != nil {
		panic(err)
	}

	return zipFile.Name()
}