Статьи

Студент проекта: сервер веб-сервиса с Джерси

Март 20, 2019

Это часть проекта Студент . Другие посты — Клиент Webservice с Джерси , Бизнес-уровень и Постоянство с Spring Data .

Вторым слоем веб-приложения RESTful является сервер веб-сервиса. Это должен быть тонкий слой, который переносит вызовы на бизнес-уровень, но не выполняет значительную собственную обработку. В этом посте много кода, но в основном это тестовые классы.

Проектные решения

Джерси — я использую Джерси для REST-сервера. Я рассматривал альтернативы — Spring MVC , Netty и т. Д., Но решил поехать с Джерси по той же причине, что и клиент. Это легкий и не ограничивает разработчика.

Внедрение зависимостей — мне нужно внедрение зависимостей, а это значит, что мне нужно определиться с фреймворком: Spring, EJB3, Guice и т. Д. Я уже знаю, что буду использовать Spring Data для слоя персистентности, поэтому использовать его не составит труда. пружинный каркас. Я все еще буду стараться минимизировать любые зависимости (ха!) От этой структуры для максимальной гибкости.

Ограничения

Джерси — я не знаю, насколько хорошо Джерси будет выдерживать высокие нагрузки. Это ключевая причина, по которой сервер REST должен быть тонкой оболочкой для бизнес-уровня — при необходимости будет безболезненно менять библиотеки.

Полномочия пользователя — нет попытки ограничить доступ к определенным методам для определенных пользователей или хостов. Это должно обрабатываться бизнес-уровнем с исключениями безопасности, преобразованными в коды состояния FORBIDDEN сервером REST.

Джерси REST Сервер

Одним из наших ранних проектных документов является REST API. Для сервера это означает, что мы реализуем уровень от сервера REST вниз, а не от API бизнес-уровня вверх. Фактически сервер REST определяет необходимые методы в API бизнес-уровня.

Есть одно небольшое отклонение от стандартного API REST CRUD: объекты создаются с POST вместо PUT, так как семантика последнего состоит в том, что объект создается точно так, как предусмотрено. Мы не можем этого сделать — по соображениям безопасности мы никогда не раскрываем наш внутренний идентификатор и никогда не должны принимать пользовательский UUID. Это означает, что мы нарушим контракт REST API, поэтому вместо него мы используем POST.

Существует также один небольшой обман: для контракта CRUD требуется только возможность создавать или обновлять объекты. Это означает, что мы можем вычислить необходимое действие, используя только путь — нам не нужно добавлять конкретное поле «действие». Это может измениться, если мы расширим реализацию, включив в нее нечто большее, чем просто действия CRUD.

Вперед к коду …

001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
@Service
@Path("/course")
public class CourseResource extends AbstractResource {
    private static final Logger log = Logger.getLogger(CourseResource.class);
    private static final Course[] EMPTY_COURSE_ARRAY = new Course[0];
 
    @Context
    UriInfo uriInfo;
 
    @Context
    Request request;
 
    @Resource
    private CourseService service;
 
    /**
     * Default constructor.
     */
    public CourseResource() {
 
    }
 
    /**
     * Unit test constructor.
     *
     * @param service
     */
    CourseResource(CourseService service) {
        this.service = service;
    }
 
