src/chromiumos/tast/local/bundles/cros/ui/tab_switch_cuj2.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"
	"time"

	"chromiumos/tast/ctxutil"
	"chromiumos/tast/local/bundles/cros/ui/cuj"
	"chromiumos/tast/local/bundles/cros/ui/setup"
	"chromiumos/tast/local/bundles/cros/ui/tabswitchcuj"
	"chromiumos/tast/local/chrome"
	"chromiumos/tast/local/chrome/ash"
	"chromiumos/tast/local/chrome/browser"
	"chromiumos/tast/local/chrome/display"
	"chromiumos/tast/local/chrome/lacros/lacrosfixt"
	"chromiumos/tast/local/wpr"
	"chromiumos/tast/testing"
	"chromiumos/tast/testing/hwdep"
)

type tabSwitchParam struct {
	level       tabswitchcuj.Level
	wprProxy    bool
	browserType browser.Type
}

func init() {
	testing.AddTest(&testing.Test{
		Func:         TabSwitchCUJ2,
		LacrosStatus: testing.LacrosVariantExists,
		Desc:         "Measures the performance of tab-switching CUJ, scrolling content with trackpad",
		Contacts:     []string{"abergman@google.com", "tclaiborne@chromium.org", "xliu@cienet.com", "alfredyu@cienet.com"},
		SoftwareDeps: []string{"chrome"},
		Vars: []string{
			"ui.cuj_mute",
			"ui.cuj_mode", // Expecting "tablet" or "clamshell".
			// WPR addresses are only required when running with WPR Proxy.
			"ui.wpr_http_addr",
			"ui.wpr_https_addr",
		},
		Params: []testing.Param{
			{
				Name:    "basic",
				Timeout: 30 * time.Minute,
				Val:     tabSwitchParam{level: tabswitchcuj.Basic, wprProxy: true},
				Pre:     wpr.RemoteReplayMode(),
			}, {
				Name:    "plus",
				Timeout: 35 * time.Minute,
				Val:     tabSwitchParam{level: tabswitchcuj.Plus, wprProxy: true},
				Pre:     wpr.RemoteReplayMode(),
			}, {
				Name:    "premium",
				Timeout: 40 * time.Minute,
				Val:     tabSwitchParam{level: tabswitchcuj.Premium, wprProxy: true},
				Pre:     wpr.RemoteReplayMode(),
			}, {
				Name:              "basic_noproxy",
				Timeout:           35 * time.Minute,
				Val:               tabSwitchParam{level: tabswitchcuj.Basic, wprProxy: false},
				Fixture:           "loggedInAndKeepState",
				ExtraSoftwareDeps: []string{"arc"},
			}, {
				Name:              "basic_lacros_noproxy",
				Timeout:           35 * time.Minute,
				Val:               tabSwitchParam{level: tabswitchcuj.Basic, wprProxy: false, browserType: browser.TypeLacros},
				Fixture:           "loggedInAndKeepStateLacrosWithARC",
				ExtraSoftwareDeps: []string{"lacros", "arc"},
			}, {
				Name:              "basic_noproxy_crosbolt",
				Timeout:           35 * time.Minute,
				Val:               tabSwitchParam{level: tabswitchcuj.Basic, wprProxy: false},
				ExtraAttr:         []string{"group:crosbolt", "crosbolt_perbuild"},
				Fixture:           "loggedInAndKeepState",
				ExtraSoftwareDeps: []string{"arc"},
				ExtraHardwareDeps: hwdep.D(setup.PerfCUJBasicDevices()),
			}, {
				Name:              "plus_noproxy",
				Timeout:           40 * time.Minute,
				Val:               tabSwitchParam{level: tabswitchcuj.Plus, wprProxy: false},
				Fixture:           "loggedInAndKeepState",
				ExtraSoftwareDeps: []string{"arc"},
			}, {
				Name:              "plus_lacros_noproxy",
				Timeout:           40 * time.Minute,
				Val:               tabSwitchParam{level: tabswitchcuj.Plus, wprProxy: false, browserType: browser.TypeLacros},
				Fixture:           "loggedInAndKeepStateLacrosWithARC",
				ExtraSoftwareDeps: []string{"lacros", "arc"},
			}, {
				Name:              "plus_noproxy_crosbolt",
				Timeout:           40 * time.Minute,
				Val:               tabSwitchParam{level: tabswitchcuj.Plus, wprProxy: false},
				ExtraAttr:         []string{"group:crosbolt", "crosbolt_perbuild"},
				Fixture:           "loggedInAndKeepState",
				ExtraSoftwareDeps: []string{"arc"},
				ExtraHardwareDeps: hwdep.D(setup.PerfCUJPlusDevices()),
			}, {
				Name:    "premium_noproxy",
				Timeout: 45 * time.Minute,
				Val:     tabSwitchParam{level: tabswitchcuj.Premium, wprProxy: false},

				Fixture:           "loggedInAndKeepState",
				ExtraSoftwareDeps: []string{"arc"},
			}, {
				Name:    "premium_lacros_noproxy",
				Timeout: 45 * time.Minute,
				Val:     tabSwitchParam{level: tabswitchcuj.Premium, wprProxy: false, browserType: browser.TypeLacros},

				Fixture:           "loggedInAndKeepStateLacrosWithARC",
				ExtraSoftwareDeps: []string{"lacros", "arc"},
			}, {
				Name:              "premium_noproxy_crosbolt",
				Timeout:           45 * time.Minute,
				Val:               tabSwitchParam{level: tabswitchcuj.Premium, wprProxy: false},
				ExtraAttr:         []string{"group:crosbolt", "crosbolt_perbuild"},
				Fixture:           "loggedInAndKeepState",
				ExtraSoftwareDeps: []string{"arc"},
				ExtraHardwareDeps: hwdep.D(setup.PerfCUJPremiumDevices()),
			},
		},
	})
}

