환경 설정을 시작 시점에 검증하기, 먼저 지킬 계약을 적어 보기

누락된 환경 변수가 특정 기능을 누르는 순간에야 드러나면 배포 성공 표시를 믿기 어렵다. 기본값으로 조용히 우회하는 설정은 원인 파악도 어렵게 한다.

새로운 기능을 붙일 때 구현 방법부터 고르면 무엇을 확인해야 하는지 뒤늦게 고민하게 된다. 이번 기록에서는 입력과 결과 사이에 반드시 유지할 약속을 먼저 적고, 작은 예제로 그 약속을 확인한다. 복잡한 설계보다 같은 동작을 다시 설명할 수 있는 기준 하나가 출발점이다.

동작보다 먼저 정할 기준

필수 설정과 선택 설정을 나누고 필수 값의 존재와 형식을 시작 시점에 검증한다. 오류에는 설정 이름을 남기되 비밀 값 자체는 포함하지 않는다.

이번에 확인할 질문: 입력과 실행 순서가 같을 때, 다른 동료도 같은 결과를 예상할 수 있는가?

작게 확인하는 예제

다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.

import os

port = int(os.environ.get('PORT', '4000'))
if not 1 <= port <= 65535:
    raise ValueError('PORT must be a valid TCP port')
if not os.environ.get('DATABASE_URL'):
    raise ValueError('DATABASE_URL is required')

필수 값 누락, 잘못된 숫자, 정상 설정을 별도 실행으로 확인하고 오류 출력에 값이 노출되지 않는지 살핀다.

놓치기 쉬운 조건

개발 편의를 위한 비밀번호 기본값이 운영까지 이어지지 않도록 한다. 형식 검증만으로 실제 연결 가능 여부가 보장되는 것은 아니다.

확인할 부분	살펴볼 내용
기준 동작	필수 값 누락, 잘못된 숫자, 정상 설정을 별도 실행으로 확인하고 오류 출력에 값이 노출되지 않는지 살핀다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 사용자에게 보이는 결과를 한 문장으로 적는다.
2. 정상 입력 하나와 경계 입력 하나를 같은 조건에서 비교한다.
3. 설명이 달라지는 부분을 코드나 문서의 명시적인 규칙으로 옮긴다.

처음 정한 계약은 영원한 정답이 아니다. 다만 바꾸려면 어떤 사용자가 영향을 받는지 함께 설명할 수 있어야 한다. 오늘의 기준을 짧게 남겨 두면 다음 변경에서 구현 취향과 제품의 약속을 구분하기 쉬워진다.