當前位置：首頁 > 前端技术 > javascript >内容正文

javascript

在Spring MVC Web应用程序中添加社交登录：单元测试

發布時間：2023/12/3 javascript 30 豆豆

生活随笔收集整理的這篇文章主要介紹了在Spring MVC Web应用程序中添加社交登录：单元测试小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

Spring Social 1.0具有spring-social-test模塊，該模塊為測試Connect實現和API綁定提供支持。該模塊已從Spring Social 1.1.0中刪除，并由 Spring MVC Test框架替換。

問題在于，實際上沒有有關為使用Spring Social 1.1.0的應用程序編寫單元測試的信息。

這篇博客文章解決了這個問題 。

在此博客文章中，我們將學習如何為示例應用程序的注冊功能編寫單元測試，該功能是在本Spring Social教程的前面部分中創建的。

注意：如果您尚未閱讀Spring Social教程的先前部分，建議您在閱讀此博客文章之前先閱讀它們。以下描述了此博客文章的前提條件：

在Spring MVC Web應用程序中添加社交登錄：配置描述了如何配置示例應用程序的應用程序上下文。
在Spring MVC Web應用程序中添加社交登錄：注冊和登錄介紹了如何向示例應用程序添加注冊和登錄功能。
Spring MVC測試教程描述了如何使用Spring MVC Test框架編寫單元測試和集成測試。

讓我們從發現如何使用Maven獲得所需的測試標準開始。

使用Maven獲取所需的依賴關系

我們可以通過在POM文件中聲明以下依賴關系來獲得所需的測試依賴關系：

FEST聲明（1.4版）。 FEST-Assert是一個提供流暢接口以編寫斷言的庫。
hamcrest-all（1.4版）。我們使用Hamcrest匹配器在單元測試中編寫斷言。
JUnit （版本4.11）。我們還需要排除hamcrest-core，因為我們已經添加了hamcrest-all依賴項。
全模擬（版本1.9.5）。我們使用Mockito作為我們的模擬庫。
Catch-Exception（版本1.2.0）。 catch-exception庫可幫助我們在不終止測試方法執行的情況下捕獲異常，并使捕獲的異?？捎糜谶M一步分析。由于我們已經添加了“ mockito-all”依賴性，因此需要排除“ mockito-core”依賴性。
Spring測試（版本3.2.4.RELEASE）。 Spring Test Framework是一個框架，可以為基于Spring的應用程序編寫測試。

pom.xml文件的相關部分如下所示：

<dependency><groupId>org.easytesting</groupId><artifactId>fest-assert</artifactId><version>1.4</version><scope>test</scope> </dependency> <dependency><groupId>org.hamcrest</groupId><artifactId>hamcrest-all</artifactId><version>1.3</version><scope>test</scope> </dependency> <dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.11</version><scope>test</scope><exclusions><exclusion><artifactId>hamcrest-core</artifactId><groupId>org.hamcrest</groupId></exclusion></exclusions> </dependency> <dependency><groupId>org.mockito</groupId><artifactId>mockito-all</artifactId><version>1.9.5</version><scope>test</scope> </dependency> <dependency><groupId>com.googlecode.catch-exception</groupId><artifactId>catch-exception</artifactId><version>1.2.0</version><exclusions><exclusion><groupId>org.mockito</groupId><artifactId>mockito-core</artifactId></exclusion></exclusions> </dependency> <dependency><groupId>org.springframework</groupId><artifactId>spring-test</artifactId><version>3.2.4.RELEASE</version><scope>test</scope> </dependency>

讓我們動起來，快速瀏覽一下Spring Social的內部。

展望Spring社交網絡

我們可能在本教程的第二部分中還記得過， RegistrationController類負責呈現注冊表單并處理注冊表單的表單提交。它使用ProviderSignInUtils類有兩個目的：

呈現注冊表單時，如果用戶正在使用社交登錄創建新的用戶帳戶，則RegistrationController類會預先填充表單字段。表單對象是使用所用SaaS API提供程序提供的信息來預先填充的。此信息存儲到Connection對象。控制器類通過調用ProviderSignInUtils類的靜態getConnection（）方法來獲取Connection對象。

創建新用戶帳戶后，如果用戶帳戶是使用社交登錄創建的，則RegistrationConnection類會將Connection對象保留在數據庫中?？刂破黝愅ㄟ^調用ProviderSignInUtils類的handlePostSignUp（）方法來實現此目的。

