Почему Mock выдает некорректные данные?

Question

[Денис Кузнецов]

Здравствуйте, у меня есть тест класс

@RunWith(MockitoJUnitRunner.class)
@SpringBootTest
public class UserRepositoryImplTest {

    private static final Logger log = LoggerFactory.getLogger(UserRepositoryImplTest.class);

    @Mock
    JdbcTemplate jdbcTemplate;

    @Before
    public void initMocks(){
        MockitoAnnotations.initMocks(this);
    }

    @Test
    public void findByNameTest() {
        User user = setupUser();
        String userName = user.getUserName();
        UserRepository userRepository = new UserRepositoryImpl();
        ReflectionTestUtils.setField(userRepository, "jdbcTemplate", jdbcTemplate);
        Mockito.when(jdbcTemplate.queryForObject(
                FIND_BY_NAME,
                new ForUnitTestUserRowMapper(),
                userName))
                .thenReturn(user);
        assertEquals(user, userRepository.findByName(userName));
    }

}

Я делал его по следующему примеру: Пример.
Но я получаю NPE при попытке сравнить то что возвращает мок и подготовленный результат.
Вот стектрейс ошибки и логи до нее

16:23:10.048 [main] DEBUG org.springframework.test.util.ReflectionTestUtils - Setting field 'jdbcTemplate' of type [null] on target object [com.trainig.spring.main.project.repository.user.UserRepositoryImpl@7d61eccf] or target class [class com.trainig.spring.main.project.repository.user.UserRepositoryImpl] to value [jdbcTemplate]
16:23:10.101 [main] INFO com.trainig.spring.main.project.repository.user.UserRepositoryImpl - find by name : name
16:23:10.121 [main] INFO com.trainig.spring.main.project.repository.user.UserRepositoryImpl - Empty user

java.lang.NullPointerException
at com.trainig.spring.main.project.entity.User.equals(User.java:136)
com.training.spring.main.project.repository.user.UserRepositoryImplTest.findByNameTest(UserRepositoryImplTest.java:50)
...
[MockitoHint] UserRepositoryImplTest.findByNameTest (see javadoc for MockitoHint):
[MockitoHint] 1. Unused... -> at com.training.spring.main.project.repository.user.UserRepositoryImplTest.findByNameTest(UserRepositoryImplTest.java:45)
[MockitoHint] ...args ok? -> at com.trainig.spring.main.project.repository.user.UserRepositoryImpl.findByName(UserRepositoryImpl.java:63)

вот метод для подготовки объекта для тестирования:

public static User setupUser() {
        User user = new User();
        user.setUserId(ID);
        user.setUserName(USER_NAME);
        user.setUserPassword(PASSWORD);
        user.setRoles(Collections.singleton(new Role(ID, USER_ROLE)));
        return user;
    }

вот метод который я тестирую :

@Override
    public User findByName(String userName) {
        logger.info("find by name : {}", userName);
        User user = jdbcTemplate.queryForObject(
                FIND_BY_NAME,
                (rs, rowNum) -> new User(
                        rs.getLong("user_id"),
                        rs.getString("user_name"),
                        rs.getString("user_password"),
                        Collections.singleton(new Role(
                                rs.getLong("role_id"),
                                rs.getString("role_name")
                        ))),
                userName);
        if (Objects.isNull(user)) {
            logger.info("Empty user");
            return new User();
        } else {
            return user;
        }
    }

Вот запрос который я использую

public static final String FIND_BY_NAME = "select ut.user_id, ut.user_name, ut.user_password," +
            " user_role.role_id, role_name from \n" +
            "user_role inner join user_to_role\n" +
            "on user_role.role_id = user_to_role.role_id \n" +
            "inner join user_table as ut\n" +
            "on ut.user_id = user_to_role.user_id\n" +
            "where ut.user_name = ?";

Тестовый метод работает если в репозитории в моменте проверки на ноль, вернуть не нового юзера, а засетапленного юзера. Из чего я делаю вывод, что результатом работы мока становится результат работы самого метода, а не то что я написал в

.thenReturn(user)

Тоесть если в классе UserRepositoryImpl
поменять с

if (Objects.isNull(user)) {
            logger.info("Empty user");
            return new User();
        } else {
            return user;
        }

на

if (Objects.isNull(user)) {
            logger.info("Empty user");
            return ModelUtil.setupUser();
        } else {
            return user;
        }

то тест отрабатывает корректно. Что я должен делать чтобы корректно работал

Mockito.when(jdbcTemplate.queryForObject(
                FIND_BY_NAME,
                new ForUnitTestUserRowMapper(),
                userName))
               <b> .thenReturn(user);</b>

?

Answer 1

[Dmitry Roo]

1. Cамое главное. Нет никакого смысла в интеграциионых тестах мокать базу данных. Для этого используйте лучше testcontainers (на худой конец h2, но это верный способ выстрелить себе в ногу).
2.

ReflectionTestUtils.setField(userRepository, "jdbcTemplate", jdbcTemplate);

wtf? Неужели нет другого способа?
3. Для мока следует использовать "матчеры" eq, any и т.д.
Попробуйте что-то типа такого:

