Test drush commands as a functional test

DrushCommandsTest.php

<?php

namespace Drupal\Tests\staffing_figures_api\Functional;

use Drupal\taxonomy\Entity\Vocabulary;
use Drupal\Tests\BrowserTestBase;
use Drush\TestTraits\DrushTestTrait;

/**
 * Tests the Drush commands provided by the staffing_figures_api module.
 *
 * @group staffing_figures_api
 */
class DrushCommandsTest extends BrowserTestBase {

  use DrushTestTrait;

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = [
    'taxonomy',
    'staffing_figures',
    'staffing_figures_api',
  ];

  protected function setUp(): void {
    parent::setUp();
    Vocabulary::create(['vid' => 'workplace', 'name' => 'Workplace'])->save();
  }

  /**
   * Tests the Drush commands
   */
  public function testDrushCommands() {
    // Test the different drush commands are executed without errors.
    // TODO: Extend the tests with proper test for results and return messges.
    $this->drush('staffing-figures-api:generate:workplaces');
    $this->drush('staffing-figures-api:generate:file');
    $this->drush('staffing-figures-api:generate:file', [2020, 2, 1]);
    $this->drush('staffing-figures-api:generate:merged', [1]);
  }

}