File: compile.go

package info (click to toggle)
golang-github-onsi-ginkgo-v2 2.22.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,060 kB
  • sloc: javascript: 59; makefile: 23; sh: 14
file content (173 lines) | stat: -rw-r--r-- 4,528 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
173
package internal

import (
	"fmt"
	"os"
	"os/exec"
	"path/filepath"
	"strings"
	"sync"

	"github.com/onsi/ginkgo/v2/types"
)

func CompileSuite(suite TestSuite, goFlagsConfig types.GoFlagsConfig) TestSuite {
	if suite.PathToCompiledTest != "" {
		return suite
	}

	suite.CompilationError = nil

	path, err := filepath.Abs(filepath.Join(suite.Path, suite.PackageName+".test"))
	if err != nil {
		suite.State = TestSuiteStateFailedToCompile
		suite.CompilationError = fmt.Errorf("Failed to compute compilation target path:\n%s", err.Error())
		return suite
	}

	if len(goFlagsConfig.O) > 0 {
		userDefinedPath, err := filepath.Abs(goFlagsConfig.O)
		if err != nil {
			suite.State = TestSuiteStateFailedToCompile
			suite.CompilationError = fmt.Errorf("Failed to compute compilation target path %s:\n%s", goFlagsConfig.O, err.Error())
			return suite
		}
		path = userDefinedPath
	}

	goFlagsConfig.O = path

	ginkgoInvocationPath, _ := os.Getwd()
	ginkgoInvocationPath, _ = filepath.Abs(ginkgoInvocationPath)
	packagePath := suite.AbsPath()
	pathToInvocationPath, err := filepath.Rel(packagePath, ginkgoInvocationPath)
	if err != nil {
		suite.State = TestSuiteStateFailedToCompile
		suite.CompilationError = fmt.Errorf("Failed to get relative path from package to the current working directory:\n%s", err.Error())
		return suite
	}
	args, err := types.GenerateGoTestCompileArgs(goFlagsConfig, "./", pathToInvocationPath)
	if err != nil {
		suite.State = TestSuiteStateFailedToCompile
		suite.CompilationError = fmt.Errorf("Failed to generate go test compile flags:\n%s", err.Error())
		return suite
	}

	cmd := exec.Command("go", args...)
	cmd.Dir = suite.Path
	output, err := cmd.CombinedOutput()
	if err != nil {
		if len(output) > 0 {
			suite.State = TestSuiteStateFailedToCompile
			suite.CompilationError = fmt.Errorf("Failed to compile %s:\n\n%s", suite.PackageName, output)
		} else {
			suite.State = TestSuiteStateFailedToCompile
			suite.CompilationError = fmt.Errorf("Failed to compile %s\n%s", suite.PackageName, err.Error())
		}
		return suite
	}

	if strings.Contains(string(output), "[no test files]") {
		suite.State = TestSuiteStateSkippedDueToEmptyCompilation
		return suite
	}

	if len(output) > 0 {
		fmt.Println(string(output))
	}

	if !FileExists(path) {
		suite.State = TestSuiteStateFailedToCompile
		suite.CompilationError = fmt.Errorf("Failed to compile %s:\nOutput file %s could not be found", suite.PackageName, path)
		return suite
	}

	suite.State = TestSuiteStateCompiled
	suite.PathToCompiledTest = path
	return suite
}

func Cleanup(goFlagsConfig types.GoFlagsConfig, suites ...TestSuite) {
	if goFlagsConfig.BinaryMustBePreserved() {
		return
	}
	for _, suite := range suites {
		if !suite.Precompiled {
			os.Remove(suite.PathToCompiledTest)
		}
	}
}

type parallelSuiteBundle struct {
	suite    TestSuite
	compiled chan TestSuite
}

type OrderedParallelCompiler struct {
	mutex        *sync.Mutex
	stopped      bool
	numCompilers int

	idx                int
	numSuites          int
	completionChannels []chan TestSuite
}

func NewOrderedParallelCompiler(numCompilers int) *OrderedParallelCompiler {
	return &OrderedParallelCompiler{
		mutex:        &sync.Mutex{},
		numCompilers: numCompilers,
	}
}

func (opc *OrderedParallelCompiler) StartCompiling(suites TestSuites, goFlagsConfig types.GoFlagsConfig) {
	opc.stopped = false
	opc.idx = 0
	opc.numSuites = len(suites)
	opc.completionChannels = make([]chan TestSuite, opc.numSuites)

	toCompile := make(chan parallelSuiteBundle, opc.numCompilers)
	for compiler := 0; compiler < opc.numCompilers; compiler++ {
		go func() {
			for bundle := range toCompile {
				c, suite := bundle.compiled, bundle.suite
				opc.mutex.Lock()
				stopped := opc.stopped
				opc.mutex.Unlock()
				if !stopped {
					suite = CompileSuite(suite, goFlagsConfig)
				}
				c <- suite
			}
		}()
	}

	for idx, suite := range suites {
		opc.completionChannels[idx] = make(chan TestSuite, 1)
		toCompile <- parallelSuiteBundle{suite, opc.completionChannels[idx]}
		if idx == 0 { //compile first suite serially
			suite = <-opc.completionChannels[0]
			opc.completionChannels[0] <- suite
		}
	}

	close(toCompile)
}

func (opc *OrderedParallelCompiler) Next() (int, TestSuite) {
	if opc.idx >= opc.numSuites {
		return opc.numSuites, TestSuite{}
	}

	idx := opc.idx
	suite := <-opc.completionChannels[idx]
	opc.idx = opc.idx + 1

	return idx, suite
}

func (opc *OrderedParallelCompiler) StopAndDrain() {
	opc.mutex.Lock()
	opc.stopped = true
	opc.mutex.Unlock()
}