Add InlineComment sniff

.gitignore

@@ -19,3 +19,5 @@ drupal
 cx-api-spec
 gardener
 
+// Artifacts from mutation testing
+*.cache

phpcs.xml.dist

@@ -24,6 +24,7 @@
 
   <rule ref="AcquiaPHP" />
 
+  <rule ref="Drupal.Commenting.InlineComment"/>
   <rule ref="SlevomatCodingStandard.Arrays.AlphabeticallySortedByKeys" />
   <rule ref="SlevomatCodingStandard.Arrays.DisallowImplicitArrayCreation"/>
   <rule ref="SlevomatCodingStandard.Arrays.MultiLineArrayEndBracketPlacement"/>

src/Command/Api/ApiCommandHelper.php

@@ -277,7 +277,7 @@ private function getParameterSchemaFromSpec(string $paramKey, array $acquiaCloud
     return $acquiaCloudSpec['components']['schemas'][$paramKey];
   }
 
-  /** @infection-ignore-all */
+  // @infection-ignore-all
   private function isApiSpecChecksumCacheValid(\Symfony\Component\Cache\CacheItem $cacheItem, string $acquiaCloudSpecFileChecksum): bool {
     // If the spec file doesn't exist, assume cache is valid.
     if (!$acquiaCloudSpecFileChecksum && $cacheItem->isHit()) {
@@ -296,7 +296,7 @@ private function isApiSpecChecksumCacheValid(\Symfony\Component\Cache\CacheItem
   private function getCloudApiSpec(string $specFilePath): array {
     $cacheKey = basename($specFilePath);
     $cache = new PhpArrayAdapter(__DIR__ . '/../../../var/cache/' . $cacheKey . '.cache', new NullAdapter());
-    /** @infection-ignore-all */
+    // @infection-ignore-all
     $cacheItemChecksum = $cache->getItem($cacheKey . '.checksum');
     $cacheItemSpec = $cache->getItem($cacheKey);
 
@@ -307,7 +307,7 @@ private function getCloudApiSpec(string $specFilePath): array {
 
     // Otherwise, only use cache when it is valid.
     $checksum = md5_file($specFilePath);
-    /** @infection-ignore-all */
+    // @infection-ignore-all
     if ($this->useCloudApiSpecCache()
       && $this->isApiSpecChecksumCacheValid($cacheItemChecksum, $checksum) && $cacheItemSpec->isHit()
     ) {
@@ -333,7 +333,7 @@ private function generateApiCommandsFromSpec(array $acquiaCloudSpec, string $com
     $apiCommands = [];
     foreach ($acquiaCloudSpec['paths'] as $path => $endpoint) {
       // Skip internal endpoints. These shouldn't actually be in the spec.
-      /** @infection-ignore-all */
+      // @infection-ignore-all
       if (array_key_exists('x-internal', $endpoint) && $endpoint['x-internal']) {
         continue;
       }
@@ -348,7 +348,7 @@ private function generateApiCommandsFromSpec(array $acquiaCloudSpec, string $com
         }
 
         // Skip deprecated endpoints.
-        /** @infection-ignore-all */
+        // @infection-ignore-all
         if (array_key_exists('deprecated', $schema) && $schema['deprecated']) {
           continue;
         }

src/Command/CodeStudio/CodeStudioCiCdVariables.php

@@ -10,7 +10,7 @@ class CodeStudioCiCdVariables {
    * @return array<mixed>
    */
   public static function getList(): array {
-    //getlist is being utilised in pipeline-migrate command. By default command is supporting drupal project but going forward need to support both drupal and nodejs project.
+    // Getlist is being utilised in pipeline-migrate command. By default command is supporting drupal project but going forward need to support both drupal and nodejs project.
     return array_column(self::getDefaultsForPhp(), 'key');
   }
 

src/Command/CodeStudio/CodeStudioCommandTrait.php

@@ -178,7 +178,6 @@ private function determineGitLabProject(ApplicationResponse $cloudApplication):
       );
     }
     // Prompt to create project.
-
     $this->io->writeln([
       "",
       "Could not find any existing Code Studio project for Acquia Cloud Platform application <comment>{$cloudApplication->name}</comment>.",
@@ -189,7 +188,6 @@ private function determineGitLabProject(ApplicationResponse $cloudApplication):
       return $this->createGitLabProject($cloudApplication);
     }
     // Prompt to choose from full list, regardless of description.
-
     return $this->promptChooseFromObjectsOrArrays(
       $this->gitLabClient->projects()->all(),
       'id',

src/Command/CodeStudio/CodeStudioPipelinesMigrateCommand.php

@@ -52,7 +52,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     $cloudApplication = $this->getCloudApplication($cloudApplicationUuid);
     $project = $this->determineGitLabProject($cloudApplication);
 
-    // Migrate acquia-pipeline file
+    // Migrate acquia-pipeline file.
     $this->checkGitLabCiCdVariables($project);
     $this->validateCwdIsValidDrupalProject();
     $acquiaPipelinesFileDetails = $this->getAcquiaPipelinesFileContents($project);

src/Command/CodeStudio/CodeStudioWizardCommand.php

@@ -80,15 +80,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
       $account,
       [
         "deploy to non-prod",
-        # Add SSH key to git repository
+        // Add SSH key to git repository.
         "add ssh key to git",
-        # Add SSH key to non-production environments
+        // Add SSH key to non-production environments.
         "add ssh key to non-prod",
-        # Add a CD environment
+        // Add a CD environment.
         "add an environment",
-        # Delete a CD environment
+        // Delete a CD environment.
         "delete an environment",
-        # Manage environment variables on a non-production environment
+        // Manage environment variables on a non-production environment.
         "administer environment variables on non-prod",
       ]
     );
@@ -255,7 +255,7 @@ private function createScheduledPipeline(array $project): void {
     if (!$this->getGitLabScheduleByDescription($project, $scheduledPipelineDescription)) {
       $this->checklist->addItem("Creating scheduled pipeline <comment>$scheduledPipelineDescription</comment>");
       $pipeline = $this->gitLabClient->schedules()->create($project['id'], [
-        # Every Thursday at midnight.
+        // Every Thursday at midnight.
         'cron' => '0 0 * * 4',
         'description' => $scheduledPipelineDescription,
         'ref' => $project['default_branch'],

src/Command/CommandBase.php

@@ -590,7 +590,7 @@ protected function determineEnvironment(InputInterface $input, OutputInterface $
     return $chosenEnvironment;
   }
 
-  // Todo: obviously combine this with promptChooseEnvironment
+  // Todo: obviously combine this with promptChooseEnvironment.
   private function promptChooseEnvironmentConsiderProd(Client $acquiaCloudClient, string $applicationUuid, bool $allowProduction = FALSE): EnvironmentResponse {
     $environmentResource = new Environments($acquiaCloudClient);
     $applicationEnvironments = iterator_to_array($environmentResource->getAll($applicationUuid));
@@ -1749,7 +1749,7 @@ protected function waitForNotificationToComplete(Client $acquiaCloudClient, stri
     $notification = NULL;
     $checkNotificationStatus = static function () use ($notificationsResource, &$notification, $uuid): bool {
       $notification = $notificationsResource->get($uuid);
-      /** @infection-ignore-all */
+      // @infection-ignore-all
       return $notification->status !== 'in-progress';
     };
     if ($success === NULL) {

src/Command/DocsCommand.php

@@ -100,7 +100,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     if ($acquiaProductName = $input->getArgument('product')) {
       $productUrl = NULL;
       foreach ($acquiaProducts as $acquiaProduct) {
-        // If product provided by the user exists in the alias
+        // If product provided by the user exists in the alias.
         if (in_array(strtolower($acquiaProductName), $acquiaProduct['alias'], TRUE)) {
           $productUrl = $acquiaProduct['url'];
           break;

src/Command/Email/ConfigurePlatformEmailCommand.php

@@ -305,7 +305,7 @@ private function checkIfDomainVerified(
         return TRUE;
       }
 
-      /** @infection-ignore-all */
+      // @infection-ignore-all
       if (isset($response->health) && str_starts_with($response->health->code, "4")) {
         $this->io->error($response->health->details);
         if ($this->io->confirm('Would you like to refresh?')) {

src/Command/Email/EmailInfoForSubscriptionCommand.php

@@ -68,13 +68,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
    */
   private function writeDomainsToTables(OutputInterface $output, SubscriptionResponse $subscription, array $domainList): void {
 
-    // initialize tables to be displayed in console
+    // Initialize tables to be displayed in console.
     $allDomainsTable = $this->createTotalDomainTable($output, "Subscription $subscription->name - All Domains");
     $verifiedDomainsTable = $this->createDomainStatusTable($output, "Subscription $subscription->name - Verified Domains");
     $pendingDomainsTable = $this->createDomainStatusTable($output, "Subscription $subscription->name - Pending Domains");
     $failedDomainsTable = $this->createDomainStatusTable($output, "Subscription $subscription->name - Failed Domains");
 
-    // initialize csv writers for each file
+    // Initialize csv writers for each file.
     $writerAllDomains = Writer::createFromPath("./subscription-$subscription->uuid-domains/all-domains-summary.csv", 'w+');
     $writerVerifiedDomains = Writer::createFromPath("./subscription-$subscription->uuid-domains/verified-domains-summary.csv", 'w+');
     $writerPendingDomains = Writer::createFromPath("./subscription-$subscription->uuid-domains/pending-domains-summary.csv", 'w+');

src/Command/Ide/IdeCreateCommand.php

@@ -105,7 +105,7 @@ private function waitForDnsPropagation(string $ideUrl): int {
       // @see https://stackoverflow.com/questions/28277889/guzzlehttp-client-change-base-url-dynamically
       $response = $this->httpClient->request('GET', "$ideUrl/health");
       // Mutating this will result in an infinite loop and timeout.
-      /** @infection-ignore-all */
+      // @infection-ignore-all
       if ($response->getStatusCode() === 200) {
         $ideCreated = TRUE;
       }

src/Command/Ide/Wizard/IdeWizardCreateSshKeyCommand.php

@@ -34,9 +34,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
       self::getThisCloudIdeCloudAppUuid(),
       $account,
       [
-        # Add SSH key to git repository
+        // Add SSH key to git repository.
         "add ssh key to git",
-        # Add SSH key to non-production environments
+        // Add SSH key to non-production environments.
         "add ssh key to non-prod",
       ]
     );

src/Command/Remote/DrushCommand.php

@@ -32,9 +32,9 @@ protected function execute(InputInterface $input, OutputInterface $output): ?int
     $alias = self::getEnvironmentAlias($environment);
     $acliArguments = $input->getArguments();
     $drushArguments = (array) $acliArguments['drush_command'];
-    // When available, provide the default domain to drush
+    // When available, provide the default domain to drush.
     if (!empty($environment->default_domain)) {
-      // Insert at the beginning so a user-supplied --uri arg will override
+      // Insert at the beginning so a user-supplied --uri arg will override.
       array_unshift($drushArguments, "--uri=http://{$environment->default_domain}");
     }
     $drushCommandArguments = [

src/Helpers/LoopHelper.php

@@ -23,14 +23,14 @@ public static function getLoopy(OutputInterface $output, SymfonyStyle $io, Logge
     $spinner->start();
 
     $cancelTimers = static function () use (&$timers, $spinner): void {
-      /** @infection-ignore-all */
+      // @infection-ignore-all
       array_map('\React\EventLoop\Loop::cancelTimer', $timers);
       $timers = [];
       $spinner->finish();
     };
     $periodicCallback = static function () use ($logger, $statusCallback, $doneCallback, $cancelTimers): void {
       try {
-        /** @infection-ignore-all */
+        // @infection-ignore-all
         if ($statusCallback()) {
           $cancelTimers();
           $doneCallback();

src/Helpers/TelemetryHelper.php

@@ -64,7 +64,7 @@ public function initializeBugsnag(): void {
       if (str_contains($context, 'acli ')) {
         $context = substr($context, strpos($context, 'acli ') + 5);
       }
-      // Strip sensitive parameters from context
+      // Strip sensitive parameters from context.
       if (str_contains($context, "--password")) {
         $context = substr($context, 0, strpos($context, "--password") + 10) . 'REDACTED';
       }

tests/phpunit/src/Commands/Acsf/AcsfApiCommandTest.php

@@ -43,12 +43,11 @@ public function testAcsfCommandExecutionForHttpPostWithMultipleDataTypes(): void
     $this->executeCommand([
       'uids' => '1,2,3',
     ], [
-      // group_id
+      // group_id.
       '1',
     ]);
 
     // Assert.
-
     $output = $this->getDisplay();
   }
 
@@ -58,12 +57,11 @@ public function testAcsfCommandExecutionBool(): void {
     $this->clientProphecy->addOption('json', ["pause" => TRUE])->shouldBeCalled();
     $this->command = $this->getApiCommandByName('acsf:updates:pause');
     $this->executeCommand([], [
-      // pause
+      // Pause.
       '1',
     ]);
 
     // Assert.
-
   }
 
   public function testAcsfCommandExecutionForHttpGet(): void {
@@ -76,7 +74,6 @@ public function testAcsfCommandExecutionForHttpGet(): void {
     $this->executeCommand(['--limit' => '1']);
 
     // Assert.
-
     $output = $this->getDisplay();
     $this->assertNotNull($output);
     $this->assertJson($output);
@@ -111,7 +108,6 @@ public function testAcsfCommandExecutionForHttpGetMultiple(string $method, strin
     $this->executeCommand($arguments);
 
     // Assert.
-
     $output = $this->getDisplay();
     $this->assertNotNull($output);
     $this->assertJson($output);

tests/phpunit/src/Commands/Acsf/AcsfAuthLoginCommandTest.php

@@ -31,13 +31,13 @@ public function providerTestAuthLoginCommand(): array {
         FALSE,
         // $inputs
         [
-          // Would you like to share anonymous performance usage and data? (yes/no) [yes]
+          // Would you like to share anonymous performance usage and data? (yes/no) [yes].
           'yes',
-          // Enter the full URL of the factory
+          // Enter the full URL of the factory.
           $this->acsfCurrentFactoryUrl,
-          // Enter a value for username
+          // Enter a value for username.
           $this->acsfUsername,
-          //  Enter a value for key
+          // Enter a value for key.
           $this->acsfKey,
         ],
         // No arguments, all interactive.
@@ -53,11 +53,11 @@ public function providerTestAuthLoginCommand(): array {
         [],
         // Arguments.
         [
-          // Enter the full URL of the factory
+          // Enter the full URL of the factory.
           '--factory-url' => $this->acsfCurrentFactoryUrl,
-          //  Enter a value for key
+          // Enter a value for key.
           '--key' => $this->acsfKey,
-          // Enter a value for username
+          // Enter a value for username.
           '--username' => $this->acsfUsername,
         ],
         // Output to assert.

tests/phpunit/src/Commands/Acsf/AcsfAuthLogoutCommandTest.php

@@ -38,7 +38,7 @@ public function providerTestAuthLogoutCommand(): array {
         TRUE,
         // $inputs
         [
-          // Choose a Factory to logout of
+          // Choose a Factory to logout of.
           0,
         ],
         // $config.

tests/phpunit/src/Commands/Api/ApiCommandTest.php

@@ -97,7 +97,6 @@ public function testApiCommandErrorResponse(): void {
     ]);
 
     // Assert.
-
     $output = $this->getDisplay();
     $this->assertJson($output);
     $this->assertStringContainsString($mockBody->message, $output);
@@ -114,7 +113,6 @@ public function testApiCommandExecutionForHttpGet(): void {
     $this->executeCommand(['--limit' => '1']);
 
     // Assert.
-
     $output = $this->getDisplay();
     $this->assertNotNull($output);
     $this->assertJson($output);
@@ -151,7 +149,6 @@ public function testInferApplicationUuidArgument(): void {
     ]);
 
     // Assert.
-
     $output = $this->getDisplay();
     $this->assertStringContainsString('Inferring Cloud Application UUID for this command since none was provided...', $output);
     $this->assertStringContainsString('Set application uuid to ' . $application->uuid, $output);
@@ -201,7 +198,6 @@ public function testConvertApplicationAliasToUuidArgument(bool $support): void {
     ]);
 
     // Assert.
-
     $this->getDisplay();
     $this->assertEquals(0, $this->getStatusCode());
   }
@@ -273,7 +269,6 @@ public function testConvertEnvironmentAliasToUuidArgument(): void {
     ]);
 
     // Assert.
-
     $this->getDisplay();
     $this->assertEquals(0, $this->getStatusCode());
   }
@@ -306,7 +301,6 @@ public function testApiCommandExecutionForHttpPost(): void {
     $this->executeCommand($mockRequestArgs);
 
     // Assert.
-
     $output = $this->getDisplay();
     $this->assertNotNull($output);
     $this->assertJson($output);
@@ -334,7 +328,6 @@ public function testApiCommandExecutionForHttpPut(): void {
     $this->executeCommand($args);
 
     // Assert.
-
     $output = $this->getDisplay();
     $this->assertNotNull($output);
     $this->assertJson($output);

tests/phpunit/src/Commands/App/AppVcsInfoTest.php

@@ -103,7 +103,7 @@ public function testNoDeployedVcs(): void {
     $application = $this->mockRequest('getApplicationByUuid', $applications[self::$INPUT_DEFAULT_CHOICE]->uuid);
     $environments = $this->mockRequest('getApplicationEnvironments', $applications[self::$INPUT_DEFAULT_CHOICE]->uuid);
     foreach ($environments as $environment) {
-      // Empty the VCS
+      // Empty the VCS.
       $environment->vcs = new \stdClass();
     }