Files
HeuJung 85e266d361 fix(core,extensions): 확장 쓰기 경로 공통화 · HTMLPurifier 정의 캐시 storage 이전
https://github.com/gnuboard/g7/issues/125 — 상품 상세설명을 HTML 로 저장할 때
HTMLPurifier 가 모듈 vendor 폴더 안에 정의 캐시를 만들려다 실패해 저장이 매번 500 으로
끝나던 문제를 고친다. vendor 를 읽기 전용으로 두는 표준 배포에서 그 쓰기는 예외가 아니라
PHP 경고로 나오고 Laravel 이 이를 ErrorException 으로 승격시킨다. 캐시는 설정 해시당 1회만
기록되므로 캐시가 영영 생기지 않아 재시도해도 같은 결과였다.

캐시 경로를 storage 아래로 옮기고, 그 경로마저 확보하지 못하면 캐시만 끄고 정화는 그대로
수행한다 — 캐시는 성능 장치이고 정화는 보안 장치라, 전자의 실패가 후자를 건너뛰게 만들면
안 된다. 저장은 성공하므로 운영자에게 도달하는 흔적이 로그 하나뿐이라 error 수준으로 남긴다
(출하 기본 로그 수준이 error 라 warning 은 기본 설치 상태에서 파일에 남지 않는다).

그 과정에서 갈라져 있던 두 축을 코어 한 곳으로 모은다.

- 쓰기 디렉토리 확보: 억제 생성·chmod·setgid·소유권 상속·쓰기 판정 절차가 정적 게시와
 정의 캐시 두 곳에 서로 다른 하드닝으로 복제돼 있었다(억제 mkdir·setgid·clearstatcache 가
 사본마다 한쪽씩 빠져 있었다). FilePermissionHelper 의 ensureWritableDirectory 와
 hardenDirectory 로 통합하고, 실패 사유는 out 파라미터로 올려 정책(조용한 성능 저하 대
 시끄러운 실패)은 호출부가 정하게 둔다.

- 확장 저장 경로: storage_path('app/modules/…') 손조립이 30곳에 흩어져 있어 테스트 격리
 분기를 넣으려면 사본마다 복제해야 했고, 한 곳만 빠뜨려도 그 확장의 테스트가 운영 설정
 파일을 덮어쓴다. 디스크 root 를 단일 출처로 읽는 ExtensionStoragePath 로 전환하고 테스트
 분기는 config/filesystems.php 한 줄에서 끝낸다.

함께 고친 것

- 테스트가 운영 라우트 캐시로 부팅해 확장 allowlist 가 라우트 축에서 통째로 무력화되던
 문제. 삭제가 아니라 경로를 돌린다 — 라우트 캐시는 확장 작업 전까지 재생성되지 않아,
 삭제하면 운영 사이트가 그때까지 라우트 파일 스캔 경로로 떨어진다.
- PHPUnit 프로세스가 확장 vendor 의 제3자 composer 패키지를 오토로드하지 않아 그 패키지를
 쓰는 코드 경로가 통째로 테스트 불가였던 문제. 확장 자신의 오토로더를 그대로 쓰면 활성
 디렉토리가 _bundled 를 이기고 base path 유추까지 깨지므로, 생성된 맵에서 제3자 항목만
 골라 별도 로더로 등록한다.
- 게시 폴더가 setgid 를 갖지 않아, 명령줄과 웹이 번갈아 만든 하위 폴더를 다른 쪽이 쓰지
 못하던 문제.
- 관리자 템플릿이 HTML 정화 라이브러리를 직접 지정하지 않아 전이 의존으로 딸려온 구버전이
 쓰이던 문제.

동반 산출물

- 규정 표(·AGENTS.md) 6행 + storage-driver/service-repository/testing-guide 문서
- audit 룰 2종 + coverage 6항목. 저장소가 이미 전량 전환돼 전수 실행이 공허 통과하므로
 판정식은 픽스처 36건이 잠근다
- INSTALL.md 에 설치 후 파일 권한 절 추가 (vendor 쓰기 권한 불요를 명시)
2026-08-28 15:22:22 +09:00

225 lines
10 KiB
PHP

