11608 Fix Intermittent PHPUnit Fails (#3863)

modules/datastore/modules/datastore_mysql_import/datastore_mysql_import.info.yml

@@ -5,4 +5,5 @@ core_version_requirement: ^9.1
 package: DKAN
 dependencies:
   - common
+  - datastore
   - metastore

modules/datastore/src/Service/Factory/Import.php

@@ -8,8 +8,6 @@
 
 /**
  * Create an importer object for a given resource.
- *
- * @codeCoverageIgnore
  */
 class Import implements ImportFactoryInterface {
 

modules/datastore/src/Service/ResourcePurger.php

@@ -7,6 +7,7 @@
 
 use Drupal\common\LoggerTrait;
 use Drupal\common\DataResource;
+use Drupal\Core\Entity\EntityPublishedInterface;
 use Drupal\datastore\Service;
 use Drupal\metastore\ReferenceLookupInterface;
 use Drupal\metastore\Storage\DataFactory;
@@ -207,7 +208,7 @@ private function purge(int $vid, string $uuid, bool $prior) {
 
     foreach (array_diff($purge, $keep) as $idAndVersion) {
       // $idAndVersion is a json encoded array with resource's id and version.
-      list($id, $version) = json_decode($idAndVersion);
+      [$id, $version] = json_decode($idAndVersion);
       $this->delete($id, $version);
     }
   }
@@ -230,7 +231,7 @@ private function getResourcesToPurge(int $initialVid, NodeInterface $node, bool
     $purge = [];
 
     foreach ($this->getOlderRevisionIds($initialVid, $node) as $vid) {
-      list($published, $resource) = $this->getRevisionData($vid);
+      [$published, $resource] = $this->getRevisionData($vid);
       $purge = array_merge($purge, $resource);
       $publishedCount = $published ? $publishedCount + 1 : $publishedCount;
       if (!$prior && $publishedCount >= 2) {
@@ -315,8 +316,12 @@ private function getResourcesToKeep(string $uuid) : array {
    */
   private function getRevisionData(string $vid) : array {
     $revision = $this->storage->getEntityStorage()->loadRevision($vid);
+    $published = FALSE;
+    if ($revision instanceof EntityPublishedInterface) {
+      $published = $revision->isPublished();
+    }
     return [
-      $revision->status->value ?? FALSE,
+      $published,
       $this->getResources($revision),
     ];
   }

modules/datastore/tests/src/Functional/DictionaryEnforcerTest.php

@@ -6,6 +6,7 @@
 
 use Drupal\datastore\Controller\ImportController;
 use Drupal\metastore\DataDictionary\DataDictionaryDiscovery;
+use Drupal\Tests\common\Traits\CleanUp;
 use Drupal\Tests\common\Traits\GetDataTrait;
 use Drupal\Tests\metastore\Unit\ServiceTest;
 
@@ -20,7 +21,7 @@
  */
 class DictionaryEnforcerTest extends ExistingSiteBase {
 
-  use GetDataTrait;
+  use GetDataTrait, CleanUp;
 
   /**
    * Uploaded resource file destination.
@@ -85,6 +86,13 @@ class DictionaryEnforcerTest extends ExistingSiteBase {
    */
   protected $webServiceApi;
 
+  /**
+   * External URL for the fixture CSV file.
+   *
+   * @var string
+   */
+  protected $resourceUrl;
+
   /**
    * {@inheritdoc}
    */
@@ -100,16 +108,22 @@ public function setUp(): void {
     $this->datasetStorage = \Drupal::service('dkan.metastore.storage')
       ->getInstance('dataset');
     // Copy resource file to uploads directory.
+    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
     $file_system = \Drupal::service('file_system');
     $upload_path = $file_system->realpath(self::UPLOAD_LOCATION);
     $file_system->prepareDirectory($upload_path, FileSystemInterface::CREATE_DIRECTORY);
-    $file_system->copy(self::TEST_DATA_PATH . self::RESOURCE_FILE, $upload_path);
+    $file_system->copy(self::TEST_DATA_PATH . self::RESOURCE_FILE, $upload_path, FileSystemInterface::EXISTS_REPLACE);
     // Create resource URL.
     $this->resourceUrl = \Drupal::service('stream_wrapper_manager')
       ->getViaUri(self::UPLOAD_LOCATION . self::RESOURCE_FILE)
       ->getExternalUrl();
   }
 
+  public function tearDown() {
+    parent::tearDown();
+    $this->removeAllMappedFiles();
+  }
+
   /**
    * Test dictionary enforcement.
    */
@@ -194,6 +208,9 @@ public function testDictionaryEnforcement(): void {
     $response = $this->webServiceApi->summary($dist_id, $request);
     $result = json_decode($response->getContent(), TRUE);
 
+    // Clean up after ourselves, before performing the assertion.
+    $this->metastore->delete('dataset', $dataset_id);
+
     // Validate schema.
     $this->assertEquals([
       'numOfColumns' => 6,

modules/datastore/tests/src/Unit/Controller/QueryDownloadControllerTest.php

@@ -45,6 +45,11 @@ protected function setUp() {
     \Drupal::setContainer($chain->getMock());
   }
 
+  protected function tearDown(): void {
+    parent::tearDown();
+    $this->buffer = NULL;
+  }
+
   /**
    * Helper function to compare output of streaming vs normal query controller.
    */

modules/datastore/tests/src/Unit/Plugin/QueueWorker/ImportJobTest.php

@@ -26,6 +26,11 @@ protected function setUp(): void {
     $this->assertTrue($this->database instanceof DatabaseTableInterface);
   }
 
+  protected function tearDown() {
+    parent::tearDown();
+    $this->database = NULL;
+  }
+
   /**
    *
    */

modules/frontend/tests/src/Unit/Controller/PageTest.php → modules/frontend/tests/src/Unit/Controller/ControllerPageTest.php

@@ -8,7 +8,7 @@
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- *
+ * @coversDefaultClass Drupal\frontend\Controller\Page
  */
 class ControllerPageTest extends TestCase {
 
@@ -17,15 +17,20 @@ class ControllerPageTest extends TestCase {
    *
    * @var int
    */
-  private $cacheMaxAge = 0;
+  private $cacheMaxAge;
+
+  protected function setUp(): void {
+    parent::setUp();
+    $this->cacheMaxAge = 0;
+  }
 
   /**
    * Getter.
    */
   public function getContainer() {
 
     $container = $this->getMockBuilder(ContainerInterface::class)
-      ->setMethods(['get', 'has'])
+      ->onlyMethods(['get', 'has'])
       ->disableOriginalConstructor()
       ->getMockForAbstractClass();
 
@@ -53,22 +58,22 @@ public function containerGet($input) {
       case 'frontend.page':
         $pageBuilder = $this->getMockBuilder(Page::class)
           ->disableOriginalConstructor()
-          ->setMethods(['build'])
+          ->onlyMethods(['build'])
           ->getMock();
         $pageBuilder->method('build')->willReturn("<h1>Hello World!!!</h1>\n");
         return $pageBuilder;
 
-      break;
+        break;
       case 'config.factory':
         $immutableConfig = $this->getMockBuilder(ImmutableConfig::class)
           ->disableOriginalConstructor()
-          ->setMethods(["get"])
+          ->onlyMethods(["get"])
           ->getMock();
         $immutableConfig->method('get')->willReturn($this->cacheMaxAge);
 
         $configFactory = $this->getMockBuilder(ConfigFactory::class)
           ->disableOriginalConstructor()
-          ->setMethods(["get"])
+          ->onlyMethods(["get"])
           ->getMock();
         $configFactory->method('get')->willReturn($immutableConfig);
         return $configFactory;

modules/metastore/src/Storage/Data.php

@@ -4,6 +4,7 @@
 
 use Drupal\common\LoggerTrait;
 use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\Entity\EntityPublishedInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Entity\Query\QueryInterface;
 use Drupal\Core\Entity\RevisionLogInterface;
@@ -243,12 +244,10 @@ public function getEntityPublishedRevision(string $uuid): ?ContentEntityInterfac
     }
 
     $entity = $this->entityStorage->load($entity_id);
-    $published = $entity->status->value ?? FALSE;
-    if (!$published) {
-      return NULL;
+    if ($entity instanceof EntityPublishedInterface) {
+      return $entity->isPublished() ? $entity : NULL;
     }
-
-    return $entity;
+    return NULL;
   }
 
   /**

modules/metastore/tests/src/Unit/ServiceTest.php

@@ -22,7 +22,7 @@
 use RootedData\RootedJsonData;
 
 /**
- *
+ * @coversDefaultClass Drupal\metastore\Service
  */
 class ServiceTest extends TestCase {
 
@@ -296,7 +296,7 @@ public function testPublish() {
     $result = $service->publish('dataset', 1);
     $this->assertTrue($result);
   }
-  
+
   /**
    *
    */

tests/src/Functional/DatasetTest.php

@@ -42,10 +42,22 @@ public function setUp(): void {
     $this->removeDatastoreTables();
     $this->setDefaultModerationState();
     $this->changeDatasetsResourceOutputPerspective();
-
     $this->validMetadataFactory = ServiceTest::getValidMetadataFactory($this);
   }
 
+  public function tearDown() {
+    parent::tearDown();
+    $this->removeHarvests();
+    $this->removeAllNodes();
+    $this->removeAllMappedFiles();
+    $this->removeAllFileFetchingJobs();
+    $this->flushQueues();
+    $this->removeFiles();
+    $this->removeDatastoreTables();
+    $this->setDefaultModerationState();
+    $this->changeDatasetsResourceOutputPerspective();
+  }
+
   public function testChangingDatasetResourcePerspectiveOnOutput() {
     $this->datastoreImportAndQuery();