forked from cert-manager/cert-manager
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request cert-manager#2236 from munnerz/covered-images
Add Bazel image targets with coverage enabled
- Loading branch information
Showing
12 changed files
with
253 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
load("@io_bazel_rules_go//go:def.bzl", "go_library") | ||
|
||
go_library( | ||
name = "go_default_library", | ||
srcs = [ | ||
"coverage.go", | ||
"faketestdeps.go", | ||
], | ||
importpath = "github.com/jetstack/cert-manager/pkg/util/coverage", | ||
visibility = ["//visibility:public"], | ||
deps = [ | ||
"@io_k8s_apimachinery//pkg/util/wait:go_default_library", | ||
"@io_k8s_klog//:go_default_library", | ||
], | ||
) | ||
|
||
filegroup( | ||
name = "package-srcs", | ||
srcs = glob(["**"]), | ||
tags = ["automanaged"], | ||
visibility = ["//visibility:private"], | ||
) | ||
|
||
filegroup( | ||
name = "all-srcs", | ||
srcs = [":package-srcs"], | ||
tags = ["automanaged"], | ||
visibility = ["//visibility:public"], | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
/* | ||
Copyright 2019 The Jetstack cert-manager contributors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
// Package coverage provides tools for coverage-instrumented binaries to collect and | ||
// flush coverage information. | ||
package coverage | ||
|
||
import ( | ||
"flag" | ||
"fmt" | ||
"os" | ||
"testing" | ||
"time" | ||
|
||
"k8s.io/apimachinery/pkg/util/wait" | ||
"k8s.io/klog" | ||
) | ||
|
||
var coverageFile string | ||
|
||
// tempCoveragePath returns a temporary file to write coverage information to. | ||
// The file is in the same directory as the destination, ensuring os.Rename will work. | ||
func tempCoveragePath() string { | ||
return coverageFile + ".tmp" | ||
} | ||
|
||
// InitCoverage is called from the dummy unit test to prepare Go's coverage framework. | ||
// Clients should never need to call it. | ||
func InitCoverage(name string) { | ||
// We read the coverage destination in from the COVERPROFILE env var, | ||
// or if it's empty we just use a default in /tmp | ||
coverageFile = os.Getenv("COVERPROFILE") | ||
if coverageFile == "" { | ||
coverageFile = "/tmp/cm-" + name + ".cov" | ||
} | ||
fmt.Println("Dumping coverage information to " + coverageFile) | ||
|
||
flushInterval := 5 * time.Second | ||
requestedInterval := os.Getenv("COVERAGE_FLUSH_INTERVAL") | ||
if requestedInterval != "" { | ||
if duration, err := time.ParseDuration(requestedInterval); err == nil { | ||
flushInterval = duration | ||
} else { | ||
panic("Invalid COVERAGE_FLUSH_INTERVAL value; try something like '30s'.") | ||
} | ||
} | ||
|
||
// Set up the unit test framework with the required arguments to activate test coverage. | ||
flag.CommandLine.Parse([]string{"-test.coverprofile", tempCoveragePath()}) | ||
|
||
// Begin periodic logging | ||
go wait.Forever(FlushCoverage, flushInterval) | ||
} | ||
|
||
// FlushCoverage flushes collected coverage information to disk. | ||
// The destination file is configured at startup and cannot be changed. | ||
// Calling this function also sends a line like "coverage: 5% of statements" to stdout. | ||
func FlushCoverage() { | ||
// We're not actually going to run any tests, but we need Go to think we did so it writes | ||
// coverage information to disk. To achieve this, we create a bunch of empty test suites and | ||
// have it "run" them. | ||
tests := []testing.InternalTest{} | ||
benchmarks := []testing.InternalBenchmark{} | ||
examples := []testing.InternalExample{} | ||
|
||
var deps fakeTestDeps | ||
|
||
dummyRun := testing.MainStart(deps, tests, benchmarks, examples) | ||
dummyRun.Run() | ||
|
||
// Once it writes to the temporary path, we move it to the intended path. | ||
// This gets us atomic updates from the perspective of another process trying to access | ||
// the file. | ||
if err := os.Rename(tempCoveragePath(), coverageFile); err != nil { | ||
klog.Errorf("Couldn't move coverage file from %s to %s", coverageFile, tempCoveragePath()) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
/* | ||
Copyright 2019 The Jetstack cert-manager contributors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package coverage | ||
|
||
import ( | ||
"io" | ||
) | ||
|
||
// This is an implementation of testing.testDeps. It doesn't need to do anything, because | ||
// no tests are actually run. It does need a concrete implementation of at least ImportPath, | ||
// which is called unconditionally when running tests. | ||
type fakeTestDeps struct{} | ||
|
||
func (fakeTestDeps) ImportPath() string { | ||
return "" | ||
} | ||
|
||
func (fakeTestDeps) MatchString(pat, str string) (bool, error) { | ||
return false, nil | ||
} | ||
|
||
func (fakeTestDeps) StartCPUProfile(io.Writer) error { | ||
return nil | ||
} | ||
|
||
func (fakeTestDeps) StopCPUProfile() {} | ||
|
||
func (fakeTestDeps) StartTestLog(io.Writer) {} | ||
|
||
func (fakeTestDeps) StopTestLog() error { | ||
return nil | ||
} | ||
|
||
func (fakeTestDeps) WriteHeapProfile(io.Writer) error { | ||
return nil | ||
} | ||
|
||
func (fakeTestDeps) WriteProfileTo(string, io.Writer, int) error { | ||
return nil | ||
} |