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

import (
	"context"
	"path/filepath"
	"strings"
	"time"

	"chromiumos/tast/ctxutil"
	"chromiumos/tast/errors"
	"chromiumos/tast/local/bundles/cros/inputs/fixture"
	"chromiumos/tast/local/bundles/cros/inputs/pre"
	"chromiumos/tast/local/bundles/cros/inputs/testserver"
	"chromiumos/tast/local/bundles/cros/inputs/util"
	"chromiumos/tast/local/chrome"
	"chromiumos/tast/local/chrome/uiauto"
	"chromiumos/tast/local/chrome/uiauto/faillog"
	"chromiumos/tast/local/chrome/uiauto/nodewith"
	"chromiumos/tast/local/chrome/uiauto/touch"
	"chromiumos/tast/local/chrome/uiauto/vkb"
	"chromiumos/tast/local/chrome/useractions"
	"chromiumos/tast/testing"
	"chromiumos/tast/testing/hwdep"
)

func init() {
	testing.AddTest(&testing.Test{
		Func:         VirtualKeyboardAutoShift,
		LacrosStatus: testing.LacrosVariantUnknown,
		Desc:         "Checks that auto shift feature of virtual keyboard",
		Contacts:     []string{"shengjun@chromium.org", "tranbaoduy@chromium.org", "essential-inputs-team@google.com"},
		Attr:         []string{"group:mainline", "group:input-tools"},
		SoftwareDeps: []string{"chrome", "google_virtual_keyboard"},
		HardwareDeps: hwdep.D(pre.InputsStableModels),
		Timeout:      5 * time.Minute,
		Params: []testing.Param{{
			// Auto-shift is primarily designed for tablet mode.
			Pre:       pre.VKEnabledTabletReset,
			ExtraAttr: []string{"group:input-tools-upstream"},
		}, {
			Name:      "fixture",
			Fixture:   fixture.TabletVK,
			ExtraAttr: []string{"informational"},
		}},
	})
}