如果我們想了解ProviderSignInUtils類的作用，請看一下其源代碼。 ProviderSignInUtils類的源代碼如下所示：

package org.springframework.social.connect.web;import org.springframework.social.connect.Connection; import org.springframework.web.context.request.RequestAttributes;public class ProviderSignInUtils {public static Connection<?> getConnection(RequestAttributes request) {ProviderSignInAttempt signInAttempt = getProviderUserSignInAttempt(request);return signInAttempt != null ? signInAttempt.getConnection() : null;}public static void handlePostSignUp(String userId, RequestAttributes request) {ProviderSignInAttempt signInAttempt = getProviderUserSignInAttempt(request);if (signInAttempt != null) {signInAttempt.addConnection(userId);request.removeAttribute(ProviderSignInAttempt.SESSION_ATTRIBUTE, RequestAttributes.SCOPE_SESSION);} }private static ProviderSignInAttempt getProviderUserSignInAttempt(RequestAttributes request) {return (ProviderSignInAttempt) request.getAttribute(ProviderSignInAttempt.SESSION_ATTRIBUTE, RequestAttributes.SCOPE_SESSION);} }

我們可以從ProviderSignInUtils類的源代碼中看到兩件事：

getConnection（）方法從會話中獲取ProviderSignInAttempt對象。如果獲取的對象為null，則返回null。否則，它將調用ProviderSignInAttempt類的getConnection（）方法并返回Connection對象。

handlePostSignUp（）方法從會話中獲取ProviderSignInAttempt對象。如果找到該對象，它將調用ProviderSignInAttempt類的addConnection（）方法，并從會話中刪除找到的ProviderSignInAttempt對象。

顯然，為了為RegistrationController類編寫單元測試，我們必須找出一種創建ProviderSignInAttempt對象并將創建的對象設置為session的方法。

讓我們找出這是如何完成的。

創建測試雙打

如我們所知，如果要為RegistrationController類編寫單元測試，則必須找到一種創建ProviderSignInAttempt對象的方法。本節介紹如何通過使用測試雙打來實現此目標。

讓我們繼續前進，了解如何在單元測試中創建ProviderSignInAttempt對象。

創建ProviderSignInAttempt對象

如果我們想了解如何創建ProviderSignInAttempt對象，則必須仔細查看其源代碼。 ProviderSignInAttempt類的源代碼如下所示：

package org.springframework.social.connect.web;import java.io.Serializable;import org.springframework.social.connect.Connection; import org.springframework.social.connect.ConnectionData; import org.springframework.social.connect.ConnectionFactoryLocator; import org.springframework.social.connect.DuplicateConnectionException; import org.springframework.social.connect.UsersConnectionRepository;@SuppressWarnings("serial") public class ProviderSignInAttempt implements Serializable {public static final String SESSION_ATTRIBUTE = ProviderSignInAttempt.class.getName();private final ConnectionData connectionData;private final ConnectionFactoryLocator connectionFactoryLocator;private final UsersConnectionRepository connectionRepository;public ProviderSignInAttempt(Connection<?> connection, ConnectionFactoryLocator connectionFactoryLocator, UsersConnectionRepository connectionRepository) {this.connectionData = connection.createData();this.connectionFactoryLocator = connectionFactoryLocator;this.connectionRepository = connectionRepository; }public Connection<?> getConnection() {return connectionFactoryLocator.getConnectionFactory(connectionData.getProviderId()).createConnection(connectionData);}void addConnection(String userId) {connectionRepository.createConnectionRepository(userId).addConnection(getConnection());} }

如我們所見， ProviderSignInAttempt類具有三個依賴關系，如下所示：

Connection接口表示與使用的SaaS API提供程序的連接。
ConnectionFactoryLocator接口指定查找ConnectionFactory對象所需的方法。
UsersConnectionRepository接口聲明用于管理用戶與SaaS API提供程序之間的連接的方法。

首先想到的是模擬這些依賴關系。盡管這似乎是一個好主意，但是這種方法有兩個問題：

在編寫的每個測試中，我們都必須配置模擬對象的行為。這意味著我們的測試將更難理解。

我們正在將Spring Social的實現細節泄漏到我們的測試中。這將使我們的測試難以維護，因為如果實施Spring Social更改，我們的測試可能會被破壞。

