TOC

Testen der API der Reddit App

Testen der API der Reddit App

1. Überblick

Wir haben die REST-API vonour simple Reddit App schon seit einiger Zeit entwickelt - es ist Zeit, ernst zu werden undstart testing it.

Und jetzt, da wirfinally switchedauf einen einfacheren Authentifizierungsmechanismus setzen, ist dies auch einfacher. Für all diese Live-Tests werden wirthe powerful rest-assured library verwenden.

2. Ersteinrichtung

Für API-Tests muss ein Benutzer ausgeführt werden. Um das Ausführen von Tests für die API zu vereinfachen, wird zuvor ein Testbenutzer erstellt - auf dem Bootstrap der Anwendung: 

@Component
public class Setup {
    @Autowired
    private UserRepository userRepository;

    @Autowired
    private PreferenceRepository preferenceRepository;

    @Autowired
    private PasswordEncoder passwordEncoder;

    @PostConstruct
    private void createTestUser() {
        User userJohn = userRepository.findByUsername("john");
        if (userJohn == null) {
            userJohn = new User();
            userJohn.setUsername("john");
            userJohn.setPassword(passwordEncoder.encode("123"));
            userJohn.setAccessToken("token");
            userRepository.save(userJohn);
            final Preference pref = new Preference();
            pref.setTimezone(TimeZone.getDefault().getID());
            pref.setEmail("[email protected]");
            preferenceRepository.save(pref);
            userJohn.setPreference(pref);
            userRepository.save(userJohn);
        }
    }
}

Beachten Sie, dassSetup eine einfache Bean ist und wir die Annotation@PostConstructverwenden, um die eigentliche Setup-Logik einzubinden.

3. Unterstützung für Live-Tests

Bevor wir anfangen, unsere Tests tatsächlich zu schreiben, können wirlet’s first set up some basic supporting functionality nutzen.

Wir benötigen Dinge wie Authentifizierung, URL-Pfade und möglicherweise einige JSON-Marshalling- und Unmarshalling-Funktionen: 

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(
  classes = { TestConfig.class },
  loader = AnnotationConfigContextLoader.class)
public class AbstractLiveTest {
    public static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");

    @Autowired
    private CommonPaths commonPaths;

    protected String urlPrefix;

    protected ObjectMapper objectMapper = new ObjectMapper().setDateFormat(dateFormat);

    @Before
    public void setup() {
        urlPrefix = commonPaths.getServerRoot();
    }

    protected RequestSpecification givenAuth() {
        FormAuthConfig formConfig
          = new FormAuthConfig(urlPrefix + "/j_spring_security_check", "username", "password");
        return RestAssured.given().auth().form("john", "123", formConfig);
    }

    protected RequestSpecification withRequestBody(RequestSpecification req, Object obj)
      throws JsonProcessingException {
        return req.contentType(MediaType.APPLICATION_JSON_VALUE)
          .body(objectMapper.writeValueAsString(obj));
    }
}

Wir definieren nur einige einfache Hilfsmethoden und -felder, um das eigentliche Testen zu vereinfachen:

  • givenAuth(): Zum Durchführen der Authentifizierung

  • withRequestBody(): Zum Senden der JSON-Darstellung vonObject als Hauptteil der HTTP-Anforderung

Und hier ist unsere einfache Bean -CommonPaths -, die eine saubere Abstraktion der URLs des Systems bietet: 

@Component
@PropertySource({ "classpath:web-${envTarget:local}.properties" })
public class CommonPaths {

    @Value("${http.protocol}")
    private String protocol;

    @Value("${http.port}")
    private String port;

    @Value("${http.host}")
    private String host;

    @Value("${http.address}")
    private String address;

    public String getServerRoot() {
        if (port.equals("80")) {
            return protocol + "://" + host + "/" + address;
        }
        return protocol + "://" + host + ":" + port + "/" + address;
    }
}

Und die lokale Version der Eigenschaftendatei:web-local.properties: 

http.protocol=http
http.port=8080
http.host=localhost
http.address=reddit-scheduler

Zum Schluss der sehr einfache Test der Federkonfiguration: 

@Configuration
@ComponentScan({ "org.example.web.live" })
public class TestConfig {
    @Bean
    public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
        return new PropertySourcesPlaceholderConfigurer();
    }
}

4. Testen Sie die API / scheduledPosts

Die erste API, die wir testen werden, ist die/scheduledPosts-API: 

public class ScheduledPostLiveTest extends AbstractLiveTest {
    private static final String date = "2016-01-01 00:00";

    private Post createPost() throws ParseException, IOException {
        Post post = new Post();
        post.setTitle("test");
        post.setUrl("test.com");
        post.setSubreddit("test");
        post.setSubmissionDate(dateFormat.parse(date));

        Response response = withRequestBody(givenAuth(), post)
          .post(urlPrefix + "/api/scheduledPosts?date=" + date);

        return objectMapper.reader().forType(Post.class).readValue(response.asString());
    }
}

Testen wir zunächstscheduling a new post: 

