@@ -22,22 +22,21 @@ final class AppWindowScreenshotTests: XCTestCase {
2222 windowInfo ( id : 8 ) ,
2323 ]
2424
25- let frontID = try frontWindow ( pid : 42 , windowInfo : windows ) ? . number
26- let selected = frontCaptureWindow ( [ 7 , 8 ] , frontWindowID : frontID , sharingState : 1 , windowID : { $0 } )
25+ let front = try frontWindow ( pid : 42 , windowInfo : windows )
26+ let selected = frontShareableWindow ( [ 7 , 8 ] , front : front , windowID : { $0 } )
2727
2828 // Scroll and the click actionWindow fallback both consume frontWindowFrame.
2929 XCTAssertEqual (
3030 try frontWindowFrame ( pid : 42 , windowInfo : windows ) ,
3131 CGRect ( x : 10 , y : 10 , width : 20 , height : 20 ) )
32- XCTAssertEqual ( frontID , 7 )
32+ XCTAssertEqual ( front ? . number , 7 )
3333 XCTAssertEqual ( try selected . get ( ) , 7 )
3434 }
3535
3636 func testSkipsAppModalAlertInFrontOfNormalLayerWindow ( ) throws {
3737 let windows = [ windowInfo ( id : 8 , layer : 8 ) , windowInfo ( id : 3 ) ]
3838 let front = try frontWindow ( pid : 42 , windowInfo : windows )
39- let selected = frontCaptureWindow (
40- [ 8 , 3 ] , frontWindowID : front ? . number , sharingState : front ? . sharingState , windowID : { $0 } )
39+ let selected = frontShareableWindow ( [ 8 , 3 ] , front : front , windowID : { $0 } )
4140
4241 XCTAssertEqual ( front ? . number , 3 )
4342 XCTAssertEqual ( try selected . get ( ) , 3 )
@@ -51,28 +50,22 @@ final class AppWindowScreenshotTests: XCTestCase {
5150 windowInfo ( id : 3 , width : 0 ) ,
5251 windowInfo ( id : 4 , height : 0 ) ,
5352 ]
54- let frontID = try frontWindow ( pid : 42 , windowInfo : windows ) ? . number
55- let selected = frontCaptureWindow ( [ 5 ] , frontWindowID : frontID , sharingState : 1 , windowID : { $0 } )
53+ let front = try frontWindow ( pid : 42 , windowInfo : windows )
54+ let selected = frontShareableWindow ( [ 5 ] , front : front , windowID : { $0 } )
5655
5756 XCTAssertNil ( try frontWindowFrame ( pid : 42 , windowInfo : windows ) )
58- XCTAssertNil ( frontID )
57+ XCTAssertNil ( front )
5958 XCTAssertThrowsError ( try selected . get ( ) ) { error in
60- XCTAssertEqual ( error as? AppWindowScreenshotRefusal , . windowNotFound )
59+ assertRefusal ( error , reason : " window-not-found " , hint : " Open or unminimize " )
6160 }
6261 }
6362
6463 func testUnreadableWindowListRefusesBeforeCaptureOrScrollCanReportNoWindow ( ) {
6564 XCTAssertThrowsError ( try frontWindow ( pid : 42 , windowInfo : nil ) ) { error in
66- guard case HelperError . commandFailed ( _, let details ) = error else {
67- return XCTFail ( " expected a typed window-list refusal, got \( error ) " )
68- }
69- XCTAssertEqual ( details [ " reason " ] , " window-list-unreadable " )
65+ assertUnreadableList ( error )
7066 }
7167 XCTAssertThrowsError ( try frontWindowFrame ( pid : 42 , windowInfo : nil ) ) { error in
72- guard case HelperError . commandFailed ( _, let details ) = error else {
73- return XCTFail ( " expected a typed window-list refusal, got \( error ) " )
74- }
75- XCTAssertEqual ( details [ " reason " ] , " window-list-unreadable " )
68+ assertUnreadableList ( error )
7669 }
7770 XCTAssertNil ( try frontWindow ( pid : 42 , windowInfo : [ ] ) )
7871 XCTAssertNil ( try frontWindowFrame ( pid : 42 , windowInfo : [ ] ) )
@@ -81,18 +74,22 @@ final class AppWindowScreenshotTests: XCTestCase {
8174 func testSelectsTheFrontWindowEvenWhenAnotherIsLarger ( ) {
8275 let candidates = [ Candidate ( id : 7 , area : 10_000 ) , Candidate ( id : 3 , area : 100 ) ]
8376
84- let selected = frontCaptureWindow ( candidates , frontWindowID : 3 , sharingState : 1 , windowID : \. id )
77+ let selected = frontShareableWindow ( candidates , front : onScreenWindow ( id : 3 ) , windowID : \. id )
8578
8679 XCTAssertEqual ( try selected . get ( ) , Candidate ( id : 3 , area : 100 ) )
8780 }
8881
8982 func testRefusesWhenTheFrontWindowIsNotShareable ( ) {
9083 let candidates = [ Candidate ( id : 7 , area : 10_000 ) , Candidate ( id : 8 , area : 100 ) ]
9184
92- let selected = frontCaptureWindow ( candidates , frontWindowID : 3 , sharingState : 1 , windowID : \. id )
85+ let selected = frontShareableWindow ( candidates , front : onScreenWindow ( id : 3 ) , windowID : \. id )
9386
9487 XCTAssertThrowsError ( try selected . get ( ) ) { error in
95- XCTAssertEqual ( error as? AppWindowScreenshotRefusal , . frontWindowNotShareable )
88+ assertRefusal (
89+ error ,
90+ reason : " front-window-not-shareable " ,
91+ hint : " retry after it settles " ,
92+ frontWindowId : " 3 " )
9693 }
9794 }
9895
@@ -103,31 +100,78 @@ final class AppWindowScreenshotTests: XCTestCase {
103100 XCTAssertEqual ( front ? . sharingState , 0 )
104101
105102 for candidates in [ [ 3 , 7 ] , [ 7 ] ] {
106- let selected = frontCaptureWindow (
107- candidates , frontWindowID : front ? . number , sharingState : front ? . sharingState , windowID : { $0 } )
103+ let selected = frontShareableWindow ( candidates , front : front , windowID : { $0 } )
108104 XCTAssertThrowsError ( try selected . get ( ) ) { error in
109- XCTAssertEqual ( error as? AppWindowScreenshotRefusal , . frontWindowCaptureExcluded )
105+ assertRefusal (
106+ error ,
107+ reason : " front-window-capture-excluded " ,
108+ hint : " Run `snapshot` to read the window " ,
109+ frontWindowId : " 3 " )
110110 }
111111 }
112112
113113 var entry = windowInfo ( id : 3 )
114114 entry . removeValue ( forKey : kCGWindowSharingState as String )
115115 let unknown = try frontWindow ( pid : 42 , windowInfo : [ entry ] )
116- let selected = frontCaptureWindow (
117- [ 3 ] , frontWindowID : unknown ? . number , sharingState : unknown ? . sharingState , windowID : { $0 } )
116+ let selected = frontShareableWindow ( [ 3 ] , front : unknown , windowID : { $0 } )
118117 XCTAssertEqual ( try selected . get ( ) , 3 )
119118 }
120119
121120 func testRefusesWhenTheAppHasNoOnScreenWindow ( ) {
122- let selected = frontCaptureWindow (
123- [ Candidate ( id : 7 , area : 10_000 ) ] , frontWindowID : nil , sharingState : nil , windowID : \. id )
121+ let selected = frontShareableWindow (
122+ [ Candidate ( id : 7 , area : 10_000 ) ] , front : nil , windowID : \. id )
124123
125124 XCTAssertThrowsError ( try selected . get ( ) ) { error in
126- XCTAssertEqual ( error as? AppWindowScreenshotRefusal , . windowNotFound )
125+ assertRefusal ( error , reason : " window-not-found " , hint : " Open or unminimize " )
127126 }
128127 }
129128}
130129
130+ /// The refusal carries the reason and the remedy the agent runs next, alongside the front window
131+ /// it refused.
132+ private func assertRefusal (
133+ _ error : Error ,
134+ reason : String ,
135+ hint : String ,
136+ frontWindowId : String ? = nil ,
137+ file : StaticString = #filePath ,
138+ line : UInt = #line
139+ ) {
140+ guard let refusal = error as? AppWindowScreenshotRefusal else {
141+ return XCTFail ( " expected an AppWindowScreenshotRefusal, got \( error ) " , file : file , line : line )
142+ }
143+ guard
144+ case HelperError . commandFailed ( _, let details ) = refusal . error (
145+ bundleId : " com.apple.TextEdit " )
146+ else {
147+ return XCTFail ( " expected a commandFailed refusal error " , file : file , line : line )
148+ }
149+ XCTAssertEqual ( details [ " reason " ] , reason , file : file , line : line )
150+ XCTAssertEqual ( details [ " bundleId " ] , " com.apple.TextEdit " , file : file , line : line )
151+ XCTAssertEqual ( details [ " frontWindowId " ] , frontWindowId , file : file , line : line )
152+ XCTAssertTrue (
153+ ( details [ " hint " ] ?? " " ) . contains ( hint ) ,
154+ " hint \( details [ " hint " ] ?? " <nil> " ) lacks \( hint ) " ,
155+ file : file , line : line )
156+ }
157+
158+ private func assertUnreadableList (
159+ _ error : Error , file : StaticString = #filePath , line : UInt = #line
160+ ) {
161+ guard case HelperError . commandFailed ( _, let details ) = error else {
162+ return XCTFail ( " expected a typed window-list refusal, got \( error ) " , file : file , line : line )
163+ }
164+ XCTAssertEqual ( details [ " reason " ] , " window-list-unreadable " , file : file , line : line )
165+ XCTAssertEqual (
166+ details [ " hint " ] ,
167+ " The app's on-screen window list could not be read. Retry the command. " ,
168+ file : file , line : line )
169+ }
170+
171+ private func onScreenWindow ( id : Int ) -> OnScreenWindow {
172+ OnScreenWindow ( number : id , bounds : . zero , sharingState : 1 )
173+ }
174+
131175private func windowInfo (
132176 id : Int , pid : Int32 = 42 , layer : Int = 0 , onScreen : Bool = true ,
133177 alpha : Double = 1 , sharingState : Int = 1 , width : Double = 100 , height : Double = 100
0 commit comments