顯然，模擬并不是解決此問題的最佳解決方案。我們必須記住，即使模擬是一種有價值且方便的測試工具，我們也不應過度使用它。

這就產生了一個新問題：

如果無法進行模擬，那么什么才是正確的工具？

這個問題的答案可以從Martin Fowler的一篇文章中找到。在本文中，馬丁·福勒（Martin Fowler）指定了一個稱為存根的測試雙精度，如下所示：

存根提供對測試過程中進行的呼叫的固定答復，通常通常根本不響應為測試編程的內容。存根還可以記錄有關呼叫的信息，例如，電子郵件網關存根可以記住“已發送”的消息，或者僅記住“已發送”的消息數量。

使用存根非常有意義，因為我們對兩件事感興趣：

我們需要能夠配置存根返回的Connection <？>對象。

創建新的用戶帳戶后，我們需要驗證連接是否與數據庫保持一致。

我們可以按照以下步驟創建一個實現這些目標的存根：

創建一個TestProviderSignInAttempt類，該類擴展了ProviderSignInAttempt類。

將私有連接字段添加到該類，并將添加的字段的類型設置為Connection <？> 。該字段包含對用戶和SaaS API提供程序之間的連接的引用。

將私有連接字段添加到該類，并將添加到的字段的類型設置為Set <String> 。該字段包含持久連接的用戶標識。

向創建的類添加一個將Connection <？>對象作為構造函數參數的構造函數。通過執行以下步驟來實現構造函數：

調用ProviderSignInAttempt類的構造函數，并將Connection <？>對象作為構造函數參數傳遞。將其他構造函數參數的值設置為null 。

將作為構造函數參數提供的Connection <？>對象設置為connection字段。

重寫ProviderSignInAttempt類的getConnection（）方法，并通過將存儲的對象返回到連接字段來實現它。

重寫ProviderSignInAttempt類的addConnection（String userId）方法，并通過將作為方法參數給出的用戶ID添加到連接集中來實現它。

將公共getConnections（）方法添加到創建的類中，并通過返回連接集來實現它。

TestProviderSignInAttempt的源代碼如下所示：

package org.springframework.social.connect.web;import org.springframework.social.connect.Connection;import java.util.HashSet; import java.util.Set;public class TestProviderSignInAttempt extends ProviderSignInAttempt {private Connection<?> connection;private Set<String> connections = new HashSet<>();public TestProviderSignInAttempt(Connection<?> connection) {super(connection, null, null);this.connection = connection;}@Overridepublic Connection<?> getConnection() {return connection;}@Overridevoid addConnection(String userId) {connections.add(userId);}public Set<String> getConnections() {return connections;} }

讓我們繼續前進，找出如何創建用于單元測試的Connection <？>類。

創建連接類

創建的連接類是一個存根類，它模擬“真實”連接類的行為，但是它沒有實現與OAuth1和OAuth2連接關聯的任何邏輯。同樣，此類必須實現Connection接口。

我們可以按照以下步驟創建此存根類：

創建一個TestConnection類，該類擴展了AbstractConnection類。 AbstractConnection類是基類，它定義了所有連接實現共享的狀態和行為。

將connectionData字段添加到創建的類。將字段的類型設置為ConnectionData 。 ConnectionData是一個數據傳輸對象，其中包含與使用的SaaS API提供程序的連接的內部狀態。

將userProfile字段添加到創建的類。將字段的類型設置為UserProfile 。此類表示所使用的SaaS API提供程序的用戶配置文件，并且包含在不同服務提供程序之間共享的信息。

創建一個將ConnectionData和UserProfile對象作為構造函數參數的構造函數，并按照以下步驟實現它：

調用AbstractConnection類的構造函數，并將ConnectionData對象作為第一個構造函數參數傳遞。將第二個構造函數參數設置為null 。

設置connectionData字段的值。

設置userProfile字段的值。

重寫AbstractConnection類的fetchUserProfile（）方法，并通過將存儲的對象返回到userProfile字段來實現它。

重寫AbstractConnection類的getAPI（）方法，并通過返回null來實現它。

重寫AbstractConnection類的createData（）方法，并通過將存儲的對象返回到connectionData字段來實現它。

TestConnection類的源代碼如下所示：

