如何编写用于网关云过滤器的junit5测试以及如何获得此代码的完整代码覆盖率

问题描述

我想为网关云过滤器编写junit测试，但是问题是我是单元测试的新手。请帮我。这是一种私有的授权方法。

[如果没有人知道如何编写spring网关云过滤器，请通过我的网关过滤器方法进行操作。和逻辑]

@Component
@Slf4j
public class AuthorizationFilter extends AbstractGatewayFilterFactory<AuthorizationFilter.Config> {

    @Value("${rest.auth.service.url}")
    private String authServiceUrl;

    @Autowired
    RestTemplate restTemplate;

    public AuthorizationFilter() {
        super(Config.class);
    }

    private Mono<Void> onError(ServerWebExchange exchange,String err,HttpStatus httpStatus) {
        ServerHttpResponse response = exchange.getResponse();
        response.setStatusCode(httpStatus);

        return response.setComplete();
    }
    //Here is my authorization details 
    private UserRoleDetailsDTO getAuthorizationDetails(String authorizationHeader) {
        try {
            log.error("Checking authorization");
            HttpEntity<?> entity = new HttpEntity(null,new HttpHeaders() {{
                add("Authorization",authorizationHeader);
                add("Accept","application/json");
            }});

            ResponseEntity<Map> responseMap = restTemplate.exchange(authServiceUrl.concat("/v1/profile"),HttpMethod.GET,entity,Map.class);
            System.out.println(responseMap);
            if (responseMap.getBody() == null)
                log.warn("Received null body in response. Request will end now");
            Map data = (Map) responseMap.getBody().get("data");
            boolean isAuthorized = data.get("authorized") == null || (boolean) data.get("authorized");
            UserRoleDetailsDTO userRoleDetailsDTO = UserRoleDetailsDTO.builder().userId(String.valueOf(data.get("userId"))).
                    roles((List<RoleDTO>) data.get("roles")).isAuthorized(isAuthorized).build();
            return userRoleDetailsDTO;
        } catch (RestClientException e) {
            String errorResponse = null;
            if (e instanceof HttpClientErrorException) {
                HttpClientErrorException exception = (HttpClientErrorException) e;
                errorResponse = exception.getResponseBodyAsString();
            } else errorResponse = e.getMessage();
            log.error("error with http connect with error response : {} : {}",errorResponse,e);
            return null;
        } catch (Exception e) {
            log.error("error with http connect : {}",e);
            return null;
        }
    }
    // Here is my Gateway filter
    @Override
    public GatewayFilter apply(Config config) {

        return (exchange,chain) -> {
            ServerHttpRequest request = exchange.getRequest();

            String requestId;
            if (request.getHeaders().containsKey("Request-Id")) {
                requestId = request.getHeaders().get("Request-Id").get(0);
            } else {
                requestId = UUID.randomUUID().toString();
                log.debug("Request Id not passed. {} is genertaing requestId {}",AuthorizationFilter.class.getSimpleName(),requestId);
            }
            MDC.put("requestId",requestId);
            request.mutate().header("Request-Id",requestId);

            if (!request.getHeaders().containsKey("Authorization")) {
                log.error("No authorization header");
                return onError(exchange,"No Authorization header",HttpStatus.UNAUTHORIZED);
            }

            String authorizationHeader = request.getHeaders().get("Authorization").get(0);

            UserRoleDetailsDTO userRoleDetailsDTO = getAuthorizationDetails(authorizationHeader);
            if (userRoleDetailsDTO == null || !userRoleDetailsDTO.isAuthorized()) {
                log.error("Invalid authorization header");
                return onError(exchange,"Invalid Authorization header",HttpStatus.UNAUTHORIZED);
            }
            String userDetailsStr = "";
            try {
                userDetailsStr = new ObjectMapper().writeValueAsString(userRoleDetailsDTO);
                System.out.println("value 1 :"+userDetailsStr);
            } catch (JsonProcessingException e) {
                log.error("Exception writing user details to string. ",e);
            }
            if (StringUtils.isEmpty(userDetailsStr))
                log.warn("Empty User Details string being passed!!");
            request.mutate().header(ApplicationConstants.USER_DETAILS_HEADER,userDetailsStr);
            System.out.println("value 2 :"+request.mutate().header(ApplicationConstants.USER_DETAILS_HEADER,userDetailsStr));
            return chain.filter(exchange.mutate().request(request).build());
        };

    }

    @Override
    public Config newConfig() {
        return new Config();
    }

    public static class Config {
        // Put the configuration properties
    }

}

这是我的用户角色详细信息

public class UserRoleDetailsDTO {
    private String userId;
    private List<RoleDTO> roles;
    private boolean isAuthorized = true;
} 

