การใช้ Spring MVC Test เพื่อทดสอบหน่วยการทดสอบหลายส่วนของคำขอ POST


115

ฉันมีตัวจัดการคำขอต่อไปนี้สำหรับการบันทึกรถยนต์ ฉันได้ตรวจสอบแล้วว่าใช้งานได้เมื่อฉันใช้เช่น cURL ตอนนี้ฉันต้องการทดสอบหน่วยด้วยวิธีการทดสอบ Spring MVC ฉันได้พยายามใช้ fileUploader แต่ฉันไม่ได้จัดการเพื่อให้มันใช้งานได้ ฉันไม่สามารถเพิ่มส่วน JSON ได้

ฉันจะทดสอบวิธีนี้ด้วย Spring MVC Test ได้อย่างไร ฉันไม่พบตัวอย่างใด ๆ ในเรื่องนี้

@RequestMapping(value = "autos", method = RequestMethod.POST)
public ResponseEntity saveAuto(
    @RequestPart(value = "data") autoResource,
    @RequestParam(value = "files[]", required = false) List<MultipartFile> files) {
    // ...
}

ฉันต้องการอัปเดตการแสดง JSON สำหรับไฟล์อัตโนมัติ + หนึ่งไฟล์ขึ้นไป

ฉันจะเพิ่มค่าหัว 100 ให้กับคำตอบที่ถูกต้อง!

คำตอบ:


256

เนื่องจากMockMvcRequestBuilders#fileUploadเลิกใช้งานแล้วคุณจะต้องใช้MockMvcRequestBuilders#multipart(String, Object...)ซึ่งส่งคืนไฟล์MockMultipartHttpServletRequestBuilder. แล้วโซ่พวงของfile(MockMultipartFile)การโทร

นี่คือตัวอย่างการทำงาน รับ@Controller

@Controller
public class NewController {

    @RequestMapping(value = "/upload", method = RequestMethod.POST)
    @ResponseBody
    public String saveAuto(
            @RequestPart(value = "json") JsonPojo pojo,
            @RequestParam(value = "some-random") String random,
            @RequestParam(value = "data", required = false) List<MultipartFile> files) {
        System.out.println(random);
        System.out.println(pojo.getJson());
        for (MultipartFile file : files) {
            System.out.println(file.getOriginalFilename());
        }
        return "success";
    }

    static class JsonPojo {
        private String json;

        public String getJson() {
            return json;
        }

        public void setJson(String json) {
            this.json = json;
        }

    }
}

และแบบทดสอบหน่วย

@WebAppConfiguration
@ContextConfiguration(classes = WebConfig.class)
@RunWith(SpringJUnit4ClassRunner.class)
public class Example {

    @Autowired
    private WebApplicationContext webApplicationContext;

    @Test
    public void test() throws Exception {

        MockMultipartFile firstFile = new MockMultipartFile("data", "filename.txt", "text/plain", "some xml".getBytes());
        MockMultipartFile secondFile = new MockMultipartFile("data", "other-file-name.data", "text/plain", "some other type".getBytes());
        MockMultipartFile jsonFile = new MockMultipartFile("json", "", "application/json", "{\"json\": \"someValue\"}".getBytes());

        MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
        mockMvc.perform(MockMvcRequestBuilders.multipart("/upload")
                        .file(firstFile)
                        .file(secondFile)
                        .file(jsonFile)
                        .param("some-random", "4"))
                    .andExpect(status().is(200))
                    .andExpect(content().string("success"));
    }
}

และ@Configurationชั้นเรียน

@Configuration
@ComponentScan({ "test.controllers" })
@EnableWebMvc
public class WebConfig extends WebMvcConfigurationSupport {
    @Bean
    public MultipartResolver multipartResolver() {
        CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver();
        return multipartResolver;
    }
}

การทดสอบควรผ่านและให้ผลลัพธ์ของ

4 // from param
someValue // from json file
filename.txt // from first file
other-file-name.data // from second file

สิ่งที่ควรทราบคือคุณกำลังส่ง JSON เช่นเดียวกับไฟล์มัลติพาร์ทอื่น ๆ ยกเว้นประเภทเนื้อหาที่แตกต่างกัน


1
สวัสดี Sotirios ฉันมีความสุขที่ได้เห็นตัวอย่างที่สวยงามนั้นแล้วฉันก็ดูว่าใครเป็นคนเสนอมันและบิงโก! มันคือ Sotirios! การทดสอบทำให้มันเจ๋งมาก ฉันมีสิ่งหนึ่งที่รบกวนฉันมันบ่นว่าคำขอไม่ใช่หลายส่วน (500)
Stephane

เป็นการยืนยันที่ล้มเหลว assertIsMultipartRequest (servletRequest); ฉันสงสัยว่าไม่ได้กำหนดค่า CommonsMultipartResolver แต่คนตัดไม้ในถั่วของฉันจะปรากฏในบันทึก
Stephane

@shredding ฉันใช้แนวทางนี้ในการส่งไฟล์มัลติพาร์ทและโมเดลอ็อบเจ็กต์เป็น json ไปยังคอนโทรลเลอร์ของฉัน แต่วัตถุแบบจำลองจะพ่นMethodArgumentConversionNotSupportedExceptionเมื่อกดปุ่มควบคุม .. ขั้นตอนที่แย่ที่สุดที่ฉันพลาดที่นี่? - stackoverflow.com/questions/50953227/…
Brian J

1
ตัวอย่างนี้ช่วยฉันได้มาก ขอบคุณ
kiranNswamy

หลายส่วนใช้วิธีการ POST ใครช่วยให้ตัวอย่างนี้ แต่ใช้วิธี PATCH ได้ไหม
lalilulelo_1986