package org.springframework.social.connect.support;import org.springframework.social.connect.ConnectionData; import org.springframework.social.connect.UserProfile;public class TestConnection extends AbstractConnection {private ConnectionData connectionData;private UserProfile userProfile;public TestConnection(ConnectionData connectionData, UserProfile userProfile) {super(connectionData, null);this.connectionData = connectionData;this.userProfile = userProfile;}@Overridepublic UserProfile fetchUserProfile() {return userProfile;}@Overridepublic Object getApi() {return null;}@Overridepublic ConnectionData createData() {return connectionData;} }

讓我們繼續前進，弄清楚如何在單元測試中創建這些測試雙打。

創建構建器類

現在，我們為單元測試創??建了存根類。我們的最后一步是弄清楚如何使用這些類創建TestProviderSignInAttempt對象。

至此，我們知道

TestProviderSignInAttempt類的構造函數將Connection對象作為構造函數參數。

TestConnection類的構造函數將ConnectionData和UserProfile對象用作構造函數參數。

這意味著我們可以按照以下步驟創建新的TestProviderSignInAttempt對象：

創建一個新的ConnectionData對象。 ConnectionData類具有單個構造函數，該構造函數將必填字段用作構造函數參數。

創建一個新的UserProfile對象。我們可以使用UserProfileBuilder類創建新的UserProfile對象。

創建一個新的TestConnection對象，并將創建的ConnectionData和UserProfile對象作為構造函數參數傳遞。

創建一個新的TestProviderSignInAttempt對象，并將創建的TestConnectionConnection對象作為構造函數參數傳遞。

創建一個新的TestProviderSignInAttempt對象的源代碼如下所示：

ConnectionData connectionData = new ConnectionData("providerId","providerUserId","displayName","profileUrl","imageUrl","accessToken","secret","refreshToken",1000L);UserProfile userProfile = userProfileBuilder.setEmail("email").setFirstName("firstName").setLastName("lastName").build();TestConnection connection = new TestConnection(connectionData, userProfile); TestProviderSignInAttempt signIn = new TestProviderSignInAttempt(connection);

好消息是，我們現在知道如何在測試中創建TestProviderSignInAttempt對象。壞消息是我們無法在測試中使用此代碼。

我們必須記住，我們并不是為了確保我們的代碼按預期工作而編寫單元測試。每個測試用例還應該揭示我們的代碼在特定情況下的行為。如果我們通過將此代碼添加到每個測試用例中來創建TestProviderSignInAttempt ，那么我們將過于強調創建測試用例所需的對象。這意味著很難理解測試用例，并且丟失了測試用例的“本質”。

相反，我們將創建一個測試數據構建器類，該類提供了用于創建TestProviderSignInAttempt對象的流利的API。我們可以按照以下步驟創建此類：

創建一個名為TestProviderSignInAttemptBuilder的類。

將創建新的ConnectionData和UserProfile對象所需的所有字段添加到TestProviderSignInAttemptBuilder類。

添加用于設置所添加字段的字段值的方法。通過執行以下步驟來實現每種方法：

將作為方法參數給出的值設置為正確的字段。

返回對TestProviderSignInAttemptBuilder對象的引用。

將connectionData（）和userProfile（）方法添加到TestProviderSignInAttemptBuilder類。這些方法僅返回對TestProviderSignInAttemptBuilder對象的引用，其目的是使我們的API更具可讀性。

將build（）方法添加到測試數據構建器類。這將按照前面介紹的步驟創建TestProviderSignInAttempt對象，并返回創建的對象。

TestProviderSignInAttemptBuilder類的源代碼如下所示：

