blob: 94b1f457809e7c2cf2350a6af525be7e2b381cbb [file] [log] [blame]
// Copyright 2017 syzkaller project authors. All rights reserved.
// Use of this source code is governed by Apache 2 LICENSE that can be found in the LICENSE file.
// The test uses aetest package that starts local dev_appserver and handles all requests locally:
// https://cloud.google.com/appengine/docs/standard/go/tools/localunittesting/reference
// The test requires installed appengine SDK (dev_appserver), so we guard it by aetest tag.
// Run the test with: goapp test -tags=aetest
// +build aetest
package dash
import (
"bytes"
"fmt"
"io/ioutil"
"net/http"
"net/http/httptest"
"path/filepath"
"reflect"
"runtime"
"strings"
"sync"
"testing"
"time"
"github.com/google/go-cmp/cmp"
"github.com/google/syzkaller/dashboard/dashapi"
"golang.org/x/net/context"
"google.golang.org/appengine"
"google.golang.org/appengine/aetest"
db "google.golang.org/appengine/datastore"
aemail "google.golang.org/appengine/mail"
"google.golang.org/appengine/user"
)
type Ctx struct {
t *testing.T
inst aetest.Instance
ctx context.Context
mockedTime time.Time
emailSink chan *aemail.Message
client *apiClient
client2 *apiClient
}
func NewCtx(t *testing.T) *Ctx {
t.Parallel()
inst, err := aetest.NewInstance(&aetest.Options{
// Without this option datastore queries return data with slight delay,
// which fails reporting tests.
StronglyConsistentDatastore: true,
})
if err != nil {
t.Fatal(err)
}
r, err := inst.NewRequest("GET", "", nil)
if err != nil {
t.Fatal(err)
}
c := &Ctx{
t: t,
inst: inst,
ctx: appengine.NewContext(r),
mockedTime: time.Date(2000, 1, 1, 0, 0, 0, 0, time.UTC),
emailSink: make(chan *aemail.Message, 100),
}
c.client = c.makeClient(client1, key1, true)
c.client2 = c.makeClient(client2, key2, true)
registerContext(r, c)
return c
}
func (c *Ctx) expectOK(err error) {
if err != nil {
c.t.Fatalf("\n%v: %v", caller(0), err)
}
}
func (c *Ctx) expectFail(msg string, err error) {
if err == nil {
c.t.Fatalf("\n%v: expected to fail, but it does not", caller(0))
}
if !strings.Contains(err.Error(), msg) {
c.t.Fatalf("\n%v: expected to fail with %q, but failed with %q", caller(0), msg, err)
}
}
func (c *Ctx) expectForbidden(err error) {
if err == nil {
c.t.Fatalf("\n%v: expected to fail as 403, but it does not", caller(0))
}
httpErr, ok := err.(HttpError)
if !ok || httpErr.Code != http.StatusForbidden {
c.t.Fatalf("\n%v: expected to fail as 403, but it failed as %v", caller(0), err)
}
}
func (c *Ctx) expectEQ(got, want interface{}) {
if diff := cmp.Diff(got, want); diff != "" {
c.t.Fatalf("\n%v: %v", caller(0), diff)
}
}
func (c *Ctx) expectNE(got, want interface{}) {
if reflect.DeepEqual(got, want) {
c.t.Fatalf("\n%v: equal: %#v", caller(0), got)
}
}
func (c *Ctx) expectTrue(v bool) {
if !v {
c.t.Fatalf("\n%v: failed", caller(0))
}
}
func caller(skip int) string {
pcs := make([]uintptr, 10)
n := runtime.Callers(skip+3, pcs)
pcs = pcs[:n]
frames := runtime.CallersFrames(pcs)
stack := ""
for {
frame, more := frames.Next()
if strings.HasPrefix(frame.Function, "testing.") {
break
}
stack = fmt.Sprintf("%v:%v\n", filepath.Base(frame.File), frame.Line) + stack
if !more {
break
}
}
if stack != "" {
stack = stack[:len(stack)-1]
}
return stack
}
func (c *Ctx) Close() {
if !c.t.Failed() {
// Ensure that we can render main page and all bugs in the final test state.
c.expectOK(c.GET("/test1"))
c.expectOK(c.GET("/test2"))
c.expectOK(c.GET("/test1/fixed"))
c.expectOK(c.GET("/test2/fixed"))
c.expectOK(c.GET("/admin"))
var bugs []*Bug
keys, err := db.NewQuery("Bug").GetAll(c.ctx, &bugs)
if err != nil {
c.t.Errorf("ERROR: failed to query bugs: %v", err)
}
for _, key := range keys {
c.expectOK(c.GET(fmt.Sprintf("/bug?id=%v", key.StringID())))
}
// No pending emails (tests need to consume them).
c.expectOK(c.GET("/email_poll"))
for len(c.emailSink) != 0 {
c.t.Errorf("ERROR: leftover email: %v", (<-c.emailSink).Body)
}
}
unregisterContext(c)
c.inst.Close()
}
func (c *Ctx) advanceTime(d time.Duration) {
c.mockedTime = c.mockedTime.Add(d)
}
// GET sends admin-authorized HTTP GET request to the app.
func (c *Ctx) GET(url string) error {
_, err := c.httpRequest("GET", url, "", AccessAdmin)
return err
}
// AuthGET sends HTTP GET request to the app with the specified authorization.
func (c *Ctx) AuthGET(access AccessLevel, url string) ([]byte, error) {
return c.httpRequest("GET", url, "", access)
}
// POST sends admin-authorized HTTP POST request to the app.
func (c *Ctx) POST(url, body string) error {
_, err := c.httpRequest("POST", url, body, AccessAdmin)
return err
}
func (c *Ctx) httpRequest(method, url, body string, access AccessLevel) ([]byte, error) {
c.t.Logf("%v: %v", method, url)
r, err := c.inst.NewRequest(method, url, strings.NewReader(body))
if err != nil {
c.t.Fatal(err)
}
registerContext(r, c)
if access == AccessAdmin || access == AccessUser {
user := &user.User{
Email: "user@syzkaller.com",
AuthDomain: "gmail.com",
}
if access == AccessAdmin {
user.Admin = true
}
aetest.Login(user, r)
}
w := httptest.NewRecorder()
http.DefaultServeMux.ServeHTTP(w, r)
c.t.Logf("REPLY: %v", w.Code)
if w.Code != http.StatusOK {
return nil, HttpError{w.Code, w.Body.String(), w.HeaderMap}
}
return w.Body.Bytes(), nil
}
type HttpError struct {
Code int
Body string
Headers http.Header
}
func (err HttpError) Error() string {
return fmt.Sprintf("%v: %v", err.Code, err.Body)
}
func (c *Ctx) loadBug(extID string) (*Bug, *Crash, *Build) {
bug, _, err := findBugByReportingID(c.ctx, extID)
if err != nil {
c.t.Fatalf("failed to load bug: %v", err)
}
return c.loadBugInfo(bug)
}
func (c *Ctx) loadBugByHash(hash string) (*Bug, *Crash, *Build) {
bug := new(Bug)
bugKey := db.NewKey(c.ctx, "Bug", hash, 0, nil)
c.expectOK(db.Get(c.ctx, bugKey, bug))
return c.loadBugInfo(bug)
}
func (c *Ctx) loadBugInfo(bug *Bug) (*Bug, *Crash, *Build) {
crash, _, err := findCrashForBug(c.ctx, bug)
if err != nil {
c.t.Fatalf("failed to load crash: %v", err)
}
build := c.loadBuild(bug.Namespace, crash.BuildID)
return bug, crash, build
}
func (c *Ctx) loadJob(extID string) (*Job, *Build, *Crash) {
jobKey, err := jobID2Key(c.ctx, extID)
if err != nil {
c.t.Fatalf("failed to create job key: %v", err)
}
job := new(Job)
if err := db.Get(c.ctx, jobKey, job); err != nil {
c.t.Fatalf("failed to get job %v: %v", extID, err)
}
build := c.loadBuild(job.Namespace, job.BuildID)
crash := new(Crash)
crashKey := db.NewKey(c.ctx, "Crash", "", job.CrashID, jobKey.Parent())
if err := db.Get(c.ctx, crashKey, crash); err != nil {
c.t.Fatalf("failed to load crash for job: %v", err)
}
return job, build, crash
}
func (c *Ctx) loadBuild(ns, id string) *Build {
build, err := loadBuild(c.ctx, ns, id)
c.expectOK(err)
return build
}
func (c *Ctx) loadManager(ns, name string) (*Manager, *Build) {
mgr, err := loadManager(c.ctx, ns, name)
c.expectOK(err)
build := c.loadBuild(ns, mgr.CurrentBuild)
return mgr, build
}
func (c *Ctx) checkURLContents(url string, want []byte) {
got, err := c.AuthGET(AccessAdmin, url)
if err != nil {
c.t.Fatalf("\n%v: %v request failed: %v", caller(0), url, err)
}
if !bytes.Equal(got, want) {
c.t.Fatalf("\n%v: url %v: got:\n%s\nwant:\n%s\n", caller(0), url, got, want)
}
}
func (c *Ctx) pollEmailBug() *aemail.Message {
c.expectOK(c.GET("/email_poll"))
if len(c.emailSink) == 0 {
c.t.Fatalf("\n%v: got no emails", caller(0))
}
return <-c.emailSink
}
func (c *Ctx) expectNoEmail() {
c.expectOK(c.GET("/email_poll"))
if len(c.emailSink) != 0 {
msg := <-c.emailSink
c.t.Fatalf("\n%v: got unexpected email: %v\n%s", caller(0), msg.Subject, msg.Body)
}
}
type apiClient struct {
*Ctx
*dashapi.Dashboard
}
func (c *Ctx) makeClient(client, key string, failOnErrors bool) *apiClient {
doer := func(r *http.Request) (*http.Response, error) {
registerContext(r, c)
w := httptest.NewRecorder()
http.DefaultServeMux.ServeHTTP(w, r)
// Later versions of Go have a nice w.Result method,
// but we stuck on 1.6 on appengine.
if w.Body == nil {
w.Body = new(bytes.Buffer)
}
res := &http.Response{
StatusCode: w.Code,
Status: http.StatusText(w.Code),
Body: ioutil.NopCloser(bytes.NewReader(w.Body.Bytes())),
}
return res, nil
}
logger := func(msg string, args ...interface{}) {
c.t.Logf("%v: "+msg, append([]interface{}{caller(3)}, args...)...)
}
errorHandler := func(err error) {
if failOnErrors {
c.t.Fatalf("\n%v: %v", caller(2), err)
}
}
return &apiClient{
Ctx: c,
Dashboard: dashapi.NewCustom(client, "", key, c.inst.NewRequest, doer, logger, errorHandler),
}
}
func (client *apiClient) pollBugs(expect int) []*dashapi.BugReport {
resp, _ := client.ReportingPollBugs("test")
if len(resp.Reports) != expect {
client.t.Fatalf("\n%v: want %v reports, got %v", caller(0), expect, len(resp.Reports))
}
for _, rep := range resp.Reports {
reproLevel := dashapi.ReproLevelNone
if len(rep.ReproC) != 0 {
reproLevel = dashapi.ReproLevelC
} else if len(rep.ReproSyz) != 0 {
reproLevel = dashapi.ReproLevelSyz
}
reply, _ := client.ReportingUpdate(&dashapi.BugUpdate{
ID: rep.ID,
JobID: rep.JobID,
Status: dashapi.BugStatusOpen,
ReproLevel: reproLevel,
CrashID: rep.CrashID,
})
client.expectEQ(reply.Error, false)
client.expectEQ(reply.OK, true)
}
return resp.Reports
}
func (client *apiClient) pollBug() *dashapi.BugReport {
return client.pollBugs(1)[0]
}
func (client *apiClient) pollNotifs(expect int) []*dashapi.BugNotification {
resp, _ := client.ReportingPollNotifications("test")
if len(resp.Notifications) != expect {
client.t.Fatalf("\n%v: want %v notifs, got %v", caller(0), expect, len(resp.Notifications))
}
return resp.Notifications
}
func (client *apiClient) pollNotif() *dashapi.BugNotification {
return client.pollNotifs(1)[0]
}
func (client *apiClient) updateBug(extID string, status dashapi.BugStatus, dup string) {
reply, _ := client.ReportingUpdate(&dashapi.BugUpdate{
ID: extID,
Status: status,
DupOf: dup,
})
client.expectTrue(reply.OK)
}
func (client *apiClient) pollJobs(manager string) *dashapi.JobPollResp {
resp, err := client.JobPoll(&dashapi.JobPollReq{
PatchTestManagers: []string{manager},
BisectManagers: []string{manager},
})
client.expectOK(err)
return resp
}
func (client *apiClient) pollAndFailBisectJob(manager string) {
resp := client.pollJobs(manager)
client.expectNE(resp.ID, "")
client.expectEQ(resp.Type, dashapi.JobBisectCause)
done := &dashapi.JobDoneReq{
ID: resp.ID,
Error: []byte("pollAndFailBisectJob"),
}
client.expectOK(client.JobDone(done))
}
type (
EmailOptMessageID int
EmailOptFrom string
EmailOptCC []string
)
func (c *Ctx) incomingEmail(to, body string, opts ...interface{}) {
id := 0
from := "default@sender.com"
cc := []string{"test@syzkaller.com", "bugs@syzkaller.com", "bugs2@syzkaller.com"}
for _, o := range opts {
switch opt := o.(type) {
case EmailOptMessageID:
id = int(opt)
case EmailOptFrom:
from = string(opt)
case EmailOptCC:
cc = []string(opt)
}
}
email := fmt.Sprintf(`Sender: %v
Date: Tue, 15 Aug 2017 14:59:00 -0700
Message-ID: <%v>
Subject: crash1
From: %v
Cc: %v
To: %v
Content-Type: text/plain
%v
`, from, id, from, strings.Join(cc, ","), to, body)
c.expectOK(c.POST("/_ah/mail/", email))
}
func initMocks() {
// Mock time as some functionality relies on real time.
timeNow = func(c context.Context) time.Time {
return getRequestContext(c).mockedTime
}
sendEmail = func(c context.Context, msg *aemail.Message) error {
getRequestContext(c).emailSink <- msg
return nil
}
}
// Machinery to associate mocked time with requests.
type RequestMapping struct {
c context.Context
ctx *Ctx
}
var (
requestMu sync.Mutex
requestContexts []RequestMapping
)
func registerContext(r *http.Request, c *Ctx) {
requestMu.Lock()
defer requestMu.Unlock()
requestContexts = append(requestContexts, RequestMapping{appengine.NewContext(r), c})
}
func getRequestContext(c context.Context) *Ctx {
requestMu.Lock()
defer requestMu.Unlock()
for _, m := range requestContexts {
if reflect.DeepEqual(c, m.c) {
return m.ctx
}
}
panic(fmt.Sprintf("no context for: %#v", c))
}
func unregisterContext(c *Ctx) {
requestMu.Lock()
defer requestMu.Unlock()
n := 0
for _, m := range requestContexts {
if m.ctx == c {
continue
}
requestContexts[n] = m
n++
}
requestContexts = requestContexts[:n]
}