$data * The contents of recipe.yml. If passed as an array, will be encoded to * YAML. * @param string|null $machine_name * The machine name for the recipe. Will be used as the directory name. * * @return \Drupal\Core\Recipe\Recipe * The recipe object. */ protected function createRecipe(string|array $data, ?string $machine_name = NULL): Recipe { if (is_array($data)) { $data = Yaml::encode($data); } $recipes_dir = $this->siteDirectory . '/recipes'; if ($machine_name === NULL) { $dir = uniqid($recipes_dir . '/'); } else { $dir = $recipes_dir . '/' . $machine_name; } mkdir($dir, recursive: TRUE); file_put_contents($dir . '/recipe.yml', $data); return Recipe::createFromDirectory($dir); } /** * Applies a recipe to the site. * * @param string $path * The path of the recipe to apply. Must be a directory. * @param int $expected_exit_code * The expected exit code of the `dr recipe` process. Defaults to 0, * which indicates that no error occurred. * @param string[] $options * (optional) Additional options to pass to the `dr recipe` command. * @param string $command * (optional) The name of the command to run. Defaults to `recipe`. * * @return \Symfony\Component\Process\Process * The `dr recipe` command process, after having run. */ protected function applyRecipe(string $path, int $expected_exit_code = 0, array $options = [], string $command = 'recipe'): Process { $process = $this->runDrupalCommand([ $command, // Never apply recipes interactively. '--no-interaction', ...$options, $path, ]); $this->assertSame($expected_exit_code, $process->getExitCode(), sprintf("Process exit code mismatch.\nExpected: %d\nActual: %d\n\nSTDOUT:\n%s\n\nSTDERR:\n%s", $expected_exit_code, $process->getExitCode(), $process->getOutput(), $process->getErrorOutput())); // Applying a recipe: // - creates new checkpoints, hence the "state" service in the test runner // is outdated // - may install modules, which would cause the entire container in the test // runner to be outdated. // Hence the entire environment must be rebuilt for assertions to target the // actual post-recipe-application result. // @see \Drupal\Core\Config\Checkpoint\LinearHistory::__construct() assert($this instanceof BrowserTestBase); $this->rebuildAll(); return $process; } /** * Runs the `core/scripts/dr` script with the given arguments. * * @param array $arguments * The arguments and options to pass to the script. * @param int $timeout * (optional) How long the command should run before timing out, in seconds. * Defaults to 500. * * @return \Symfony\Component\Process\Process * The started process. */ protected function runDrupalCommand(array $arguments, int $timeout = 500): Process { assert($this instanceof BrowserTestBase); // `dr` must be run from the project root. ['install_path' => $project_root] = InstalledVersions::getRootPackage(); array_unshift($arguments, (new PhpExecutableFinder())->find(), static::binDir() . '/dr'); $process = (new Process($arguments)) ->setWorkingDirectory($project_root) ->setEnv([ 'DRUPAL_DEV_SITE_PATH' => $this->siteDirectory, // Ensure that the command boots Drupal into a state where it knows it's // a test site. // @see drupal_valid_test_ua() 'HTTP_USER_AGENT' => drupal_generate_test_ua($this->databasePrefix), ]) ->setTimeout($timeout); $process->run(); return $process; } /** * Alters an existing recipe. * * @param string $path * The recipe directory path. * @param callable $alter * A function that will receive the decoded contents of recipe.yml as an * array. This should returned a modified array to be written to recipe.yml. */ protected function alterRecipe(string $path, callable $alter): void { $file = $path . '/recipe.yml'; $this->assertFileExists($file); $contents = file_get_contents($file); $contents = Yaml::decode($contents); $contents = $alter($contents); file_put_contents($file, Yaml::encode($contents)); } }