Share test helper code

Author: mdmathias

Package.swift

@@ -64,15 +64,21 @@ let package = Package(
             path: "Source/AppAuthTV",
             publicHeadersPath: ""
         ),
+        .target(
+            name: "TestHelpers",
+            dependencies: ["AppAuthCore"],
+            path: "UnitTests/Helpers",
+            publicHeadersPath: ""
+        ),
         .testTarget(
             name: "AppAuthCoreTests",
-            dependencies: ["AppAuthCore"],
+            dependencies: ["AppAuthCore", "TestHelpers"],
             path: "UnitTests/AppAuthCore",
-            exclude: ["OIDSwiftTests.swift", "AppAuthTV"]
+            exclude: ["OIDSwiftTests.swift"]
         ),
         .testTarget(
             name: "AppAuthTests",
-            dependencies: ["AppAuth", "AppAuthCore"],
+            dependencies: ["AppAuth", "TestHelpers"],
             path: "UnitTests/AppAuth"
         ),
         .testTarget(
@@ -85,6 +91,6 @@ let package = Package(
             name: "AppAuthTVTests",
             dependencies: ["AppAuthTV"],
             path: "UnitTests/AppAuthTV"
-        ),
+        )
     ]
 )

UnitTests/AppAuth/OIDExternUserAgentIOSTests.m

@@ -1,78 +1,31 @@
-//
-//  OIDExternalUserAgentIOSTests.m
-//  
-//
-//  Created by Matt Mathias on 1/11/23.
-//
+/*! @file OIDExternalUserAgentIOSTests.m
+   @brief AppAuth iOS SDK
+   @copyright
+       Copyright 2023 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 AppAuth;
-@import AppAuthCore;
+@import TestHelpers;
 #else
 #import "Source/AppAuth/iOS/OIDExternalUserAgentIOS.h"
-#import "Source/AppAuthCore/OIDAuthorizationRequest.h"
-#import "Source/AppAuthCore/OIDAuthorizationService.h"
+#import "UnitTests/TestHelpers/OIDAuthorizationRequest+TestHelper.h"
 #endif
 
-/*! @brief Test value for the @c clientID property.
- */
-static NSString *const kTestClientID = @"ClientID";
-
-/*! @brief Test value for the @c clientID property.
- */
-static NSString *const kTestClientSecret = @"ClientSecret";
-
-/*! @brief Test key for the @c additionalParameters property.
- */
-static NSString *const kTestAdditionalParameterKey = @"A";
-
-/*! @brief Test value for the @c additionalParameters property.
- */
-static NSString *const kTestAdditionalParameterValue = @"1";
-
-/*! @brief Test value for the @c scope property.
- */
-static NSString *const kTestScope = @"Scope";
-
-/*! @brief Test value for the @c scope property.
- */
-static NSString *const kTestScopeA = @"ScopeA";
-
-/*! @brief Test value for the @c redirectURL property.
- */
-static NSString *const kTestRedirectURL = @"http://www.google.com/";
-
-/*! @brief Test value for the @c state property.
- */
-static NSString *const kTestState = @"State";
-
-/*! @brief Test value for the @c responseType property.
- */
-static NSString *const kTestResponseType = @"code";
-
-/*! @brief Test value for the @c nonce property.
- */
-static NSString *const kTestNonce = @"Nonce";
-
-/*! @brief Test value for the @c codeVerifier property.
- */
-static NSString *const kTestCodeVerifier = @"code verifier";
-
-/*! @brief Test value for the @c authorizationEndpoint property.
- */
-static NSString *const kInitializerTestAuthEndpoint = @"https://www.example.com/auth";
-
-/*! @brief Test value for the @c tokenEndpoint property.
- */
-static NSString *const kInitializerTestTokenEndpoint = @"https://www.example.com/token";
-
-/*! @brief Test value for the @c tokenEndpoint property.
- */
-static NSString *const kInitializerTestRegistrationEndpoint =
-    @"https://www.example.com/registration";
-
 @interface OIDExternalUserAgentIOSTests : XCTestCase
 
 @end
