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

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

	"chromiumos/tast/errors"
	"chromiumos/tast/fsutil"
	"chromiumos/tast/local/arc"
	"chromiumos/tast/local/bundles/cros/arc/storage"
	"chromiumos/tast/local/chrome"
	"chromiumos/tast/local/chrome/uiauto"
	"chromiumos/tast/local/chrome/uiauto/cws"
	"chromiumos/tast/local/chrome/uiauto/filesapp"
	"chromiumos/tast/local/chrome/uiauto/nodewith"
	"chromiumos/tast/local/chrome/uiauto/role"
	"chromiumos/tast/local/cryptohome"
	"chromiumos/tast/testing"
)

// arc.Fsp / arc.Fsp.vm tast tests make use of an unarchiver to mount a test zip file
// on a pseudo file system, accessible by FSP. An Android app is then used to read a
// file on this file system via FSP.

const (
	// fspURI contains the FSP id of Wicked Good Unarchiver.
	// It is defined in ui/file_manager/file_manager/background/js/mount_metrics.js
	fspURI = "content://org.chromium.arc.chromecontentprovider/externalfile%3Amljpablpddhocfbnokacjggdbmafjnon%253A~%25252FMyFiles%25252Farc_fsp_storage%25252Ezip%253A"
	// fspZipFile is the name of the test zip file.
	fspZipFile = "arc_fsp_storage.zip"
)

func init() {
	testing.AddTest(&testing.Test{
		Func: Fsp,
		Desc: "Android app can read files on pseudo file systems using File System Provider (FSP) via FilesApp",
		Contacts: []string{
			"cherieccy@google.com",
			"arc-storage@google.com",
		},
		Attr:         []string{"group:mainline", "informational"},
		SoftwareDeps: []string{"chrome"},
		Timeout:      4 * time.Minute,
		VarDeps:      []string{"ui.gaiaPoolDefault"},
		Data:         []string{fspZipFile},
		Params: []testing.Param{
			{
				ExtraSoftwareDeps: []string{"android_p"},
			}, {
				Name:              "vm",
				ExtraSoftwareDeps: []string{"android_vm"},
			},
		},
	})
}

func Fsp(ctx context.Context, s *testing.State) {
	// GAIA login is required to use Chrome Web Store.
	cr, err := chrome.New(
		ctx,
		chrome.ARCEnabled(),
		chrome.GAIALoginPool(s.RequiredVar("ui.gaiaPoolDefault")),
	)
	if err != nil {
		s.Fatal("Failed to start Chrome: ", err)
	}
	defer cr.Close(ctx)

	a, err := arc.New(ctx, s.OutDir())
	if err != nil {
		s.Fatal("Failed to start ARC: ", err)
	}
	defer a.Close(ctx)

	tconn, err := cr.TestAPIConn(ctx)
	if err != nil {
		s.Fatal("Creating test API connection failed: ", err)
	}

	// Install the unarchiver Chrome app, that supports FSP.
	unarchiverName := "Wicked Good Unarchiver"
	unarchiverURL := "https://chrome.google.com/webstore/detail/wicked-good-unarchiver/mljpablpddhocfbnokacjggdbmafjnon?hl=en"
	app := cws.App{Name: unarchiverName, URL: unarchiverURL, InstalledTxt: "Launch app",
		AddTxt: "Add to Chrome", ConfirmTxt: "Add app"}
	if err := cws.InstallApp(ctx, cr, tconn, app); err != nil {
		s.Fatal("Chrome app installation failed: ", err)
	}

	userPath, err := cryptohome.UserPath(ctx, cr.NormalizedUser())
	if err != nil {
		s.Fatalf("Failed to get the cryptohome user path for %s: %v", cr.NormalizedUser(), err)
	}

	destPath := filepath.Join(userPath, "MyFiles", fspZipFile)
	if err := fsutil.CopyFile(s.DataPath(fspZipFile), destPath); err != nil {
		s.Fatalf("Failed to copy %s to %s: %v", fspZipFile, destPath, err)
	}

	// By unzipping, it will create a pseudo file system accessible by FSP.
	if err := unzipFile(ctx, tconn, fspZipFile, "My files", unarchiverName); err != nil {
		s.Fatal("Unzip test zip file failed: ", err)
	}

	config := storage.TestConfig{DirName: fspZipFile, DirTitle: "Files - " + fspZipFile,
		FileName: "storage.txt"}
	expect := []storage.Expectation{
		{LabelID: storage.ActionID, Value: storage.ExpectedAction},
		{LabelID: storage.URIID, Value: constructFSPURI(userPath, config.FileName)},
		{LabelID: storage.FileContentID, Value: storage.ExpectedFileContent}}

	storage.TestOpenWithAndroidApp(ctx, s, a, cr, config, expect)
}

// unzipFile unzips the specified "zipFile" located at "folder" using the "unarchiver".
func unzipFile(ctx context.Context, tconn *chrome.TestConn, zipFile, folder, unarchiver string) error {
	msg := "Opening the test zip file with " + unarchiver
	testing.ContextLog(ctx, msg)

	files, err := filesapp.Launch(ctx, tconn)
	if err != nil {
		return errors.Wrap(err, "launching the Files App failed")
	}

	return uiauto.Combine(msg,
		files.OpenPath("Files - "+folder, folder),
		files.SelectFile(zipFile),
		files.LeftClick(nodewith.Name("Open").Role(role.Button)),
		files.LeftClick(nodewith.Name("Open with "+unarchiver).Role(role.StaticText)),
	)(ctx)
}

// constructFSPURI constructs a FSP URI.
func constructFSPURI(path, file string) string {
	hash := strings.ReplaceAll(path, "/home/user/", "")
	return fspURI + hash + url.PathEscape("/") + file
}