src/chromiumos/tast/local/bundles/cros/ui/notification_popup_perf.go

// Copyright 2021 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package ui

import (
	"context"
	"fmt"
	"time"

	"chromiumos/tast/errors"
	"chromiumos/tast/local/bundles/cros/ui/perfutil"
	"chromiumos/tast/local/chrome"
	"chromiumos/tast/local/chrome/ash"
	"chromiumos/tast/local/power"
	"chromiumos/tast/testing"
	"chromiumos/tast/testing/hwdep"
)

func init() {
	testing.AddTest(&testing.Test{
		Func:         NotificationPopupPerf,
		Desc:         "Measures animation smoothness of notification popup animations",
		Contacts:     []string{"leandre@chromium.org", "amehfooz@chromium.org", "chromeos-wmp@google.com"},
		Attr:         []string{"group:crosbolt", "crosbolt_perbuild"},
		SoftwareDeps: []string{"chrome"},
		HardwareDeps: hwdep.D(hwdep.InternalDisplay()),
		Fixture:      "chromeLoggedIn",
		Timeout:      3 * time.Minute,
	})
}

func NotificationPopupPerf(ctx context.Context, s *testing.State) {
	// Ensure display on to record ui performance correctly.
	if err := power.TurnOnDisplay(ctx); err != nil {
		s.Fatal("Failed to turn on display: ", err)
	}

	cr := s.FixtValue().(*chrome.Chrome)
	tconn, err := cr.TestAPIConn(ctx)
	if err != nil {
		s.Fatal("Failed to connect to test API: ", err)
	}

	// Pre-add some notifications to show remove animation on the first run.
	ids, err := addNotifications(ctx, tconn)
	if err != nil {
		s.Fatal("Failed to add notifications: ", err)
	}

	// This includes adding notifications to show popup fade in and move up animation,
	// then remove notification in reverse order (newer then older) to show fade out and move down animation.
	pv := perfutil.RunMultiple(ctx, s, cr, perfutil.RunAndWaitAll(tconn, func(ctx context.Context) error {
		for _, id := range ids {
			if err := ash.ClearNotification(ctx, tconn, id); err != nil {
				return errors.Wrapf(err, "failed to clear notification (id: %s): ", id)
			}
		}
		ids = nil

		ids, err = addNotifications(ctx, tconn)
		if err != nil {
			return errors.Wrap(err, "failed to add notifications: ")
		}

		return nil
	},
		"Ash.NotificationPopup.AnimationSmoothness"),
		perfutil.StoreSmoothness)

	if err := pv.Save(ctx, s.OutDir()); err != nil {
		s.Fatal("Failed saving perf data: ", err)
	}
}

// addNotifications create some test notifications and return the ids of those notifications
// in reverse order (newer then older).
func addNotifications(ctx context.Context, tconn *chrome.TestConn) ([]string, error) {
	var ids []string
	const uiTimeout = 30 * time.Second
	ts := []ash.NotificationType{
		ash.NotificationTypeBasic,
		ash.NotificationTypeImage,
		ash.NotificationTypeProgress,
		ash.NotificationTypeList,
	}
	for _, t := range ts {
		id, err := ash.CreateTestNotification(ctx, tconn, t, fmt.Sprintf("Test%sNotification", t), "test message")
		if err != nil {
			return nil, errors.Wrapf(err, "failed to create %s notification: ", t)
		}
		ids = append([]string{id}, ids...)
	}

	// Wait for the last notification to finish creating.
	if _, err := ash.WaitForNotification(ctx, tconn, uiTimeout, ash.WaitTitle(fmt.Sprintf("Test%sNotification", ts[len(ts)-1]))); err != nil {
		return nil, errors.Wrap(err, "failed to wait for notification: ")
	}
	return ids, nil
}