Composer exit on patch failure (acquia#411)

* Initial commit

* Fix tests

* Minor fixes

* Update src/Domain/Fixture/FixtureCreator.php

Co-authored-by: Travis Carden <[email protected]>

---------

Co-authored-by: Travis Carden <[email protected]>

bin/ci/_includes.sh

@@ -123,6 +123,7 @@ allowed_failures=(
 )
 if [[ " ${allowed_failures[*]} " =~ " ${ORCA_JOB} " ]]; then
   set +e
+  export ORCA_IS_ALLOWED_FAILURE="TRUE"
   notice "This job is allowed to fail and will report as passing regardless of outcome."
 fi
 

config/services.yml

@@ -13,6 +13,7 @@ parameters:
   env(ORCA_PACKAGES_CONFIG_ALTER): ~
   env(ORCA_PHPCS_STANDARD): "AcquiaDrupalTransitional"
   env(ORCA_TELEMETRY_ENABLE): "false"
+  env(ORCA_IS_ALLOWED_FAILURE): "%env(ORCA_IS_ALLOWED_FAILURE)%"
 
 services:
 

src/Domain/Composer/ComposerFacade.php

@@ -261,6 +261,22 @@ private function runComposer(array $command, array $args = [], string $cwd = NUL
     $this->processRunner->runExecutable('composer', $command, $cwd);
   }
 
+  /**
+   * Set config to root composer.json.
+   *
+   * @param array $config
+   *   A list of config elements to be removed, e.g., "platform".
+   */
+  public function setConfig(array $config): void {
+    if (empty($config)) {
+      throw new \InvalidArgumentException('No config provided to remove.');
+    }
+
+    $this->runComposer([
+      'config',
+    ], $config);
+  }
+
   /**
    * Validates a composer.json.
    *

src/Domain/Fixture/FixtureCreator.php

@@ -11,6 +11,7 @@
 use Acquia\Orca\Domain\Package\Package;
 use Acquia\Orca\Domain\Package\PackageManager;
 use Acquia\Orca\Exception\OrcaException;
+use Acquia\Orca\Helper\EnvFacade;
 use Acquia\Orca\Helper\Filesystem\FixturePathHandler;
 use Acquia\Orca\Helper\Process\ProcessRunner;
 use Acquia\Orca\Options\FixtureOptions;
@@ -135,6 +136,13 @@ class FixtureCreator {
    */
   private $fixtureCustomizer;
 
+  /**
+   * The environment facade.
+   *
+   * @var \Acquia\Orca\Helper\EnvFacade
+   */
+  private EnvFacade $env;
+
   /**
    * Constructs an instance.
    *
@@ -168,8 +176,26 @@ class FixtureCreator {
    *   The version finder.
    * @param \Acquia\Orca\Domain\Fixture\FixtureCustomizer $fixtureCustomizer
    *   The fixture customizer.
-   */
-  public function __construct(CloudHooksInstaller $cloud_hooks_installer, CodebaseCreator $codebase_creator, ComposerFacade $composer, ComposerJsonHelper $composer_json_helper, DrupalSettingsHelper $drupal_settings_helper, FixturePathHandler $fixture_path_handler, FixtureInspector $fixture_inspector, GitFacade $git, SiteInstaller $site_installer, SymfonyStyle $output, ProcessRunner $process_runner, PackageManager $package_manager, SubextensionManager $subextension_manager, VersionFinder $version_finder, FixtureCustomizer $fixtureCustomizer) {
+   * @param \Acquia\Orca\Helper\EnvFacade $env
+   *   The environment facade.
+   */
+  public function __construct(CloudHooksInstaller $cloud_hooks_installer,
+    CodebaseCreator $codebase_creator,
+    ComposerFacade $composer,
+    ComposerJsonHelper $composer_json_helper,
+    DrupalSettingsHelper $drupal_settings_helper,
+    FixturePathHandler $fixture_path_handler,
+    FixtureInspector $fixture_inspector,
+    GitFacade $git,
+    SiteInstaller $site_installer,
+    SymfonyStyle $output,
+    ProcessRunner $process_runner,
+    PackageManager $package_manager,
+    SubextensionManager $subextension_manager,
+    VersionFinder $version_finder,
+    FixtureCustomizer $fixtureCustomizer,
+    EnvFacade $env
+  ) {
     $this->cloudHooksInstaller = $cloud_hooks_installer;
     $this->codebaseCreator = $codebase_creator;
     $this->composer = $composer;
@@ -185,6 +211,7 @@ public function __construct(CloudHooksInstaller $cloud_hooks_installer, Codebase
     $this->subextensionManager = $subextension_manager;
     $this->versionFinder = $version_finder;
     $this->fixtureCustomizer = $fixtureCustomizer;
+    $this->env = $env;
   }
 
   /**
@@ -199,6 +226,7 @@ public function __construct(CloudHooksInstaller $cloud_hooks_installer, Codebase
   public function create(FixtureOptions $options): void {
     $this->options = $options;
     $this->createComposerProject();
+    $this->configureComposerExitOnPatchFailure();
     $this->removeComposerConfigPlatform();
     $this->fixDefaultDependencies();
     $this->addAllowedComposerPlugins();
@@ -222,6 +250,27 @@ private function createComposerProject(): void {
     $this->codebaseCreator->create($this->options);
   }
 
+  /**
+   * Configures composer "composer-exit-on-patch-failure" parameter.
+   */
+  private function configureComposerExitOnPatchFailure(): void {
+    if (!$this->env->get('ORCA_IS_ALLOWED_FAILURE')) {
+      return;
+    }
+
+    $this->output->section("Setting composer-exit-on-patch-failure to false.");
+    try {
+      $this->composer->setConfig([
+        'extra.composer-exit-on-patch-failure',
+        'false',
+        '--json',
+      ]);
+    }
+    catch (\Exception $e) {
+      $this->output->writeln("Failed to set composer-exit-on-patch-failure.");
+    }
+  }
+
   /**
    * Remove "config.platform" parameter from fixture root composer.json.
    */
@@ -411,7 +460,7 @@ private function shouldSymlinkNonSut(Package $package): bool {
    */
   private function addAssetPackagistPathRepositories(): void {
     $this->composerJsonHelper->addRepository(
-     'asset-packagist',
+      'asset-packagist',
       'composer',
       'https://asset-packagist.org'
     );
@@ -571,7 +620,6 @@ private function verifySut(): void {
    * Add packages defined in "allow-plugins" config of SUT to root composer.
    */
   private function addSutAllowedPluginsToRootComposer(): void {
-
     $this->output->section("Adding Allowed Plugins from SUT");
 
     $package = $this->options->getSut();

tests/Domain/Fixture/FixtureCreatorTest.php

@@ -15,6 +15,7 @@
 use Acquia\Orca\Domain\Fixture\SubextensionManager;
 use Acquia\Orca\Domain\Git\GitFacade;
 use Acquia\Orca\Domain\Package\PackageManager;
+use Acquia\Orca\Helper\EnvFacade;
 use Acquia\Orca\Helper\Filesystem\FixturePathHandler;
 use Acquia\Orca\Helper\Filesystem\OrcaPathHandler;
 use Acquia\Orca\Helper\Process\ProcessRunner;
@@ -58,6 +59,7 @@ protected function setUp(): void {
     $this->versionFinder = $this->prophesize(VersionFinder::class);
     $this->output = $this->prophesize(SymfonyStyle::class);
     $this->customizer = $this->prophesize(FixtureCustomizer::class);
+    $this->envFacade = $this->prophesize(EnvFacade::class);
   }
 
   private function createFixtureCreator(): FixtureCreator {
@@ -76,6 +78,7 @@ private function createFixtureCreator(): FixtureCreator {
     $subextension_manager = $this->subextensionManager->reveal();
     $version_finder = $this->versionFinder->reveal();
     $customizer = $this->customizer->reveal();
+    $env = $this->envFacade->reveal();
     return new FixtureCreator(
         $cloud_hooks_installer,
         $codebase_creator,
@@ -91,7 +94,8 @@ private function createFixtureCreator(): FixtureCreator {
         $package_manager,
         $subextension_manager,
         $version_finder,
-        $customizer
+        $customizer,
+        $env
     );
   }