16

ดูตัวอย่างนี้ที่นำมาจากตู้โชว์ MVC ในฤดูใบไม้ผลินี่คือลิงค์ไปยังซอร์สโค้ด :

@RunWith(SpringJUnit4ClassRunner.class)
public class FileUploadControllerTests extends AbstractContextControllerTests {

    @Test
    public void readString() throws Exception {

        MockMultipartFile file = new MockMultipartFile("file", "orig", null, "bar".getBytes());

        webAppContextSetup(this.wac).build()
            .perform(fileUpload("/fileupload").file(file))
            .andExpect(model().attribute("message", "File 'orig' uploaded successfully"));
    }

}

1
fileUploadmultipart(String, Object...)จะเลิกในความโปรดปรานของ
naXa

14

วิธีMockMvcRequestBuilders.fileUploadนี้เลิกใช้แล้วให้ใช้MockMvcRequestBuilders.multipartแทน

นี่คือตัวอย่าง:

import static org.hamcrest.CoreMatchers.containsString;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.ResultActions;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.multipart.MultipartFile;


/**
 * Unit test New Controller.
 *
 */
@RunWith(SpringRunner.class)
@WebMvcTest(NewController.class)
public class NewControllerTest {

    private MockMvc mockMvc;

    @Autowired
    WebApplicationContext wContext;

    @MockBean
    private NewController newController;

    @Before
    public void setup() {
        this.mockMvc = MockMvcBuilders.webAppContextSetup(wContext)
                   .alwaysDo(MockMvcResultHandlers.print())
                   .build();
    }

   @Test
    public void test() throws Exception {
       // Mock Request
        MockMultipartFile jsonFile = new MockMultipartFile("test.json", "", "application/json", "{\"key1\": \"value1\"}".getBytes());

        // Mock Response
        NewControllerResponseDto response = new NewControllerDto();
        Mockito.when(newController.postV1(Mockito.any(Integer.class), Mockito.any(MultipartFile.class))).thenReturn(response);

        mockMvc.perform(MockMvcRequestBuilders.multipart("/fileUpload")
                .file("file", jsonFile.getBytes())
                .characterEncoding("UTF-8"))
        .andExpect(status().isOk());

    }

}

2

นี่คือสิ่งที่ใช้ได้ผลสำหรับฉันที่นี่ฉันกำลังแนบไฟล์กับ EmailController ของฉันอยู่ระหว่างการทดสอบ ลองดูภาพหน้าจอของบุรุษไปรษณีย์ด้วยว่าฉันโพสต์ข้อมูลอย่างไร

    @WebAppConfiguration
    @RunWith(SpringRunner.class)
    @SpringBootTest(
            classes = EmailControllerBootApplication.class
        )
    public class SendEmailTest {

        @Autowired
        private WebApplicationContext webApplicationContext;

        @Test
        public void testSend() throws Exception{
            String jsonStr = "{\"to\": [\"email.address@domain.com\"],\"subject\": "
                    + "\"CDM - Spring Boot email service with attachment\","
                    + "\"body\": \"Email body will contain  test results, with screenshot\"}";

            Resource fileResource = new ClassPathResource(
                    "screen-shots/HomePage-attachment.png");

            assertNotNull(fileResource);

            MockMultipartFile firstFile = new MockMultipartFile( 
                       "attachments",fileResource.getFilename(),
                        MediaType.MULTIPART_FORM_DATA_VALUE,
                        fileResource.getInputStream());  
                        assertNotNull(firstFile);


            MockMvc mockMvc = MockMvcBuilders.
                  webAppContextSetup(webApplicationContext).build();

            mockMvc.perform(MockMvcRequestBuilders
                   .multipart("/api/v1/email/send")
                    .file(firstFile)
                    .param("data", jsonStr))
                    .andExpect(status().is(200));
            }
        }

คำขอบุรุษไปรษณีย์


ขอบคุณมากที่คำตอบของคุณได้ผลสำหรับฉันเช่นกัน @Alfred
Parameshwar

1

หากคุณใช้ Spring4 / SpringBoot 1.x คุณควรเพิ่มส่วน "text" (json) ด้วย สามารถทำได้ผ่าน MockMvcRequestBuilders.fileUpload () ไฟล์ (ไฟล์ MockMultipartFile) (ซึ่งจำเป็นเนื่องจากเมธอด.multipart()ไม่มีในเวอร์ชันนี้):

@Test
public void test() throws Exception {

   mockMvc.perform( 
       MockMvcRequestBuilders.fileUpload("/files")
         // file-part
         .file(makeMultipartFile( "file-part" "some/path/to/file.bin", "application/octet-stream"))
        // text part
         .file(makeMultipartTextPart("json-part", "{ \"foo\" : \"bar\" }", "application/json"))
       .andExpect(status().isOk())));

   }

   private MockMultipartFile(String requestPartName, String filename, 
       String contentType, String pathOnClassPath) {

       return new MockMultipartFile(requestPartName, filename, 
          contentType, readResourceFile(pathOnClasspath);
   }

   // make text-part using MockMultipartFile
   private MockMultipartFile makeMultipartTextPart(String requestPartName, 
       String value, String contentType) throws Exception {

       return new MockMultipartFile(requestPartName, "", contentType,
               value.getBytes(Charset.forName("UTF-8")));   
   }


   private byte[] readResourceFile(String pathOnClassPath) throws Exception {
      return Files.readAllBytes(Paths.get(Thread.currentThread().getContextClassLoader()
         .getResource(pathOnClassPath).toUri()));
   }

}
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.