Selector in CLI is ignored

[PHPirat]

Hello,

I'm switching from Deployer v6 to v7.4.1. I did follow the official migration guide and ended up with this deploy.php:

<?php

set( 'default_selector', 'stage=staging' );
set( 'application', 'test' );
set( 'user', 'example' );

$stages = [
	'production' => 'master',
	'staging' => 'development'
];

array_walk( $stages, function( $branch, $stage ) {
	$serverCount = "[01:05]";
	host( "node-{$serverCount}.example.com/{$stage}" )
		->setLabels( [ 'stage' => $str_stage ] )
		->setRemoteUser( get( 'user' ) )
		->setForwardAgent( true )
		->setSshMultiplexing( true )
		->setSshArguments( [
			'-o UserKnownHostsFile=/dev/null',
			'-o StrictHostKeyChecking=no'
		] )
		->set( 'branch', function() use ( $branch ) {
			return input()->getOption( 'branch' ) ?: $branch;
		} )
		->set( 'deploy_path', "/var/www/{{application}}/{$stage}" );
} );

When running the command php deployer.phar deploy stage=production it deploys to the staging host.
If I set the default_selector to a non-existing value like abcd and run the same command again, i do get the error No host selected. Please, check your selector: stage=abcd (as expected). So I do assume that my host definitions are correct (deploying to staging is working fine).

Can somebody point me towards my mistake?

On side note, the migration guide does not mention that the RuntimeException was renamed to RunException. I do think that this should be included in the guide, at least it took me some time to figure it out on my own.

[antonmedv]

On side note, the migration guide does not mention that the RuntimeException was renamed to RunException. I do think that this should be included in the guide, at least it took me some time to figure it out on my own.

Good point.

Can somebody point me towards my mistake?

I'm not completely getting but your mistake is. Could you please explain and show some examples?

[PHPirat]

Ok, so first of all, I do think I found the problem:
It seems that setting the default_selector overrides the selector set in the command. Removing it does solve the problem and the correct host it selected. If I don't supply any selector to the command, I'm asked to chose a host as expected.
What I still don't get is why it overrides the command input instead of being a fallback?

Regarding your question:
$str_stage or $stage as it should be called, is the value passed by array_walk function. The different stages are defined inside $stages where the key is equal to the stage and the value is the default branch to use. $stage is therefore equal to either "staging" or "production".
Our stages mainly differ by the deploy-path, that's why we used array_walk to define both stages inside the loop.

[antonmedv]

What I still don't get is why it overrides the command input instead of being a fallback?

A think it is a bug.

[PHPirat]

Do you think the problem is on my side or is it more likely a general bug?

[antonmedv]

I need to check it. You can also try to reproduce the error with simple deploy.php.

[uacode]

@antonmedv Hello, seems to me, the dynamic Labels does not work

->setLabels([
//        'stage' => 'prod',
        'stage' => function () {
            return getHost() === 'vps-2.domain.net' ? 'prod' : 'dev';
        },
        'role' => 'web',
    ]);

[florinr08]

What's taking so long to find and fix the issue here @antonmedv? It's been more than 2 months since this issue was raised and there's still no fix! The specified selector and default_selector act like default and override respectively.

Using a simple deploy.php file:

set('default_selector', 'type=web');

host('web.example.com')
    ->setLabels([
        'type' => 'web',
        'env' => 'prod',
    ]);

host('db.example.com')
    ->setLabels([
        'type' => 'db',
        'env' => 'prod',
    ]);

task('info', function () {
    writeln('type:' . get('labels')['type'] . ' env:' . get('labels')['env']);
});

If you run this command:

$ dep info all
task info
[web.example.com] type:web env:prod

$ dep info anythingyoulikehere
task info
[web.example.com] type:web env:prod

$ dep info this_gets_completely_ignored_when_default_selector_is_set
task info
[web.example.com] type:web env:prod

The default_selector config is acting like the supplied input parameter that overrides any defaults set. Any selector I provide in my command will be ignored because there's a default_selector config set that will always override.

---

The issue is here: https://github.com/deployphp/deployer/blob/v7.5.8/src/Command/SelectCommand.php#L54

$selector = Deployer::get()->config->get('default_selector', $input->getArgument('selector'));

Yes, you're wanting to set a default for something but you're setting the wrong default...

This should instead read something like this:

$selector = $input->getArgument('selector');
$selector = empty($selector) ? Deployer::get()->config->get('default_selector') : $selector;

[antonmedv]

Make sense. I’m planning to fix it next September. =) But you can always motivate me by supporting via GitHub Sponsors. Let say for one time donation of $500 I will fix it today!

[antonmedv]

Fixed in v7.5.10 and v8-alpha.1.