Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement pinned tabs UI tests #3201

Merged
merged 1 commit into from
Sep 6, 2024
Merged

Implement pinned tabs UI tests #3201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions DuckDuckGo.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2577,6 +2577,7 @@
B6F9BDE52B45CD1900677B33 /* ModalView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B6F9BDE32B45CD1900677B33 /* ModalView.swift */; };
B6FA893F269C424500588ECD /* PrivacyDashboardViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B6FA893E269C424500588ECD /* PrivacyDashboardViewController.swift */; };
B6FA8941269C425400588ECD /* PrivacyDashboardPopover.swift in Sources */ = {isa = PBXBuildFile; fileRef = B6FA8940269C425400588ECD /* PrivacyDashboardPopover.swift */; };
BB4339DB2C7F9606005D7ED7 /* PinnedTabsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = BB4339DA2C7F9606005D7ED7 /* PinnedTabsTests.swift */; };
BB470EBB2C5A66D6002EE91D /* BookmarkManagementDetailViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = BB470EBA2C5A66D6002EE91D /* BookmarkManagementDetailViewModel.swift */; };
BB470EBC2C5A66D6002EE91D /* BookmarkManagementDetailViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = BB470EBA2C5A66D6002EE91D /* BookmarkManagementDetailViewModel.swift */; };
BB5789722B2CA70F0009DFE2 /* DataBrokerProtectionSubscriptionEventHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = BB5789712B2CA70F0009DFE2 /* DataBrokerProtectionSubscriptionEventHandler.swift */; };
Expand Down Expand Up @@ -4330,6 +4331,7 @@
B6F9BDE32B45CD1900677B33 /* ModalView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ModalView.swift; sourceTree = "<group>"; };
B6FA893E269C424500588ECD /* PrivacyDashboardViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PrivacyDashboardViewController.swift; sourceTree = "<group>"; };
B6FA8940269C425400588ECD /* PrivacyDashboardPopover.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PrivacyDashboardPopover.swift; sourceTree = "<group>"; };
BB4339DA2C7F9606005D7ED7 /* PinnedTabsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PinnedTabsTests.swift; sourceTree = "<group>"; };
BB470EBA2C5A66D6002EE91D /* BookmarkManagementDetailViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BookmarkManagementDetailViewModel.swift; sourceTree = "<group>"; };
BB5789712B2CA70F0009DFE2 /* DataBrokerProtectionSubscriptionEventHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DataBrokerProtectionSubscriptionEventHandler.swift; sourceTree = "<group>"; };
BB5F46A22C8751F6005F72DF /* BookmarkSortTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BookmarkSortTests.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -6318,6 +6320,7 @@
56A054522C2592CE007D8FAB /* OnboardingUITests.swift */,
BBBB653F2C77BB9400E69AC6 /* BookmarkSearchTests.swift */,
BB5F46A22C8751F6005F72DF /* BookmarkSortTests.swift */,
BB4339DA2C7F9606005D7ED7 /* PinnedTabsTests.swift */,
);
path = UITests;
sourceTree = "<group>";
Expand Down Expand Up @@ -11510,6 +11513,7 @@
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
BB4339DB2C7F9606005D7ED7 /* PinnedTabsTests.swift in Sources */,
EEBCE6842BA4643200B9DF00 /* NSSizeExtension.swift in Sources */,
BB5F46A32C8751F6005F72DF /* BookmarkSortTests.swift in Sources */,
EE7F74912BB5D76600CD9456 /* BookmarksBarTests.swift in Sources */,
Expand Down
2 changes: 1 addition & 1 deletion UITests/Common/UITests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ enum UITests {
<title>\(title)</title>
</head>
<body>
<p>Sample text</p>
<p>Sample text for \(title)</p>
</body>
</html>
""".utf8data)
Expand Down
175 changes: 175 additions & 0 deletions UITests/PinnedTabsTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
//
// PinnedTabsTests.swift
//
// Copyright © 2024 DuckDuckGo. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

import XCTest

class PinnedTabsTests: XCTestCase {
private var app: XCUIApplication!

override func setUpWithError() throws {
continueAfterFailure = false
app = XCUIApplication()
app.launchEnvironment["UITEST_MODE"] = "1"
app.launch()

app.typeKey("n", modifierFlags: .command)
}

override class func setUp() {
UITests.firstRun()
}

func testPinnedTabsFunctionality() {
openThreeSitesOnSameWindow()
openNewWindowAndLoadSite()
moveBackToPreviousWindows()

waitForSite(pageTitle: "Page #3")
pinsPageOne()
pinsPageTwo()
assertsPageTwoIsPinned()
assertsPageOneIsPinned()
dragsPageTwoPinnedTabToTheFirstPosition()
assertsCommandWFunctionality()
assertWindowTwoHasTheTwoPinnedTabFromWindowsOne()
app.terminate()
assertPinnedTabsRestoredState()
}

// MARK: - Utilities

private func openThreeSitesOnSameWindow() {
openSite(pageTitle: "Page #1")
app.openNewTab()
openSite(pageTitle: "Page #2")
app.openNewTab()
openSite(pageTitle: "Page #3")
}

private func openNewWindowAndLoadSite() {
app.typeKey("n", modifierFlags: .command)
openSite(pageTitle: "Page #4")
}

private func moveBackToPreviousWindows() {
let menuItem = app.menuItems["Page #3"].firstMatch
XCTAssertTrue(
menuItem.waitForExistence(timeout: UITests.Timeouts.elementExistence),
"Reset bookmarks menu item didn't become available in a reasonable timeframe."
)
menuItem.hover()
app.typeKey(XCUIKeyboardKey.return, modifierFlags: [])
}

private func openSite(pageTitle: String) {
let url = UITests.simpleServedPage(titled: pageTitle)
let addressBarTextField = app.windows.firstMatch.textFields["AddressBarViewController.addressBarTextField"]
XCTAssertTrue(
addressBarTextField.waitForExistence(timeout: UITests.Timeouts.elementExistence),
"The address bar text field didn't become available in a reasonable timeframe."
)
addressBarTextField.typeURL(url)
XCTAssertTrue(
app.windows.firstMatch.webViews[pageTitle].waitForExistence(timeout: UITests.Timeouts.elementExistence),
"Visited site didn't load with the expected title in a reasonable timeframe."
)
}

private func pinsPageOne() {
app.typeKey("[", modifierFlags: [.command, .shift])
app.typeKey("[", modifierFlags: [.command, .shift])
app.menuItems["Pin Tab"].tap()
}

private func pinsPageTwo() {
app.typeKey("]", modifierFlags: [.command, .shift])
app.menuItems["Pin Tab"].tap()
}

private func assertsPageTwoIsPinned() {
XCTAssertTrue(app.menuItems["Unpin Tab"].firstMatch.waitForExistence(timeout: UITests.Timeouts.elementExistence))
XCTAssertTrue(app.menuItems["Unpin Tab"].firstMatch.exists)
XCTAssertFalse(app.menuItems["Pin Tab"].firstMatch.exists)
}

private func assertsPageOneIsPinned() {
app.typeKey("[", modifierFlags: [.command, .shift])
XCTAssertTrue(app.menuItems["Unpin Tab"].firstMatch.exists)
XCTAssertFalse(app.menuItems["Pin Tab"].firstMatch.exists)
}

private func dragsPageTwoPinnedTabToTheFirstPosition() {
app.typeKey("]", modifierFlags: [.command, .shift])
let toolbar = app.toolbars.firstMatch
let toolbarCoordinate = toolbar.coordinate(withNormalizedOffset: CGVector(dx: 0, dy: 0))
let startPoint = toolbarCoordinate.withOffset(CGVector(dx: 120, dy: 15))
let endPoint = toolbarCoordinate.withOffset(CGVector(dx: 0, dy: 0))
startPoint.press(forDuration: 0, thenDragTo: endPoint)

sleep(1)

/// Asserts the re-order worked by moving to the next tab and checking is Page #1
app.typeKey("]", modifierFlags: [.command, .shift])
XCTAssertTrue(app.staticTexts["Sample text for Page #1"].exists)
}

private func assertsCommandWFunctionality() {
app.typeKey("w", modifierFlags: .command)
XCTAssertTrue(app.staticTexts["Sample text for Page #3"].exists)
}

private func assertWindowTwoHasTheTwoPinnedTabFromWindowsOne() {
let items = app.menuItems.matching(identifier: "Page #4")
let pageFourMenuItem = items.element(boundBy: 1)
XCTAssertTrue(
pageFourMenuItem.waitForExistence(timeout: UITests.Timeouts.elementExistence),
"Reset bookmarks menu item didn't become available in a reasonable timeframe."
)
pageFourMenuItem.hover()
app.typeKey(XCUIKeyboardKey.return, modifierFlags: [])

sleep(2)

/// Goes to Page #2 to check the state
app.typeKey("[", modifierFlags: [.command, .shift])
app.typeKey("[", modifierFlags: [.command, .shift])
XCTAssertTrue(app.staticTexts["Sample text for Page #2"].exists)
/// Goes to Page #1 to check the state
app.typeKey("]", modifierFlags: [.command, .shift])
XCTAssertTrue(app.staticTexts["Sample text for Page #1"].exists)
}

private func assertPinnedTabsRestoredState() {
let newApp = XCUIApplication()
newApp.launch()

sleep(2)

/// Goes to Page #2 to check the state
newApp.typeKey("[", modifierFlags: [.command, .shift])
newApp.typeKey("[", modifierFlags: [.command, .shift])
XCTAssertTrue(newApp.staticTexts["Sample text for Page #2"].waitForExistence(timeout: UITests.Timeouts.elementExistence))
/// Goes to Page #1 to check the state
newApp.typeKey("]", modifierFlags: [.command, .shift])
XCTAssertTrue(newApp.staticTexts["Sample text for Page #1"].waitForExistence(timeout: UITests.Timeouts.elementExistence))
}

private func waitForSite(pageTitle: String) {
XCTAssertTrue(app.windows.webViews[pageTitle].waitForExistence(timeout: UITests.Timeouts.elementExistence))
}
}
Loading