Skip to main content

File upload using Spring boot rest service with unit testing

We will create a REST service using spring boot which will have an endpoint to upload the file. Then we create JUnit test for upload service using mocking.

Maven dependency

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

REST Service for file upload

Below service reads the content of uploaded file and print on the console. Client application will upload the file using given endpoint "loadFile".
    @PostMapping(path="/loadFile")
    public void loadWordsFromFile(MultipartFile file) throws IOException {
        try(BufferedReader reader = new BufferedReader(new InputStreamReader(file.getInputStream()))){
        Set<String> dictList = new HashSet<>();
        reader.lines()
            .filter(ln->ln!=null && !ln.trim().equals(""))
            .map(ln->ln.split("[\\s*]"))
            .forEach(arr->{
                Arrays.stream(arr)
                .map(str->str.replaceAll("[.!]", ""))
                .filter(str->str.length()>0)
                .forEach(str->{
                    System.out.println(str);
                });
            });
        }
    }

JUnit Test

Below is the complete code for unit testing where we are creating a mock file with given text and then uploading it to our mocked service.
@RunWith(SpringRunner.class)
@SpringBootTest
public class WordDictionaryApplicationTests {
    private MockMvc mockMvc;
    @Autowired
    WebApplicationContext wContext;

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

    @Test
    public void firstUploadWordsTest() throws Exception {
        String text ="Text to be uploaded.";
        MockMultipartFile file = new MockMultipartFile("file","test.txt", "text/plain", text.getBytes());
        mockMvc.perform(MockMvcRequestBuilders.multipart("/loadFile/")
               .file(file)
               .characterEncoding("UTF-8"))
               .andExpect(MockMvcResultMatchers.status().isOk());
    }
}

Test output:

After executing the test you will see similar output where it has printed the submitted text from uploaded file.
2019-11-17 16:02:36.122  INFO 10269 --- [           main] com.wd.WordDictionaryApplicationTests    : Started WordDictionaryApplicationTests in 7.13 seconds (JVM running for 8.675)
2019-11-17 16:02:36.281  INFO 10269 --- [           main] o.s.b.t.m.w.SpringBootMockServletContext : Initializing Spring TestDispatcherServlet ''
2019-11-17 16:02:36.281  INFO 10269 --- [           main] o.s.t.web.servlet.TestDispatcherServlet  : Initializing Servlet ''
2019-11-17 16:02:36.323  INFO 10269 --- [           main] o.s.t.web.servlet.TestDispatcherServlet  : Completed initialization in 41 ms
Text
to
be
uploaded

Comments

Post a Comment

Popular Posts

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check. havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false. matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment. name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "property.name" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"} prefix - It can be use when you want to apply some prefix to

Why HashMap key should be immutable in java

HashMap is used to store the data in key, value pair where key is unique and value can be store or retrieve using the key. Any class can be a candidate for the map key if it follows below rules. 1. Overrides hashcode() and equals() method.   Map stores the data using hashcode() and equals() method from key. To store a value against a given key, map first calls key's hashcode() and then uses it to calculate the index position in backed array by applying some hashing function. For each index position it has a bucket which is a LinkedList and changed to Node from java 8. Then it will iterate through all the element and will check the equality with key by calling it's equals() method if a match is found, it will update the value with the new value otherwise it will add the new entry with given key and value. In the same way it check for the existing key when get() is called. If it finds a match for given key in the bucket with given hashcode(), it will return the value other

jaxb2-maven-plugin to generate java code from XSD schema

In this tutorial I will show how to generate the Java source code from XSD schema. I will use jaxb2-maven-plugin to generate the code using XSD file which will be declared in pom.xml to make it part of build, so when maven build is executed it will generate the java code using XSD. Class generation can be controlled in plugin configuration. Maven changes (pom.xml) Include below plugin in your pom.xml. Here we have done some configuration under configuration section as given below. schemaDirectory : This is the directory where I keep my schema (XSD file). outputDirectory : This is the java source location where I want to generate the Java files. If it is not given then by default it will be generate inside target folder. clearOutputDir : If this property is true then it will generate the classes on each build otherwise it will generate only if output directory is empty. <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jaxb2-maven-plugin</art