<?php
namespace Plugins\Sirsoft\VerificationKginicis\Tests;
use App\Extension\HookListenerRegistrar;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Storage;
use Plugins\Sirsoft\VerificationKginicis\Listeners\AssertNoDuplicateInicisIdentity;
use Plugins\Sirsoft\VerificationKginicis\Listeners\CleanInicisRecordOnUserDelete;
use Plugins\Sirsoft\VerificationKginicis\Listeners\CleanInicisRecordOnUserWithdraw;
use Plugins\Sirsoft\VerificationKginicis\Listeners\CompleteInicisRecordAfterRegister;
use Plugins\Sirsoft\VerificationKginicis\Listeners\RegisterInicisProviderListener;
use Plugins\Sirsoft\VerificationKginicis\Listeners\ValidateInicisSettingsListener;
use Plugins\Sirsoft\VerificationKginicis\Providers\InicisVerificationServiceProvider;
use Tests\TestCase;
/**
* KG이니시스 본인인증 플러그인 테스트 베이스.
*
* RefreshDatabase 로 매 테스트마다 DB 초기화 + plugin migration 포함.
* ServiceProvider + plugin route 도 setUp 시점에 등록 — 코어 plugin 시스템이
* 테스트 환경에서는 자동 부팅되지 않으므로 수동 등록 필수.
*/
abstract class PluginTestCase extends TestCase
{
use RefreshDatabase;
/** 테스트 격리용 임시 plugins 스토리지 루트 (setUp 에서 생성, tearDown 에서 제거). */
private ?string $isolatedPluginsRoot = null;
protected function migrateFreshUsing(): array
{
// 모든 번들 확장 migrations 포함 — 여러 확장 스위트를 한 프로세스에서 함께 돌릴 때
// 가장 먼저 실행된 TestCase 가 스키마를 확정하므로, 자기 확장만 넘기면 뒤따르는
// 확장의 테이블이 생성되지 않는다 (troubleshooting-backend.md 사례 21).
$paths = ['database/migrations'];
foreach (glob(base_path('modules/_bundled/*/database/migrations'), GLOB_ONLYDIR) as $p) {
$paths[] = str_replace(base_path().DIRECTORY_SEPARATOR, '', $p);
}
foreach (glob(base_path('plugins/_bundled/*/database/migrations'), GLOB_ONLYDIR) as $p) {
$paths[] = str_replace(base_path().DIRECTORY_SEPARATOR, '', $p);
}
return [
'--drop-views' => $this->shouldDropViews(),
'--drop-types' => $this->shouldDropTypes(),
'--seed' => false,
'--path' => $paths,
];
}
protected function setUp(): void
{
parent::setUp();
$this->isolatePluginStorage();
$this->registerPluginAutoload();
// 플러그인 lang 네임스페이스 등록 — 실 환경에서는 코어 TranslationServiceProvider::boot()
// 의 loadPluginTranslations() 가 수행하나 테스트 환경에서는 미등록이므로 코어와 동일한
// 경로로 register namespace 한다 (translator->getLoader()->addNamespace 직접 호출).
// ServiceProvider boot(__()) 와 검증 attribute 해석이 가능하도록 register 보다 먼저 등록.
$translator = $this->app['translator'];
$translator->getLoader()->addNamespace(
'sirsoft-verification_kginicis',
base_path('plugins/sirsoft-verification_kginicis/lang'),
);
// 부팅 과정에서 plugin 네임스페이스 + 코어 validation 그룹이 namespace 등록/파일 준비 전에
// 빈 값으로 캐시(loaded)되어 원본 키가 노출되므로 무효화한다. 무효화로 실제 파일을 다시
// 읽도록 한 뒤 ServiceProvider 를 register 하여 boot 의 Lang::addLines(validation.attributes)
// 가 채워진 validation 그룹 위에 얹히도록 순서를 보장한다.
$loadedProp = new \ReflectionProperty($translator, 'loaded');
$loadedProp->setAccessible(true);
$loaded = $loadedProp->getValue($translator);
unset($loaded['sirsoft-verification_kginicis']);
unset($loaded['*']['validation']);
$loadedProp->setValue($translator, $loaded);
// validation 그룹을 실제 파일에서 먼저 로드시켜 캐시를 채운다.
$translator->get('validation.required');
$this->app->register(InicisVerificationServiceProvider::class);
// ServiceProvider 의 validation.attributes 등록은 booted 콜백에서 수행되는데, 테스트
// 환경의 캐시 무효화/등록 순서와 어긋날 수 있으므로 무효화 이후 시점에 동일 라벨을
// 재적용한다. (실 환경에서는 booted 콜백이 plugin lang 준비 후 유효하므로 본 보정은 테스트 전용)
foreach (['ko', 'en'] as $locale) {
$translator->addLines([
'validation.attributes.live_mid' => __('sirsoft-verification_kginicis::messages.settings.live_mid_attribute', [], $locale),
'validation.attributes.live_api_key' => __('sirsoft-verification_kginicis::messages.settings.live_api_key_attribute', [], $locale),
], $locale);
}
$this->registerPluginRoutes();
$this->registerPluginHookListeners();
}
protected function tearDown(): void
{
$this->restorePluginStorage();
parent::tearDown();
}
/**
* 플러그인 스토리지('plugins' 디스크)를 테스트 전용 임시 디렉토리로 격리한다.
*
* 설정 저장 테스트(PluginSettingsService::save)는 코어 'plugins' 디스크
* (root = `plugins` 디스크, config/filesystems.php)에 setting.json 을 쓴다. 격리하지 않으면
* 테스트가 실제 로컬 런타임 설정 파일을 덮어써 라이브 모드/자격증명이 오염된다
* (RefreshDatabase 는 DB 만 롤백하고 파일시스템은 되돌리지 않음). 디스크 root 를
* 임시 경로로 바꾸고 resolved 인스턴스를 purge 하여 실제 파일을 원천적으로 못
* 건드리게 한다.
*/
private function isolatePluginStorage(): void
{
// Laravel 이 테스트용 쓰기 공간으로 보장하는 storage/framework/testing 하위를 사용한다.
// sys_get_temp_dir() 은 CI/컨테이너/open_basedir 제약 환경에서 위치가 다르거나
// 쓰기 불가일 수 있어 프로젝트 내부의 격리 경로를 쓴다 (Laravel 규약 준수).
$this->isolatedPluginsRoot = storage_path(
'framework/testing/plugin-storage-'.uniqid('', true)
);
File::ensureDirectoryExists($this->isolatedPluginsRoot);
config(['filesystems.disks.plugins.root' => $this->isolatedPluginsRoot]);
// 이미 resolve 된 'plugins' 디스크 인스턴스를 폐기해 새 root 로 재생성되게 한다.
Storage::forgetDisk('plugins');
}
/**
* 격리 임시 디렉토리를 제거한다 (테스트 간 잔여 파일 격리).
*/
private function restorePluginStorage(): void
{
if ($this->isolatedPluginsRoot !== null && is_dir($this->isolatedPluginsRoot)) {
File::deleteDirectory($this->isolatedPluginsRoot);
}
$this->isolatedPluginsRoot = null;
Storage::forgetDisk('plugins');
}
/**
* Plugin 의 hook listener 들을 코어 HookManager 에 등록.
*
* 실 환경: 코어 PluginManager 가 부팅 시 HookListenerRegistrar 를 호출.
* 테스트 환경: plugin 이 미설치 상태이므로 수동 등록 필수.
*/
protected function registerPluginHookListeners(): void
{
HookListenerRegistrar::register(
RegisterInicisProviderListener::class,
'plugin:sirsoft-verification_kginicis',
);
HookListenerRegistrar::register(
CompleteInicisRecordAfterRegister::class,
'plugin:sirsoft-verification_kginicis',
);
HookListenerRegistrar::register(
CleanInicisRecordOnUserWithdraw::class,
'plugin:sirsoft-verification_kginicis',
);
HookListenerRegistrar::register(
CleanInicisRecordOnUserDelete::class,
'plugin:sirsoft-verification_kginicis',
);
HookListenerRegistrar::register(
AssertNoDuplicateInicisIdentity::class,
'plugin:sirsoft-verification_kginicis',
);
HookListenerRegistrar::register(
ValidateInicisSettingsListener::class,
'plugin:sirsoft-verification_kginicis',
);
}
/**
* 활성 디렉토리(plugins/sirsoft-verification_kginicis/src/) PSR-4 자동 로드.
*/
protected function registerPluginAutoload(): void
{
$base = base_path('plugins/sirsoft-verification_kginicis/src/');
spl_autoload_register(function (string $class) use ($base): void {
$prefix = 'Plugins\\Sirsoft\\VerificationKginicis\\';
$len = strlen($prefix);
if (strncmp($prefix, $class, $len) !== 0) {
return;
}
$file = $base.str_replace('\\', '/', substr($class, $len)).'.php';
if (file_exists($file)
&& ! class_exists($class, false) && ! interface_exists($class, false)
&& ! trait_exists($class, false) && ! enum_exists($class, false)) {
// 활성 디렉토리 사본이 이미 로드된 심볼을 다시 선언하면 fatal 이 된다 —
// 선언 여부를 자체 확인하고 require_once 로 이중 방어한다
require_once $file;
}
});
}
/**
* Plugin 라우트 등록 — 코어 PluginManager 의 자동 prefix 흉내.
*
* 실 환경: `/plugins/sirsoft-verification_kginicis/{path}` + 이름 prefix `web.plugins.sirsoft-verification_kginicis.`
*/
protected function registerPluginRoutes(): void
{
$webRoutesFile = base_path('plugins/sirsoft-verification_kginicis/src/routes/web.php');
if (file_exists($webRoutesFile)) {
Route::prefix('plugins/sirsoft-verification_kginicis')
->name('web.plugins.sirsoft-verification_kginicis.')
->middleware('web')
->group($webRoutesFile);
}
}
}