package org.springframework.social.connect.support;import org.springframework.social.connect.Connection; import org.springframework.social.connect.ConnectionData; import org.springframework.social.connect.UserProfile; import org.springframework.social.connect.UserProfileBuilder; import org.springframework.social.connect.web.TestProviderSignInAttempt;public class TestProviderSignInAttemptBuilder {private String accessToken;private String displayName;private String email;private Long expireTime;private String firstName;private String imageUrl;private String lastName;private String profileUrl;private String providerId;private String providerUserId;private String refreshToken;private String secret;public TestProviderSignInAttemptBuilder() {}public TestProviderSignInAttemptBuilder accessToken(String accessToken) {this.accessToken = accessToken;return this;}public TestProviderSignInAttemptBuilder connectionData() {return this;}public TestProviderSignInAttemptBuilder displayName(String displayName) {this.displayName = displayName;return this;}public TestProviderSignInAttemptBuilder email(String email) {this.email = email;return this;}public TestProviderSignInAttemptBuilder expireTime(Long expireTime) {this.expireTime = expireTime;return this;}public TestProviderSignInAttemptBuilder firstName(String firstName) {this.firstName = firstName;return this;}public TestProviderSignInAttemptBuilder imageUrl(String imageUrl) {this.imageUrl = imageUrl;return this;}public TestProviderSignInAttemptBuilder lastName(String lastName) {this.lastName = lastName;return this;}public TestProviderSignInAttemptBuilder profileUrl(String profileUrl) {this.profileUrl = profileUrl;return this;}public TestProviderSignInAttemptBuilder providerId(String providerId) {this.providerId = providerId;return this;}public TestProviderSignInAttemptBuilder providerUserId(String providerUserId) {this.providerUserId = providerUserId;return this;}public TestProviderSignInAttemptBuilder refreshToken(String refreshToken) {this.refreshToken = refreshToken;return this;}public TestProviderSignInAttemptBuilder secret(String secret) {this.secret = secret;return this;}public TestProviderSignInAttemptBuilder userProfile() {return this;}public TestProviderSignInAttempt build() {ConnectionData connectionData = new ConnectionData(providerId,providerUserId,displayName,profileUrl,imageUrl,accessToken,secret,refreshToken,expireTime);UserProfile userProfile = new UserProfileBuilder().setEmail(email).setFirstName(firstName).setLastName(lastName).build();Connection connection = new TestConnection(connectionData, userProfile);return new TestProviderSignInAttempt(connection);} }

注意：在為RegistrationController類編寫單元測試時，不需要調用此構建器類的所有方法。我添加這些字段的主要原因是，當我們為示例應用程序編寫集成測試時，它們將非常有用。

現在，創建新的TestProviderSignInAttempt對象的代碼更加整潔，可讀性更好：

TestProviderSignInAttempt socialSignIn = new TestProviderSignInAttemptBuilder().connectionData().providerId("twitter").userProfile().email("email").firstName("firstName").lastName("lastName").build();

讓我們繼續前進，了解如何使用自定義FEST-Assert斷言清理單元測試。

創建自定義斷言

我們可以通過將標準JUnit斷言替換為自定義FEST-Assert斷言來清理單元測試。我們必須創建以下三個自定義斷言類：

第一個斷言類用于為ExampleUserDetails對象編寫斷言。 ExampleUserDetails類包含已登錄用戶的信息，該信息存儲在應用程序的SecurityContext中。換句話說，此類提供的斷言用于驗證登錄用戶的信息是否正確。
第二個斷言類用于為SecurityContext對象編寫斷言。此類用于為其信息存儲到SecurityContext的用戶寫斷言。
第三個斷言類用于為TestProviderSignInAttempt對象編寫斷言。此斷言類用于驗證是否通過使用TestProviderSignInAttempt對象創建了與SaaS API提供程序的連接。

注意：如果您不熟悉FEST-Assert，則應閱讀我的博客文章，其中解釋了如何使用FEST-Assert創建自定義斷言，以及為什么要考慮這樣做。

讓我們繼續。

創建ExampleUserDetailsAssert類

通過執行以下步驟，我們可以實現第一個自定義斷言類：

創建一個ExampleUserDetailsAssert類，該類擴展了GenericAssert類。提供以下類型參數：

第一個類型參數是自定義斷言的類型。將此類型參數的值設置為ExampleUserDetailsAssert 。

第二個類型參數是實際值對象的類型。將此類型參數的值設置為ExampleUserDetails。

向創建的類添加一個私有構造函數。此構造函數將ExampleUserDetails對象作為構造函數參數。通過調用超類的構造函數并將以下對象作為構造函數參數傳遞來實現控制器：

第一個構造函數參數是一個Class對象，它指定自定義斷言類的類型。將此構造函數參數的值設置為ExampleUserDetailsAssert.class 。

第二個構造函數參數是實際值對象。將作為構造函數參數給出的對象傳遞給超類的構造函數。

將靜態assertThat（）方法添加到創建的類。此方法將ExampleUserDetails對象作為方法參數。通過創建一個新的ExampleUserDetailsAssert對象來實現此方法。

將hasFirstName（）方法添加到ExampleUserDetailsAssert類。此方法將String對象作為方法參數，并返回ExampleUserDetailsAssert對象。我們可以通過執行以下步驟來實現此方法：