Embedded Mongo/Redis 적용하기

들어가며

이번 프로젝트를 진행하면서 로컬 개발 환경의 일관성과 효율성에 대해 고민이 있었습니다. 팀 프로젝트가 진행됨에 따라, 여러 명의 개발자가 동시에 작업을 시작하게 되었고, 프로젝트를 GitHub에서 클론한 뒤, 빠르게 개발을 시작할 수 있는 환경을 제공하는 것이 중요하다는 점을 깨달았습니다. 

 

초기에는 각 개발자가 Redis, MySQL, MongoDB와 같은 외부 데몬은 별도로 설치해야 하는 경우가 많았고, 그로 인해 설정에만 오랜 시간이 걸리거나, 환경 세팅을 하지 못한 채로 진행되는 경우도 있었습니다. 따라서, 프로젝트를 클론한 후 바로 실행 가능한 환경을 구성해야 한다는 생각이 들었고, 이를 위해 로컬에서 독립적으로 실행할 수 있는 기술이 필요하다고 판단했습니다. 

 

이 문제를 해결하기 위한 방법으로 Docker와 TestContainer를 고려했지만, 내장형 방식을 사용하는 Embedded Mongo와 Redis를 선택하게 되었습니다. 

 

선정 이유

Docker와 TestContainer를 사용하여도 원하는 환경을 구축할 수 있지만 각 방식에는 특정한 제약이 있었고, 이를 고려한 최적의 선택이 필요했습니다. 

 

Docker를 사용하면 컨테이너화된 서비스를 로컬에서 손쉽게 실행할 수 있었지만, 컨테이너를 실행하는 데 있어 추가적인 설정과 관리가 필요합니다. 개발자는 직접 컨테이너를 시작하고 관리해야 하므로 로컬 개발환경을 신속하게 시작하는 데 번거로움이 있을 수 있습니다. 

 

TestContainer는 주로 테스트 환경에서 컨테이너를 동적으로 생성하고 관리하는 라이브러리 입니다. 이를 통해 다양한 외부 서비스를 테스트용 컨테이너로 실행할 수 있지만, 테스트 코드 실행 시에만 동작합니다. 이는 테스트 자동화에는 매우 유용하지만, 일상적인 로컬 개발환경에서 지속적으로 Redis나 MongoDB와 같은 서비스를 사용해야 하는 경우에는 불편함이 따릅니다. 개발자가 일반적인 작업을 하는 도중에도 지속적으로 테스트 환경이 필요할 수 있는데, TestContainer는 이와 같은 지속적인 사용에 적합하지 않다고 판단하였습니다. 

 

따라서, 저희 프로젝트에서는 Embedded Mongo와 Redis를 선택하게 되었습니다. 이 방식은 외부 의존성 없이 애플리케이션 내에서 MongoDB와 Redis를 직접 내장하여 실행할 수 있어, 처음 설정 후에는 별도의 설정 없이 바로 실행할 수 있기 때문에 즉시 테스트와 개발을 시작할 수 있다는 장점이 있었습니다. 

 

 

라이브러리

일단 로컬 개발환경에서 Embedded Mongo와 Redis를 사용하기 위해 아래 라이브러리들을 build.gradle에 추가합니다. 

// embedded-mongo
implementation 'de.bwaldvogel:mongo-java-server:1.45.0'
// embedded-redis
implementation 'com.github.codemonstur:embedded-redis:1.4.3'

 

PortInspector 추가

로컬 개발 환경에서 Embedded Mongo와 Redis는 별도의 외부 서버 없이 로컬에서 실행되는 장점이 있지만, 통합 테스트를 수행할 때 문제가 발생할 수 있습니다. 특히, 서로 다른 속성을 가진 테스트들이 동시에 실행되면, 내장 데이터베이스가 동일한 포트를 사용하려고 시도할 수 있어 충돌이 발생할게 됩니다. 이로 인해 포트 충돌이 일어나 테스트가 실패하고 오류가 발생하게 됩니다. 

문제 상황

여러 테스트가 실행될 때 새로운 컨텍스트가 생성되면, 이전에 실행중인 포트를 재사용하려고 시도합니다. 만약 해당 포트가 이미 사용중이라면, 다른 테스트가 진행되지 않거나 오류가 발생하게 됩니다. 이를 방지하기 위해, 테스트가 샐행되는 동한 포트 충돌을 막고 속성이 변경되는 테스트마다 독립적인 포트를 할당할 필요가 있었습니다. 

해결 방법

