summaryrefslogtreecommitdiffstats
path: root/src/goqtestlib/runner.go
blob: c1236d865fac28b63b5af9ca4ef302731a7f10c2 (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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
package goqtestlib

import (
	"errors"
	"fmt"
	"io/ioutil"
	"os"
	"os/exec"
	"path/filepath"
)

const (
	// NoRepetitionsOnFailure is a convenience value for indicating that even a single failing test function is considered an overall failure.
	NoRepetitionsOnFailure int = 0
)

// RunFunction is used by GenerateTestResult to run unit tests in the current environment. In
// the agent this usually means running "make check".
type RunFunction func() error

// GenerateTestResult sets up the environment for QTestLib style testing and calls the runner function for
// to produce the test results. The repetitionsOnFailure allows for a failing test function to fail once
// and have that failure to be ignored under the condition that consequent repeated running of the same
// test function does not produce any failures.
func GenerateTestResult(name string, resultsDirectory string, repetitionsOnFailure int, runner RunFunction) (*TestResult, error) {
	resultsDir := filepath.Join(resultsDirectory, filepath.Dir(name))
	os.MkdirAll(resultsDir, 0755)
	resultsFile, err := ioutil.TempFile(resultsDirectory, name)
	if err != nil {
		return nil, fmt.Errorf("Error creating temporary file to collected test output: %s", err)
	}
	testResult := &TestResult{
		TestCaseName:     name,
		PathToResultsXML: resultsFile.Name(),
	}
	resultsFile.Close()

	os.Setenv("QT_CI_RESULTS_PATH", testResult.PathToResultsXML)

	os.Setenv("TESTARGS", fmt.Sprintf("-o %s,xml -o -,txt", testResult.PathToResultsXML))
	defer os.Setenv("TESTARGS", "")

	err = runner()

	os.Setenv("QT_CI_RESULTS_PATH", "")

	_, ok := err.(*exec.ExitError)
	if err != nil && !ok {
		return nil, err
	}

	fileInfo, statErr := os.Stat(testResult.PathToResultsXML)
	if os.IsNotExist(statErr) || fileInfo.Size() == 0 {
		return nil, err
	}

	if err != nil {
		parsedResult, err := testResult.Parse()
		if err != nil {
			return nil, err
		}

		failingFunctions := parsedResult.FailingFunctions()
		if len(failingFunctions) > 0 {
			if repetitionsOnFailure == 0 {
				return nil, errors.New("Tests failed")
			}

			for _, testFunction := range failingFunctions {
				for i := 0; i < repetitionsOnFailure; i++ {
					os.Setenv("TESTARGS", testFunction)
					if err = runner(); err != nil {
						return nil, err
					}
				}
			}
		}
	}

	return testResult, nil
}