@@ -81,51 +34,16 @@ @implementation OIDExternalUserAgentIOSTests
 
 - (void)testThatPresentExternalUserAgentRequestReturnsNoWhenMissingPresentingViewController {
   OIDExternalUserAgentIOS *userAgent = [[OIDExternalUserAgentIOS alloc] init];
-  OIDAuthorizationRequest *authRequest = [[self class] authorizationRequestTestInstance];
-  [OIDAuthorizationService presentAuthorizationRequest:authRequest externalUserAgent:userAgent callback:^(OIDAuthorizationResponse * _Nullable authorizationResponse, NSError * _Nullable error) {
+  OIDAuthorizationRequest *authRequest = [OIDAuthorizationRequest testInstance];
+  [OIDAuthorizationService
+      presentAuthorizationRequest:authRequest
+      externalUserAgent:userAgent
+      callback:^(OIDAuthorizationResponse * _Nullable authorizationResponse,
+                 NSError * _Nullable error) {
     XCTAssertNotNil(error);
     XCTAssertEqual(error.code, OIDErrorCodeSafariOpenError);
     XCTAssertEqualObjects(error.localizedDescription, @"Unable to open Safari.");
   }];
 }
 
-+ (OIDAuthorizationRequest *)authorizationRequestTestInstance {
-  NSDictionary *additionalParameters =
-      @{ kTestAdditionalParameterKey : kTestAdditionalParameterValue };
-  OIDServiceConfiguration *configuration = [[self class] serviceConfigurationTestInstance];
-  OIDAuthorizationRequest *request =
-      [[OIDAuthorizationRequest alloc] initWithConfiguration:configuration
-                      clientId:kTestClientID
-                  clientSecret:kTestClientSecret
-                         scope:[OIDScopeUtilities scopesWithArray:@[ kTestScope, kTestScopeA ]]
-                   redirectURL:[NSURL URLWithString:kTestRedirectURL]
-                  responseType:kTestResponseType
-                         state:kTestState
-                         nonce:kTestNonce
-                  codeVerifier:kTestCodeVerifier
-                 codeChallenge:[[self class] codeChallenge]
-           codeChallengeMethod:[[self class] codeChallengeMethod]
-          additionalParameters:additionalParameters];
-  return request;
-}
-
-+ (OIDServiceConfiguration *)serviceConfigurationTestInstance {
-  NSURL *authEndpoint = [NSURL URLWithString:kInitializerTestAuthEndpoint];
-  NSURL *tokenEndpoint = [NSURL URLWithString:kInitializerTestTokenEndpoint];
-  NSURL *registrationEndpoint = [NSURL URLWithString:kInitializerTestRegistrationEndpoint];
-  OIDServiceConfiguration *configuration =
-      [[OIDServiceConfiguration alloc] initWithAuthorizationEndpoint:authEndpoint
-                                                       tokenEndpoint:tokenEndpoint
-                                                registrationEndpoint:registrationEndpoint];
-  return configuration;
-}
-
-+ (NSString *)codeChallenge {
-  return [OIDAuthorizationRequest codeChallengeS256ForVerifier:kTestCodeVerifier];
-}
-
-+ (NSString *)codeChallengeMethod {
-  return OIDOAuthorizationRequestCodeChallengeMethodS256;
-}
-
 @end

UnitTests/AppAuthCore/OIDAuthorizationRequestTests.h

@@ -26,10 +26,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface OIDAuthorizationRequestTests : XCTestCase
 
-/*! @brief Creates a new @c OIDAuthorizationRequest for testing.
- */
-+ (OIDAuthorizationRequest *)testInstance;
-
 /*! @brief Creates a new @c OIDAuthorizationRequest testing a code flow request.
  */
 + (OIDAuthorizationRequest *)testInstanceCodeFlow;

UnitTests/AppAuthCore/OIDAuthorizationRequestTests.m

@@ -18,69 +18,25 @@
 
 #import "OIDAuthorizationRequestTests.h"
 
-#import "OIDServiceConfigurationTests.h"
-
 #if SWIFT_PACKAGE
 @import AppAuthCore;
+@import TestHelpers;
 #else
 #import "Source/AppAuthCore/OIDAuthorizationRequest.h"
 #import "Source/AppAuthCore/OIDScopeUtilities.h"
-#import "Source/AppAuthCore/OIDServiceConfiguration.h"
+#import "UnitTests/TestHelpers/OIDServiceConfiguration+TestHelper.h"
+#import "UnitTests/TestHelpers/OIDAuthorizationRequest+TestHelper.h"
 #endif
 
 // Ignore warnings about "Use of GNU statement expression extension" which is raised by our use of
 // the XCTAssert___ macros.
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wgnu"
 
-/*! @brief Test value for the @c responseType property.
- */
-static NSString *const kTestResponseType = @"code";
-
-/*! @brief Test value for the @c clientID property.
- */
-static NSString *const kTestClientID = @"ClientID";
-
-/*! @brief Test value for the @c clientID property.
- */
-static NSString *const kTestClientSecret = @"ClientSecret";
-
-/*! @brief Test value for the @c scope property.
- */
-static NSString *const kTestScope = @"Scope";
-
-/*! @brief Test value for the @c scope property.
- */
-static NSString *const kTestScopeA = @"ScopeA";
-
 /*! @brief Test value for the @c scope property.
  */
 static NSString *const kTestScopesMerged = @"Scope ScopeA";
 
-/*! @brief Test value for the @c redirectURL property.
- */
-static NSString *const kTestRedirectURL = @"http://www.google.com/";
-
-/*! @brief Test key for the @c additionalParameters property.
- */
-static NSString *const kTestAdditionalParameterKey = @"A";
-
-/*! @brief Test value for the @c additionalParameters property.
- */
-static NSString *const kTestAdditionalParameterValue = @"1";
-
-/*! @brief Test value for the @c state property.
- */
-static NSString *const kTestState = @"State";
-
-/*! @brief Test value for the @c nonce property.
- */
-static NSString *const kTestNonce = @"Nonce";
-
-/*! @brief Test value for the @c codeVerifier property.
- */
-static NSString *const kTestCodeVerifier = @"code verifier";
-
 /*! @brief This test scope contains a character which is one character below the allowed character
         range.
  */
@@ -144,28 +100,8 @@ + (NSString *)codeChallengeMethod {
   return OIDOAuthorizationRequestCodeChallengeMethodS256;
 }
 
-+ (OIDAuthorizationRequest *)testInstance {
-  NSDictionary *additionalParameters =
-      @{ kTestAdditionalParameterKey : kTestAdditionalParameterValue };
-  OIDServiceConfiguration *configuration = [OIDServiceConfigurationTests testInstance];
-  OIDAuthorizationRequest *request =
-      [[OIDAuthorizationRequest alloc] initWithConfiguration:configuration
-                      clientId:kTestClientID
-                  clientSecret:kTestClientSecret
-                         scope:[OIDScopeUtilities scopesWithArray:@[ kTestScope, kTestScopeA ]]
-                   redirectURL:[NSURL URLWithString:kTestRedirectURL]
-                  responseType:kTestResponseType
-                         state:kTestState
-                         nonce:kTestNonce
-                  codeVerifier:kTestCodeVerifier
-                 codeChallenge:[[self class] codeChallenge]
-           codeChallengeMethod:[[self class] codeChallengeMethod]
-          additionalParameters:additionalParameters];
-  return request;
-}
-
 + (OIDAuthorizationRequest *)testInstanceCodeFlow {
-  OIDServiceConfiguration *configuration = [OIDServiceConfigurationTests testInstance];
+  OIDServiceConfiguration *configuration = [OIDServiceConfiguration testInstance];
   OIDAuthorizationRequest *request =
       [[OIDAuthorizationRequest alloc] initWithConfiguration:configuration
                       clientId:kTestClientID
@@ -183,7 +119,7 @@ + (OIDAuthorizationRequest *)testInstanceCodeFlow {
 }
 
 + (OIDAuthorizationRequest *)testInstanceCodeFlowClientAuth {
-  OIDServiceConfiguration *configuration = [OIDServiceConfigurationTests testInstance];
+  OIDServiceConfiguration *configuration = [OIDServiceConfiguration testInstance];
   OIDAuthorizationRequest *request =
       [[OIDAuthorizationRequest alloc] initWithConfiguration:configuration
                       clientId:kTestClientID
@@ -205,7 +141,7 @@ + (OIDAuthorizationRequest *)testInstanceCodeFlowClientAuth {
 - (void)testScopeInitializerWithManyScopesAndNoClientSecret {
   NSDictionary *additionalParameters =
       @{ kTestAdditionalParameterKey : kTestAdditionalParameterValue };
-  OIDServiceConfiguration *configuration = [OIDServiceConfigurationTests testInstance];
+  OIDServiceConfiguration *configuration = [OIDServiceConfiguration testInstance];
   OIDAuthorizationRequest *request =
       [[OIDAuthorizationRequest alloc] initWithConfiguration:configuration
                       clientId:kTestClientID
@@ -226,7 +162,7 @@ - (void)testScopeInitializerWithManyScopesAndNoClientSecret {
 - (void)testScopeInitializerWithManyScopesAndClientSecret {
   NSDictionary *additionalParameters =
       @{ kTestAdditionalParameterKey : kTestAdditionalParameterValue };
-  OIDServiceConfiguration *configuration = [OIDServiceConfigurationTests testInstance];
+  OIDServiceConfiguration *configuration = [OIDServiceConfiguration testInstance];
   OIDAuthorizationRequest *request =
       [[OIDAuthorizationRequest alloc] initWithConfiguration:configuration
                       clientId:kTestClientID
@@ -249,7 +185,7 @@ - (void)testScopeInitializerWithManyScopesAndClientSecret {
         process and checking to make sure the source and destination instances are equivalent.
  */
 - (void)testCopying {
-  OIDAuthorizationRequest *request = [[self class] testInstance];
+  OIDAuthorizationRequest *request = [OIDAuthorizationRequest testInstance];
 
   XCTAssertEqualObjects(request.responseType, kTestResponseType, @"");
   XCTAssertEqualObjects(request.scope, kTestScopesMerged, @"");
@@ -285,7 +221,7 @@ - (void)testCopying {
         checking to make sure the source and destination instances are equivalent.
  */
 - (void)testSecureCoding {
-  OIDAuthorizationRequest *request = [[self class] testInstance];
+  OIDAuthorizationRequest *request = [OIDAuthorizationRequest testInstance];
 
   XCTAssertEqualObjects(request.responseType, kTestResponseType, @"");
   XCTAssertEqualObjects(request.scope, kTestScopesMerged, @"");
@@ -327,7 +263,7 @@ - (void)testSecureCoding {
  */
 - (void)testDisallowedCharactersInScopes {
   NSURL *redirectURL = [NSURL URLWithString:kTestRedirectURL];
-  OIDServiceConfiguration *configuration = [OIDServiceConfigurationTests testInstance];
+  OIDServiceConfiguration *configuration = [OIDServiceConfiguration testInstance];
   XCTAssertThrows(
       [[OIDAuthorizationRequest alloc] initWithConfiguration:configuration
                                                     clientId:kTestClientID
@@ -441,7 +377,7 @@ - (void)testPKCEVerifierRecommendations {
 - (void)testSupportedResponseTypes {
   NSDictionary *additionalParameters =
       @{ kTestAdditionalParameterKey : kTestAdditionalParameterValue };
-  OIDServiceConfiguration *configuration = [OIDServiceConfigurationTests testInstance];
+  OIDServiceConfiguration *configuration = [OIDServiceConfiguration testInstance];
 
   NSString *scope = [OIDScopeUtilities scopesWithArray:@[ kTestScope, kTestScopeA ]];
 
@@ -524,7 +460,7 @@ - (void)testSupportedResponseTypes {
 }
 
 - (void)testExternalUserAgentMethods {
-  OIDAuthorizationRequest *request = [[self class] testInstance];
+  OIDAuthorizationRequest *request = [OIDAuthorizationRequest testInstance];
   XCTAssertEqualObjects([request externalUserAgentRequestURL], [request authorizationRequestURL]);
   XCTAssert([[request redirectScheme] isEqualToString:request.redirectURL.scheme]);
 }