和RoleDto类

  public class RoleDTO {
        private String name;
        private int weight;
    }

这是我在进行代码覆盖率测试时进行的junit测试，但是我没有完全覆盖代码，请帮忙

 public YourClassTest{   

    @Test
    void apply() throws Exception {
        AuthorizationFilter authorizationFilter  = new AuthorizationFilter();
        AuthorizationFilter.Config config = new YourClass.Config();
        GatewayFilter filter =authorizationFilter.apply(config);
        String st ;
        st = new  ObjectMapper().writeValueAsString(userRoleDetailsDTO);
             MockServerHttpRequest expected  = MockServerHttpRequest.get("/v1/profile").
               header("Authorization","Bearer sdfsf",st,TestConstants.USER_DETAILS_HEADER).build();
        MockServerWebExchange exchange = MockServerWebExchange.from(expected);
        filter.filter(exchange,FilterChain);
        String requestid;
        ServerHttpRequest actual =  exchange.getRequest();
        assertEquals(expected,actual);
    }
 }

解决方法

我等了两天，有人会回答我的问题，但没人回答我的问题，但最终我解决了。我用过junit5

这是我正确的解决方法

@SpringBootTest(properties = { "spring.profiles.active=test" })
class AuthorizationFilterTest {

    @Mock
    GatewayFilterChain filterChain;
    @MockBean()
    RestTemplate restTemplate;
    @Autowired
    AuthorizationFilter authorizationFilter = new AuthorizationFilter();
    
    @BeforeAll
    public static void init() {
    userRoleDetailsDTO = new UserRoleDetailsDTO();
    RoleDTO roleDTO = new RoleDTO();
    roleDTO.setName("ADMIN_ROLE");
    roleDTO.setWeight(1);
    userRoleDetailsDTO.setUserId("user::2f840056-e7aa-84m- 68e1-1e2ef697c78b");
    userRoleDetailsDTO.setRoles(Stream.of(roleDTO).collect(Collectors.toList()));

}


    @Test
    void apply()
    {
     AuthorizationFilter.Config config = new AuthorizationFilter.Config();
    Map<String,Object> profile = objectMapper.readValue(TestConstantsTest.ADMIN_PROFILE_RESPONSE,Map.class);
    ResponseEntity<Map> profileMap = ResponseEntity.ok(profile);
    Mockito.when(restTemplate.exchange(Mockito.anyString(),Mockito.any(HttpMethod.class),Mockito.any(HttpEntity.class),Mockito.eq(Map.class))).thenReturn(profileMap);
    GatewayFilter filter = authorizationFilter.apply(config);
    MockServerHttpRequest expected = MockServerHttpRequest.post("/v1/profile")
            .header("Authorization",TestConstantsTest.ADMIN_INITIALISE_REQUEST_AUTH_HEADER).build();
    MockServerWebExchange exchange = MockServerWebExchange.from(expected);
    filter.filter(exchange,GatewayfilterChain);
    ServerHttpRequest actual = exchange.getRequest();
    assertEquals(expected,actual);
   
    }

这是我的TestConstant.class

    Class TestConstantTest
    {
         public static final String ADMIN_PROFILE_RESPONSE = "{\n" +
                "   \"code\":\"200\",\n" +
                "   \"data\":{\n" +
                "      \"myroles\":[\n" +
                "         {\n" +
                "            \"name\":\"ADMIN_ROLE\",\n" +
                "            \"weight\":\"1\"\n" +
                "         }\n" +
                "      ],\n" +
                "      \"userId=User\":\"manually-inserted-usser-user-id-normallt-uuid\"\n" +
                "   },\n" +
                "   \"message\":\"Success\",\n" +
                "   \"status\":1\n" +
                " }";
    
        public static final String ADMIN_INITIALISE_REQUEST_AUTH_HEADER ="Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX" +
                "VCJ9.eyJhdWQiOlsicmVzb3VyY2Utc2VydmVghingbshtYXBpIl0sImV4cCI6MTU5NTI0NDU2MywidXNlcl9uYW1lIj" +
                "oiYzNlMjk0MGEtYzM3ZS0xMWVhLTg3ZDAtMDI0MmFjMTMwMDAzIiwianRpIjoiZTNkZDA1MTEtNDM0NC00MjhiLTk2Z" +
                "WQtYjUzNzU3Y2uytrewqasdY2xpZW50X2lkIjoic3ByaW5nLXNlY3VyaXR5LW9hdXRoMi1yZWFkLXdyaXRlLWNsa" +
                "WVudCIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdfQ.HvbThWCTqs2y9dP87kE31PmPA-EFk3J6HDFyAiEQlsM";
}