Java Community | Help. Code. Learn.•3mo ago

I try to write JUnit integration test and to test whether service method works well. It isn't.

This is the service class:

107 Replies

⌛ This post has been reserved for your question.

Hey @Tomasm21! Please use /close or the Close Post button above when your problem is solved. Please remember to follow the help guidelines. This post will be automatically closed after 300 minutes of inactivity.

TIP: Narrow down your issue to simple and precise questions to maximize the chance that others will reply in here.

Tomasm21OP•3mo ago

@Service
public class ValidateCaptcha {
    
    private static final Logger LOG = LoggerFactory.getLogger(ValidateCaptcha.class);
    
    private final RestTemplate template;
    
    @Value("${google.recaptcha.verification.endpoint}")
    String recaptchaEndpoint;
    
    @Value("${google.recaptcha.secret}")
    String recaptchaSecret;
 
    public ValidateCaptcha(final RestTemplateBuilder templateBuilder) {
        this.template = templateBuilder.build();
    }

@Service
public class ValidateCaptcha {
    
    private static final Logger LOG = LoggerFactory.getLogger(ValidateCaptcha.class);
    
    private final RestTemplate template;
    
    @Value("${google.recaptcha.verification.endpoint}")
    String recaptchaEndpoint;
    
    @Value("${google.recaptcha.secret}")
    String recaptchaSecret;
 
    public ValidateCaptcha(final RestTemplateBuilder templateBuilder) {
        this.template = templateBuilder.build();
    }

    /**
     * Method to validate the captcha response coming from the client
     * and to return either true or false after the validation.
     * Reference url - https://developers.google.com/recaptcha/docs/verify
     * @param captchaResponse
     * @return boolean
     */
    public boolean validateCaptcha(final String captchaResponse) {
        LOG.info("RestTemplate instance: {}", template);     
        LOG.info("Going to validate the captcha response = [{}]", captchaResponse);
        final MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
        // "secret" is a required param and it represents the shared key between your site and the recaptcha. 
        params.add("secret", recaptchaSecret);
        
        // "response" is a required param and it represents the user token provided
        // by the recaptcha client-side integration on your site.
        params.add("response", captchaResponse);
     
        CaptchaResponse apiResponse = null;
        try {
            apiResponse = template.postForObject(recaptchaEndpoint, params, CaptchaResponse.class);
        } catch (final RestClientException e) {
            LOG.error("Some exception occurred while binding to the recaptcha endpoint.\n[{}]", e);
        }
     
        if (Objects.nonNull(apiResponse) && apiResponse.isSuccess()) {
           LOG.info("Captcha API response = [{}]", apiResponse.toString());
           return true;
        } else {
           return false;
        }
    }
}

    /**
     * Method to validate the captcha response coming from the client
     * and to return either true or false after the validation.
     * Reference url - https://developers.google.com/recaptcha/docs/verify
     * @param captchaResponse
     * @return boolean
     */
    public boolean validateCaptcha(final String captchaResponse) {
        LOG.info("RestTemplate instance: {}", template);     
        LOG.info("Going to validate the captcha response = [{}]", captchaResponse);
        final MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
        // "secret" is a required param and it represents the shared key between your site and the recaptcha. 
        params.add("secret", recaptchaSecret);
        
        // "response" is a required param and it represents the user token provided
        // by the recaptcha client-side integration on your site.
        params.add("response", captchaResponse);
     
        CaptchaResponse apiResponse = null;
        try {
            apiResponse = template.postForObject(recaptchaEndpoint, params, CaptchaResponse.class);
        } catch (final RestClientException e) {
            LOG.error("Some exception occurred while binding to the recaptcha endpoint.\n[{}]", e);
        }
     
        if (Objects.nonNull(apiResponse) && apiResponse.isSuccess()) {
           LOG.info("Captcha API response = [{}]", apiResponse.toString());
           return true;
        } else {
           return false;
        }
    }
}

This is the test:

@ExtendWith(MockitoExtension.class)
@SpringBootTest
public class ValidateCaptchaTest {

    @Mock 
    private RestTemplate restTemplate;

    @Autowired
    private ValidateCaptcha validateCaptcha;

    @Test
    public void testValidateCaptcha() {
        String captchaResponse = "test-captcha-response";
        
        CaptchaResponse mockResponse = new CaptchaResponse();
        mockResponse.setSuccess(true);  // Set success or failure based on your test scenario
        
        when(restTemplate.postForObject(
                anyString(),                       // Mock any URL (recaptchaEndpoint)
                any(MultiValueMap.class),          // Mock any request params
                eq(CaptchaResponse.class)          // Expect a response of type CaptchaResponse
            )).thenReturn(mockResponse);

        boolean result = validateCaptcha.validateCaptcha(captchaResponse);
        
     // Debug output to see what's happening
        System.out.println("Captcha API call result: " + result);
        
        assertTrue(result);  // or assertFalse depending on mockResponse success
    }
}

@ExtendWith(MockitoExtension.class)
@SpringBootTest
public class ValidateCaptchaTest {

    @Mock 
    private RestTemplate restTemplate;

    @Autowired
    private ValidateCaptcha validateCaptcha;

    @Test
    public void testValidateCaptcha() {
        String captchaResponse = "test-captcha-response";
        
        CaptchaResponse mockResponse = new CaptchaResponse();
        mockResponse.setSuccess(true);  // Set success or failure based on your test scenario
        
        when(restTemplate.postForObject(
                anyString(),                       // Mock any URL (recaptchaEndpoint)
                any(MultiValueMap.class),          // Mock any request params
                eq(CaptchaResponse.class)          // Expect a response of type CaptchaResponse
            )).thenReturn(mockResponse);

        boolean result = validateCaptcha.validateCaptcha(captchaResponse);
        
     // Debug output to see what's happening
        System.out.println("Captcha API call result: " + result);
        
        assertTrue(result);  // or assertFalse depending on mockResponse success
    }
}

Tomasm21OP•3mo ago

Tomasm21OP•3mo ago

Console output:

test_output.txt

Tomasm21OP•3mo ago

Am I doing anything wrong in the test? Or it cannot be tested like this? The application works well. When requesting from the frontend with the specific captchaResponse string the method returns true. But I want to test this method like a JUnit test. It should assert to true, but it is false. Why? I though mocked rest template already set the response. Looks like the service method is invoked for real. Should it be like this?

Gaming

Programming

I try to write JUnit integration test and to test whether service method works well. It isn't.