Solr 9.6 → 9.7 for integration tests

Author: thomascorthals

.github/workflows/run-tests.yml

@@ -51,12 +51,12 @@ jobs:
                 ref: branch_8_11
                 path: lucene-solr
 
-            - name: Checkout solr 9.6
+            - name: Checkout solr 9.7
               if: matrix.solr == 9
               uses: actions/checkout@v4
               with:
                 repository: apache/solr
-                ref: branch_9_6
+                ref: branch_9_7
                 path: lucene-solr
 
             - name: Start Solr ${{ matrix.solr }} in ${{ matrix.mode }} mode

tests/Integration/AbstractTechproductsTestCase.php

@@ -20,6 +20,7 @@
 use Solarium\Core\Client\Request;
 use Solarium\Core\Client\Response;
 use Solarium\Core\Event\Events;
+use Solarium\Core\Query\AbstractDocument;
 use Solarium\Core\Query\AbstractQuery;
 use Solarium\Core\Query\Helper;
 use Solarium\Core\Query\RequestBuilderInterface;
@@ -95,6 +96,25 @@ abstract class AbstractTechproductsTestCase extends TestCase
      */
     protected static $isSolrOnWindows;
 
+    /**
+     * Asserts that a document contains exactly the expected fields.
+     *
+     * {@internal We used to compare the actual array of fields directly to the
+     *            expected array with {@see assertSame()} but that stopped working
+     *            with Solr 9.7.0 because the order in which fields are returned
+     *            has changed for some queries. There was never a guarantee that
+     *            Solr maintains field order (SOLR-1190), we had just been lucky
+     *            that it had always happened to work out before.}
+     */
+    public static function assertDocumentHasFields(array $expectedFields, AbstractDocument $actualDocument, string $message = ''): void
+    {
+        $actualFields = $actualDocument->getFields();
+        ksort($actualFields);
+        ksort($expectedFields);
+
+        static::assertSame($expectedFields, $actualFields, $message);
+    }
+
     abstract protected static function createTechproducts(): void;
 
     public static function setUpBeforeClass(): void
@@ -187,16 +207,16 @@ public static function setUpBeforeClass(): void
             $select->setQuery('êâîôû');
             $result = self::$client->select($select);
             static::assertCount(1, $result);
-            static::assertSame([
+            static::assertDocumentHasFields([
                 'id' => 'UTF8TEST',
-            ], $result->getIterator()->current()->getFields());
+            ], $result->getIterator()->current());
 
             $select->setQuery('这是一个功能');
             $result = self::$client->select($select);
             static::assertCount(1, $result);
-            static::assertSame([
+            static::assertDocumentHasFields([
                 'id' => 'GB18030TEST',
-            ], $result->getIterator()->current()->getFields());
+            ], $result->getIterator()->current());
         } catch (\Exception $e) {
             self::tearDownAfterClass();
             static::markTestSkipped('Solr techproducts sample data not indexed properly.');
@@ -551,15 +571,15 @@ public function testRangeQueries(string $responseWriter)
         $result = self::$client->select($select);
         $this->assertSame(2, $result->getNumFound());
         $iterator = $result->getIterator();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => 'MA147LL/A',
             'manufacturedate_dt' => '2005-10-12T08:00:00Z',
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
         $iterator->next();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => 'F8V7067-APL-KIT',
             'manufacturedate_dt' => '2005-08-01T16:30:25Z',
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
 
         // VS1GB400C3 costs 74.99, SP2514N costs 92.0, 0579B002 costs 179.99
         $select->setFields('id,price');
@@ -570,63 +590,63 @@ public function testRangeQueries(string $responseWriter)
         $result = self::$client->select($select);
         $this->assertSame(3, $result->getNumFound());
         $iterator = $result->getIterator();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => 'VS1GB400C3',
             'price' => 74.99,
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
         $iterator->next();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => 'SP2514N',
             'price' => 92.0,
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
         $iterator->next();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => '0579B002',
             'price' => 179.99,
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
 
         $select->setQuery(
             $select->getHelper()->rangeQuery('price', 74.99, 179.99, [true, false])
         );
         $result = self::$client->select($select);
         $this->assertSame(2, $result->getNumFound());
         $iterator = $result->getIterator();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => 'VS1GB400C3',
             'price' => 74.99,
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
         $iterator->next();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => 'SP2514N',
             'price' => 92.0,
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
 
         $select->setQuery(
             $select->getHelper()->rangeQuery('price', 74.99, 179.99, [false, true])
         );
         $result = self::$client->select($select);
         $this->assertSame(2, $result->getNumFound());
         $iterator = $result->getIterator();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => 'SP2514N',
             'price' => 92.0,
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
         $iterator->next();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => '0579B002',
             'price' => 179.99,
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
 
         $select->setQuery(
             $select->getHelper()->rangeQuery('price', 74.99, 179.99, [false, false])
         );
         $result = self::$client->select($select);
         $this->assertSame(1, $result->getNumFound());
         $iterator = $result->getIterator();
-        $this->assertSame([
+        $this->assertDocumentHasFields([
             'id' => 'SP2514N',
             'price' => 92.0,
-        ], $iterator->current()->getFields());
+        ], $iterator->current());
     }
 
     public function testFacetHighlightSpellcheckComponent()

tests/Integration/Fixtures/schema9.patch

@@ -6,8 +6,8 @@ index 190214aebad..7a76a28276a 100644
     <!-- points to the root document of a block of nested documents. Required for nested
        document support, may be removed otherwise
     -->
--   <field name="_root_" type="string" indexed="true" stored="false" docValues="false" />
-+   <field name="_root_" type="string" indexed="true" stored="true" docValues="false" />
+-   <field name="_root_" type="string" indexed="true" stored="false" />
++   <field name="_root_" type="string" indexed="true" stored="true" />
 +   <fieldType name="_nest_path_" class="solr.NestPathField" />
 +   <field name="_nest_path_" type="_nest_path_" />