src/chromiumos/tast/local/bundles/cros/ui/windowarrangementcuj/util.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 windowarrangementcuj contains helper util and test code for
// WindowArrangementCUJ.
package windowarrangementcuj

import (
	"context"

	"chromiumos/tast/errors"
	"chromiumos/tast/local/chrome"
	"chromiumos/tast/local/chrome/ash"
	"chromiumos/tast/local/lacros"
	"chromiumos/tast/local/lacros/launcher"
	"chromiumos/tast/testing"
)

// TestParam holds parameters of window arrangement cuj test variations.
type TestParam struct {
	ChromeType lacros.ChromeType
	Tablet     bool
}

// ChromeCleanUpFunc defines the clean up function of chrome browser.
type ChromeCleanUpFunc func(ctx context.Context) error

// CloseAboutBlankFunc defines the helper to close about:blank page. It is
// implemented for lacros-chrome and no-op for ash-chrome.
type CloseAboutBlankFunc func(ctx context.Context) error

// SetupChrome creates ash-chrome or lacros-chrome based on test parameters.
func SetupChrome(ctx context.Context, s *testing.State) (ash.ConnSource, *chrome.TestConn, ChromeCleanUpFunc, CloseAboutBlankFunc, error) {
	testParam := s.Param().(TestParam)

	var cr *chrome.Chrome
	var cs ash.ConnSource
	var l *launcher.LacrosChrome

	cleanup := func(ctx context.Context) error { return nil }
	closeAboutBlank := func(ctx context.Context) error { return nil }

	if testParam.ChromeType == lacros.ChromeTypeChromeOS {
		if testParam.Tablet {
			var err error
			if cr, err = chrome.New(ctx, chrome.EnableFeatures("WebUITabStrip", "WebUITabStripTabDragIntegration")); err != nil {
				return nil, nil, nil, nil, errors.Wrap(err, "failed to init chrome")
			}
			cleanup = func(ctx context.Context) error {
				return cr.Close(ctx)
			}
		} else {
			cr = s.FixtValue().(*chrome.Chrome)
		}
		cs = cr
	} else {
		// TODO(crbug.com/1127165): Remove the artifactPath argument when we can use Data in fixtures.
		artifactPath := s.DataPath(launcher.DataArtifact)

		var err error
		cr, l, cs, err = lacros.Setup(ctx, s.FixtValue(), artifactPath, testParam.ChromeType)
		if err != nil {
			return nil, nil, nil, nil, errors.Wrap(err, "failed to setup lacros")
		}
		cleanup = func(ctx context.Context) error {
			lacros.CloseLacrosChrome(ctx, l)
			return nil
		}
	}

	tconn, err := cr.TestAPIConn(ctx)
	if err != nil {
		return nil, nil, nil, nil, errors.Wrap(err, "failed to conect to test api")
	}

	if testParam.ChromeType == lacros.ChromeTypeLacros {
		closeAboutBlank = func(ctx context.Context) error {
			return lacros.CloseAboutBlank(ctx, tconn, l.Devsess, 0)
		}
	}
	return cs, tconn, cleanup, closeAboutBlank, nil
}