src/go.chromium.org/tast-tests/cros/remote/bundles/cros/factory/kiosk.go

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

package factory

import (
	"bytes"
	"context"
	"encoding/json"
	"os"
	"path/filepath"
	"time"

	"go.chromium.org/tast-tests/cros/remote/bundles/cros/factory/fixture"
	"go.chromium.org/tast/core/errors"
	"go.chromium.org/tast/core/ssh"
	"go.chromium.org/tast/core/testing"
	"go.chromium.org/tast/core/testing/hwdep"
)

const (
	testPageTitle = "CrOS Factory"
	testPageType  = "page"
)

func init() {
	testing.AddTest(&testing.Test{
		Func:         Kiosk,
		LacrosStatus: testing.LacrosVariantUnneeded,
		Desc:         "Test if factory UI is running",
		Contacts:     []string{"chromeos-factory-eng@google.com", "lschyi@google.com"},
		// ChromeOS > Platform > Enablement > Factory
		BugComponent: "b:167224",
		Attr:         []string{"group:mainline"},
		Timeout:      time.Minute,
		Fixture:      fixture.EnsureToolkit,
		// Skip "nyan_kitty" due to slow reboot speed, skip nocturne as
		// it can not open the Kiosk page and is not manufactured, and
		// skip amd64-generic as it is not a real board go through
		// factory process, and the browser blocks loading toolkit
		// plugin. See b/365652714.
		HardwareDeps: hwdep.D(hwdep.SkipOnModel("kitty", "nocturne", "amd64-generic")),
		SoftwareDeps: append([]string{"factory_flow"}, fixture.EnsureToolkitSoftwareDeps...),
	})
}

func Kiosk(ctx context.Context, s *testing.State) {
	// Wait factory test UI show up
	var debugEntries []*debugEntry
	if err := testing.Poll(ctx, func(ctx context.Context) error {
		debugResponse, err := getDebugResponse(ctx, s.DUT().Conn())
		if err != nil {
			return errors.Wrap(err, "failed to connect to debugging port")
		}
		debugEntries, err = getDebugEntries(ctx, debugResponse)
		if err != nil {
			return testing.PollBreak(err)
		}
		if !containsFactoryEntryResponse(debugEntries) {
			return errors.New("factory test UI page not ready")
		}
		return nil
	}, &testing.PollOptions{Interval: time.Second}); err != nil {
		dumpPath := filepath.Join(s.OutDir(), "CDP_available_targets.json")
		if dumpError := dumpEntries(debugEntries, dumpPath); dumpError != nil {
			s.Error("Dump entries failed: ", dumpError)
		}
		s.Fatal("Device not showing factory test UI: ", err)
	}
}

func getDebugResponse(ctx context.Context, conn *ssh.Conn) ([]byte, error) {
	probeDebugPortCmd := conn.CommandContext(ctx, "curl", "localhost:9222/json/list")
	return probeDebugPortCmd.Output()
}

func getDebugEntries(ctx context.Context, debugResponse []byte) ([]*debugEntry, error) {
	responseReader := bytes.NewReader(debugResponse)
	decoder := json.NewDecoder(responseReader)
	var debugEntries []*debugEntry
	if err := decoder.Decode(&debugEntries); err != nil {
		return nil, errors.Wrap(err, "failed to parse probe response")
	}
	return debugEntries, nil
}

func containsFactoryEntryResponse(entries []*debugEntry) bool {
	for _, e := range entries {
		if e.Title == testPageTitle && e.Type == testPageType {
			return true
		}
	}
	return false
}

func dumpEntries(entries []*debugEntry, path string) error {
	marshaledEntries, err := json.MarshalIndent(entries, "", "  ")
	if err != nil {
		return err
	}
	if err = os.WriteFile(path, marshaledEntries, 0644); err != nil {
		return err
	}
	return nil
}

type debugEntry struct {
	Title string `json:"title"`
	Type  string `json:"type"`
}