Mockito.when(jdbcTemplate.queryForObject(
                eq(FIND_BY_NAME),
                any(ForUnitTestUserRowMapper.class),
                anyString())
               .thenReturn(user);

Comments

[Денис Кузнецов]

1. Цель была написать юнит тесты, а не интеграционные. Как я понял, идеологически, юнит тесты, это тест функционала определенного класса, не используя другое api, а интеграционные, это использование других слоев, т.е. в контроллере сервиса, в сервисе - репозиторий и тд. Поэтому я мокаю подгружаемые бины, как написать чистый и корректный юнит тест без мока, так и не додумался. Был вариант писать с помощью h2, но это уже вроде как интеграционный.
2. Есть еще вариант с @InjectMocks, но в схожем вопросе на stackoverflow советовали использовать рефлексию, да и в примере, по которому я делал, так же используют рефлексию.
3. Нет, не сработало, так же падает с NPE, потому что так же игнорирует thenReturn и просто возвращает то, что должен вернуть метод по факту, т.е. new User(). Который пустой.

[Денис Кузнецов]

тут дело видимо не в матчерах, а в том, что assertEquals(user, userRepository.findByName(userName)); сравнивает user с new User(). Я мокал только jdbcTemplate, может надо как то замокать userRepository, но этого не было в примере, да и будет ли в тесте тогда вообще смысл?!

[Dmitry Roo]

Денис Кузнецов, если вы ставите аннотацию @SpringBootTest - это уже не юнит тесты. Если вы тестируете взаимодействие с бд - это не юнит тесты.

[Денис Кузнецов]

Dmitry Roo, я так же попробовал заглушить репозиторий

@RunWith(MockitoJUnitRunner.class)
public class UserRepositoryImplTest {

    @Mock
    private UserRepositoryImpl userRepository;

    @Before
    public void initMocks(){
        MockitoAnnotations.initMocks(this);
    }

    @Test
    public void findByNameTest() {
        User user = setupUser();
        String userName = user.getUserName();
        JdbcTemplate jdbcTemplate = mock(JdbcTemplate.class);
        ReflectionTestUtils.setField(userRepository, "jdbcTemplate", jdbcTemplate);

//        Mockito.when(jdbcTemplate.queryForObject(
//                FIND_BY_NAME,
//                new ForUnitTestUserRowMapper(),
//                userName))
//                .thenReturn(user);

        Mockito.when(userRepository.jdbcTemplate.queryForObject(eq(FIND_BY_NAME),
                any(ForUnitTestUserRowMapper.class),
                anyString())).thenReturn(user);
        assertEquals(user, userRepository.findByName(userName));
    }

}

Но он все равно выдает ошибку ассерта, потому что так же игнорирует thenReturn и просто возвращает то, что должен вернуть боевой метод.

java.lang.AssertionError:
Expected :User{userId=1, userName='name', userPassword='password', roles=[Role{roleId=1, roleName='ROLE', users=null}]}
Actual :null

[Dmitry Roo]

Денис Кузнецов, а что там в UserRepositoryImpl?

[Денис Кузнецов]

Dmitry Roo, Как то так:

@Transactional
@Repository
public class UserRepositoryImpl implements UserRepository {

    public static final String FIND_BY_NAME = "select ut.user_id, ut.user_name, ut.user_password," +
            " user_role.role_id, role_name from \n" +
            "user_role inner join user_to_role\n" +
            "on user_role.role_id = user_to_role.role_id \n" +
            "inner join user_table as ut\n" +
            "on ut.user_id = user_to_role.user_id\n" +
            "where ut.user_name = ?";

    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Override
    public User findByName(String userName) {
        logger.info("find by name : {}", userName);
        User user = jdbcTemplate.queryForObject(
                FIND_BY_NAME,
                (rs, rowNum) -> new User(
                        rs.getLong("user_id"),
                        rs.getString("user_name"),
                        rs.getString("user_password"),
                        Collections.singleton(new Role(
                                rs.getLong("role_id"),
                                rs.getString("role_name")
                        ))),
                userName);
        if (Objects.isNull(user)) {
            logger.info("Empty user");
            return new User(); //test works if return setupUser();
        } else {
            return user;
        }
    }


}

[Dmitry Roo]

Денис Кузнецов, не используйте @Autowired. Внедрение зависимостей через поля — плохая практика Используйте конструктор, тогда и рефлексия не понадобится.
Проверьте что у вас с моком. Проверьте прямо в тесте, инициализируется ли jdbcTemplate и прямо в тесте проверьте, что будет, если вызвать .queryForObject

И я не понимаю, что вы тестируете? Какую логику? Вы создаете объект user, сами подсовываете его моком, а потом сами проверяете, что этот user тот же самый, которого вы создали...

[Денис Кузнецов]

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

DEBUG org.springframework.test.util.ReflectionTestUtils - Setting field 'jdbcTemplate' of type [null] on target object

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

[Денис Кузнецов]

Dmitry Roo, я подставлять в репозиторий напрямую через конструктор, или же сделать поле публичным и подставлять напрямую, но оба варианта тоже не сработали, значит дело в моке