Mock внешний сервер во время тестирования интеграции с Spring

Question

У меня есть веб-сервер Spring, который по запросу делает внешний вызов стороннему веб-API (например, retreive Facebook oauth token). После получения данных из этого вызова вычисляет ответ:

@RestController 
public class HelloController { 
    @RequestMapping("/hello_to_facebook") 
    public String hello_to_facebook() { 
     // Ask facebook about something 
     HttpGet httpget = new HttpGet(buildURI("https", "graph.facebook.com", "/oauth/access_token")); 
     String response = httpClient.execute(httpget).getEntity().toString(); 
     // .. Do something with a response 
     return response; 
    } 
} 

Я пишу интеграционный тест, который проверяет, что удар URL на моем сервере приводит к некоторому ожидаемому результату. Однако я хочу издеваться над внешним сервером локально, так что мне даже не нужен интернет-доступ, чтобы проверить все это. Каков наилучший способ сделать это?

Я новичок весной, это то, что у меня есть до сих пор.

@RunWith(SpringJUnit4ClassRunner.class) 
@SpringApplicationConfiguration(classes = Application.class) 
@WebAppConfiguration 
@IntegrationTest({}) 
public class TestHelloControllerIT {   
    @Test 
    public void getHelloToFacebook() throws Exception { 
     String url = new URL("http://localhost:8080/hello_to_facebook").toString(); 
     //Somehow setup facebook server mock ... 
     //FaceBookServerMock facebookMock = ... 

     RestTemplate template = new TestRestTemplate(); 
     ResponseEntity<String> response = template.getForEntity(url, String.class); 
     assertThat(response.getBody(), equalTo("...")); 

     //Assert that facebook mock got called 
     //facebookMock.verify(); 
    } 
} 

Фактические реальная создана более сложный - я делаю Facebook OAuth логин и все, что логика не в контроллере, но в различных объектах Spring Security. Однако я подозреваю, что код тестирования должен быть таким же, поскольку я просто нажимаю URL-адреса и ожидаю ответа, не так ли?

Answer 1

Поиграв немного с различными сценариями, вот один из способов, как можно достичь того, что было предложено с минимальным вмешательством в основной код

1. Refactor контроллера использовать параметр для третьего стороны адреса сервера:

   @RestController 
   public class HelloController { 
       @Value("${api_host}") 
       private String apiHost; 
   
       @RequestMapping("/hello_to_facebook") 
       public String hello_to_facebook() { 
        // Ask facebook about something 
        HttpGet httpget = new HttpGet(buildURI("http", this.apiHost, "/oauth/access_token")); 
        String response = httpClient.execute(httpget).getEntity().toString(); 
        // .. Do something with a response 
        return response + "_PROCESSED"; 
       } 
   } 
   

'api_host' равно 'graph.facebook.com' в application.properties в SRC/основные/ресурсов

2. Создайте новый контроллер в папке src/test/java, который высмеивает сервер третьей стороны.

3. Переопределить «api_host» для тестирования на «localhost».

Вот код для шагов 2 и 3 в одном файле для краткости:

@RestController 
class FacebookMockController { 
    @RequestMapping("/oauth/access_token") 
    public String oauthToken() { 
     return "TEST_TOKEN"; 
    } 
} 

@RunWith(SpringJUnit4ClassRunner.class) 
@SpringApplicationConfiguration(classes = Application.class) 
@WebAppConfiguration 
@IntegrationTest({"api_host=localhost",}) 
public class TestHelloControllerIT {   
    @Test 
    public void getHelloToFacebook() throws Exception { 
     String url = new URL("http://localhost:8080/hello_to_facebook").toString(); 
     RestTemplate template = new TestRestTemplate(); 
     ResponseEntity<String> response = template.getForEntity(url, String.class); 
     assertThat(response.getBody(), equalTo("TEST_TOKEN_PROCESSED")); 

     // Assert that facebook mock got called: 
     // for example add flag to mock, get the mock bean, check the flag 
    } 
} 

Есть ли лучше способ сделать это? Все отзывы приветствуются!

P.S.Вот некоторые осложнения, с которыми я столкнулся положить этот ответ в более реалистичном приложение:

1. Eclipse, смешивает тест и основную конфигурацию в пути к классам, чтобы вы могли задрать основную конфигурацию тестовых классов и параметров: https://issuetracker.springsource.com/browse/STS-3882 Использование Gradle bootRun, чтобы избежать его

2. Вы должны открыть доступ к вашим издеваемым ссылкам в конфиге безопасности, если у вас установлена ​​защита от пружины. Для добавления к конфигурации безопасности, а не возиться с основной конфигурацией конфигурацией:

   @Configuration 
   @Order(1) 
   class TestWebSecurityConfig extends WebSecurityConfig { 
       @Override 
       protected void configure(HttpSecurity http) throws Exception { 
        http 
         .authorizeRequests() 
          .antMatchers("/oauth/access_token").permitAll(); 
        super.configure(http); 
       } 
   } 
   

3. Это не просто ударить по протоколу HTTPS ссылки в интеграционных тестах. В конечном итоге я использую TestRestTemplate с настраиваемым запросом и настроенным SSLConnectionSocketFactory.

Answer 2

У вас может быть другой файл конфигурации весны, который предоставляет ту же конечную точку, что и класс HelloController. Затем вы можете просто вернуть законченный ответ json.

Из вашего кода я не уверен в том, чего вы пытаетесь достичь. Если вы просто хотите увидеть, что вызов в facebook работает, то нет никакой замены для тестирования на службу, которая фактически разговаривает с facebook. Издеваясь над ответом на facebook, чтобы убедиться, что он издевается правильно, не кажется мне ужасно полезным тестом.

Если вы тестируете, что данные, возвращаемые с facebook, каким-то образом мутируются, и вы хотите убедиться, что работа над ним выполнена правильно, вы можете сделать эту работу отдельным методом, который взял ответ facebook как параметр, а затем выполнил мутацию. Затем вы можете проверить на основе различных json-входов, что он работает правильно.

Вы можете протестировать, не введя в него веб-сервис.