blob: 5c86f28bd40d0223411089a4a6a23e19db7648da [file] [log] [blame]
// Copyright 2017 Google LLC
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package profiler
import (
compute ""
const (
cloudScope = ""
benchFinishString = "busybench finished profiling"
errorString = "failed to set up or run the benchmark"
const startupTemplate = `
{{- template "prologue" . }}
# Install git
retry apt-get update >/dev/null
retry apt-get -y -q install git >/dev/null
# $GOCACHE is required from Go 1.12. See
# $GOCACHE is explicitly set becasue $HOME is not set when this code runs
mkdir -p /tmp/gocache
export GOCACHE=/tmp/gocache
# Install gcc, needed to install go master
if [ "{{.GoVersion}}" = "master" ]
retry apt-get -y -q install gcc >/dev/null
# Install desired Go version
mkdir -p /tmp/bin
retry curl -sL -o /tmp/bin/gimme
chmod +x /tmp/bin/gimme
export PATH=$PATH:/tmp/bin
retry eval "$(gimme {{.GoVersion}})"
export GOPATH="$HOME/go"
mkdir -p $GOCLOUD_HOME
# Install agent
retry git clone $GOCLOUD_HOME >/dev/null
retry git fetch origin {{.Commit}}
git reset --hard {{.Commit}}
cd $GOCLOUD_HOME/profiler/busybench
retry go get >/dev/null
# Run benchmark with agent
go run busybench.go --service="{{.Service}}" --mutex_profiling="{{.MutexProfiling}}"
{{ template "epilogue" . -}}
type goGCETestCase struct {
name string
goVersion string
mutexProfiling bool
wantProfileTypes []string
func (tc *goGCETestCase) initializeStartupScript(template *template.Template, commit string) error {
var buf bytes.Buffer
err := template.Execute(&buf,
struct {
Service string
GoVersion string
Commit string
ErrorString string
MutexProfiling bool
GoVersion: tc.goVersion,
Commit: commit,
ErrorString: errorString,
MutexProfiling: tc.mutexProfiling,
if err != nil {
return fmt.Errorf("failed to render startup script for %s: %v",, err)
tc.StartupScript = buf.String()
return nil
func TestAgentIntegration(t *testing.T) {
// Testing against master requires building go code and may take up to 10 minutes.
// Allow this test to run in parallel with other top level tests to avoid timeouts.
if testing.Short() {
t.Skip("skipping profiler integration test in short mode")
if projectID == "" {
t.Skip("skipping profiler integration test when GCLOUD_TESTS_GOLANG_PROJECT_ID variable is not set")
if zone == "" {
t.Fatalf("GCLOUD_TESTS_GOLANG_PROFILER_ZONE environment variable must be set when integration test is requested")
// Figure out the Git commit of the current directory. The source checkout in
// the test VM will run in the same commit. Note that any local changes to
// the profiler agent won't be tested in the integration test. This flow only
// works with code that has been committed and pushed to the public repo
// (either to master or to a branch).
output, err := exec.Command("git", "rev-parse", "HEAD").CombinedOutput()
if err != nil {
t.Fatalf("failed to gather the Git revision of the current source: %v", err)
commit := strings.Trim(string(output), "\n")
t.Logf("using Git commit %q for the profiler integration test", commit)
pst, err := time.LoadLocation("America/Los_Angeles")
if err != nil {
t.Fatalf("failed to initiate PST location: %v", err)
runID := strings.Replace(time.Now().In(pst).Format("2006-01-02-15-04-05.000000-0700"), ".", "-", -1)
ctx := context.Background()
client, err := google.DefaultClient(ctx, cloudScope)
if err != nil {
t.Fatalf("failed to get default client: %v", err)
computeService, err := compute.New(client)
if err != nil {
t.Fatalf("failed to initialize compute service: %v", err)
template, err := proftest.BaseStartupTmpl.Parse(startupTemplate)
if err != nil {
t.Fatalf("failed to parse startup script template: %v", err)
tr := proftest.TestRunner{
Client: client,
gceTr := proftest.GCETestRunner{
TestRunner: tr,
ComputeService: computeService,
// Determine go version used by current test run
goVersion := strings.TrimPrefix(runtime.Version(), "go")
goVersionName := strings.Replace(goVersion, ".", "", -1)
testcases := []goGCETestCase{
InstanceConfig: proftest.InstanceConfig{
ProjectID: projectID,
Zone: zone,
Name: fmt.Sprintf("profiler-test-gomaster-%s", runID),
MachineType: "n1-standard-1",
name: fmt.Sprintf("profiler-test-gomaster-%s-gce", runID),
wantProfileTypes: []string{"CPU", "HEAP", "THREADS", "CONTENTION", "HEAP_ALLOC"},
goVersion: "master",
mutexProfiling: true,
InstanceConfig: proftest.InstanceConfig{
ProjectID: projectID,
Zone: zone,
Name: fmt.Sprintf("profiler-test-go%s-%s", goVersionName, runID),
MachineType: "n1-standard-1",
name: fmt.Sprintf("profiler-test-go%s-%s-gce", goVersionName, runID),
wantProfileTypes: []string{"CPU", "HEAP", "THREADS", "CONTENTION", "HEAP_ALLOC"},
goVersion: goVersion,
mutexProfiling: true,
// The number of tests run in parallel is the current value of GOMAXPROCS.
for _, tc := range testcases {
tc := tc // capture range variable
t.Run(, func(t *testing.T) {
if err := tc.initializeStartupScript(template, commit); err != nil {
t.Fatalf("failed to initialize startup script")
if err := gceTr.StartInstance(ctx, &tc.InstanceConfig); err != nil {
defer func() {
if gceTr.DeleteInstance(ctx, &tc.InstanceConfig); err != nil {
timeoutCtx, cancel := context.WithTimeout(ctx, time.Minute*25)
defer cancel()
if err := gceTr.PollForSerialOutput(timeoutCtx, &tc.InstanceConfig, benchFinishString, errorString); err != nil {
t.Fatalf("PollForSerialOutput() got error: %v", err)
timeNow := time.Now()
endTime := timeNow.Format(time.RFC3339)
startTime := timeNow.Add(-1 * time.Hour).Format(time.RFC3339)
for _, pType := range tc.wantProfileTypes {
pr, err := tr.QueryProfilesWithZone(tc.ProjectID,, startTime, endTime, pType, tc.Zone)
if err != nil {
t.Errorf("QueryProfilesWithZone(%s, %s, %s, %s, %s, %s) got error: %v", tc.ProjectID,, startTime, endTime, pType, tc.Zone, err)
if err := pr.HasFunction("busywork"); err != nil {
t.Errorf("HasFunction(%s, %s, %s, %s, %s) got error: %v", tc.ProjectID,, startTime, endTime, pType, err)