@Sql - Spring Testing Annotation

In this tutorial, we will learn about the @Sql annotation, and at the end, we will see how the Spring Boot application can utilize the @Sql annotation for testing. Therefore, read the post till the end.

About @Sql

The @Sql is a part of the org.springframework.test.context.jdbc package. It can be applied at the test class level or the test method level. 

Within the Spring testing context, SQL scripts and statements are executed against a database using the Spring @Sql annotation.

@Sql declarations at the method level take precedence over those at the class level. But we can change this behavior by configuring @SqlMergeMode. 

The annotation supports the following attributes:

  • scripts
  • statements
  • executionPhase
  • config
  • value

1. scripts

It specifies the path on which SQL scripts should run.

The following example shows how to use it:

@Sql(scripts = {"/create-schema.sql"})
public class StudentRepositoryTests {


We can specify the path of multiple SQL scripts, like below.

@Sql(scripts = {"/create-schema.sql","/test-student-data-1.sql"})
public class StudentRepositoryTests {


2. executionPhase

It determines when the SQL scripts and statements are run. Four types of executionPhase are listed below:

  • BEFORE_TEST_METHOD (Default)
  • AFTER_TEST_METHOD
  • BEFORE_TEST_CLASS
  • AFTER_TEST_CLASS

Default is BEFORE_TEST_METHOD.


The following example shows how to use the type AFTER_TEST_METHOD:

@Test
@Sql(scripts={"/clean-up-process.sql"},
        executionPhase = AFTER_TEST_METHOD)
void findByName_ReturnsTheStudent_1() {

Here, the script inside clean-up-process.sql will be executed after the corresponding test method.


The following example shows how to use the type BEFORE_TEST_CLASS:

@Sql(
        scripts = {"/create-schema.sql"},
        executionPhase = BEFORE_TEST_CLASS
)
public class StudentRepositoryTests {

Here, the script inside create-schema.sql will be executed once per test class before any test method is run.


The following example shows how to use the type AFTER_TEST_CLASS:

@Sql(
        scripts = {"/clean-up-process.sql"},
        executionPhase = AFTER_TEST_CLASS
)
public class StudentRepositoryTests {

Here, the script inside clean-up-process.sql will be executed once per test class after all test methods have run.


3. statements

It sets up the execution of inline SQL statements.

The following example shows how to use it:

@Test
@Sql(statements = "INSERT INTO student (id,name, email, age) " +
        "VALUES (112,'Tera', 'tera@knf.com', 100)")
void findByName_ReturnsTheStudent_2() {


4. config

We can configure the way we parse and run the SQL scripts by using the @SqlConfig annotation.  We can use it to configure a particular @Sql annotation.

The following example shows how to use it:

@Test
@Sql(scripts={"/test-student-data-1.sql"},
        config = @SqlConfig(encoding = "utf-8", 
                transactionMode = SqlConfig.TransactionMode.ISOLATED))
void findByName_ReturnsTheStudent_1() {


5. value

It is the alias of scripts element. Although they can be used with the statements element, the scripts and value cannot be used simultaneously.


Complete Example with @Sql

Next we will create a spring boot JPA application, create repository layer which contains three query methods and finally we will do 'slice' testing with help of @DataJpaTest and @Sql annotation to verify our system is working as expected.

@DataJpaTest Examples are available in our Blog: 


Creating a spring boot application

First, open the Spring initializr https://start.spring.io

Then, Provide the Group and Artifact name. We have provided Group name com.knf.dev.demo and Artifact sql-annotation-example. Here I selected the Maven project - language Java 17 - Spring Boot 3.2.5, Spring Data JPA, and PostgreSQL Driver.


Final Project Directory


Complete pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<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
   https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>3.2.5</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.knf.dev.demo</groupId>
   <artifactId>sql-annotation-example</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>sql-annotation-example</name>
   <description>Demo project for Spring Boot</description>
   <properties>
      <java.version>17</java.version>
   </properties>
   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-data-jpa</artifactId>
      </dependency>

      <dependency>
         <groupId>org.postgresql</groupId>
         <artifactId>postgresql</artifactId>
         <scope>runtime</scope>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>
   </dependencies>

   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>

</project>

spring-boot-starter-test starter will provide following libraries:

  • JUnit 
  • Spring Test & Spring Boot Test 
  • AssertJ
  • Hamcrest 
  • Mockito 
  • JSONassert 
  • JsonPath 

application.yaml

We are writing test against real(Postgresql) database. 
So, Let’s configure Spring Boot to use PostgreSQL as our data source. We are simply adding PostgreSQL database URL, username, and password in the src/main/resources/application.yaml

#PostgreSQL configuration

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/postgres
    username: postgres
    password: root
  jpa:
    hibernate:
    show-sql: true
    open-in-view: false


Let's create the scripts for testing our application.

Create create-schema.sql

drop table if exists student;
CREATE TABLE student (
  id SERIAL PRIMARY KEY,
  name VARCHAR(250) NOT NULL,
  email VARCHAR(250) NOT NULL,
  age INT
);


Create test-student-data-1.sql

INSERT INTO student (id,name, email, age) VALUES
  (101,'Alpha', 'alpha@knf.com', 50),
  (102,'Beta', 'beta@knf.com', 40),
  (103,'Gama', 'gama@knf.com', 30),
  (104,'Pekka', 'pekka@knf.com', 20);


Create test-student-data-2.sql

INSERT INTO student (id,name, email, age) VALUES
  (120,'Carl', 'carl@knf.com', 19),
  (121,'Rick', 'rick@knf.com', 42),
  (122,'Maggy', 'maggy@knf.com', 29),
  (123,'Morgan', 'morgan@knf.com', 42);


Create Student Entity

A Student object as JPA entity. I am not a big fan of Project Lombok; therefore, getters and setters are explicitly added.

package com.knf.dev.demo.entity;

import jakarta.persistence.*;

@Entity
@Table(name = "student")
public class Student {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    private String email;

    private Integer age;

    public Student() {
    }

    public Student(String name, String email, Integer age) {
        this.name = name;
        this.email = email;
        this.age = age;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

The @Entity annotation specifies that the class is an entity and is mapped to a database table. 

The @Table annotation specifies the name of the database table to be used for mapping. 

The @Id annotation specifies the primary key of an entity and the @GeneratedValue provides for the specification of generation strategies for the values of primary keys.


Create Student Repository

It doesn't make sense to test inherited default methods like save(), findById(), deleteById(), or findAll() from JpaRepository. If we are doing like so, means we are testing the framework.

So, i created three methods findStudentByAgeGreaterThan(), findByName(), and findByAgeLessThan(). 
package com.knf.dev.demo.repository;

import com.knf.dev.demo.entity.Student;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;

import java.util.List;
import java.util.Optional;

public interface StudentRepository extends JpaRepository<Student,Long> {


    //Using JPQL query
    @Query("FROM Student WHERE age > ?1")
    List<Student> findStudentByAgeGreaterThan(Integer age);

    //Using native sql query
    @Query(value = "select * from student as u where u.name = :name",
            nativeQuery = true)
    Optional<Student> findByName(@Param("name") String name);

    //Derived Query Method
    List<Student> findByAgeLessThan(Integer age);
    
}
  • JpaRepository is a JPA-specific extension of Repository. It contains an API for basic CRUD operations and also API for pagination and sorting.
  • findStudentByAgeGreaterThan(): If we want to retrieve students whose age is greater than the given age.
  • findByName(): This method will get student entity by name.(Optional)
  • findByAgeLessThan(): If we want to retrieve students whose age is less than the given age.


Driver class

package com.knf.dev.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SqlAnnotationExampleApplication {

   public static void main(String[] args) {
      SpringApplication.run(SqlAnnotationExampleApplication.class, args);
   }

}


Implementing the Tests

When using JUnit 4, @SpringBootTest annotation should be used in combination with @RunWith(SpringRunner.class). But for this example  we are using JUnit 5, there’s no need to add the equivalent @ExtendWith(SpringExtension.class).

package com.knf.dev.demo;

import com.knf.dev.demo.entity.Student;
import com.knf.dev.demo.repository.StudentRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure
        .jdbc.AutoConfigureTestDatabase;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.test.context.jdbc.Sql;

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
import static org.springframework.test.context.jdbc.Sql
        .ExecutionPhase.BEFORE_TEST_CLASS;


@Sql(
        scripts = {"/create-schema.sql"},
        executionPhase = BEFORE_TEST_CLASS
)
@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
public class StudentRepositoryTests {

    @Autowired
    private StudentRepository studentRepository;

    @Test
    @Sql({"/test-student-data-1.sql"})
    void findByName_ReturnsTheStudent_1() {

        Student student = studentRepository.findByName("Alpha").get();
        assertThat(student).isNotNull();
        assertThat(student.getEmail()).isEqualTo("alpha@knf.com");
        assertThat(student.getName()).isEqualTo("Alpha");
        assertThat(student.getId()).isEqualTo(101);
        assertThat(student.getAge()).isEqualTo(50);
    }

    @Test
    @Sql(statements = "INSERT INTO student (id,name, email, age) " +
            "VALUES (112,'Tera', 'tera@knf.com', 100)")
    void findByName_ReturnsTheStudent_2() {

        Student student = studentRepository.findByName("Tera").get();
        assertThat(student).isNotNull();
        assertThat(student.getEmail()).isEqualTo("tera@knf.com");
        assertThat(student.getName()).isEqualTo("Tera");
        assertThat(student.getId()).isEqualTo(112);
        assertThat(student.getAge()).isEqualTo(100);
    }

    @Test
    @Sql({"/test-student-data-1.sql"})
    void findByAgeGreaterThan_ReturnsTheListStudents_1() {

        List<Student> students = studentRepository
                .findStudentByAgeGreaterThan(29);

        //Convert list of students to list of id(Integer)
        List<Integer> ids = students.stream()
                .map(o -> o.getId().intValue())
                .collect(Collectors.toList());

        assertThat(students.size()).isEqualTo(3);
        assertThat(ids).hasSameElementsAs(Arrays.asList(103, 102, 101));
    }

    @Test
    @Sql({"/test-student-data-1.sql", "/test-student-data-2.sql"})
    void findByAgeGreaterThan_ReturnsTheListStudents_2() {

        List<Student> students = studentRepository
                .findStudentByAgeGreaterThan(29);

        //Convert list of students to list of id(Integer)
        List<Integer> ids = students.stream()
                .map(o -> o.getId().intValue())
                .collect(Collectors.toList());

        assertThat(students.size()).isEqualTo(5);
        assertThat(ids).hasSameElementsAs(
                Arrays.asList(103, 102, 101, 121, 123));
    }

    @Test
    @Sql({"/test-student-data-1.sql"})
    void findByAgeLessThan_ReturnsTheListStudents() {

        List<Student> students = studentRepository
                .findByAgeLessThan(31);

        //Convert list of students to list of id(Integer)
        List<Integer> ids = students.stream()
                .map(o -> o.getId().intValue())
                .collect(Collectors.toList());

        assertThat(students.size()).isEqualTo(2);
        assertThat(ids).hasSameElementsAs(Arrays.asList(104, 103));
    }
}
  • We run tests against a real database; for that, configure AutoConfigureTestDatabase.Replace.NONE.
  • The @Sql annotation executes SQL scripts and SQL statements using datasource for testing.
  • assertThat is used to check the specified value matches the expected value. It will accept the two parameters, the first contains the actual value, and the second will have the object matching the condition.


Run the test

Or you can run the test using following command:

mvn  test -Dtest=StudentRepositoryTests

Popular posts from this blog

Learn Java 8 streams with an example - print odd/even numbers from Array and List

Example 1: Java 8 program to print odd numbers from a List   import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; /*Java 8 Program to find Odd Numbers from a List*/ public class DriverClass { public static void main( String [] args) { List < Integer > numbers = Arrays. asList( 1 , 4 , 8 , 40 , 11 , 22 , 33 , 99 ); List < Integer > oddNumbers = numbers.stream(). filter(o -> o % 2 != 0 ). collect(Collectors.toList()); System.out.println(oddNumbers); } } 1. Initialize List using Arrays.asList() method. Java's built-in Arrays.asList() method converts an array into a list. This method takes an array as an argument and returns a List object. 2.  Java List interface provides stream() method which returns a sequential Stream with list of Integer as its source. 3. The Java stream filter(...
Read more

Java Stream API - How to convert List of objects to another List of objects using Java streams?

Image
In this section, we will show you how to convert a List of objects to another List of objects in Java using the Java streams map(). The ‘map’ method maps each element to its corresponding result. Java Stream API   The Java Stream API provides a functional programming approach over the object oriented capabilities of Java. It is used for processing collections of objects. The Stream in Java can be defined as a sequence of elements from a source List, Set or Array. Most of the stream operations return a Stream. This avails engender a chain of stream operations(stream pipe-lining). The streams withal support the aggregate or terminal operations on the elements. for example, finding the sum or maximum element or finding the average etc...Stream operations can either be executed sequentially or parallel. when performed parallelly, it is called a parallel stream.   Stream map() Method   The Java 8 Stream map() is an intermediate operation. It converts Stream<obj1> to Str...
Read more

Registration and Login with Spring Boot + Spring Security + Thymeleaf

Image
In this section, we will learn how to create user registration and login using Spring boot, Spring security, Thymeleaf, JPA, and H2DB. The GitHub repository link is provided at the end of this tutorial. You can download the source code. Technologies used: Spring Boot 2.5.5  Spring Data JPA  Spring Security  Thymeleaf  Maven 3+  Java 17  H2 Database   User Interface User Registration Authentication Failed Authentication success Sign out Final Project Structure: Complete pom.xml: <? xml version ="1.0" encoding ="UTF-8" ?> < 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 https://maven.apache.org/xsd/maven-4.0.0.xsd" > < modelVersion >4.0.0</ modelVersion > < parent > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-pare...
Read more

Java, Spring Boot Mini Project - Library Management System - Download

Image
Hello everyone, Hope you are doing well. Here, we provide a Library Management System mini-project for beginners, it's free for download. Maybe you can build more on top of this project and create your own product, that's all about you. The source code download link is provided at the end of this post. 1. Benefit of this project You could cover the following technologies and features by learning and debugging this mini project. Java 17 Java Stream Java Lamda Expressions Java Records Functional programming Object-oriented programming var Keyword in Java Generics in Java Java Switch Spring boot 2.6.4 Spring Security Thymeleaf template engine OpenCSV Spring Data JPA Server Side Pagination H2 Database  Bootstrap HTML CSS and more... 2. Objective Of Spring Boot On Library Management System The main objective of this project is to manage the details of the books, author, category, and publisher. Only Admin/Librarian will manage all these activities. Also, they can export the data in ...
Read more

ReactJS, Spring Boot JWT Authentication Example

Image
In this tutorial, we’ll create a user registration & login example using ReactJS, Spring Boot, Spring Security, and JWT authentication. You could download the source code from our Github repository, the download link is provided at the end of this tutorial. Technologies used Backend Technologies: Java 17 Spring Boot 2.7.0 Spring Security Spring Data JPA JWT H2 Database Frontend Technologies: React 17.0.1 Axios 0.27.2 Redux 4.0.5 Bootstrap 4.5.2 ReactJS - SpringBoot - JWT - Flow Backend Project Directory: Frontend Project Directory: Following is the screenshot of our application - User Registration: User Signin: Profile View: Access Resource: We will build two projects:  1. Backend:   spring-boot-security-jwt 2. Frontend: react-redux-jwt Project 1: spring-boot-security-jwt Pom.xml <?xml version = "1.0" encoding = "UTF-8" ?> <project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"...
Read more

Top 5 Java ORM tools - 2024

Image
  The term ORM refers to object-relational mapping, which uses objects to adapt programming languages to database systems while allowing them to function with SQL and object-oriented programming ideas. Any kind of database management system that can accomplish object mapping to the table in the virtual system is suitable for the implementation of ORM. Java has a wide variety of ORM tools, some of which are mentioned below: 1. Hibernate Hibernate is a lightweight, open-source, non-invasive Java ORM (Object-Relational Mapping) framework that allows developers to create objects that function independently of database software and create persistence logic in any Java or JavaEE application. It offers an abstraction layer, so developers don't have to bother about implementations; Hibernate handles these tasks internally, such as connecting to databases and creating queries to carry out CRUD operations, among other things. Persistence logic development is done with it. Persistence logic r...
Read more

Java - Blowfish Encryption and decryption Example

Image
Blowfish is an encryption method developed by Bruce Schneier in 1993 as an alternative to the DES encryption method. It is significantly faster than DES and provides good encryption speed, although no effective cryptanalysis technique has been found to date. It is one of the first secure block ciphers that is not protected by any patents and is therefore freely available for anyone to use. This is a symmetric block cipher algorithm. Block size: 64 bits Key size: variable size from 32 to 448 bits number of subsections: 18 [P-array] number of rounds: 16 number of substitution blocks: 4 [each with 512 records of 32 bits each] develop  Example 1: Encryption and decryption using Blowfish import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.util.Base64; import javax.crypto.BadPaddingException; import javax.crypto.Cipher; import javax.crypto.IllegalBlockSiz...
Read more

Spring boot video streaming example-HTML5

Image
Hello everyone, Today we will learn how to stream MP4 video using Spring Boot and Spring Web Flux.  The Source code download link is provided at the end of this post. New, Quarkus Practice User Interface   Project Structure: G radle(build.gradle) plugins { id 'org.springframework.boot' version '2.5.4' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.knf.demo' version = '0.0.1-SNAPSHOT' sourceCompatibility = '11' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-webflux' testImplementation 'org.springframework.boot:spring-boot-starter-test' testImplementation 'io.projectreactor:reactor-test' } test { useJUnitPlatform() } Service (VideoStreamingService.java) package  com.knf.demo.service ; import org.springframework.beans.factory.annotation. Autowired ; import org.springframework...
Read more

Google Cloud Storage + Spring Boot - File Upload, Download, and Delete

Image
In this section, we will learn  how to  create a simple spring boot application to perform different file operations such as upload, download, list, and delete files from the Google Cloud Storage. 1.  A little bit of Background Google Cloud Storage Cloud Storage is a managed service for storing unstructured data. Store any amount of data and retrieve it as often as you like. More Info - click here! Spring Boot Spring Boot makes it easy to create stand-alone, production-grade Spring-based Applications that you can "just run".  More Info - click here! 2. Create a GCP Project First, Sign into the Google console at  https://console.cloud.google.com . You can create a new project by first selecting the project dropdown in the top left and selecting " New Project ". Next, specify your GCP  Project name  and  Project ID . Then  Click on the " CREATE " button. Copy " Project ID " and keep it for future purposes. 3. Create a Google Cloud Storage bucke...
Read more