PHP_CodeSniffer (PHP)

phpcs-aaa는 PHP 테스트 메서드에 Arrange-Act-Assert 패턴을 강제하는 PHPCS 표준입니다.

설치

composer require --dev babu-ch/phpcs-aaa

phpcodesniffer-composer-installer를 사용하지 않는다면 표준 경로를 수동으로 등록하세요.

vendor/bin/phpcs --config-set installed_paths vendor/babu-ch/phpcs-aaa

Sniff 활성화

<!-- phpcs.xml.dist -->
<?xml version="1.0"?>
<ruleset name="Project">
    <file>tests</file>
    <rule ref="AAA"/>
</ruleset>

임시 실행:

vendor/bin/phpcs --standard=AAA tests/

Sniff: AAA.Tests.Pattern

설정

<rule ref="AAA.Tests.Pattern">
    <properties>
        <property name="caseSensitive" value="false"/>
        <property name="allowEmptySection" value="true"/>
        <property name="testFunctionPrefixes" type="array">
            <element value="test"/>
        </property>
        <property name="labels" type="array">
            <element key="arrange" value="arrange"/>
            <element key="act"     value="act"/>
            <element key="assert"  value="assert"/>
        </property>
    </properties>
</rule>

테스트 메서드는 이름 접두사로 매칭됩니다 (PHPUnit 관례: test로 시작하는 메서드). 다른 네이밍을 쓴다면 목록을 확장하세요.

예시

Given / When / Then

<property name="labels" type="array">
    <element key="arrange" value="given"/>
    <element key="act"     value="when"/>
    <element key="assert"  value="then"/>
</property>

감지 예시

// 오류: "arrange" 누락
public function testBad(): void
{
    // act
    $x = $this->doThing();
    // assert
    $this->assertSame(1, $x);
}

// 오류: 순서가 잘못됨
public function testAlsoBad(): void
{
    // act
    $x = $this->doThing();
    // arrange
    $y = 1;
    // assert
    $this->assertSame($y, $x);
}

자동 수정

세 개의 섹션 주석이 모두 누락된 경우, vendor/bin/phpcbf (PHP_CodeSniffer 에 포함된 자동 수정 도구) 가 테스트 메서드 상단에 // arrange / // act / // assert 템플릿을 삽입합니다. 이후 각 주석을 해당 코드 위로 옮기기만 하면 됩니다.

다른 경우 (한두 개 누락, 순서 오류, 빈 섹션) 는 자동 수정되지 않습니다 — 올바른 삽입 위치가 테스트 의도에 따라 다르기 때문이며, 에러 메시지가 「무엇을」「어디에」 추가해야 하는지 명확히 알려줍니다.