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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
|
package integration_test
import (
"os"
"os/exec"
"regexp"
"strconv"
"strings"
"time"
"fmt"
. "github.com/onsi/ginkgo/v2"
"github.com/onsi/ginkgo/v2/types"
. "github.com/onsi/gomega"
"github.com/onsi/gomega/gbytes"
"github.com/onsi/gomega/gexec"
)
type ProfileLine struct {
Index int
Caller string
CumStat float64
}
type ProfileLines []ProfileLine
func (lines ProfileLines) FindCaller(caller string) ProfileLine {
for _, line := range lines {
if strings.Contains(line.Caller, caller) {
return line
}
}
Fail(fmt.Sprintf("Could not find caller %s among profile lines %+v.", caller, lines), 1)
return ProfileLine{}
}
var PROFILE_RE = regexp.MustCompile(`[\d\.]+[MBms]*\s*[\d\.]+\%\s*[\d\.]+\%\s*([\d\.]+[MBnms]*)\s*[\d\.]+\%\s*(.*)`)
func ParseProfile(binary string, path string) ProfileLines {
cmd := exec.Command("go", "tool", "pprof", "-cum", "-top", binary, path)
output, err := cmd.CombinedOutput()
GinkgoWriter.Printf("Profile for: %s\n%s\n", path, string(output))
ExpectWithOffset(1, err).ShouldNot(HaveOccurred())
out := ProfileLines{}
idx := 0
for _, line := range strings.Split(string(output), "\n") {
matches := PROFILE_RE.FindStringSubmatch(line)
if matches == nil {
continue
}
cumStatEntry := matches[1]
var cumStat float64
if strings.Contains(cumStatEntry, "MB") {
var err error
cumStat, err = strconv.ParseFloat(strings.TrimSuffix(cumStatEntry, "MB"), 64)
ExpectWithOffset(1, err).ShouldNot(HaveOccurred())
} else {
duration, err := time.ParseDuration(cumStatEntry)
ExpectWithOffset(1, err).ShouldNot(HaveOccurred())
cumStat = float64(duration.Milliseconds())
}
out = append(out, ProfileLine{
Index: idx,
Caller: matches[2],
CumStat: cumStat,
})
idx += 1
}
return out
}
var _ = Describe("Profiling Specs", func() {
Describe("Measuring code coverage", func() {
BeforeEach(func() {
fm.MountFixture("coverage")
})
processCoverageProfile := func(path string) string {
profileOutput, err := exec.Command("go", "tool", "cover", fmt.Sprintf("-func=%s", path)).CombinedOutput()
ExpectWithOffset(1, err).ShouldNot(HaveOccurred())
return string(profileOutput)
}
Context("when running a single package in series or in parallel with -cover", func() {
It("emits the coverage percentage and generates a cover profile", func() {
seriesSession := startGinkgo(fm.PathTo("coverage"), "--no-color", "-cover")
Eventually(seriesSession).Should(gexec.Exit(0))
Ω(seriesSession.Out).Should(gbytes.Say(`coverage: 80\.0% of statements`))
seriesCoverage := processCoverageProfile(fm.PathTo("coverage", "coverprofile.out"))
fm.RemoveFile("coverage", "coverprofile.out")
parallelSession := startGinkgo(fm.PathTo("coverage"), "--no-color", "--procs=2", "-cover")
Eventually(parallelSession).Should(gexec.Exit(0))
Ω(parallelSession.Out).Should(gbytes.Say(`coverage: 80\.0% of statements`))
parallelCoverage := processCoverageProfile(fm.PathTo("coverage", "coverprofile.out"))
Ω(parallelCoverage).Should(Equal(seriesCoverage))
})
})
Context("with -coverpkg", func() {
It("computes coverage of the passed-in additional packages", func() {
coverPkgFlag := fmt.Sprintf("-coverpkg=%s,%s", fm.PackageNameFor("coverage"), fm.PackageNameFor("coverage/external_coverage"))
seriesSession := startGinkgo(fm.PathTo("coverage"), coverPkgFlag)
Eventually(seriesSession).Should(gexec.Exit(0))
Ω(seriesSession.Out).Should(gbytes.Say(`coverage: (80\.0|71\.4)% of statements in`))
seriesCoverage := processCoverageProfile(fm.PathTo("coverage", "coverprofile.out"))
fm.RemoveFile("coverage", "coverprofile.out")
parallelSession := startGinkgo(fm.PathTo("coverage"), "--no-color", "--procs=2", coverPkgFlag)
Eventually(parallelSession).Should(gexec.Exit(0))
Ω(parallelSession.Out).Should(gbytes.Say(`coverage: (80\.0|71\.4)% of statements`))
parallelCoverage := processCoverageProfile(fm.PathTo("coverage", "coverprofile.out"))
Ω(parallelCoverage).Should(Equal(seriesCoverage))
})
It("supports ./...", func() {
seriesSession := startGinkgo(fm.PathTo("coverage"), "-coverpkg=./...", "-r")
Eventually(seriesSession).Should(gexec.Exit(0))
Ω(seriesSession.Out).Should(gbytes.Say(`composite coverage: 100\.0% of statements`))
seriesCoverage := processCoverageProfile(fm.PathTo("coverage", "coverprofile.out"))
fm.RemoveFile("coverage", "coverprofile.out")
parallelSession := startGinkgo(fm.PathTo("coverage"), "--no-color", "--procs=2", "-coverpkg=./...", "-r")
Eventually(parallelSession).Should(gexec.Exit(0))
Ω(parallelSession.Out).Should(gbytes.Say(`composite coverage: 100\.0% of statements`))
parallelCoverage := processCoverageProfile(fm.PathTo("coverage", "coverprofile.out"))
Ω(parallelCoverage).Should(Equal(seriesCoverage))
})
})
Context("with a custom profile name", func() {
It("generates cover profiles with the specified name", func() {
session := startGinkgo(fm.PathTo("coverage"), "--no-color", "-coverprofile=myprofile.out")
Eventually(session).Should(gexec.Exit(0))
Ω(session.Out).Should(gbytes.Say(`coverage: 80\.0% of statements`))
Ω(fm.PathTo("coverage", "myprofile.out")).Should(BeAnExistingFile())
Ω(fm.PathTo("coverage", "coverprofile.out")).ShouldNot(BeAnExistingFile())
})
})
Context("when multiple suites are tested", func() {
BeforeEach(func() {
fm.MountFixture("combined_coverage")
})
It("generates a single cover profile", func() {
session := startGinkgo(fm.PathTo("combined_coverage"), "--no-color", "--cover", "-r", "--procs=2", "--covermode=atomic")
Eventually(session).Should(gexec.Exit(0))
Ω(fm.PathTo("combined_coverage", "coverprofile.out")).Should(BeAnExistingFile())
Ω(fm.PathTo("combined_coverage", "first_package/coverprofile.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("combined_coverage", "second_package/coverprofile.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("combined_coverage", "third_package/coverprofile.out")).ShouldNot(BeAnExistingFile())
Ω(session.Out).Should(gbytes.Say(`coverage: 80\.0% of statements`))
Ω(session.Out).Should(gbytes.Say(`coverage: 100\.0% of statements`))
Ω(session.Out).Should(gbytes.Say(`coverage: \[no statements\]`))
By("ensuring there is only one 'mode:' line")
re := regexp.MustCompile(`mode: atomic`)
content := fm.ContentOf("combined_coverage", "coverprofile.out")
matches := re.FindAllStringIndex(content, -1)
Ω(len(matches)).Should(Equal(1))
By("emitting a composite coverage score")
Ω(session.Out).Should(gbytes.Say(`composite coverage: 90\.0% of statements`))
})
Context("when -keep-separate-coverprofiles is set", func() {
It("generates separate coverprofiles", Label("slow"), func() {
session := startGinkgo(fm.PathTo("combined_coverage"), "--no-color", "--cover", "-r", "--procs=2", "--keep-separate-coverprofiles")
Eventually(session).Should(gexec.Exit(0))
Ω(fm.PathTo("combined_coverage", "coverprofile.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("combined_coverage", "first_package/coverprofile.out")).Should(BeAnExistingFile())
Ω(fm.PathTo("combined_coverage", "second_package/coverprofile.out")).Should(BeAnExistingFile())
Ω(fm.PathTo("combined_coverage", "third_package/coverprofile.out")).Should(BeAnExistingFile())
})
})
})
Context("when -output-dir is set", func() {
BeforeEach(func() {
fm.MountFixture("combined_coverage")
})
It("puts the cover profile in -output-dir", func() {
session := startGinkgo(fm.PathTo("combined_coverage"), "--no-color", "--cover", "-r", "--procs=2", "--output-dir=./output")
Eventually(session).Should(gexec.Exit(0))
Ω(fm.PathTo("combined_coverage", "output/coverprofile.out")).Should(BeAnExistingFile())
By("emitting a composite coverage score")
Ω(session.Out).Should(gbytes.Say(`composite coverage: 90\.0% of statements`))
})
Context("when -keep-separate-coverprofiles is set", func() {
It("puts namespaced coverprofiles in the -output-dir", func() {
session := startGinkgo(fm.PathTo("combined_coverage"), "--no-color", "--cover", "-r", "--procs=2", "--output-dir=./output", "--keep-separate-coverprofiles")
Eventually(session).Should(gexec.Exit(0))
Ω(fm.PathTo("combined_coverage", "output/coverprofile.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("combined_coverage", "output/first_package_coverprofile.out")).Should(BeAnExistingFile())
Ω(fm.PathTo("combined_coverage", "output/second_package_coverprofile.out")).Should(BeAnExistingFile())
})
})
})
})
Describe("measuring cpu, memory, block, and mutex profiles", func() {
BeforeEach(func() {
fm.MountFixture("profile")
})
DescribeTable("profile behavior",
func(pathToBinary func(string) string, pathToProfile func(string, string) string, args ...string) {
args = append([]string{"--no-color", "-r", "--cpuprofile=cpu.out", "--memprofile=mem.out", "--blockprofile=block.out", "--mutexprofile=mutex.out"}, args...)
session := startGinkgo(fm.PathTo("profile"), args...)
Eventually(session).Should(gexec.Exit(0))
// Verify that the binaries have been preserved and the profiles were generated
for _, pkg := range []string{"slow_memory_hog", "block_contest", "lock_contest"} {
Ω(pathToBinary(pkg)).Should(BeAnExistingFile())
for _, profile := range []string{"cpu.out", "mem.out", "block.out", "mutex.out"} {
Ω(pathToProfile(pkg, profile)).Should(BeAnExistingFile())
}
}
cpuProfile := ParseProfile(pathToBinary("slow_memory_hog"), pathToProfile("slow_memory_hog", "cpu.out"))
// The CPUProfile for the slow_memory_hog test should list the slow_memory_hog.SomethingExpensive functions as one of the most time-consuming functions
// we can't assert on time as that will vary from machine to machine, however we _can_ assert that the slow_memory_hog.SomethingExpensive
// function has a low index
Ω(cpuProfile.FindCaller("slow_memory_hog.SomethingExpensive").Index).Should(BeNumerically("<=", 10))
memProfile := ParseProfile(pathToBinary("slow_memory_hog"), pathToProfile("slow_memory_hog", "mem.out"))
// The MemProfile for the slow_memory_hog test should list the slow_memory_hog.SomethingExpensive functions as one of the most memory-consuming functions
// Assrting on the amount of memory consumed should be stable across tests as the function always builds a large array of this size
Ω(memProfile.FindCaller("slow_memory_hog.SomethingExpensive").CumStat).Should(BeNumerically(">=", 100))
blockProfile := ParseProfile(pathToBinary("block_contest"), pathToProfile("block_contest", "block.out"))
// The BlockProfile for the block_contest test should list two channel-reading functions:
// block_contest.ReadTheChannel is called 10 times and takes ~5ms per call
// block_contest.SlowReadTheChannel is called once and teakes ~500ms per call
// Asserting that both times are within a range should be stable across tests
// Note: these numbers are adjusted slightly to tolerate variance during test runs
Ω(blockProfile.FindCaller("block_contest.ReadTheChannel").CumStat).Should(BeNumerically(">=", 45))
Ω(blockProfile.FindCaller("block_contest.ReadTheChannel").CumStat).Should(BeNumerically("<", 500))
Ω(blockProfile.FindCaller("block_contest.SlowReadTheChannel").CumStat).Should(BeNumerically(">=", 450))
mutexProfile := ParseProfile(pathToBinary("lock_contest"), pathToProfile("lock_contest", "mutex.out"))
// The MutexProfile for the lock_contest test should list two functions that wait on a lock.
// Unfortunately go doesn't seem to capture the names of the functions - so they're listed here as
// lock_contest_test.glob..func1.1 is called 10 times and takes ~5ms per call
// lock_contest_test.glob..func2.1 is called once and takes ~500ms per call
// Note that in Go 1.22 and later, the functions are called lock_contest_test.init.func1.1 and lock_contest_test.init.func2.1
// Asserting that both times are within a range should be stable across tests. The function names should be as well
// but that might become a source of failure in the future
// Note: these numbers are adjusted slightly to tolerate variance during test runs
Ω(mutexProfile.FindCaller(fmt.Sprintf("%sfunc1.1", lockContestPrefix)).CumStat).Should(BeNumerically(">=", 45))
Ω(mutexProfile.FindCaller(fmt.Sprintf("%sfunc1.1", lockContestPrefix)).CumStat).Should(BeNumerically("<", 500))
Ω(mutexProfile.FindCaller(fmt.Sprintf("%sfunc2.1", lockContestPrefix)).CumStat).Should(BeNumerically(">=", 450))
},
Entry("when running in series",
func(pkg string) string { return fm.PathTo("profile", pkg+"/"+pkg+".test") },
func(pkg string, profile string) string { return fm.PathTo("profile", pkg+"/"+profile) },
),
Entry("when running in parallel",
func(pkg string) string { return fm.PathTo("profile", pkg+"/"+pkg+".test") },
func(pkg string, profile string) string { return fm.PathTo("profile", pkg+"/"+profile) },
"--procs=3",
),
Entry("when --output-dir is set", Label("slow"),
func(pkg string) string { return fm.PathTo("profile", "profiles/"+pkg+".test") },
func(pkg string, profile string) string { return fm.PathTo("profile", "profiles/"+pkg+"_"+profile) },
"--procs=3", "--output-dir=./profiles",
),
)
Context("when profiling a precompiled binary and output-dir is set", func() {
It("copies (not moves) the binary to output-dir", func() {
Eventually(startGinkgo(fm.PathTo("profile"), "build", "-r")).Should(gexec.Exit(0))
session := startGinkgo(fm.PathTo("profile"), "--cpuprofile=cpu.out", "--output-dir=./profiles", "./slow_memory_hog/slow_memory_hog.test", "./lock_contest/lock_contest.test", "./block_contest/block_contest.test")
Eventually(session).Should(gexec.Exit(0))
for _, pkg := range []string{"slow_memory_hog", "block_contest", "lock_contest"} {
Ω(fm.PathTo("profile", pkg, pkg+".test")).Should(BeAnExistingFile(), "preserve the precompiled binary in the package directory")
Ω(fm.PathTo("profile", "profiles", pkg+".test")).Should(BeAnExistingFile(), "copy the precompiled binary to the output-dir")
Ω(fm.PathTo("profile", "profiles", pkg+"_cpu.out")).Should(BeAnExistingFile(), "generate a correctly named cpu profile")
}
})
})
})
Context("when a suite has programmatic focus", func() {
BeforeEach(func() {
fm.MountFixture("focused")
fm.MountFixture("coverage")
})
Context("and running in series", func() {
It("lets the user know that the test was focused so no profiles were generated", func() {
session := startGinkgo(fm.PathTo("focused"), "--no-color", "--cover", "--blockprofile=block.out", "--cpuprofile=cpu.out", "--memprofile=mem.out", "--mutexprofile=mutex.out")
Eventually(session).Should(gexec.Exit(types.GINKGO_FOCUS_EXIT_CODE))
Ω(session).ShouldNot(gbytes.Say("could not finalize profiles"))
Ω(session).Should(gbytes.Say("coverage: no coverfile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no block profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no cpu profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mem profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mutex profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no composite coverage computed: all suites included programatically focused specs"))
Ω(fm.PathTo("focused", "coverprofile.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("focused", "block.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("focused", "mem.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("focused", "mutex.out")).ShouldNot(BeAnExistingFile())
})
})
Context("and running in parallel", func() {
It("lets the user know that the test was focused so no profiles were generated", func() {
session := startGinkgo(fm.PathTo("focused"), "--no-color", "--procs=2", "--cover", "--blockprofile=block.out", "--cpuprofile=cpu.out", "--memprofile=mem.out", "--mutexprofile=mutex.out")
Eventually(session).Should(gexec.Exit(types.GINKGO_FOCUS_EXIT_CODE))
Ω(session).ShouldNot(gbytes.Say("could not finalize profiles"))
Ω(session).Should(gbytes.Say("coverage: no coverfile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no block profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no cpu profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mem profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mutex profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no composite coverage computed: all suites included programatically focused specs"))
Ω(fm.PathTo("focused", "coverprofile.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("focused", "block.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("focused", "mem.out")).ShouldNot(BeAnExistingFile())
Ω(fm.PathTo("focused", "mutex.out")).ShouldNot(BeAnExistingFile())
})
})
Context("and keeping coverage reports separate", func() {
It("lets the user know", func() {
session := startGinkgo(fm.TmpDir, "-r", "--no-color", "--cover", "--blockprofile=block.out", "--cpuprofile=cpu.out", "--memprofile=mem.out", "--mutexprofile=mutex.out", "--keep-separate-coverprofiles", "--output-dir=./output")
Eventually(session).Should(gexec.Exit(types.GINKGO_FOCUS_EXIT_CODE))
Ω(session).Should(gbytes.Say("CoverageFixture Suite"))
Ω(session).Should(gbytes.Say("coverage: 80"))
Ω(session).Should(gbytes.Say("Focused Suite"))
Ω(session).Should(gbytes.Say("coverage: no coverfile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no block profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no cpu profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mem profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mutex profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("Focused Suite"))
Ω(session).Should(gbytes.Say("coverage: no coverfile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no block profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no cpu profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mem profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mutex profile was generated because specs are programmatically focused"))
Ω(session).ShouldNot(gbytes.Say("composite coverage"))
Ω(fm.ListDir("output")).Should(ConsistOf(
"coverage.test", "coverage_block.out", "coverage_coverprofile.out", "coverage_cpu.out", "coverage_mem.out", "coverage_mutex.out",
"focused.test", "focused_cpu.out", //this is an inconsistency in go test where the cpu.out file is generated but empty
"focused_internal.test", "focused_internal_cpu.out", //this is an inconsistency in go test where the cpu.out file is generated but empty
"coverage_additional_spec.test",
"coverage_additional_spec_block.out",
"coverage_additional_spec_coverprofile.out",
"coverage_additional_spec_cpu.out",
"coverage_additional_spec_mem.out",
"coverage_additional_spec_mutex.out"))
})
})
Context("and combining coverage reports", func() {
Context("and no suites generate coverage", func() {
It("lets the user know", func() {
session := startGinkgo(fm.PathTo("focused"), "-r", "--no-color", "--cover", "--blockprofile=block.out", "--cpuprofile=cpu.out", "--memprofile=mem.out", "--mutexprofile=mutex.out", "--output-dir=./output")
Eventually(session).Should(gexec.Exit(types.GINKGO_FOCUS_EXIT_CODE))
Ω(session).ShouldNot(gbytes.Say("CoverageFixture Suite"))
Ω(session).Should(gbytes.Say("Focused Suite"))
Ω(session).Should(gbytes.Say("coverage: no coverfile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no block profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no cpu profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mem profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mutex profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("Focused Suite"))
Ω(session).Should(gbytes.Say("coverage: no coverfile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no block profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no cpu profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mem profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mutex profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no composite coverage computed: all suites included programatically focused specs"))
Ω(fm.ListDir("focused", "output")).Should(ConsistOf(
"focused.test", "focused_cpu.out", //this is an inconsistency in go test where the cpu.out file is generated but empty
"internal.test", "internal_cpu.out", //this is an inconsistency in go test where the cpu.out file is generated but empty
))
})
})
Context("and at least one suite generates coverage", func() {
It("lets the user know", func() {
session := startGinkgo(fm.TmpDir, "-r", "--no-color", "--cover", "--blockprofile=block.out", "--cpuprofile=cpu.out", "--memprofile=mem.out", "--mutexprofile=mutex.out", "--output-dir=./output")
Eventually(session).Should(gexec.Exit(types.GINKGO_FOCUS_EXIT_CODE))
Ω(session).Should(gbytes.Say("CoverageFixture Suite"))
Ω(session).Should(gbytes.Say("coverage: 80"))
Ω(session).Should(gbytes.Say("Focused Suite"))
Ω(session).Should(gbytes.Say("coverage: no coverfile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no block profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no cpu profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mem profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mutex profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("Focused Suite"))
Ω(session).Should(gbytes.Say("coverage: no coverfile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no block profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no cpu profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mem profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("no mutex profile was generated because specs are programmatically focused"))
Ω(session).Should(gbytes.Say("composite coverage: 80.0% of statements however some suites did not contribute because they included programatically focused specs"))
Ω(fm.ListDir("output")).Should(ConsistOf(
"coverprofile.out",
"coverage.test", "coverage_block.out", "coverage_cpu.out", "coverage_mem.out", "coverage_mutex.out",
"focused.test", "focused_cpu.out", //this is an inconsistency in go test where the cpu.out file is generated but empty
"focused_internal.test", "focused_internal_cpu.out", //this is an inconsistency in go test where the cpu.out file is generated but empty,
"coverage_additional_spec.test",
"coverage_additional_spec_block.out",
"coverage_additional_spec_cpu.out",
"coverage_additional_spec_mem.out",
"coverage_additional_spec_mutex.out",
))
})
})
})
})
Context("with a read-only tree and a readable output-dir", func() {
BeforeEach(func() {
fm.MountFixture("profile")
sess := startGinkgo(fm.PathTo("profile"), "build", "-r", "-cover")
Eventually(sess).Should(gexec.Exit(0))
fm.MkEmpty("output")
Ω(os.Chmod(fm.PathTo("profile", "block_contest"), 0555)).Should(Succeed())
Ω(os.Chmod(fm.PathTo("profile", "lock_contest"), 0555)).Should(Succeed())
Ω(os.Chmod(fm.PathTo("profile", "slow_memory_hog"), 0555)).Should(Succeed())
Ω(os.Chmod(fm.PathTo("profile"), 0555)).Should(Succeed())
})
AfterEach(func() {
Ω(os.Chmod(fm.PathTo("profile"), 0755)).Should(Succeed())
Ω(os.Chmod(fm.PathTo("profile", "block_contest"), 0755)).Should(Succeed())
Ω(os.Chmod(fm.PathTo("profile", "lock_contest"), 0755)).Should(Succeed())
Ω(os.Chmod(fm.PathTo("profile", "slow_memory_hog"), 0755)).Should(Succeed())
})
It("never tries to write to the tree, and only emits to output-dir", func() {
sess := startGinkgo(fm.PathTo("profile"),
"--output-dir=../output",
"--cpuprofile=cpu.out",
"--memprofile=mem.out",
"--blockprofile=block.out",
"--mutexprofile=mutex.out",
"--coverprofile=cover.out",
"--json-report=report.json",
"--junit-report=report.xml",
"--teamcity-report=report.tm",
"--procs=2",
"./block_contest/block_contest.test",
"./lock_contest/lock_contest.test",
"./slow_memory_hog/slow_memory_hog.test",
)
Eventually(sess).Should(gexec.Exit(0))
Ω(fm.ListDir("output")).Should(ConsistOf(
"cover.out",
"report.json",
"report.xml",
"report.tm",
"block_contest_cpu.out",
"lock_contest_cpu.out",
"slow_memory_hog_cpu.out",
"block_contest_mem.out",
"lock_contest_mem.out",
"slow_memory_hog_mem.out",
"block_contest_block.out",
"lock_contest_block.out",
"slow_memory_hog_block.out",
"block_contest_mutex.out",
"lock_contest_mutex.out",
"slow_memory_hog_mutex.out",
"block_contest.test",
"lock_contest.test",
"slow_memory_hog.test",
))
})
It("also works when keeping separate reports and profiles and only emits to output-dir", func() {
sess := startGinkgo(fm.PathTo("profile"),
"--output-dir=../output",
"--cpuprofile=cpu.out",
"--memprofile=mem.out",
"--blockprofile=block.out",
"--mutexprofile=mutex.out",
"--coverprofile=cover.out",
"--json-report=report.json",
"--junit-report=report.xml",
"--teamcity-report=report.tm",
"--procs=2",
"--keep-separate-coverprofiles",
"--keep-separate-reports",
"./block_contest/block_contest.test",
"./lock_contest/lock_contest.test",
"./slow_memory_hog/slow_memory_hog.test",
)
Eventually(sess).Should(gexec.Exit(0))
Ω(fm.ListDir("output")).Should(ConsistOf(
"block_contest_cover.out",
"lock_contest_cover.out",
"slow_memory_hog_cover.out",
"block_contest_report.json",
"lock_contest_report.json",
"slow_memory_hog_report.json",
"block_contest_report.xml",
"lock_contest_report.xml",
"slow_memory_hog_report.xml",
"block_contest_report.tm",
"lock_contest_report.tm",
"slow_memory_hog_report.tm",
"block_contest_cpu.out",
"lock_contest_cpu.out",
"slow_memory_hog_cpu.out",
"block_contest_mem.out",
"lock_contest_mem.out",
"slow_memory_hog_mem.out",
"block_contest_block.out",
"lock_contest_block.out",
"slow_memory_hog_block.out",
"block_contest_mutex.out",
"lock_contest_mutex.out",
"slow_memory_hog_mutex.out",
"block_contest.test",
"lock_contest.test",
"slow_memory_hog.test",
))
})
})
})
|