File: coverage.go

package info (click to toggle)
golang-github-azure-azure-sdk-for-go 68.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 556,256 kB
  • sloc: javascript: 196; sh: 96; makefile: 7
file content (179 lines) | stat: -rw-r--r-- 4,255 bytes parent folder | download | duplicates (3)
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
package main

import (
	"encoding/json"
	"errors"
	"flag"
	"fmt"
	"io/ioutil"
	"log"
	"os"
	"path/filepath"
	"regexp"
	"strconv"
	"strings"
)

type codeCoverage struct {
	Packages []coveragePackage `json:"Packages"`
}

type coveragePackage struct {
	Name         string  `json:"name"`
	CoverageGoal float64 `json:"CoverageGoal"`
}

const (
	coverageXmlFile = "coverage.xml"
)

func check(e error) {
	if e != nil {
		log.Fatal(e)
	}
}

func findCoverageFiles(root string) []string {
	var coverageFiles []string

	err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}
		if strings.Contains(path, coverageXmlFile) {
			coverageFiles = append(coverageFiles, path)
		}

		return nil
	})

	check(err)

	return coverageFiles
}

func readConfigData(coverageConfig string) *codeCoverage {
	jsonFile, err := os.Open(coverageConfig)
	check(err)
	defer jsonFile.Close()

	byteValue, err := ioutil.ReadAll(jsonFile)
	check(err)

	var cov codeCoverage
	err = json.Unmarshal([]byte(byteValue), &cov)
	check(err)
	return &cov
}

// This supports doing a single package at a time. If this needs to be expanded in the future
// this method will have to return a []*float64 for each packages goal
func findCoverageGoal(covFiles []string, configData *codeCoverage) float64 {
	for _, covFile := range covFiles {

		// check for an exact match _first_, then go to fuzzy matching
		for _, p := range configData.Packages {
			if covFile == p.Name {
				return p.CoverageGoal
			}
		}

		for _, p := range configData.Packages {
			if strings.Contains(covFile, p.Name) {
				return p.CoverageGoal
			}
		}
	}
	fmt.Println("WARNING: Could not find a coverage goal, defaulting to 95%.")
	return 0.95
}

func parseCoveragePercent(xmlContents []byte) (float64, error) {
	re := regexp.MustCompile(`<coverage line-rate=\"(\d(?:\.\d+)?)\"`)
	matches := re.FindStringSubmatch(string(xmlContents[:]))

	if len(matches) < 2 {
		return 0, errors.New("could not match regexp to coverage.xml file")
	}

	coverageFloat, err := strconv.ParseFloat(matches[1], 32)
	if err != nil {
		return 0, err
	}

	return coverageFloat, nil
}

func parseCoverageFiles(coverageFiles []string) []float64 {
	coverageValues := make([]float64, 0)

	for _, coverageFile := range coverageFiles {
		fmt.Println(coverageFile)
		xmlFile, err := os.Open(coverageFile)
		check(err)
		defer xmlFile.Close()

		byteValue, err := ioutil.ReadAll(xmlFile)
		check(err)

		coveragePercent, err := parseCoveragePercent(byteValue)
		check(err)

		coverageValues = append(coverageValues, coveragePercent)
	}

	return coverageValues
}

func CheckCoverage(serviceDir string, coverageConfig string, searchDirectory string) {
	rootPath, err := filepath.Abs(searchDirectory)
	check(err)

	fmt.Printf("Searching for coverage files in %s\n", rootPath)

	coverageFiles := findCoverageFiles(rootPath)
	if len(coverageFiles) == 0 {
		fmt.Println("No coverage files found in " + rootPath)
		return
	}

	fmt.Printf("Reading config data from %s\n", coverageConfig)

	configData := readConfigData(coverageConfig)
	coverageGoal := findCoverageGoal([]string{serviceDir}, configData)

	fmt.Printf("(%s) Failing if the coverage is below %.2f\n", serviceDir, coverageGoal)

	coverageValues := parseCoverageFiles(coverageFiles)

	if len(coverageValues) != len(coverageFiles) {
		fmt.Printf("Found %d coverage values in %d coverage files\n", len(coverageValues), len(coverageFiles))
	}

	failedCoverage := false
	for i := range coverageValues {
		status := "Succeeded"
		if coverageValues[i] < coverageGoal {
			status = "Failed"
		}
		fmt.Printf("Status: %v\tCoverage file: %v\t Coverage Amount: %.4f\n", status, coverageFiles[i], coverageValues[i])
		if coverageValues[i] < coverageGoal {
			failedCoverage = true
		}
	}

	if failedCoverage {
		log.Fatal("Found insufficient coverage.")
	}
}

func main() {
	coverageConfig := flag.String("config", "", "Coverage Threshold Configuration")
	serviceDir := flag.String("serviceDirectory", "", "Service Directory")
	searchDirectory := flag.String("searchDirectory", ".", "Search Directory")
	flag.Parse()
	if *coverageConfig == "" {
		log.Fatal("Required flag: '-config'")
	}
	CheckCoverage(*serviceDir, *coverageConfig, *searchDirectory)
}