SDK-5690: Cleanup integration.lock and add it into .gitignore

spryker-sdk · Dec 13, 2023 · 9ea3594 · 9ea3594
1 parent 322cd1a
commit 9ea3594
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 15 deletions.
diff --git a/src/Console/IntegratorLockUpdaterConsole.php b/src/Console/IntegratorLockUpdaterConsole.php
@@ -40,14 +40,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $commandArgumentsTransfer = $this->buildCommandArgumentsTransfer($input);
         $io = $this->createInputOutputAdapter($input, $output, $commandArgumentsTransfer->getFormat());
+        $this->getFacade()
+            ->runCleanLock($io);
+
         $this->getFacade()->runUpdateLock(
             $io,
             $commandArgumentsTransfer,
         );
 
-        $this->getFacade()
-            ->runCleanLock($io);
-
         return 0;
     }
 }
diff --git a/src/IntegratorConfig.php b/src/IntegratorConfig.php
@@ -15,6 +15,11 @@
 
 class IntegratorConfig
 {
+    /**
+     * @var string
+     */
+    public const INTEGRATOR_LOCK = 'integrator.lock';
+
     /**
      * @var string
      */
@@ -366,7 +371,7 @@ protected function getDefaultConfigPath(): string
      */
     public function getIntegratorLockFilePath(): string
     {
-        return $this->getProjectRootDirectory() . 'integrator.lock';
+        return $this->getProjectRootDirectory() . static::INTEGRATOR_LOCK;
     }
 
     /**

diff --git a/src/IntegratorLock/IntegratorLockCleaner.php b/src/IntegratorLock/IntegratorLockCleaner.php
@@ -14,6 +14,11 @@
 
 class IntegratorLockCleaner implements IntegratorLockCleanerInterface
 {
+    /**
+     * @var string
+     */
+    protected const GITIGNORE_FILE = '.gitignore';
+
     /**
      * @var \SprykerSdk\Integrator\IntegratorConfig
      */
@@ -41,25 +46,27 @@ public function deleteLock(): void
     {
         $lockFilePath = $this->config->getIntegratorLockFilePath();
 
-        unlink($lockFilePath);
-
-        if (!$this->isLockFileChangeTrackedByGit($lockFilePath)) {
+        if ($this->isLockFileIgnoredByGit($lockFilePath)) {
             return;
         }
+        if (file_exists($lockFilePath)) {
+            unlink($lockFilePath);
+        }
 
+        $this->processExecutor->execute([sprintf('echo %s >> %s', $this->config::INTEGRATOR_LOCK, static::GITIGNORE_FILE)]);
         $this->processExecutor->execute(['git', 'add', $lockFilePath]);
-        $this->processExecutor->execute(['git', 'commit', '-m', 'Removed `integrator.lock` file.']);
+        $this->processExecutor->execute(['git', 'commit', '-m', sprintf('Removed `%s` file.', $this->config::INTEGRATOR_LOCK)]);
     }
 
     /**
      * @param string $filepath
      *
      * @return bool
      */
-    protected function isLockFileChangeTrackedByGit(string $filepath): bool
+    protected function isLockFileIgnoredByGit(string $filepath): bool
     {
-        $process = $this->processExecutor->execute(['git', 'status', '--porcelain', $filepath]);
+        $process = $this->processExecutor->execute(['git', 'check-ignore', $filepath]);
 
-        return $process->getOutput() !== '';
+        return !$process->getOutput();
     }
 }
diff --git a/tests/SprykerSdkTest/Integrator/IntegratorLock/IntegratorLockTest.php b/tests/SprykerSdkTest/Integrator/IntegratorLock/IntegratorLockTest.php
@@ -15,6 +15,7 @@
 use SprykerSdk\Integrator\IntegratorLock\IntegratorLockReader;
 use SprykerSdk\Integrator\IntegratorLock\IntegratorLockWriter;
 use SprykerSdkTest\Integrator\BaseTestCase;
+use Symfony\Component\Process\Process;
 
 class IntegratorLockTest extends BaseTestCase
 {
@@ -34,7 +35,8 @@ public function testWriteFileLock(): void
                 ],
             ],
         ];
-        $tmpIntegratorLockFilePath = tempnam(sys_get_temp_dir(), 'integrator.lock.');
+        $tmpIntegratorLockFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . IntegratorConfig::INTEGRATOR_LOCK;
+        touch($tmpIntegratorLockFilePath);
 
         $integratorLockWriter = $this->createIntegratorLockWriter($tmpIntegratorLockFilePath);
         $integratorLockWriter->storeLock($lockData);
@@ -52,7 +54,8 @@ public function testWriteFileLock(): void
      */
     public function testReadFileLock(): void
     {
-        $tmpIntegratorLockFilePath = tempnam(sys_get_temp_dir(), 'integrator.lock.');
+        $tmpIntegratorLockFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . IntegratorConfig::INTEGRATOR_LOCK;
+        touch($tmpIntegratorLockFilePath);
         $compareFilePath = ROOT_TESTS . '/_data/composer/spryker_lock_test_write_lock.json';
 
         file_put_contents($tmpIntegratorLockFilePath, file_get_contents($compareFilePath));
@@ -71,7 +74,8 @@ public function testReadFileLock(): void
      */
     public function testDeleteFileLock(): void
     {
-        $tmpIntegratorLockFilePath = tempnam(sys_get_temp_dir(), 'integrator.lock.');
+        $tmpIntegratorLockFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . IntegratorConfig::INTEGRATOR_LOCK;
+        touch($tmpIntegratorLockFilePath);
         $compareFilePath = ROOT_TESTS . '/_data/composer/spryker_lock_test_write_lock.json';
 
         file_put_contents($tmpIntegratorLockFilePath, file_get_contents($compareFilePath));
@@ -109,7 +113,13 @@ private function createIntegratorLockReader(string $tmpIntegratorLockFilePath):
      */
     private function createIntegratorLockCleaner(string $tmpIntegratorLockFilePath): IntegratorLockCleaner
     {
-        return new IntegratorLockCleaner($this->mockIntegratorConfig($tmpIntegratorLockFilePath), new ProcessExecutor());
+        $processMock = $this->createMock(Process::class);
+        $processMock->method('getOutput')->willReturn(IntegratorConfig::INTEGRATOR_LOCK);
+
+        $processExecutorMock = $this->createMock(ProcessExecutor::class);
+        $processExecutorMock->method('execute')->willReturn($processMock);
+
+        return new IntegratorLockCleaner($this->mockIntegratorConfig($tmpIntegratorLockFilePath), $processExecutorMock);
     }
 
     /**