package uixt import ( "bytes" "encoding/base64" "encoding/json" "encoding/xml" "fmt" "net" "net/http" "strings" "time" "github.com/pkg/errors" "github.com/rs/zerolog/log" "github.com/httprunner/httprunner/v5/code" "github.com/httprunner/httprunner/v5/internal/utf7" "github.com/httprunner/httprunner/v5/pkg/uixt/option" ) var errDriverNotImplemented = errors.New("driver method not implemented") const forwardToPrefix = "forward-to-" func NewUIA2Driver(device *AndroidDevice) (*UIA2Driver, error) { log.Info().Interface("device", device).Msg("init android UIA2 driver") localPort, err := device.Forward(device.UIA2Port) if err != nil { return nil, errors.Wrap(code.DeviceConnectionError, fmt.Sprintf("forward port %d->%d failed: %v", localPort, device.UIA2Port, err)) } conn, err := net.Dial("tcp", fmt.Sprintf(":%d", localPort)) if err != nil { return nil, fmt.Errorf("adb forward: %w", err) } driver := new(UIA2Driver) driver.Client = convertToHTTPClient(conn) driver.Device = device.Device driver.Logcat = device.Logcat _, err = driver.NewSession(nil) if err != nil { return nil, errors.Wrap(err, "create UIA2 session failed") } return driver, nil } type UIA2Driver struct { *ADBDriver } func (ud *UIA2Driver) resetDriver() error { session, err := ud.NewSession(option.NewCapabilities()) if err != nil { return err } ud.session.ID = session.SessionId return nil } func (ud *UIA2Driver) httpRequest(method string, rawURL string, rawBody []byte) (rawResp rawResponse, err error) { for retryCount := 1; retryCount <= 5; retryCount++ { rawResp, err = ud.DriverClient.Request(method, rawURL, rawBody) if err == nil { return } // wait for UIA2 server to resume automatically time.Sleep(3 * time.Second) oldSessionID := ud.session.ID if err2 := ud.resetDriver(); err2 != nil { log.Err(err2).Msgf("failed to reset uia2 driver, retry count: %v", retryCount) continue } log.Debug().Str("new session", ud.session.ID).Str("old session", oldSessionID).Msgf("successful to reset uia2 driver, retry count: %v", retryCount) if oldSessionID != "" { rawURL = strings.Replace(rawURL, oldSessionID, ud.session.ID, 1) } } return } func (ud *UIA2Driver) httpGET(pathElem ...string) (rawResp rawResponse, err error) { return ud.httpRequest(http.MethodGet, ud.concatURL(nil, pathElem...), nil) } func (ud *UIA2Driver) httpPOST(data interface{}, pathElem ...string) (rawResp rawResponse, err error) { var bsJSON []byte = nil if data != nil { if bsJSON, err = json.Marshal(data); err != nil { return nil, err } } return ud.httpRequest(http.MethodPost, ud.concatURL(nil, pathElem...), bsJSON) } func (ud *UIA2Driver) httpDELETE(pathElem ...string) (rawResp rawResponse, err error) { return ud.httpRequest(http.MethodDelete, ud.concatURL(nil, pathElem...), nil) } func (ud *UIA2Driver) NewSession(capabilities option.Capabilities) (sessionInfo SessionInfo, err error) { // register(postHandler, new NewSession("/wd/hub/session")) var rawResp rawResponse data := make(map[string]interface{}) if len(capabilities) == 0 { data["capabilities"] = make(map[string]interface{}) } else { data["capabilities"] = map[string]interface{}{"alwaysMatch": capabilities} } if rawResp, err = ud.DriverClient.POST(data, "/session"); err != nil { return SessionInfo{SessionId: ""}, err } reply := new(struct{ Value struct{ SessionId string } }) if err = json.Unmarshal(rawResp, reply); err != nil { return SessionInfo{SessionId: ""}, err } sessionID := reply.Value.SessionId ud.DriverClient.session.Reset() ud.DriverClient.session.ID = sessionID // d.sessionIdCache[sessionID] = true return SessionInfo{SessionId: sessionID}, nil } func (ud *UIA2Driver) DeleteSession() (err error) { if ud.session.ID == "" { return nil } if _, err = ud.httpDELETE("/session", ud.session.ID); err == nil { ud.session.ID = "" } return err } func (ud *UIA2Driver) Status() (deviceStatus DeviceStatus, err error) { // register(getHandler, new Status("/wd/hub/status")) var rawResp rawResponse // Notice: use Driver.GET instead of httpGET to avoid loop calling if rawResp, err = ud.DriverClient.GET("/status"); err != nil { return DeviceStatus{Ready: false}, err } reply := new(struct { Value struct { // Message string Ready bool } }) if err = json.Unmarshal(rawResp, reply); err != nil { return DeviceStatus{Ready: false}, err } return DeviceStatus{Ready: true}, nil } func (ud *UIA2Driver) DeviceInfo() (deviceInfo DeviceInfo, err error) { // register(getHandler, new GetDeviceInfo("/wd/hub/session/:sessionId/appium/device/info")) var rawResp rawResponse if rawResp, err = ud.httpGET("/session", ud.session.ID, "appium/device/info"); err != nil { return DeviceInfo{}, err } reply := new(struct{ Value struct{ DeviceInfo } }) if err = json.Unmarshal(rawResp, reply); err != nil { return DeviceInfo{}, err } deviceInfo = reply.Value.DeviceInfo return } func (ud *UIA2Driver) BatteryInfo() (batteryInfo BatteryInfo, err error) { // register(getHandler, new GetBatteryInfo("/wd/hub/session/:sessionId/appium/device/battery_info")) var rawResp rawResponse if rawResp, err = ud.httpGET("/session", ud.session.ID, "appium/device/battery_info"); err != nil { return BatteryInfo{}, err } reply := new(struct{ Value struct{ BatteryInfo } }) if err = json.Unmarshal(rawResp, reply); err != nil { return BatteryInfo{}, err } if reply.Value.Level == -1 || reply.Value.Status == -1 { return reply.Value.BatteryInfo, errors.New("cannot be retrieved from the system") } batteryInfo = reply.Value.BatteryInfo return } func (ud *UIA2Driver) WindowSize() (size Size, err error) { // register(getHandler, new GetDeviceSize("/wd/hub/session/:sessionId/window/:windowHandle/size")) if !ud.windowSize.IsNil() { // use cached window size return ud.windowSize, nil } var rawResp rawResponse if rawResp, err = ud.httpGET("/session", ud.session.ID, "window/:windowHandle/size"); err != nil { return Size{}, errors.Wrap(err, "get window size failed by UIA2 request") } reply := new(struct{ Value struct{ Size } }) if err = json.Unmarshal(rawResp, reply); err != nil { return Size{}, errors.Wrap(err, "get window size failed by UIA2 response") } size = reply.Value.Size // check orientation orientation, err := ud.Orientation() if err != nil { log.Warn().Err(err).Msgf("window size get orientation failed, use default orientation") orientation = OrientationPortrait } if orientation != OrientationPortrait { size.Width, size.Height = size.Height, size.Width } ud.windowSize = size // cache window size return size, nil } // PressBack simulates a short press on the BACK button. func (ud *UIA2Driver) PressBack(opts ...option.ActionOption) (err error) { // register(postHandler, new PressBack("/wd/hub/session/:sessionId/back")) _, err = ud.httpPOST(nil, "/session", ud.session.ID, "back") return } func (ud *UIA2Driver) Homescreen() (err error) { return ud.PressKeyCodes(KCHome, KMEmpty) } func (ud *UIA2Driver) PressKeyCode(keyCode KeyCode) (err error) { return ud.PressKeyCodes(keyCode, KMEmpty) } func (ud *UIA2Driver) PressKeyCodes(keyCode KeyCode, metaState KeyMeta, flags ...KeyFlag) (err error) { // register(postHandler, new PressKeyCodeAsync("/wd/hub/session/:sessionId/appium/device/press_keycode")) data := map[string]interface{}{ "keycode": keyCode, } if metaState != KMEmpty { data["metastate"] = metaState } if len(flags) != 0 { data["flags"] = flags[0] } _, err = ud.httpPOST(data, "/session", ud.session.ID, "appium/device/press_keycode") return } func (ud *UIA2Driver) Orientation() (orientation Orientation, err error) { // [[FBRoute GET:@"/orientation"] respondWithTarget:self action:@selector(handleGetOrientation:)] var rawResp rawResponse if rawResp, err = ud.httpGET("/session", ud.session.ID, "/orientation"); err != nil { return "", err } reply := new(struct{ Value Orientation }) if err = json.Unmarshal(rawResp, reply); err != nil { return "", err } orientation = reply.Value return } func (ud *UIA2Driver) DoubleTap(x, y float64, opts ...option.ActionOption) error { return ud.DoubleFloatTap(x, y) } func (ud *UIA2Driver) DoubleFloatTap(x, y float64) error { data := map[string]interface{}{ "actions": []interface{}{ map[string]interface{}{ "type": "pointer", "parameters": map[string]string{"pointerType": "touch"}, "id": "touch", "actions": []interface{}{ map[string]interface{}{"type": "pointerMove", "duration": 0, "x": x, "y": y, "origin": "viewport"}, map[string]interface{}{"type": "pointerDown", "duration": 0, "button": 0}, map[string]interface{}{"type": "pointerUp", "duration": 0, "button": 0}, map[string]interface{}{"type": "pointerDown", "duration": 0, "button": 0}, map[string]interface{}{"type": "pointerUp", "duration": 0, "button": 0}, }, }, }, } _, err := ud.httpPOST(data, "/session", ud.session.ID, "actions/tap") return err } func (ud *UIA2Driver) Tap(x, y float64, opts ...option.ActionOption) (err error) { // register(postHandler, new Tap("/wd/hub/session/:sessionId/appium/tap")) actionOptions := option.NewActionOptions(opts...) if len(actionOptions.Offset) == 2 { x += float64(actionOptions.Offset[0]) y += float64(actionOptions.Offset[1]) } x += actionOptions.GetRandomOffset() y += actionOptions.GetRandomOffset() duration := 100.0 if actionOptions.PressDuration > 0 { duration = actionOptions.PressDuration * 1000 } data := map[string]interface{}{ "actions": []interface{}{ map[string]interface{}{ "type": "pointer", "parameters": map[string]string{"pointerType": "touch"}, "id": "touch", "actions": []interface{}{ map[string]interface{}{"type": "pointerMove", "duration": 0, "x": x, "y": y, "origin": "viewport"}, map[string]interface{}{"type": "pointerDown", "duration": 0, "button": 0}, map[string]interface{}{"type": "pause", "duration": duration}, map[string]interface{}{"type": "pointerUp", "duration": 0, "button": 0}, }, }, }, } // update data options in post data for extra uiautomator configurations actionOptions.UpdateData(data) _, err = ud.httpPOST(data, "/session", ud.session.ID, "actions/tap") return err } func (ud *UIA2Driver) TouchAndHold(x, y float64, opts ...option.ActionOption) (err error) { actionOpts := option.NewActionOptions(opts...) duration := actionOpts.Duration if duration == 0 { duration = 1.0 } // register(postHandler, new TouchLongClick("/wd/hub/session/:sessionId/touch/longclick")) data := map[string]interface{}{ "params": map[string]interface{}{ "x": x, "y": y, "duration": int(duration * 1000), }, } _, err = ud.httpPOST(data, "/session", ud.session.ID, "touch/longclick") return } // Drag performs a swipe from one coordinate to another coordinate. You can control // the smoothness and speed of the swipe by specifying the number of steps. // Each step execution is throttled to 5 milliseconds per step, so for a 100 // steps, the swipe will take around 0.5 seconds to complete. func (ud *UIA2Driver) Drag(fromX, fromY, toX, toY float64, opts ...option.ActionOption) (err error) { actionOptions := option.NewActionOptions(opts...) if len(actionOptions.Offset) == 4 { fromX += float64(actionOptions.Offset[0]) fromY += float64(actionOptions.Offset[1]) toX += float64(actionOptions.Offset[2]) toY += float64(actionOptions.Offset[3]) } fromX += actionOptions.GetRandomOffset() fromY += actionOptions.GetRandomOffset() toX += actionOptions.GetRandomOffset() toY += actionOptions.GetRandomOffset() data := map[string]interface{}{ "startX": fromX, "startY": fromY, "endX": toX, "endY": toY, } // update data options in post data for extra uiautomator configurations actionOptions.UpdateData(data) // register(postHandler, new Drag("/wd/hub/session/:sessionId/touch/drag")) _, err = ud.httpPOST(data, "/session", ud.session.ID, "touch/drag") return } // Swipe performs a swipe from one coordinate to another using the number of steps // to determine smoothness and speed. Each step execution is throttled to 5ms // per step. So for a 100 steps, the swipe will take about 1/2 second to complete. // // `steps` is the number of move steps sent to the system func (ud *UIA2Driver) Swipe(fromX, fromY, toX, toY float64, opts ...option.ActionOption) error { // register(postHandler, new Swipe("/wd/hub/session/:sessionId/touch/perform")) actionOptions := option.NewActionOptions(opts...) if len(actionOptions.Offset) == 4 { fromX += float64(actionOptions.Offset[0]) fromY += float64(actionOptions.Offset[1]) toX += float64(actionOptions.Offset[2]) toY += float64(actionOptions.Offset[3]) } fromX += actionOptions.GetRandomOffset() fromY += actionOptions.GetRandomOffset() toX += actionOptions.GetRandomOffset() toY += actionOptions.GetRandomOffset() duration := 200.0 if actionOptions.PressDuration > 0 { duration = actionOptions.PressDuration * 1000 } data := map[string]interface{}{ "actions": []interface{}{ map[string]interface{}{ "type": "pointer", "parameters": map[string]string{"pointerType": "touch"}, "id": "touch", "actions": []interface{}{ map[string]interface{}{"type": "pointerMove", "duration": 0, "x": fromX, "y": fromY, "origin": "viewport"}, map[string]interface{}{"type": "pointerDown", "duration": 0, "button": 0}, map[string]interface{}{"type": "pointerMove", "duration": duration, "x": toX, "y": toY, "origin": "viewport"}, map[string]interface{}{"type": "pointerUp", "duration": 0, "button": 0}, }, }, }, } // update data options in post data for extra uiautomator configurations actionOptions.UpdateData(data) _, err := ud.httpPOST(data, "/session", ud.session.ID, "actions/swipe") return err } func (ud *UIA2Driver) SetPasteboard(contentType PasteboardType, content string) (err error) { lbl := content const defaultLabelLen = 10 if len(lbl) > defaultLabelLen { lbl = lbl[:defaultLabelLen] } data := map[string]interface{}{ "contentType": contentType, "label": lbl, "content": base64.StdEncoding.EncodeToString([]byte(content)), } // register(postHandler, new SetClipboard("/wd/hub/session/:sessionId/appium/device/set_clipboard")) _, err = ud.httpPOST(data, "/session", ud.session.ID, "appium/device/set_clipboard") return } func (ud *UIA2Driver) GetPasteboard(contentType PasteboardType) (raw *bytes.Buffer, err error) { if len(contentType) == 0 { contentType = PasteboardTypePlaintext } // register(postHandler, new GetClipboard("/wd/hub/session/:sessionId/appium/device/get_clipboard")) data := map[string]interface{}{ "contentType": contentType[0], } var rawResp rawResponse if rawResp, err = ud.httpPOST(data, "/session", ud.session.ID, "appium/device/get_clipboard"); err != nil { return } reply := new(struct{ Value string }) if err = json.Unmarshal(rawResp, reply); err != nil { return } if data, err := base64.StdEncoding.DecodeString(reply.Value); err != nil { raw.Write([]byte(reply.Value)) } else { raw.Write(data) } return } // SendKeys Android input does not support setting frequency. func (ud *UIA2Driver) SendKeys(text string, opts ...option.ActionOption) (err error) { // register(postHandler, new SendKeysToElement("/wd/hub/session/:sessionId/keys")) // https://github.com/appium/appium-uiautomator2-server/blob/master/app/src/main/java/io/appium/uiautomator2/handler/SendKeysToElement.java#L76-L85 actionOptions := option.NewActionOptions(opts...) err = ud.SendUnicodeKeys(text, opts...) if err != nil { data := map[string]interface{}{ "text": text, } // new data options in post data for extra uiautomator configurations actionOptions.UpdateData(data) _, err = ud.httpPOST(data, "/session", ud.session.ID, "/keys") } return } func (ud *UIA2Driver) SendUnicodeKeys(text string, opts ...option.ActionOption) (err error) { // If the Unicode IME is not installed, fall back to the old interface. // There might be differences in the tracking schemes across different phones, and it is pending further verification. // In release version: without the Unicode IME installed, the test cannot execute. if !ud.IsUnicodeIMEInstalled() { return fmt.Errorf("appium unicode ime not installed") } currentIme, err := ud.ADBDriver.GetIme() if err != nil { return } if currentIme != UnicodeImePackageName { defer func() { _ = ud.ADBDriver.SetIme(currentIme) }() err = ud.ADBDriver.SetIme(UnicodeImePackageName) if err != nil { log.Warn().Err(err).Msgf("set Unicode Ime failed") return } } encodedStr, err := utf7.Encoding.NewEncoder().String(text) if err != nil { log.Warn().Err(err).Msgf("encode text with modified utf7 failed") return } err = ud.SendActionKey(encodedStr, opts...) return } func (ud *UIA2Driver) SendActionKey(text string, opts ...option.ActionOption) (err error) { actionOptions := option.NewActionOptions(opts...) var actions []interface{} for i, c := range text { actions = append(actions, map[string]interface{}{"type": "keyDown", "value": string(c)}, map[string]interface{}{"type": "keyUp", "value": string(c)}) if i != len(text)-1 { actions = append(actions, map[string]interface{}{"type": "pause", "duration": 40}) } } data := map[string]interface{}{ "actions": []interface{}{ map[string]interface{}{ "type": "key", "id": "key", "actions": actions, }, }, } // new data options in post data for extra uiautomator configurations actionOptions.UpdateData(data) _, err = ud.httpPOST(data, "/session", ud.session.ID, "/actions/keys") return } func (ud *UIA2Driver) Input(text string, opts ...option.ActionOption) (err error) { return ud.SendKeys(text, opts...) } func (ud *UIA2Driver) Rotation() (rotation Rotation, err error) { // register(getHandler, new GetRotation("/wd/hub/session/:sessionId/rotation")) var rawResp rawResponse if rawResp, err = ud.httpGET("/session", ud.session.ID, "rotation"); err != nil { return Rotation{}, err } reply := new(struct{ Value Rotation }) if err = json.Unmarshal(rawResp, reply); err != nil { return Rotation{}, err } rotation = reply.Value return } func (ud *UIA2Driver) Screenshot() (raw *bytes.Buffer, err error) { // https://bytedance.larkoffice.com/docx/C8qEdmSHnoRvMaxZauocMiYpnLh // ui2截图受内存影响,改为adb截图 return ud.ADBDriver.Screenshot() } func (ud *UIA2Driver) Source(srcOpt ...option.SourceOption) (source string, err error) { // register(getHandler, new Source("/wd/hub/session/:sessionId/source")) var rawResp rawResponse if rawResp, err = ud.httpGET("/session", ud.session.ID, "source"); err != nil { return "", err } reply := new(struct{ Value string }) if err = json.Unmarshal(rawResp, reply); err != nil { return "", err } source = reply.Value return } func (ud *UIA2Driver) sourceTree(srcOpt ...option.SourceOption) (sourceTree *Hierarchy, err error) { source, err := ud.Source() if err != nil { return } sourceTree = new(Hierarchy) err = xml.Unmarshal([]byte(source), sourceTree) if err != nil { return } return } func (ud *UIA2Driver) TapByText(text string, opts ...option.ActionOption) error { sourceTree, err := ud.sourceTree() if err != nil { return err } return ud.tapByTextUsingHierarchy(sourceTree, text, opts...) } func (ud *UIA2Driver) TapByTexts(actions ...TapTextAction) error { sourceTree, err := ud.sourceTree() if err != nil { return err } for _, action := range actions { err := ud.tapByTextUsingHierarchy(sourceTree, action.Text, action.Options...) if err != nil { return err } } return nil } func (ud *UIA2Driver) GetDriverResults() []*DriverResult { defer func() { ud.DriverClient.driverResults = nil }() return ud.DriverClient.driverResults }