@Test
public void whenScheduleANewPost_thenCreated()
  throws ParseException, IOException {
    Post post = new Post();
    post.setTitle("test");
    post.setUrl("test.com");
    post.setSubreddit("test");
    post.setSubmissionDate(dateFormat.parse(date));

    Response response = withRequestBody(givenAuth(), post)
      .post(urlPrefix + "/api/scheduledPosts?date=" + date);

    assertEquals(201, response.statusCode());
    Post result = objectMapper.reader().forType(Post.class).readValue(response.asString());
    assertEquals(result.getUrl(), post.getUrl());
}

Als nächstes testen wirretrieving all scheduled posts eines Benutzers: 

@Test
public void whenGettingUserScheduledPosts_thenCorrect()
  throws ParseException, IOException {
    createPost();

    Response response = givenAuth().get(urlPrefix + "/api/scheduledPosts?page=0");

    assertEquals(201, response.statusCode());
    assertTrue(response.as(List.class).size() > 0);
}

Als nächstes testen wirediting a scheduled post: 

@Test
public void whenUpdatingScheduledPost_thenUpdated()
  throws ParseException, IOException {
    Post post = createPost();

    post.setTitle("new title");
    Response response = withRequestBody(givenAuth(), post).
      put(urlPrefix + "/api/scheduledPosts/" + post.getId() + "?date=" + date);

    assertEquals(200, response.statusCode());
    response = givenAuth().get(urlPrefix + "/api/scheduledPosts/" + post.getId());
    assertTrue(response.asString().contains(post.getTitle()));
}

Lassen Sie uns abschließendthe delete operation in der API testen: 

@Test
public void whenDeletingScheduledPost_thenDeleted()
  throws ParseException, IOException {
    Post post = createPost();
    Response response = givenAuth().delete(urlPrefix + "/api/scheduledPosts/" + post.getId());

    assertEquals(204, response.statusCode());
}

5. Testen Sie die API von /sites

Als Nächstes testen wir die API, die die Sites-Ressourcen veröffentlicht - die von einem Benutzer definierten Sites: 

public class MySitesLiveTest extends AbstractLiveTest {

    private Site createSite() throws ParseException, IOException {
        Site site = new Site("/feed/");
        site.setName("example");

        Response response = withRequestBody(givenAuth(), site)
          .post(urlPrefix + "/sites");

        return objectMapper.reader().forType(Site.class).readValue(response.asString());
    }
}

Testen wirretrieving all the sites des Benutzers: 

@Test
public void whenGettingUserSites_thenCorrect()
  throws ParseException, IOException {
    createSite();
    Response response = givenAuth().get(urlPrefix + "/sites");

    assertEquals(200, response.statusCode());
    assertTrue(response.as(List.class).size() > 0);
}

Und auch die Artikel einer Site abrufen: 

@Test
public void whenGettingSiteArticles_thenCorrect()
  throws ParseException, IOException {
    Site site = createSite();
    Response response = givenAuth().get(urlPrefix + "/sites/articles?id=" + site.getId());

    assertEquals(200, response.statusCode());
    assertTrue(response.as(List.class).size() > 0);
}

Als nächstes testen wiradding a new Site: 

@Test
public void whenAddingNewSite_thenCorrect()
  throws ParseException, IOException {
    Site site = createSite();

    Response response = givenAuth().get(urlPrefix + "/sites");
    assertTrue(response.asString().contains(site.getUrl()));
}

Unddeleting es: 

@Test
public void whenDeletingSite_thenDeleted() throws ParseException, IOException {
    Site site = createSite();
    Response response = givenAuth().delete(urlPrefix + "/sites/" + site.getId());

    assertEquals(204, response.statusCode());
}

6. Testen Sie die/user/preferences API

Konzentrieren wir uns abschließend auf die API, die die Einstellungen des Benutzers offenlegt.

Testen wir zunächstgetting user’s preferences: 

@Test
public void whenGettingPrefernce_thenCorrect() {
    Response response = givenAuth().get(urlPrefix + "/user/preference");

    assertEquals(200, response.statusCode());
    assertTrue(response.as(Preference.class).getEmail().contains("john"));
}

Undediting ihnen: 

@Test
public void whenUpdattingPrefernce_thenCorrect()
  throws JsonProcessingException {
    Preference pref = givenAuth().get(urlPrefix + "/user/preference").as(Preference.class);
    pref.setEmail("[email protected]");
    Response response = withRequestBody(givenAuth(), pref).
      put(urlPrefix + "/user/preference/" + pref.getId());

    assertEquals(200, response.statusCode());
    response = givenAuth().get(urlPrefix + "/user/preference");
    assertEquals(response.as(Preference.class).getEmail(), pref.getEmail());
}

7. Fazit

In diesem kurzen Artikel haben wir einige grundlegende Tests für unsere REST-API zusammengestellt.

Nichts Besonderes - fortgeschrittenere Szenarien sind erforderlich - aberthis isn’t about perfection, it’s about progress and iterating in public.

Related