[Help Wanted] Increasing test coverage of Command classes #10796

Seldaek · 2022-05-24T08:04:32Z

As you can see on this image, Command classes have very poor coverage currently (16% of lines covered in total):

Here some examples of how to write sane integration tests for most commands:

composer/tests/Composer/Test/Command/RunScriptCommandTest.php

Lines 92 to 113 in 176d258

    
           public function testCanListScripts(): void 
        
           { 
        
               $this->initTempComposer([ 
        
                   'scripts' => [ 
        
                       'test' => '@php test', 
        
                       'fix-cs' => 'php-cs-fixer fix', 
        
                   ], 
        
                   'scripts-descriptions' => [ 
        
                       'fix-cs' => 'Run the codestyle fixer', 
        
                   ], 
        
               ]); 
        
               $appTester = $this->getApplicationTester(); 
        
               $appTester->run(['command' => 'run-script', '--list' => true]); 
        
               $appTester->assertCommandIsSuccessful(); 
        
               $output = $appTester->getDisplay(); 
        
               $this->assertStringContainsString('Runs the test script as defined in composer.json.', $output, 'The default description for the test script should be printed'); 
        
               $this->assertStringContainsString('Run the codestyle fixer', $output, 'The custom description for the fix-cs script should be printed'); 
        
           }

composer/tests/Composer/Test/Command/ConfigCommandTest.php

Lines 23 to 52 in 176d258

    
               /** 
        
                * @dataProvider provideConfigUpdates 
        
                * @param array<mixed> $before 
        
                * @param array<mixed> $command 
        
                * @param array<mixed> $expected 
        
                */ 
        
               public function testConfigUpdates(array $before, array $command, array $expected): void 
        
               { 
        
                   $this->initTempComposer($before); 
        
                   $appTester = $this->getApplicationTester(); 
        
                   $appTester->run(array_merge(['command' => 'config'], $command)); 
        
                   $appTester->assertCommandIsSuccessful($appTester->getDisplay()); 
        
                   $this->assertSame($expected, json_decode((string) file_get_contents('composer.json'), true)); 
        
               } 
        
               public function provideConfigUpdates(): \Generator 
        
               { 
        
                   yield 'set scripts' => [ 
        
                       [], 
        
                       ['setting-key' => 'scripts.test', 'setting-value' => ['foo bar']], 
        
                       ['scripts' => ['test' => 'foo bar']], 
        
                   ]; 
        
                   yield 'unset scripts' => [ 
        
                       ['scripts' => ['test' => 'foo bar', 'lala' => 'baz']], 
        
                       ['setting-key' => 'scripts.lala', '--unset' => true], 
        
                       ['scripts' => ['test' => 'foo bar']], 
        
                   ];

composer/tests/Composer/Test/Command/BumpCommandTest.php

Lines 28 to 47 in 70f2dd6

    
           $this->initTempComposer($composerJson); 
        
           $packages = [ 
        
               $this->getPackage('first/pkg', '2.3.4'), 
        
               $this->getPackage('second/pkg', '3.4.0'), 
        
           ]; 
        
           $devPackages = [ 
        
               $this->getPackage('dev/pkg', '2.3.4.5'), 
        
           ]; 
        
           $this->createInstalledJson($packages, $devPackages); 
        
           if ($lock) { 
        
               $this->createComposerLock($packages, $devPackages); 
        
           } 
        
           $appTester = $this->getApplicationTester(); 
        
           $appTester->run(array_merge(['command' => 'bump'], $command)); 
        
           $json = new JsonFile('./composer.json'); 
        
           $this->assertSame($expected, $json->read());

If you feel like helping, PRs are very much welcome, I don't think we absolutely need 100% coverage but having the most common use cases covered would already be very valuable. Please target the main branch if you want to contribute some, and feel free to announce it here if you start some larger chunk of work to avoid duplicating efforts.

The text was updated successfully, but these errors were encountered:

theoboldalex · 2022-07-09T19:17:43Z

@Seldaek I'd love to take on some of this work. I have opened a first PR here #10932 and will start to work my way through the commands.

Seldaek · 2022-07-09T19:28:27Z

@theoboldalex great, thanks! Maybe wait until I get a chance to review the first one to make sure you don't run off and do more of them with the wrong assumptions. I'll try to get to it soon.

Also note the listing above is a bit outdated as I tried to work on this here and there when touching commands the last few months. But there is still plenty to be done :)

Seldaek added Good First Issue Needs Test labels May 24, 2022

Seldaek added this to the 2.4 milestone May 24, 2022

Seldaek pinned this issue May 24, 2022

Seldaek mentioned this issue Jun 4, 2022

Fix processing null config value in DiagnoseCommand #10817

Closed

Seldaek removed this from the 2.4 milestone Jul 17, 2022

Seldaek added this to the 2.5 milestone Jul 17, 2022

[Help Wanted] Increasing test coverage of Command classes #10796

[Help Wanted] Increasing test coverage of Command classes #10796

Seldaek commented May 24, 2022 •

edited

theoboldalex commented Jul 9, 2022

Seldaek commented Jul 9, 2022

[Help Wanted] Increasing test coverage of Command classes #10796

[Help Wanted] Increasing test coverage of Command classes #10796

Comments

Seldaek commented May 24, 2022 • edited

theoboldalex commented Jul 9, 2022

Seldaek commented Jul 9, 2022

Seldaek commented May 24, 2022 •

edited