    /**
     * Get all Courses.
     *
     * @return
     */
    @GET
    @Produces({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
    public Response findAllCourses() {
        log.debug("CourseResource: findAllCourses()");
 
        Response response = null;
        try {
            List<Course> courses = service.findAllCourses();
 
            List<Course> results = new ArrayList<Course>(courses.size());
            for (Course course : courses) {
                results.add(scrubCourse(course));
            }
 
            response = Response.ok(results.toArray(EMPTY_COURSE_ARRAY)).build();
        } catch (Exception e) {
            if (!(e instanceof UnitTestException)) {
                log.info("unhandled exception", e);
            }
            response = Response.status(Status.INTERNAL_SERVER_ERROR).build();
        }
 
        return response;
    }
 
    /**
     * Create a Course.
     *
     * @param req
     * @return
     */
    @POST
    @Consumes({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
    @Produces({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
    public Response createCourse(Name req) {
        log.debug("CourseResource: createCourse()");
 
        final String name = req.getName();
        if ((name == null) || name.isEmpty()) {
            return Response.status(Status.BAD_REQUEST).entity("'name' is required").build();
        }
 
        Response response = null;
 
        try {
            Course course = service.createCourse(name);
            if (course == null) {
                response = Response.status(Status.INTERNAL_SERVER_ERROR).build();
            } else {
                response = Response.created(URI.create(course.getUuid())).entity(scrubCourse(course)).build();
            }
        } catch (Exception e) {
            if (!(e instanceof UnitTestException)) {
                log.info("unhandled exception", e);
            }
            response = Response.status(Status.INTERNAL_SERVER_ERROR).build();
        }
 
        return response;
    }
 
    /**
     * Get a specific Course.
     *
     * @param uuid
     * @return
     */
    @Path("/{courseId}")
    @GET
    @Produces({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
    public Response getCourse(@PathParam("courseId") String id) {
        log.debug("CourseResource: getCourse()");
 
        Response response = null;
        try {
            Course course = service.findCourseByUuid(id);
            response = Response.ok(scrubCourse(course)).build();
        } catch (ObjectNotFoundException e) {
            response = Response.status(Status.NOT_FOUND).build();
        } catch (Exception e) {
            if (!e instanceof UnitTestException)) {
                log.info("unhandled exception", e);
            }
            response = Response.status(Status.INTERNAL_SERVER_ERROR).build();
        }
 
        return response;
    }
 
    /**
     * Update a Course.
     *
     * FIXME: what about uniqueness violations?
     *
     * @param id
     * @param req
     * @return
     */
    @Path("/{courseId}")
    @POST
    @Consumes({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
    @Produces({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
    public Response updateCourse(@PathParam("courseId") String id, Name req) {
        log.debug("CourseResource: updateCourse()");
 
        final String name = req.getName();
        if ((name == null) || name.isEmpty()) {
            return Response.status(Status.BAD_REQUEST).entity("'name' is required").build();
        }
 
        Response response = null;
        try {
            final Course course = service.findCourseByUuid(id);
            final Course updatedCourse = service.updateCourse(course, name);
            response = Response.ok(scrubCourse(updatedCourse)).build();
        } catch (ObjectNotFoundException exception) {
            response = Response.status(Status.NOT_FOUND).build();
        } catch (Exception e) {
            if (!(e instanceof UnitTestException)) {
                log.info("unhandled exception", e);
            }
            response = Response.status(Status.INTERNAL_SERVER_ERROR).build();
        }
 
        return response;
    }
 
    /**
     * Delete a Course.
     *
     * @param id
     * @return
     */
    @Path("/{courseId}")
    @DELETE
    public Response deleteCourse(@PathParam("courseId") String id) {
        log.debug("CourseResource: deleteCourse()");
 
        Response response = null;
        try {
            service.deleteCourse(id);
            response = Response.noContent().build();
        } catch (ObjectNotFoundException exception) {
            response = Response.noContent().build();
        } catch (Exception e) {
            if (!(e instanceof UnitTestException)) {
                log.info("unhandled exception", e);
            }
            response = Response.status(Status.INTERNAL_SERVER_ERROR).build();
        }
 
        return response;
    }
}

Реализация говорит нам, что нам нужно три вещи:

  • API службы (CourseService)
  • классы параметров запроса (Имя)
  • скруббер (scrubCourse)

Я не показывал полную регистрацию. Параметры запроса должны быть очищены, чтобы избежать загрязнения журнала. , В качестве простого примера рассмотрим использование логгера, который пишет в базу данных SQL для простоты анализа. Наивная реализация этого логгера — который не использует позиционные параметры — позволила бы SQL-инъекцию через тщательно созданные параметры запроса!

OWASP ESAPI содержит методы, которые можно использовать для очистки журнала. Я не включил сюда, так как это немного сложно настроить. (Это должно быть в проверенном коде в ближайшее время.)

Зачем вам входить в базу данных? Хорошей практикой является регистрация всех необработанных исключений, которые достигают уровня сервера — вы никогда не захотите, чтобы пользователь сообщал о проблемах, а ошибки, записанные в файлы журнала, легко игнорируются. В отличие от отчетов, записанных в базу данных, легко проверить с помощью простых инструментов.

Опытные разработчики могут даже создавать новые отчеты об ошибках, когда возникают необработанные исключения. В этом случае важно поддерживать отдельную базу данных исключений, чтобы избежать отправки дублирующих записей и подавляющего количества разработчиков. (База данных может содержать подробности для каждого исключения, но система отчетов об ошибках должна иметь только один отчет об ошибках на класс исключений + трассировка стека.)

API сервиса

API сервиса для операций CRUD прост.

01
02
03
04
05
06
07
08
09
10
11
12
13
public interface CourseService {
    List<Course> findAllCourses();
 
    Course findCourseById(Integer id);
 
    Course findCourseByUuid(String uuid);
 
    Course createCourse(String name);
 
    Course updateCourse(Course course, String name);
 
    void deleteCourse(String uuid);
}

API также включает исключение ObjectNotFoundException. (Это должно быть расширено, чтобы включить тип объекта, который не может быть найден.)

01
02
03
04
05
06
07
08
09
10
11
12
13
14
public class ObjectNotFoundException extends RuntimeException {
    private static final long serialVersionUID = 1L;
 
    private final String uuid;
 
    public ObjectNotFoundException(String uuid) {
        super("object not found: [" + uuid + "]");
        this.uuid = uuid;
    }
 
    public String getUuid() {
        return uuid;
    }
}

Как упомянуто выше, мы также хотим в конечном итоге исключение UnauthorizedOperationException.

Параметры запроса

Параметры запроса — это простые POJO, которые инкапсулируют полезные нагрузки POST.

01
02
03
04
05
06
07
08
09
10
11
12
@XmlRootElement
public class Name {
    private String name;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
}

Студенты и преподаватели также требуют адреса электронной почты.

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
@XmlRootElement
public class NameAndEmailAddress {
    private String name;
    private String emailAddress;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public String getEmailAddress() {
        return emailAddress;
    }
 
    public void setEmailAddress(String emailAddress) {
        this.emailAddress = emailAddress;
    }
}

В конечном приложении будет большое количество классов параметров запроса.

скруббер

Скруббер служит трем целям. Во-первых, он удаляет конфиденциальную информацию, которая не должна предоставляться клиенту, например, внутренние идентификаторы базы данных.

Во-вторых, он предотвращает массивный дамп базы данных из-за извлечения коллекций Например, студент должен включить список текущих разделов, но в каждом разделе есть список зарегистрированных студентов и преподавателей. У каждого из этих студентов и преподавателей есть свой список текущих разделов. Мыть, полоскать, повторять, и вы в конечном итоге выгрузите всю базу данных в ответ на один запрос.

Решение состоит в том, чтобы включить только поверхностную информацию о каждом объекте, который может быть запрошен независимо. Например, у студента будет список текущих разделов, но эти разделы будут содержать только UUID и имя. Очень хорошее практическое правило заключается в том, что очищенные коллекции должны содержать именно ту информацию, которая будет использоваться в раскрывающихся списках и презентационных таблицах, и ничего более. Списки презентаций могут включать ссылки (или действия AJAX) для получения дополнительной информации по мере необходимости.

Наконец, это хорошее место для кодирования и очистки HTML. Возвращенные значения должны быть очищены, чтобы предотвратить атаки межсайтового скриптинга (CSS) .

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
public abstract class AbstractResource {
 
    /**
     * Scrub 'course' object.
     *
     * FIXME add HTML scrubbing and encoding for string values!
     */
    public Course scrubCourse(final Course dirty) {
        final Course clean = new Course();
        clean.setUuid(dirty.getUuid());
        clean.setName(dirty.getName());
        // clean.setSelf("resource/" + dirty.getUuid());
        return clean;
    }
}

Классы конфигурации

У нас есть два класса конфигурации. Первый всегда используется сервером, второй используется сервером только во время интеграционного тестирования. Последняя конфигурация (и ссылочные классы) находятся в дереве исходного кода интеграционного теста .

Я предпочитаю использовать классы конфигурации (представленные в Spring 3.0), поскольку они обеспечивают наибольшую гибкость — например, я могу условно определять bean-компоненты в соответствии с пользователем, запускающим приложение или переменные среды, — и разрешать мне по-прежнему включать стандартные файлы конфигурации.

1
2
3
4
5
6
7
8
9
@Configuration
@ComponentScan(basePackages = { "com.invariantproperties.sandbox.student.webservice.server.rest" })
@ImportResource({ "classpath:applicationContext-rest.xml" })
// @PropertySource("classpath:application.properties")
public class RestApplicationContext {
 
    @Resource
    private Environment environment;
}

Весной 3.1 введены профили конфигурации. Они работают, но используемый мной сервлет с поддержкой пружинного джерси не может правильно настроить активные профили.

1
2
3
4
5
6
7
8
9
@Configuration
//@Profile("test")
public class RestApplicationContextTest {
 
    @Bean
    StudentService studentService() {
        return new DummyStudentService();
    }
}

web.xml

Теперь у нас достаточно для реализации нашего веб-сервера. Используемый сервлет — это сервлет Джерси с пружинным включением, который использует классы конфигурации, указанные в параметре contextClass . (Также можно использовать файлы конфигурации, но не комбинацию классов и файлов конфигурации.)

Сервлет также содержит определение spring.profiles.active . Намерение состоит в том, чтобы условно включить определения внутри RestApplicationContextTest с помощью аннотации @Profile весны 3.1, но я не смог заставить ее работать. Я оставил это для дальнейшего использования.

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 
    <display-name>Project Student Webservice</display-name>
 
    <context-param>
        <param-name>contextClass</param-name>
        <param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
    </context-param>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
            com.invariantproperties.sandbox.student.webservice.server.config.RestApplicationContext
            com.invariantproperties.sandbox.student.webservice.server.config.RestApplicationContextTest
        </param-value>
    </context-param>
 
    <listener>
        <listener-class>
            org.springframework.web.context.ContextLoaderListener
        </listener-class>
    </listener>
 
    <servlet>
        <servlet-name>REST dispatcher</servlet-name>
        <servlet-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</servlet-class>
        <init-param>
            <param-name>spring.profiles.active</param-name>
            <param-value>test</param-value>
        </init-param>
    </servlet>
 
    <servlet-mapping>
        <servlet-name>REST dispatcher</servlet-name>
        <url-pattern>/rest/*</url-pattern>
    </servlet-mapping>
</web-app>

Модульное тестирование

Модульные тесты просты.

001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
public class CourseResourceTest {
    private Course physics = new Course();
    private Course mechanics = new Course();
 
    @Before
    public void init() {
        physics.setId(1);
        physics.setName("physics");
        physics.setUuid(UUID.randomUUID().toString());
 
        mechanics.setId(1);
        mechanics.setName("mechanics");
        mechanics.setUuid(UUID.randomUUID().toString());
    }
 
    @Test
    public void testFindAllCourses() {
        final List<Course> expected = Arrays.asList(physics);
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.findAllCourses()).thenReturn(expected);
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.findAllCourses();
 
        assertEquals(200, response.getStatus());
        final Course[] actual = (Course[]) response.getEntity();
        assertEquals(expected.size(), actual.length);
        assertNull(actual[0].getId());
        assertEquals(expected.get(0).getName(), actual[0].getName());
        assertEquals(expected.get(0).getUuid(), actual[0].getUuid());
    }
 
    @Test
    public void testFindAllCoursesEmpty() {
        final List<Course> expected = new ArrayList<>();
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.findAllCourses()).thenReturn(expected);
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.findAllCourses();
 
        assertEquals(200, response.getStatus());
        final Course[] actual = (Course[]) response.getEntity();
        assertEquals(0, actual.length);
    }
 
    @Test
    public void testFindAllCoursesFailure() {
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.findAllCourses()).thenThrow(
                new UnitTestException();
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.findAllCourses();
 
        assertEquals(500, response.getStatus());
    }
 
    @Test
    public void testGetCourse() {
        final Course expected = physics;
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.findCourseByUuid(expected.getUuid())).thenReturn(expected);
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.getCourse(expected.getUuid());
 
        assertEquals(200, response.getStatus());
        final Course actual = (Course) response.getEntity();
        assertNull(actual.getId());
        assertEquals(expected.getName(), actual.getName());
        assertEquals(expected.getUuid(), actual.getUuid());
    }
 
    @Test
    public void testGetCourseMissing() {
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.findCourseByUuid(physics.getUuid())).thenThrow(
                new ObjectNotFoundException(physics.getUuid()));
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.getCourse(physics.getUuid());
 
        assertEquals(404, response.getStatus());
    }
 
    @Test
    public void testGetCourseFailure() {
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.findCourseByUuid(physics.getUuid())).thenThrow(
                new UnitTestException();
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.getCourse(physics.getUuid());
 
        assertEquals(500, response.getStatus());
    }
 
    @Test
    public void testCreateCourse() {
        final Course expected = physics;
        final Name name = new Name();
        name.setName(expected.getName());
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.createCourse(name.getName())).thenReturn(expected);
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.createCourse(name);
 
        assertEquals(201, response.getStatus());
        final Course actual = (Course) response.getEntity();
        assertNull(actual.getId());
        assertEquals(expected.getName(), actual.getName());
    }
 
    @Test
    public void testCreateCourseBlankName() {
        final Course expected = physics;
        final Name name = new Name();
 
        final CourseService service = Mockito.mock(CourseService.class);
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.createCourse(name);
 
        assertEquals(400, response.getStatus());
    }
 
    /**
     * Test handling when the course can't be created for some reason. For now
     * the service layer just returns a null value - it should throw an
     * appropriate exception.
     */
    @Test
    public void testCreateCourseProblem() {
        final Course expected = physics;
        final Name name = new Name();
        name.setName(expected.getName());
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.createCourse(name.getName())).thenReturn(null);
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.createCourse(name);
 
        assertEquals(500, response.getStatus());
    }
 
    @Test
    public void testCreateCourseFailure() {
        final Course expected = physics;
        final Name name = new Name();
        name.setName(expected.getName());
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.createCourse(name.getName())).thenThrow(
                new UnitTestException();
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.createCourse(name);
 
        assertEquals(500, response.getStatus());
    }
 
    @Test
    public void testUpdateCourse() {
        final Course expected = physics;
        final Name name = new Name();
        name.setName(mechanics.getName());
        final Course updated = new Course();
        updated.setId(expected.getId());
        updated.setName(mechanics.getName());
        updated.setUuid(expected.getUuid());
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.findCourseByUuid(expected.getUuid())).thenReturn(expected);
        when(service.updateCourse(expected, name.getName()))
                .thenReturn(updated);
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.updateCourse(expected.getUuid(),
                name);
 
        assertEquals(200, response.getStatus());
        final Course actual = (Course) response.getEntity();
        assertNull(actual.getId());
        assertEquals(mechanics.getName(), actual.getName());
        assertEquals(expected.getUuid(), actual.getUuid());
    }
 
    /**
     * Test handling when the course can't be updated for some reason. For now
     * the service layer just returns a null value - it should throw an
     * appropriate exception.
     */
    @Test
    public void testUpdateCourseProblem() {
        final Course expected = physics;
        final Name name = new Name();
        name.setName(expected.getName());
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.updateCourse(expected, name.getName())).thenReturn(null);
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.createCourse(name);
 
        assertEquals(500, response.getStatus());
    }
 
    @Test
    public void testUpdateCourseFailure() {
        final Course expected = physics;
        final Name name = new Name();
        name.setName(expected.getName());
 
        final CourseService service = Mockito.mock(CourseService.class);
        when(service.updateCourse(expected, name.getName())).thenThrow(
                new UnitTestException();
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.createCourse(name);
 
        assertEquals(500, response.getStatus());
    }
 
    @Test
    public void testDeleteCourse() {
        final Course expected = physics;
 
        final CourseService service = Mockito.mock(CourseService.class);
        doNothing().when(service).deleteCourse(expected.getUuid());
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.deleteCourse(expected.getUuid());
 
        assertEquals(204, response.getStatus());
    }
 
    @Test
    public void testDeleteCourseMissing() {
        final Course expected = physics;
        final Name name = new Name();
        name.setName(expected.getName());
 
        final CourseService service = Mockito.mock(CourseService.class);
        doThrow(new ObjectNotFoundException(expected.getUuid())).when(service)
                .deleteCourse(expected.getUuid());
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.deleteCourse(expected.getUuid());
 
        assertEquals(204, response.getStatus());
    }
 
    @Test
    public void testDeleteCourseFailure() {
        final Course expected = physics;
 
        final CourseService service = Mockito.mock(CourseService.class);
        doThrow(new UnitTestException()).when(service)
                .deleteCourse(expected.getUuid());
 
        final CourseResource resource = new CourseResource(service);
        final Response response = resource.deleteCourse(expected.getUuid());
 
        assertEquals(500, response.getStatus());
    }
}

Интеграционное тестирование

Вопрос: должны ли тесты интеграции сервера REST использовать живую базу данных?

Ответ: это вопрос с подвохом. Нам нужны оба.

Общая архитектура состоит из трех модулей maven. Мы рассмотрели Student-WS-Client ранее и сегодня мы расскажем о Student-WS-сервере. Каждый создает файл .jar. Есть третий модуль — student-ws-webapp — который создает реальный файл .war. Интеграционные тесты для модуля student-ws-server должны использовать вспомогательный уровень обслуживания, в то время как интеграционные тесты для модуля student-ws-webapp используют полный стек.

Мы начнем с интеграционных тестов, которые отражают тесты модулей в клиентском модуле

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
public class CourseRestServerIntegrationTest {
 
    CourseRestClient client = new CourseRestClientImpl(
            "http://localhost:8080/rest/course/");
 
    @Test
    public void testGetAll() throws IOException {
        Course[] courses = client.getAllCourses();
        assertNotNull(courses);
    }
 
    @Test(expected = ObjectNotFoundException.class)
    public void testUnknownCourse() throws IOException {
        client.getCourse("missing");
    }
 
    @Test
    public void testLifecycle() throws IOException {
        final String physicsName = "Physics 201";
        final Course expected = client.createCourse(physicsName);
        assertEquals(physicsName, expected.getName());
 
        final Course actual1 = client.getCourse(expected.getUuid());
        assertEquals(physicsName, actual1.getName());
 
        final Course[] courses = client.getAllCourses();
        assertTrue(courses.length > 0);
 
        final String mechanicsName = "Newtonian Mechanics 201";
        final Course actual2 = client.updateCourse(actual1.getUuid(),
                mechanicsName);
        assertEquals(mechanicsName, actual2.getName());
 
        client.deleteCourse(actual1.getUuid());
        try {
            client.getCourse(expected.getUuid());
            fail("should have thrown exception");
        } catch (ObjectNotFoundException e) {
            // do nothing
        }
    }
}

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

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
public class DummyCourseService implements CourseService {
    private Map cache = Collections.synchronizedMap(new HashMap<String, Course>());
 
    public List<Course> findAllCourses() {
        return new ArrayList(cache.values());
    }
 
    public Course findCourseById(Integer id) {
        throw new ObjectNotFoundException(null);       
    }
 
    public Course findCourseByUuid(String uuid) {
        if (!cache.containsKey(uuid)) {
            throw new ObjectNotFoundException(uuid);       
        }
        return cache.get(uuid);
    }
 
    public Course createCourse(String name) {
        Course course = new Course();
        course.setUuid(UUID.randomUUID().toString());
        course.setName(name);
        cache.put(course.getUuid(), course);
        return course;
    }
 
    public Course updateCourse(Course oldCourse, String name) {
        if (!cache.containsKey(oldCourse.getUuid())) {
            throw new ObjectNotFoundException(oldCourse.getUuid());                
        }
 
        Course course = cache.get(oldCourse.getUuid());
        course.setUuid(UUID.randomUUID().toString());
        course.setName(name);
        return course;     
    }
 
    public void deleteCourse(String uuid) {
        if (cache.containsKey(uuid)) {
            cache.remove(uuid);
        }
    }
}

pom.xml

Файл pom.xml должен включать плагин для запуска встроенного сервера Jetty или Tomcat. Опытные пользователи могут раскручивать и разрушать встроенный сервер в рамках интеграционного теста — см. Обновление.

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<build>
    <plugins>
 
        <!-- Run the application using "mvn jetty:run" -->
        <plugin>
            <groupId>org.mortbay.jetty</groupId>
            <artifactId>maven-jetty-plugin</artifactId>
            <version>6.1.16</version> <!-- ancient! -->
            <configuration>
                <!-- Log to the console. -->
                <requestLog implementation="org.mortbay.jetty.NCSARequestLog">
                    <!-- This doesn't do anything for Jetty, but is a workaround for a
                        Maven bug that prevents the requestLog from being set. -->
                    <append>true</append>
                </requestLog>
                <webAppConfig>
                    <contextPath>/</contextPath>
                    <extraClasspath>${basedir}/target/test-classes/</extraClasspath>
                </webAppConfig>
            </configuration>
        </plugin>
    </plugins>
</build>

Обновить

После нескольких дополнительных исследований у меня есть конфигурация для установки и демонтажа сервера Jetty во время интеграционных тестов. Эта конфигурация использует нестандартные порты, поэтому мы можем запустить ее без необходимости выключения другого экземпляра Jetty или Tomcat, работающего в одно и то же время.

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <build>
        <plugins>
 
            <!-- Run the application using "mvn jetty:run" -->
            <plugin>
                <groupId>org.eclipse.jetty</groupId>
                <artifactId>jetty-maven-plugin</artifactId>
                <version>9.1.0.v20131115</version>
                <configuration>
                    <webApp>
                        <extraClasspath>${basedir}/target/test-classes/</extraClasspath>
                    </webApp>
                    <scanIntervalSeconds>10</scanIntervalSeconds>
                    <stopPort>18005</stopPort>
                    <stopKey>STOP</stopKey>
                    <systemProperties>
                       <systemProperty>
                           <name>jetty.port</name>
                           <value>18080</value>
                       </systemProperty>
                    </systemProperties>
                </configuration>
                <executions>
                    <execution>
                        <id>start-jetty</id>
                        <phase>pre-integration-test</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                        <configuration>
                            <scanIntervalSeconds>0</scanIntervalSeconds>
                            <daemon>true</daemon>
                        </configuration>
                    </execution>
                    <execution>
                        <id>stop-jetty</id>
                        <phase>post-integration-test</phase>
                        <goals>
                            <goal>stop</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

Исходный код

31
Share: