Skip to content

Omit missing optional compose overrides #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mstrhakr merged 2 commits into from
Oct 9, 2026
Merged

Omit missing optional compose overrides #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcc55d6
fix: omit missing optional compose overrides
mstrhakr Oct 9, 2026
b06eff1
test: address override review feedback
mstrhakr Oct 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions source/compose.manager/include/Util.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1541,9 +1541,8 @@ public static function buildEnvTemplateContent(): string
/**
* Core override resolution logic shared by both factories.
*
* Computes the override filename from the compose file, resolves project
* and indirect override paths while preserving legacy filenames as-is,
* and auto-creates a project override template if needed.
* Computes the override filename from the compose file and resolves
* project and indirect override paths while preserving legacy filenames.
*
* @param string $projectPath Full path to the stack directory
* @param string|null $indirectPath Indirect target directory, or null if not indirect
Expand Down Expand Up @@ -3098,7 +3097,11 @@ private function getComposeFilePaths(): array
}
} else {
$overridePath = $this->getOverridePath();
if ($overridePath !== null) {
// Keep the preferred path available through getOverridePath() for
// editor/write operations, but only pass an existing optional
// override to Compose. Missing overrides are normal for older and
// manually created stacks.
if ($overridePath !== null && is_file($overridePath)) {
$paths[] = $overridePath;
}
}
Expand Down
20 changes: 20 additions & 0 deletions tests/unit/ComposeCommandBuilderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,26 @@ public function testBuildForActionUsesDefaultProfilesForUp(): void
$this->assertSame($stackDir, $spec['stackPath']);
}

public function testBuildForUpAndDownOmitsMissingOptionalOverride(): void
{
$stack = 'missing-override';
$stackDir = $this->tempRoot . '/' . $stack;
mkdir($stackDir);
file_put_contents($stackDir . '/compose.yaml', "services:\n web:\n image: nginx\n");

$info = \StackInfo::fromProject($this->tempRoot, $stack);
$overridePath = $info->getOverridePath();

$this->assertNotNull($overridePath);
$this->assertFileDoesNotExist($overridePath);
$upSpec = \ComposeCommandBuilder::buildForAction($info, 'up');
$downSpec = \ComposeCommandBuilder::buildForAction($info, 'down');

$this->assertSame([$stackDir . '/compose.yaml'], $upSpec['composeFiles']);
$this->assertSame([$stackDir . '/compose.yaml'], $downSpec['composeFiles']);
$this->assertSame($overridePath, $info->getOverridePath(), 'The preferred write target must remain available.');
}

public function testBuildForActionUsesRunningProfilesForUpdate(): void
{
$stack = 'profiles-update-running';
Expand Down
5 changes: 3 additions & 2 deletions tests/unit/ExtraComposeFilesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@ public function testExtraAbsoluteFileIsAppended(): void

$spec = \ComposeCommandBuilder::fromProject($this->tempRoot, 'extra-abs', 'up');

// The plugin auto-creates compose.override.yaml; extras come after it.
// The app-managed override is optional and only included when its file exists.
// With no override file, extras follow the main compose file.
$this->assertSame(
[$stackDir . '/compose.yaml', $stackDir . '/compose.override.yaml', $extraFile],
[$stackDir . '/compose.yaml', $extraFile],
$spec['composeFiles']
);
}
Expand Down
9 changes: 5 additions & 4 deletions tests/unit/StackInfoTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1121,9 +1121,11 @@ public function testBuildComposeArgsWithComposeFileInEnv(): void
$info = \StackInfo::fromProject($this->tempRoot, $stack);
$args = $info->buildComposeArgs();

$this->assertSame(3, count($args['filePaths']));
$this->assertCount(2, $args['filePaths']);
$this->assertStringContainsString('compose.debug.yaml', $args['files']);
$this->assertContains($stackDir . '/compose.debug.yaml', $args['filePaths']);
$this->assertNotContains($stackDir . '/compose.override.yaml', $args['filePaths']);
$this->assertStringNotContainsString($stackDir . '/compose.override.yaml', $args['files']);
}

public function testProjectLoadsWhenComposeFileIsOnlyDeclaredInDotEnv(): void
Expand Down Expand Up @@ -1207,16 +1209,15 @@ public function testBuildComposeArgsWithQuotedComposeFileInEnv(): void
$info = \StackInfo::fromProject($this->tempRoot, $stack);
$args = $info->buildComposeArgs();

$this->assertSame(4, count($args['filePaths']));
$this->assertSame(3, count($args['filePaths']));
$this->assertStringContainsString('compose.debug.yaml', $args['files']);
$this->assertStringContainsString('compose.extra.yaml', $args['files']);
$this->assertContains($stackDir . '/compose.debug.yaml', $args['filePaths']);
$this->assertContains($stackDir . '/compose.extra.yaml', $args['filePaths']);
$this->assertContains($stackDir . '/compose.override.yaml', $args['filePaths']);
$this->assertNotContains($stackDir . '/compose.override.yaml', $args['filePaths']);
$this->assertSame(
implode(PATH_SEPARATOR, [
$stackDir . '/compose.yaml',
$stackDir . '/compose.override.yaml',
$stackDir . '/compose.debug.yaml',
$stackDir . '/compose.extra.yaml',
]),
Expand Down
Loading