✨ Introducing new features. pigx-common-test support oauth2 test

pigx-common/pigx-common-bom/pom.xml

@@ -106,6 +106,11 @@
 				<artifactId>pigx-common-transaction</artifactId>
 				<version>${pigx.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>com.pig4cloud</groupId>
+				<artifactId>pigx-common-test</artifactId>
+				<version>${pigx.version}</version>
+			</dependency>
 			<dependency>
 				<groupId>com.pig4cloud</groupId>
 				<artifactId>pigx-upms-api</artifactId>

pigx-common/pigx-common-test/pom.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xmlns="http://maven.apache.org/POM/4.0.0"
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>com.pig4cloud</groupId>
+		<artifactId>pigx-common</artifactId>
+		<version>3.10.0</version>
+	</parent>
+
+	<artifactId>pigx-common-test</artifactId>
+	<packaging>jar</packaging>
+
+	<description>pigx oauth 2.0 单元测试工具类</description>
+
+	<dependencies>
+		<dependency>
+			<groupId>com.pig4cloud</groupId>
+			<artifactId>pigx-common-security</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.security</groupId>
+			<artifactId>spring-security-test</artifactId>
+		</dependency>
+	</dependencies>
+</project>

pigx-common/pigx-common-test/src/main/java/com/pig4cloud/pigx/test/WithMockSecurityContextFactory.java

@@ -0,0 +1,93 @@
+package com.pig4cloud.pigx.test;
+
+import cn.hutool.http.HttpRequest;
+import cn.hutool.json.JSONArray;
+import cn.hutool.json.JSONObject;
+import cn.hutool.json.JSONUtil;
+import com.pig4cloud.pigx.common.core.constant.SecurityConstants;
+import com.pig4cloud.pigx.common.core.util.SpringContextHolder;
+import com.pig4cloud.pigx.common.security.service.PigxUser;
+import com.pig4cloud.pigx.test.annotation.WithMockOAuth2User;
+import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.core.authority.AuthorityUtils;
+import org.springframework.security.core.context.SecurityContext;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.oauth2.client.OAuth2ClientContext;
+import org.springframework.security.oauth2.client.resource.OAuth2ProtectedResourceDetails;
+import org.springframework.security.oauth2.common.DefaultOAuth2AccessToken;
+import org.springframework.security.oauth2.provider.token.AccessTokenConverter;
+import org.springframework.security.test.context.support.WithSecurityContextFactory;
+
+import java.util.Collection;
+
+/**
+ * @author lengleng
+ * @date 2020/9/22
+ * <p>
+ * oauth2 上下文生成处理器
+ */
+public class WithMockSecurityContextFactory implements WithSecurityContextFactory<WithMockOAuth2User> {
+
+	@Override
+	public SecurityContext createSecurityContext(WithMockOAuth2User oAuth2User) {
+		// 1. 请求认证中心
+		JSONObject authResult = request(oAuth2User);
+
+		// 2. 解析认证中心返回报文
+		PigxUser principal = parse(authResult);
+
+		// 3. 构建 oauth2 上下文
+		SecurityContext context = SecurityContextHolder.createEmptyContext();
+		Authentication auth = new UsernamePasswordAuthenticationToken(principal, "N/A", principal.getAuthorities());
+		context.setAuthentication(auth);
+
+		// 4. 上下文保存 token
+		String token = authResult.getStr("access_token");
+		DefaultOAuth2AccessToken accessToken = new DefaultOAuth2AccessToken(token);
+		OAuth2ClientContext clientContext = SpringContextHolder.getBean(OAuth2ClientContext.class);
+		clientContext.setAccessToken(accessToken);
+		return context;
+	}
+
+	/**
+	 * 请求认证中心
+	 * @param oAuth2User 账号、密码
+	 * @return JSONObject
+	 */
+	private JSONObject request(WithMockOAuth2User oAuth2User) {
+		OAuth2ProtectedResourceDetails clientProperties = SpringContextHolder
+				.getBean(OAuth2ProtectedResourceDetails.class);
+
+		String result = HttpRequest.post(clientProperties.getAccessTokenUri())
+				.basicAuth(clientProperties.getClientId(), clientProperties.getClientSecret())
+				.form("username", oAuth2User.username()).form("password", oAuth2User.password())
+				.form("grant_type", "password").form("scope", clientProperties.getScope()).execute().body();
+
+		return JSONUtil.parseObj(result);
+	}
+
+	/**
+	 * 请求认证中心
+	 * @param tokenObj 认证中心返回结果
+	 * @return 用户信息
+	 */
+	private PigxUser parse(JSONObject tokenObj) {
+		JSONObject userInfo = tokenObj.getJSONObject("user_info");
+
+		Integer id = userInfo.getInt(SecurityConstants.DETAILS_USER_ID);
+		Integer deptId = userInfo.getInt(SecurityConstants.DETAILS_DEPT_ID);
+		String phone = userInfo.getStr(SecurityConstants.DETAILS_PHONE);
+		String avatar = userInfo.getStr(SecurityConstants.DETAILS_AVATAR);
+		String username = userInfo.getStr(SecurityConstants.DETAILS_USERNAME);
+		Integer tenantId = userInfo.getInt(SecurityConstants.DETAILS_TENANT_ID);
+		JSONArray jsonArray = userInfo.getJSONArray(AccessTokenConverter.AUTHORITIES);
+
+		Collection<? extends GrantedAuthority> authorities = AuthorityUtils
+				.createAuthorityList(jsonArray.toArray(new String[0]));
+
+		return new PigxUser(id, deptId, phone, avatar, tenantId, username, "N/A", true, true, true, true, authorities);
+	}
+
+}

pigx-common/pigx-common-test/src/main/java/com/pig4cloud/pigx/test/annotation/WithMockOAuth2User.java

@@ -0,0 +1,29 @@
+package com.pig4cloud.pigx.test.annotation;
+
+import com.pig4cloud.pigx.test.WithMockSecurityContextFactory;
+import org.springframework.security.test.context.support.WithSecurityContext;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * @author lengleng
+ * @date 2020/9/22
+ * <p>
+ * WithMockOAuth2User 注解
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@WithSecurityContext(factory = WithMockSecurityContextFactory.class)
+public @interface WithMockOAuth2User {
+
+	/**
+	 * 用户名
+	 */
+	String username() default "admin";
+
+	/**
+	 * 密码
+	 */
+	String password() default "123456";
+
+}

pigx-common/pigx-common-test/src/main/java/com/pig4cloud/pigx/test/kit/OAuthKit.java

@@ -0,0 +1,29 @@
+package com.pig4cloud.pigx.test.kit;
+
+import com.pig4cloud.pigx.common.core.util.SpringContextHolder;
+import org.springframework.http.HttpHeaders;
+import org.springframework.security.oauth2.client.OAuth2ClientContext;
+import org.springframework.test.web.servlet.request.RequestPostProcessor;
+
+/**
+ * @author lengleng
+ * @date 2020/9/22
+ * <p>
+ * Mocke 工具类
+ */
+public class OAuthKit {
+
+	/**
+	 * mock 请求增加统一请求头
+	 * @return
+	 */
+	public static RequestPostProcessor token() {
+		return mockRequest -> {
+			OAuth2ClientContext clientContext = SpringContextHolder.getBean(OAuth2ClientContext.class);
+			String token = clientContext.getAccessToken().getValue();
+			mockRequest.addHeader(HttpHeaders.AUTHORIZATION, String.format("Bearer: %s", token));
+			return mockRequest;
+		};
+	}
+
+}

pigx-common/pom.xml

@@ -47,6 +47,7 @@
 		<module>pigx-common-sentinel</module>
 		<module>pigx-common-sequence</module>
 		<module>pigx-common-swagger</module>
+		<module>pigx-common-test</module>
 		<module>pigx-common-transaction</module>
 	</modules>
 </project>