func VirtualKeyboardAutoShift(ctx context.Context, s *testing.State) {
	var cr *chrome.Chrome
	var tconn *chrome.TestConn
	var uc *useractions.UserContext
	if strings.Contains(s.TestName(), "fixture") {
		cr = s.FixtValue().(fixture.FixtData).Chrome
		tconn = s.FixtValue().(fixture.FixtData).TestAPIConn
		uc = s.FixtValue().(fixture.FixtData).UserContext
		uc.SetTestName(s.TestName())
	} else {
		cr = s.PreValue().(pre.PreData).Chrome
		tconn = s.PreValue().(pre.PreData).TestAPIConn
		uc = s.PreValue().(pre.PreData).UserContext
	}

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

	defer faillog.DumpUITreeOnError(cleanupCtx, s.OutDir(), s.HasError, tconn)

	its, err := testserver.Launch(ctx, cr, tconn)
	if err != nil {
		s.Fatal("Failed to launch inputs test server: ", err)
	}
	defer its.Close()

	vkbCtx := vkb.NewContext(cr, tconn)

	touchCtx, err := touch.New(ctx, tconn)
	if err != nil {
		s.Fatal("Fail to get touch screen: ", err)
	}
	defer touchCtx.Close()

	leftShiftKey := nodewith.Name("shift").Ancestor(vkb.NodeFinder.HasClass("key_pos_shift_left"))
	manualShift := vkbCtx.TapNode(leftShiftKey)

	shiftLock := uiauto.Combine("double tap to lock shift state",
		// Throws out error if VK is shifted already.
		vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
		vkbCtx.DoubleTapNode(leftShiftKey),
	)

	validateManualShiftAndShiftLock := uiauto.Combine("validate manual shift and shift-lock",
		// This scenario should start in unshifted state.
		vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),

		manualShift,
		vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateShifted),
		// Sleep 1s to avoid double shift.
		uiauto.Sleep(time.Second),

		manualShift,
		vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
		uiauto.Sleep(time.Second),

		shiftLock,
		vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateLocked),

		manualShift,
		vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
	)

	// setup makes sure the VK is in unshifted state.
	// It force show VK and manual unshift if VK is shifted before test.
	setup := func(ctx context.Context) error {
		if shiftState, err := vkbCtx.ShiftState(ctx); err != nil {
			return errors.Wrap(err, "failed to get VK shift state in setup")
		} else if shiftState != vkb.ShiftStateNone {
			testing.ContextLog(ctx, "VK remains shifted in last test. Try to manually unshift")
			if err := uiauto.Combine("manually unshift in setup",
				// It does not nothing if VK is already on screen.
				vkbCtx.ShowVirtualKeyboard(),
				manualShift,
				vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
			)(ctx); err != nil {
				return errors.Wrap(err, "failed to unshift VK in setup")
			}
		}

		// Making sure VK is hidden. It does not nothing if VK is not on screen.
		return vkbCtx.HideVirtualKeyboard()(ctx)
	}

	// teardown dumps information on errors.
	// Reset VK visibility & shift state is done is done in setup.
	teardown := func(ctx context.Context, subtestName string, hasError func() bool) {
		outDir := filepath.Join(s.OutDir(), subtestName)
		faillog.DumpUITreeWithScreenshotOnError(ctx, outDir, hasError, cr, subtestName)
	}

	validateVKShiftInSentenceMode := func(ctx context.Context, inputField testserver.InputField) uiauto.Action {
		return uiauto.Combine("validate VK shift in sentence mode",
			its.Clear(inputField),
			// VK should be auto shifted in empty field.
			its.ClickFieldUntilVKShown(inputField),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateShifted),

			// VK should be reverted to normal after first type.
			vkbCtx.TapKey("H"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
			vkbCtx.TapKeys(strings.Split("ello", "")),

			// VK should not be auto shifted after space
			vkbCtx.TapKeyIgnoringCase("SPACE"),
			vkbCtx.TapKeys(strings.Split("world.", "")),

			// VK should be auto shifted after a full stop and SPACE.
			vkbCtx.TapKeyIgnoringCase("space"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateShifted),

			// VK should be reverted to normal after first type.
			vkbCtx.TapKey("H"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),

			validateManualShiftAndShiftLock,
			util.WaitForFieldTextToBe(tconn, inputField.Finder(), "Hello world. H"),
		)
	}

	validateVKShiftInWordMode := func(ctx context.Context, inputField testserver.InputField) uiauto.Action {
		return uiauto.Combine("validate VK shift in word mode",
			its.Clear(inputField),
			// VK should be auto shifted in empty field.
			its.ClickFieldUntilVKShown(inputField),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateShifted),

			// VK should be reverted to normal after first type.
			vkbCtx.TapKey("H"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
			vkbCtx.TapKeys(strings.Split("ello", "")),

			// VK should be auto shifted after space
			vkbCtx.TapKeyIgnoringCase("space"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateShifted),

			// VK should be reverted to normal after first type.
			vkbCtx.TapKey("W"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
			vkbCtx.TapKeys(strings.Split("orld.", "")),

			// VK should be auto shifted after a full stop and SPACE.
			vkbCtx.TapKeyIgnoringCase("space"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateShifted),

			// VK should be reverted to normal after first type.
			vkbCtx.TapKey("H"),
			validateManualShiftAndShiftLock,
			util.WaitForFieldTextToBe(tconn, inputField.Finder(), "Hello World. H"),
		)
	}

	validateVKShiftInCharMode := func(ctx context.Context, inputField testserver.InputField) uiauto.Action {
		return uiauto.Combine("validate VK shift in character mode",
			its.Clear(inputField),
			// VK should be shift lock in character mode.
			its.ClickFieldUntilVKShown(inputField),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateLocked),

			vkbCtx.TapKeys(strings.Split("HELLO", "")),
			vkbCtx.TapKeyIgnoringCase("space"),
			vkbCtx.TapKeys(strings.Split("WORLD", "")),

			// VK should be still shifted in new line.
			vkbCtx.TapKeyIgnoringCase("enter"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateLocked),
			util.WaitForFieldTextToBe(tconn, inputField.Finder(), "HELLO WORLD\n"),
		)
	}

	validateNoVKShift := func(ctx context.Context, inputField testserver.InputField) uiauto.Action {
		return uiauto.Combine("validate no VK shift",
			its.Clear(inputField),
			// VK should not be auto shift.
			its.ClickFieldUntilVKShown(inputField),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
			vkbCtx.TapKeys(strings.Split("hello", "")),
			vkbCtx.TapKeyIgnoringCase("space"),
			vkbCtx.TapKeys(strings.Split("world.", "")),

			// VK should not be auto shifted in next sentence.
			vkbCtx.TapKeyIgnoringCase("space"),
			vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateNone),
			vkbCtx.TapKey("h"),

			validateManualShiftAndShiftLock,
			util.WaitForFieldTextToBe(tconn, inputField.Finder(), "hello world. h"),
		)
	}

	runSubtest := func(ctx context.Context, name string, f func(ctx context.Context) error) {
		s.Run(ctx, name, func(context.Context, *testing.State) {
			cleanupCtx := ctx
			ctx, cancel := ctxutil.Shorten(ctx, 5*time.Second)
			defer cancel()
			if err := setup(ctx); err != nil {
				s.Fatal("Failed to setup: ", err)
			}
			defer teardown(cleanupCtx, name, s.HasError)
			if err := f(ctx); err != nil {
				s.Fatal("Subtest failed: ", err)
			}
		})
	}

	runSubtest(ctx, "no_attribute",
		uiauto.UserAction("VK autoshift Sentense mode",
			validateVKShiftInSentenceMode(ctx, testserver.TextAreaInputField),
			uc,
			&useractions.UserActionCfg{
				Attributes: map[string]string{
					useractions.AttributeInputField:   string(testserver.TextAreaInputField),
					useractions.AttributeTestScenario: "Sentense mode applies to fields with no attribute",
					useractions.AttributeFeature:      useractions.FeatureVKAutoShift,
				},
			},
		),
	)

	runSubtest(ctx, "sentence",
		uiauto.UserAction("VK autoshift Sentense mode",
			validateVKShiftInSentenceMode(ctx, testserver.TextAreaAutoShiftInSentence),
			uc,
			&useractions.UserActionCfg{
				Attributes: map[string]string{
					useractions.AttributeInputField:   string(testserver.TextAreaAutoShiftInSentence),
					useractions.AttributeTestScenario: "Validate VK autoshift Sentense mode",
					useractions.AttributeFeature:      useractions.FeatureVKAutoShift,
				},
			},
		),
	)

	runSubtest(ctx, "word",
		uiauto.UserAction("VK autoshift Word mode",
			validateVKShiftInWordMode(ctx, testserver.TextAreaAutoShiftInWord),
			uc,
			&useractions.UserActionCfg{
				Attributes: map[string]string{
					useractions.AttributeInputField:   string(testserver.TextAreaAutoShiftInWord),
					useractions.AttributeTestScenario: "Validate VK autoshift Word mode",
					useractions.AttributeFeature:      useractions.FeatureVKAutoShift,
				},
			},
		),
	)

	runSubtest(ctx, "char",
		uiauto.UserAction("VK autoshift Char mode",
			validateVKShiftInCharMode(ctx, testserver.TextAreaAutoShiftInChar),
			uc,
			&useractions.UserActionCfg{
				Attributes: map[string]string{
					useractions.AttributeInputField:   string(testserver.TextAreaAutoShiftInChar),
					useractions.AttributeTestScenario: "Validate VK autoshift Char mode",
					useractions.AttributeFeature:      useractions.FeatureVKAutoShift,
				},
			},
		),
	)

	runSubtest(ctx, "off",
		uiauto.UserAction("VK autoshift off",
			validateNoVKShift(ctx, testserver.TextAreaAutoShiftOff),
			uc,
			&useractions.UserActionCfg{
				Attributes: map[string]string{
					useractions.AttributeInputField:   string(testserver.TextAreaAutoShiftOff),
					useractions.AttributeTestScenario: "Validate VK autoshift turned off by attribute",
					useractions.AttributeFeature:      useractions.FeatureVKAutoShift,
				},
			},
		),
	)

	runSubtest(ctx, "url_inapplicable",
		uiauto.UserAction("VK autoshift off",
			validateNoVKShift(ctx, testserver.URLInputField),
			uc,
			&useractions.UserActionCfg{
				Attributes: map[string]string{
					useractions.AttributeInputField:   string(testserver.URLInputField),
					useractions.AttributeTestScenario: "VK autoshift does not apply to inapplicable fields",
					useractions.AttributeFeature:      useractions.FeatureVKAutoShift,
				},
			},
		),
	)

	inputField := testserver.TextAreaInputField
	runSubtest(ctx, "override_autoshift",
		uiauto.UserAction("VK autoshift override",
			uiauto.Combine("override auto shift state",
				its.Clear(inputField),
				its.ClickFieldUntilVKShown(inputField),
				vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateShifted),
				manualShift,
				vkbCtx.TapKeys(strings.Split("hello", "")),
				util.WaitForFieldTextToBe(tconn, inputField.Finder(), "hello"),
			),
			uc,
			&useractions.UserActionCfg{
				Attributes: map[string]string{
					useractions.AttributeInputField:   string(inputField),
					useractions.AttributeTestScenario: "VK autoshift is override by manual shift",
					useractions.AttributeFeature:      useractions.FeatureVKAutoShift,
				},
			},
		),
	)

	inputField = testserver.TextAreaAutoShiftInChar
	runSubtest(ctx, "override_shiftlock",
		uiauto.UserAction("VK autoshift override",
			uiauto.Combine("override shift lock",
				its.Clear(inputField),
				its.ClickFieldUntilVKShown(inputField),
				vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateLocked),
				manualShift,
				vkbCtx.TapKey("h"),

				// Should recover to shift-lock after tapping first key.
				vkbCtx.WaitUntilShiftStatus(vkb.ShiftStateLocked),
				vkbCtx.TapKeys(strings.Split("ELLO", "")),
				util.WaitForFieldTextToBe(tconn, inputField.Finder(), "hELLO"),
			),
			uc,
			&useractions.UserActionCfg{
				Attributes: map[string]string{
					useractions.AttributeInputField:   string(inputField),
					useractions.AttributeTestScenario: "VK autoshift lock is override by manual shift",
					useractions.AttributeFeature:      useractions.FeatureVKAutoShift,
				},
			},
		),
	)
}