src/chromiumos/tast/local/bundles/cros/shelf/auto_hide_smoke.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 shelf

import (
	"context"

	"chromiumos/tast/local/chrome"
	"chromiumos/tast/local/chrome/ash"
	"chromiumos/tast/local/chrome/display"
	"chromiumos/tast/local/chrome/ui/pointer"
	"chromiumos/tast/local/input"
	"chromiumos/tast/local/ui"
	"chromiumos/tast/testing"
	"chromiumos/tast/testing/hwdep"
)

func init() {
	testing.AddTest(&testing.Test{
		Func: AutoHideSmoke,
		Desc: "Tests shelf autohide behavior",
		Contacts: []string{
			"yulunwu@chromium.org",
			"tbarzic@chromium.org",
			"cros-system-ui-eng@google.com",
			"chromeos-sw-engprod@google.com",
		},
		Attr:         []string{"group:mainline", "informational"},
		SoftwareDeps: []string{"chrome"},
		Fixture:      "chromeLoggedIn",
		Params: []testing.Param{{
			Name: "clamshell_mode",
			Val:  false,
		}, {
			Name:              "tablet_mode",
			Val:               true,
			ExtraHardwareDeps: hwdep.D(hwdep.InternalDisplay()),
		},
		},
	})
}

// AutoHideSmoke tests basic shelf features.
func AutoHideSmoke(ctx context.Context, s *testing.State) {
	tabletMode := s.Param().(bool)
	cr := s.FixtValue().(*chrome.Chrome)
	tconn, err := cr.TestAPIConn(ctx)
	if err != nil {
		s.Fatal("Failed to create Test API connection: ", err)
	}

	mouse, err := input.Mouse(ctx)
	if err != nil {
		s.Fatal("Failed to get the mouse: ", err)
	}
	defer mouse.Close()

	// Begin test in clamshell mode.

	cleanup, err := ash.EnsureTabletModeEnabled(ctx, tconn, false)
	if err != nil {
		s.Fatal("Failed to enter clamshell mode: ", err)
	}
	defer cleanup(ctx)

	if err := ash.WaitForHotseatAnimatingToIdealState(ctx, tconn, ash.ShelfShownClamShell); err != nil {
		s.Fatal("Failed to show clamshell shelf: ", err)
	}

	primaryDisplayInfo, err := display.GetPrimaryInfo(ctx, tconn)
	if err != nil {
		s.Fatal("Failed to find primary display info: ", err)
	}

	// The test verifies flow for enabling shelf-autohide. Make sure the shelf is shown at the start of the test.
	origShelfBehavior, err := ash.GetShelfBehavior(ctx, tconn, primaryDisplayInfo.ID)
	if err != nil {
		s.Fatal("Failed to get shelf behavior: ", err)
	}

	if origShelfBehavior != ash.ShelfBehaviorNeverAutoHide {
		if err := ash.SetShelfBehavior(ctx, tconn, primaryDisplayInfo.ID, ash.ShelfBehaviorNeverAutoHide); err != nil {
			s.Fatal("Failed to set shelf behavior to Never Auto Hide: ", err)
		}
		if err := ash.WaitForHotseatToUpdateAutoHideState(ctx, tconn, false); err != nil {
			s.Fatal("Failed verify shelf is shown without any open windows: ", err)
		}
	}

	// Restore shelf state to original behavior.
	defer ash.SetShelfBehavior(ctx, tconn, primaryDisplayInfo.ID, origShelfBehavior)

	if err := ash.AutoHide(ctx, tconn, primaryDisplayInfo.ID); err != nil {
		s.Fatal("Failed to autohide shelf: ", err)
	}

	dispMode, err := ash.PrimaryDisplayMode(ctx, tconn)
	if err != nil {
		s.Fatal("Failed to get display info: ", err)
	}

	// Move mouse to the top left corner of the screen.
	if err := mouse.Move(int32(-dispMode.WidthInNativePixels), int32(-dispMode.HeightInNativePixels)); err != nil {
		s.Fatal("Failed to move mouse to the top left corner of the screen")
	}

	if err := ash.WaitForHotseatToUpdateAutoHideState(ctx, tconn, false); err != nil {
		s.Fatal("Failed verify shelf is shown without any open windows: ", err)
	}

	// Move the mouse to the bottom right of the screen where the shelf is.
	if err := mouse.Move(int32(dispMode.WidthInNativePixels), int32(dispMode.HeightInNativePixels)); err != nil {
		s.Fatal("Failed to move mouse to the bottom right corner of the screen")
	}

	// Open a single chrome browser window.
	const numWindows = 1
	if err := ash.CreateWindows(ctx, tconn, cr, ui.PerftestURL, numWindows); err != nil {
		s.Fatal("Failed to open browser window: ", err)
	}

	if err := ash.WaitForHotseatToUpdateAutoHideState(ctx, tconn, false); err != nil {
		s.Fatal("Shelf should not be hidden because the mouse remains in the shelf area: ", err)
	}

	// Move the mouse to the top left of the screen so shelf auto-hides.
	if err := mouse.Move(int32(-dispMode.WidthInNativePixels), int32(-dispMode.HeightInNativePixels)); err != nil {
		s.Fatal("Failed to move mouse to the top left corner of the screen")
	}

	if err := ash.WaitForHotseatToUpdateAutoHideState(ctx, tconn, true); err != nil {
		s.Fatal("Shelf should be hidden when moving mouse out of shelf area: ", err)
	}

	// Move the mouse to the bottom right corner of the screen so shelf becomes visible again.
	if err := mouse.Move(int32(dispMode.WidthInNativePixels), int32(dispMode.HeightInNativePixels)); err != nil {
		s.Fatal("Failed to move mouse to the bottom right corner of the screen")
	}

	if err := ash.WaitForHotseatToUpdateAutoHideState(ctx, tconn, false); err != nil {
		s.Fatal("Shelf should not be hidden when the mouse enters the shelf area: ", err)
	}

	// Move the mouse to the top left of the screen so shelf auto-hides. The
	// shelf needs to be hidden so we can check that closing windows causes
	// it to be shown again.
	if err := mouse.Move(int32(-dispMode.WidthInNativePixels), int32(-dispMode.HeightInNativePixels)); err != nil {
		s.Fatal("Failed to move mouse to the top left corner of the screen")
	}

	if err := ash.WaitForHotseatToUpdateAutoHideState(ctx, tconn, true); err != nil {
		s.Fatal("Shelf should be hidden when moving mouse out of shelf area: ", err)
	}

	if tabletMode {
		// Enter tablet mode and verify that the shelf becomes hidden.
		cleanup, err := ash.EnsureTabletModeEnabled(ctx, tconn, true)
		if err != nil {
			s.Fatal("Failed to enter tablet mode: ", err)
		}
		defer cleanup(ctx)

		if err := ash.WaitForHotseatAnimatingToIdealState(ctx, tconn, ash.ShelfHidden); err != nil {
			s.Fatal("Shelf failed to autohide when entering tablet mode: ", err)
		}

		// Small swipe up from the bottom should cause the hotseat shelf to become visible.
		tc, err := pointer.NewTouchController(ctx, tconn)
		if err != nil {
			s.Fatal("Failed to create the touch controller: ", err)
		}
		defer tc.Close()

		if err := ash.SwipeUpHotseatAndWaitForCompletion(ctx, tconn, tc.EventWriter(), tc.TouchCoordConverter()); err != nil {
			s.Fatal("Failed to swipe up the hotseat to show extended shelf: ", err)
		}

		if err := ash.SwipeDownHotseatAndWaitForCompletion(ctx, tconn, tc.EventWriter(), tc.TouchCoordConverter()); err != nil {
			s.Fatal("Failed to swipe down the hotseat to hide: ", err)
		}
	}

	// Close all windows and check that shelf is shown.
	ws, err := ash.GetAllWindows(ctx, tconn)
	if err != nil {
		s.Fatal("Failed to get all open windows: ", err)
	}
	for _, w := range ws {
		if err := w.CloseWindow(ctx, tconn); err != nil {
			s.Logf("Warning: Failed to close window (%+v): %v", w, err)
		}
	}

	if err := ash.WaitForHotseatToUpdateAutoHideState(ctx, tconn, false); err != nil {
		s.Fatal("Shelf should not be hidden when all windows are closed: ", err)
	}
}