// TabSwitchCUJ2 measures the performance of tab-switching CUJ.
//
// WPR server should be running in a remote server. TabSwitchCUJRecorder2 case can be used to record
// WPR content for this test in the remote server.
func TabSwitchCUJ2(ctx context.Context, s *testing.State) {
	p := s.Param().(tabSwitchParam)

	var cr *chrome.Chrome
	if !p.wprProxy {
		cr = s.FixtValue().(chrome.HasChrome).Chrome()
	} else {
		cr = s.PreValue().(*chrome.Chrome)
	}

	var lacrosFixtValue lacrosfixt.FixtValue
	if p.browserType == browser.TypeLacros {
		lacrosFixtValue = s.FixtValue().(cuj.FixtureData).LacrosFixt
	}

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

	cleanupCtx := ctx
	ctx, cancel := ctxutil.Shorten(ctx, 3*time.Second)
	defer cancel()

	var tabletMode bool
	if mode, ok := s.Var("ui.cuj_mode"); ok {
		tabletMode = mode == "tablet"
		cleanup, err := ash.EnsureTabletModeEnabled(ctx, tconn, tabletMode)
		if err != nil {
			s.Fatalf("Failed to enable tablet mode to %v: %v", tabletMode, err)
		}
		defer cleanup(cleanupCtx)
	} else {
		// Use default screen mode of the DUT.
		tabletMode, err = ash.TabletModeEnabled(ctx, tconn)
		if err != nil {
			s.Fatal("Failed to get DUT default screen mode: ", err)
		}
	}
	s.Log("Running test with tablet mode: ", tabletMode)
	if tabletMode {
		cleanup, err := display.RotateToLandscape(ctx, tconn)
		if err != nil {
			s.Fatal("Failed to rotate display to landscape: ", err)
		}
		defer cleanup(cleanupCtx)
	}

	// Shorten context a bit to allow for cleanup if Run fails.
	ctx, cancel = ctxutil.Shorten(ctx, 3*time.Second)
	defer cancel()
	tabswitchcuj.Run2(ctx, s, cr, p.level, tabletMode, lacrosFixtValue)
}