Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 40 additions & 0 deletions AppAuth.xcodeproj/project.pbxproj

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- Added instance-method counterparts of the `OIDAuthorizationService` class methods, and made `-init` public, so the service can be injected and faked in tests.
- Deprecated `OIDAuthorizationService.configuration`. It is never set and is always `nil`; use the request's `configuration` instead. It will be removed in 4.0.
- Added instance-method counterparts of the iOS and macOS `OIDAuthorizationService` convenience methods, and read-only `presentingViewController` / `presentingWindow` properties on the external user agents.
- Added the `AppAuthTestHelpers` Swift package product, with `OIDFakeExternalUserAgentSession`, for testing code that depends on AppAuth.

# 3.0.0
- BREAKING: Updates made to support Xcode 27. ([#972](https://github.com/openid/AppAuth-iOS/pull/972), [#973](https://github.com/openid/AppAuth-iOS/pull/973))
Expand Down
13 changes: 11 additions & 2 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ let package = Package(
targets: ["AppAuth"]),
.library(
name: "AppAuthTV",
targets: ["AppAuthTV"])
targets: ["AppAuthTV"]),
.library(
name: "AppAuthTestHelpers",
targets: ["AppAuthTestHelpers"])
],
dependencies: [],
targets: [
Expand Down Expand Up @@ -67,9 +70,15 @@ let package = Package(
resources: [.copy("Resources/PrivacyInfo.xcprivacy")],
publicHeadersPath: ""
),
.target(
name: "AppAuthTestHelpers",
dependencies: ["AppAuthCore"],
path: "Sources/AppAuthTestHelpers",
publicHeadersPath: ""
),
.testTarget(
name: "AppAuthCoreTests",
dependencies: ["AppAuthCore"],
dependencies: ["AppAuthCore", "AppAuthTestHelpers"],
path: "UnitTests",
exclude: ["OIDSwiftTests.swift", "AppAuthTV"]
),
Expand Down
19 changes: 19 additions & 0 deletions Sources/AppAuthTestHelpers/AppAuthTestHelpers.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/*! @file AppAuthTestHelpers.h
@brief Fakes for testing code that depends on AppAuth.
@copyright
Copyright 2026 The AppAuth Authors. All Rights Reserved.
@copydetails
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 "OIDFakeExternalUserAgentSession.h"
49 changes: 49 additions & 0 deletions Sources/AppAuthTestHelpers/OIDFakeExternalUserAgentSession.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*! @file OIDFakeExternalUserAgentSession.h
@brief AppAuth iOS SDK
@copyright
Copyright 2026 The AppAuth Authors. All Rights Reserved.
@copydetails
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 <Foundation/Foundation.h>

#import "OIDExternalUserAgentSession.h"

NS_ASSUME_NONNULL_BEGIN

/*! @brief An @c OIDExternalUserAgentSession that records the messages it receives instead of
driving a user agent.
*/
@interface OIDFakeExternalUserAgentSession : NSObject <OIDExternalUserAgentSession>

/*! @brief How many times @c -cancel or @c -cancelWithCompletion: was called.
*/
@property(nonatomic, readonly) NSUInteger cancelCount;

/*! @brief The URL passed to the most recent @c -resumeExternalUserAgentFlowWithURL:error:, if
any.
*/
@property(nonatomic, readonly, nullable) NSURL *lastResumedURL;

/*! @brief What @c -resumeExternalUserAgentFlowWithURL:error: returns. Defaults to YES.
*/
@property(nonatomic) BOOL resumeResult;

/*! @brief The error passed to the most recent @c -failExternalUserAgentFlowWithError:, if any.
*/
@property(nonatomic, readonly, nullable) NSError *lastFailureError;

@end

NS_ASSUME_NONNULL_END
71 changes: 71 additions & 0 deletions Sources/AppAuthTestHelpers/OIDFakeExternalUserAgentSession.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*! @file OIDFakeExternalUserAgentSession.m
@brief AppAuth iOS SDK
@copyright
Copyright 2026 The AppAuth Authors. All Rights Reserved.
@copydetails
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 "OIDFakeExternalUserAgentSession.h"

#import "OIDError.h"
#import "OIDErrorUtilities.h"

NS_ASSUME_NONNULL_BEGIN

@implementation OIDFakeExternalUserAgentSession

- (instancetype)init {
self = [super init];
if (self) {
_resumeResult = YES;
}
return self;
}

- (void)cancel {
_cancelCount++;
}

- (void)cancelWithCompletion:(nullable void (^)(void))completion {
_cancelCount++;
if (completion) {
completion();
}
}

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-implementations"
- (BOOL)resumeExternalUserAgentFlowWithURL:(NSURL *)URL {
return [self resumeExternalUserAgentFlowWithURL:URL error:nil];
}
#pragma clang diagnostic pop

- (BOOL)resumeExternalUserAgentFlowWithURL:(NSURL *)URL
error:(NSError *_Nullable *_Nullable)error {
_lastResumedURL = URL;
if (!_resumeResult && error) {
*error = [OIDErrorUtilities errorWithCode:OIDErrorCodeURLMismatch
underlyingError:nil
description:@"Fake session was told not to handle the URL."];
}
return _resumeResult;
}

- (void)failExternalUserAgentFlowWithError:(NSError *)error {
_lastFailureError = error;
}

@end

NS_ASSUME_NONNULL_END
81 changes: 81 additions & 0 deletions UnitTests/OIDFakeExternalUserAgentSessionTests.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/*! @file OIDFakeExternalUserAgentSessionTests.m
@brief AppAuth iOS SDK
@copyright
Copyright 2026 The AppAuth Authors. All Rights Reserved.
@copydetails
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/XCTest.h>

#if SWIFT_PACKAGE
@import AppAuthCore;
@import AppAuthTestHelpers;
#else
#import "Sources/AppAuthCore/OIDError.h"
#import "Sources/AppAuthTestHelpers/AppAuthTestHelpers.h"
#endif

/*! @brief Unit tests for @c OIDFakeExternalUserAgentSession.
*/
@interface OIDFakeExternalUserAgentSessionTests : XCTestCase
@end

@implementation OIDFakeExternalUserAgentSessionTests

/*! @brief Resuming records the URL and returns @c resumeResult, with an error when it is NO. */
- (void)testResumeRecordsURLAndReturnsResumeResult {
OIDFakeExternalUserAgentSession *session = [[OIDFakeExternalUserAgentSession alloc] init];
session.resumeResult = NO;
NSURL *firstURL = [NSURL URLWithString:@"https://example.com/callback?code=1"];
NSError *error = nil;
XCTAssertFalse([session resumeExternalUserAgentFlowWithURL:firstURL error:&error]);
XCTAssertEqualObjects(session.lastResumedURL, firstURL);
XCTAssertEqualObjects(error.domain, OIDGeneralErrorDomain);
XCTAssertEqual(error.code, OIDErrorCodeURLMismatch);

session.resumeResult = YES;
error = nil;
NSURL *secondURL = [NSURL URLWithString:@"https://example.com/callback?code=2"];
XCTAssertTrue([session resumeExternalUserAgentFlowWithURL:secondURL error:&error]);
XCTAssertEqualObjects(session.lastResumedURL, secondURL);
XCTAssertNil(error);
}

/*! @brief A new session handles every URL. */
- (void)testResumeResultDefaultsToYES {
OIDFakeExternalUserAgentSession *session = [[OIDFakeExternalUserAgentSession alloc] init];
XCTAssertTrue(session.resumeResult);
}

/*! @brief Both cancel methods are counted, and the completion runs. */
- (void)testCancelIsCounted {
OIDFakeExternalUserAgentSession *session = [[OIDFakeExternalUserAgentSession alloc] init];
[session cancel];
__block BOOL completionCalled = NO;
[session cancelWithCompletion:^{
completionCalled = YES;
}];
XCTAssertEqual(session.cancelCount, 2u);
XCTAssertTrue(completionCalled);
}

/*! @brief Failing the flow records the error. */
- (void)testFailRecordsError {
OIDFakeExternalUserAgentSession *session = [[OIDFakeExternalUserAgentSession alloc] init];
NSError *error = [NSError errorWithDomain:@"com.example" code:42 userInfo:nil];
[session failExternalUserAgentFlowWithError:error];
XCTAssertEqualObjects(session.lastFailureError, error);
}

@end
Loading