이를 해결하기 위해 PortInspector 클래스를 추가했습니다. 이 클래스는 현재 사용중인 포트를 검사하여, 특정 포트가 이미 사용중인지를 확인합니다. 만약 해당 포트가 사용중이라면, 새로운 포트를 자동으로 할당하여 포트 충돌을 방지합니다. 

@Component("portInspector")
@Profile("local")
public class PortInspector {

    private static final int MIN_PORT = 10000;
    private static final int MAX_PORT = 65535;

    public boolean isPortRunning(int port) throws IOException {
        return isRunning(executeGrepProcessCommand(port));
    }

    public int findAvailablePort() throws IOException {
        for (int port = MIN_PORT; port <= MAX_PORT; port++) {
            Process process = executeGrepProcessCommand(port);

            if (!isRunning(process)) {
                return port;
            }
        }

        throw new IllegalArgumentException("Not Found Available Port: 10000 ~ 65535");
    }

    private Process executeGrepProcessCommand(int port) throws IOException {
        String command = String.format("netstat -nat | grep LISTEN|grep %d", port);
        String[] shell = {"/bin/sh", "-c", command};
        return Runtime.getRuntime().exec(shell);
    }

    private boolean isRunning(Process process) throws IOException {
        String line;
        StringBuilder pid = new StringBuilder();

        try (BufferedReader input = new BufferedReader(new InputStreamReader(process.getInputStream()))) {
            while ((line = input.readLine()) != null) {
                pid.append(line);
            }
        } catch (Exception e) {
        }

        return !isEmpty(pid.toString());
    }

}

 

Embedded 설정

내장 데이터베이스 설정 코드에서 @DependsOn("portInspector") 어노테이션을 사용한 이유는 portInspector 빈이 번저 초기화된 후에 내장 데이터베이스 설정이 실행되어야 하기 때문입니다. 이를 보장하기 위해 @DependsOn을 사용하여, portInspector 빈이 먼저 초기화된 후에 다른 빈들이 초기화되도록 설정했습니다. 

EmbeddedMongoConfig

@Configuration  
@RequiredArgsConstructor  
@DependsOn("portInspector")  
@Profile("local")  
public class EmbeddedMongoConfig {  
  
    @Value("${spring.data.mongodb.port}")  
    private int port;  
  
    @Value("${spring.data.mongodb.host}")  
    private String host;  
  
    @Value("${spring.data.mongodb.database}")  
    private String database;  
  
    private final PortInspector portInspector;  
  
	// MongoTemplate Bean 생성
    @Bean  
    public MongoTemplate mongoTemplate(MongoDatabaseFactory mongoDatabaseFactory) {  
        return new MongoTemplate(mongoDatabaseFactory);  
    }  
    
    // MongoDatabaseFactory 생성
    @Bean  
    public MongoDatabaseFactory mongoDatabaseFactory(MongoServer mongoServer) {  
        String connection = mongoServer.getConnectionString();  
        return new SimpleMongoClientDatabaseFactory(appendDatabaseName(connection));  
    }  
    
    // MongoServer 실행
    @Bean(destroyMethod = "shutdown")  
    public MongoServer mongoServer() throws IOException {  
        MongoServer mongoServer = new MongoServer(new MemoryBackend());  
        int availablePort = portInspector.isPortRunning(port) ? portInspector.findAvailablePort() : port;  
        mongoServer.bind(host, availablePort);  
        return mongoServer;  
    }  
	
	// connection String에 데이터베이스 이름 추가
    private String appendDatabaseName(String baseConnection) {  
        return String.format("%s/%s", baseConnection, database);  
    }  
    
}

EmbeddedRedisConfig

@Configuration
@RequiredArgsConstructor
@DependsOn("portInspector")
@Profile("local")
public class EmbeddedRedisConfig {

    private final RedisProperties redisProperties;
    private final PortInspector portInspector;
    private RedisServer redisServer;

	// Redis 서버 시작
    @PostConstruct
    private void start() throws IOException {
        int redisPort = portInspector.isPortRunning(redisProperties.getPort()) ? portInspector.findAvailablePort()
                : redisProperties.getPort();
        redisProperties.setPort(redisPort);

        redisServer = new RedisServer(redisPort);
        redisServer.start();
    }

	// Redis 서버 종료
    @PreDestroy
    private void stop() throws IOException {
        if (redisServer != null) {
            redisServer.stop();
        }
    }

}

 

위와 같이 설정을 끝마쳤다면, 테스트 실행이나 프로젝트를 실행 시 내장 데이터베이스 방식으로 MongoDB와 Redis를 손쉽게 사용할 수 있습니다. 

Embedded 설정을 마친후 테스트 실행

Embedded 설정을 마친 후 프로젝트 실행