Unify test conventions

Author: stevebauman

tests/Unit/Documents/DocumentManagerTest.php

@@ -15,7 +15,7 @@
     $this->documentManager = new DocumentManager($this->client);
 });
 
-test('documents can be indexed with refresh', function () {
+it('indexes documents with refresh', function () {
     $this->client
         ->expects($this->once())
         ->method('bulk')
@@ -43,7 +43,7 @@
     $this->assertSame($this->documentManager, $this->documentManager->index('test', $documents, true));
 });
 
-test('documents can be indexed without refresh', function () {
+it('indexes documents without refresh', function () {
     $this->client
         ->expects($this->once())
         ->method('bulk')
@@ -68,7 +68,7 @@
     $this->assertSame($this->documentManager, $this->documentManager->index('test', $documents, false));
 });
 
-test('documents can be indexed with custom routing', function () {
+it('indexes documents with custom routing', function () {
     $this->client
         ->expects($this->once())
         ->method('bulk')
@@ -99,7 +99,7 @@
     $this->assertSame($this->documentManager, $this->documentManager->index('test', $documents, true, $routing));
 });
 
-test('documents can be deleted with refresh', function () {
+it('deletes documents with refresh', function () {
     $this->client
         ->expects($this->once())
         ->method('bulk')
@@ -122,7 +122,7 @@
     $this->assertSame($this->documentManager, $this->documentManager->delete('test', $ids, true));
 });
 
-test('documents can be deleted without refresh', function () {
+it('deletes documents without refresh', function () {
     $this->client
         ->expects($this->once())
         ->method('bulk')
@@ -144,7 +144,7 @@
     $this->assertSame($this->documentManager, $this->documentManager->delete('test', $ids, false));
 });
 
-test('documents can be deleted with custom routing', function () {
+it('deletes documents with custom routing', function () {
     $this->client
         ->expects($this->once())
         ->method('bulk')
@@ -170,7 +170,7 @@
     $this->assertSame($this->documentManager, $this->documentManager->delete('test', $ids, true, $routing));
 });
 
-test('documents can be deleted by query with refresh', function () {
+it('deletes documents by query with refresh', function () {
     $this->client
         ->expects($this->once())
         ->method('deleteByQuery')
@@ -189,7 +189,7 @@
     $this->assertSame($this->documentManager, $this->documentManager->deleteByQuery('test', $query, true));
 });
 
-test('documents can be deleted by query without refresh', function () {
+it('deletes documents by query without refresh', function () {
     $this->client
         ->expects($this->once())
         ->method('deleteByQuery')
@@ -208,7 +208,7 @@
     $this->assertSame($this->documentManager, $this->documentManager->deleteByQuery('test', $query, false));
 });
 
-test('documents can be found', function () {
+it('finds documents', function () {
     $this->client
         ->expects($this->once())
         ->method('search')
@@ -246,7 +246,7 @@
     $this->assertEquals(new Document('1', ['content' => 'foo']), $response->hits()[0]->document());
 });
 
-test('exception is thrown when index operation was unsuccessful', function () {
+it('throws an exception when an index operation is unsuccessful', function () {
     $this->client
         ->expects($this->once())
         ->method('bulk')

tests/Unit/Documents/DocumentRoutingTest.php

@@ -4,7 +4,7 @@
 
 use DirectoryTree\OpenSearchAdapter\Documents\DocumentRouting;
 
-test('routing values can be added and retrieved', function () {
+it('adds and retrieves routing values', function () {
     $routing = DocumentRouting::make('1', 'user1')
         ->add('2', 'user2');
 

tests/Unit/Documents/DocumentTest.php

@@ -4,7 +4,7 @@
 
 use DirectoryTree\OpenSearchAdapter\Documents\Document;
 
-test('document getters', function () {
+it('retrieves document values', function () {
     $document = new Document('123456', ['title' => 'book', 'price' => 10]);
 
     $this->assertSame('123456', $document->id());
@@ -13,14 +13,14 @@
     $this->assertNull($document->get('missing'));
 });
 
-test('fake document can be created', function () {
+it('creates a fake document', function () {
     $document = Document::fake('123456', ['title' => 'book']);
 
     expect($document->id())->toBe('123456')
         ->and($document->source())->toBe(['title' => 'book']);
 });
 
-test('array casting', function () {
+it('casts to an array', function () {
     $document = new Document('1', ['title' => 'test']);
 
     $this->assertSame([
@@ -29,7 +29,7 @@
     ], $document->toArray());
 });
 
-test('bulk index payload can be retrieved', function () {
+it('retrieves bulk index payload', function () {
     $document = new Document('1', ['title' => 'test']);
 
     $this->assertSame([
@@ -38,7 +38,7 @@
     ], $document->toBulkIndex());
 });
 
-test('bulk index payload can be retrieved with routing', function () {
+it('retrieves bulk index payload with routing', function () {
     $document = new Document('1', ['title' => 'test']);
 
     $this->assertSame([

tests/Unit/Documents/FakeDocumentManagerTest.php

@@ -7,11 +7,11 @@
 use DirectoryTree\OpenSearchAdapter\Search\SearchResponse;
 use DirectoryTree\OpenSearchAdapter\Testing\Fakes\FakeDocumentManager;
 
-test('fake document manager implements the document manager contract', function () {
+it('implements the document manager contract', function () {
     expect(new FakeDocumentManager)->toBeInstanceOf(DocumentManagerInterface::class);
 });
 
-test('fake document manager records indexed documents', function () {
+it('records indexed documents', function () {
     $documents = [
         new Document('1', ['title' => 'First']),
         new Document('2', ['title' => 'Second']),
@@ -27,7 +27,7 @@
     $documentsManager->assertIndexed('posts', $documents, true, $routing);
 });
 
-test('fake document manager records deleted documents', function () {
+it('records deleted documents', function () {
     $routing = DocumentRouting::make('1', 'tenant-1')
         ->add('2', 'tenant-2');
 
@@ -38,7 +38,7 @@
     $documents->assertDeleted('posts', ['1', '2'], true, $routing);
 });
 
-test('fake document manager records delete by query operations', function () {
+it('records delete-by-query operations', function () {
     $documents = new FakeDocumentManager;
 
     $documents->deleteByQuery('posts', $query = [
@@ -50,7 +50,7 @@
     $documents->assertDeletedByQuery('posts', $query, true);
 });
 
-test('fake document manager records searches and returns configured responses', function () {
+it('records searches and returns configured responses', function () {
     $request = new SearchRequest([
         'match' => [
             'title' => 'OpenSearch',
@@ -84,7 +84,7 @@
     $documents->assertSearched('posts', $request);
 });
 
-test('fake document manager can be constructed with a search response', function () {
+it('creates a fake document manager with a search response', function () {
     $documents = new FakeDocumentManager($response = SearchResponse::fake());
 
     expect($documents->search('posts', new SearchRequest))->toBe($response);

tests/Unit/Exceptions/BulkRequestExceptionTest.php

@@ -4,7 +4,7 @@
 
 use DirectoryTree\OpenSearchAdapter\Exceptions\BulkRequestException;
 
-test('response can be retrieved', function () {
+it('retrieves response', function () {
     $response = [
         'took' => 486,
         'errors' => true,
@@ -32,7 +32,7 @@
     $this->assertSame($response, $exception->response());
 });
 
-test('first error message from response is given in exception message', function () {
+it('uses the first response error as the exception message', function () {
     $response = [
         'took' => 486,
         'errors' => true,
@@ -63,7 +63,7 @@
     );
 });
 
-test('exception can be thrown with many errors in response', function () {
+it('throws an exception when the response contains multiple errors', function () {
     $response = [
         'took' => 486,
         'errors' => true,
@@ -109,7 +109,7 @@
     );
 });
 
-test('exception can be thrown with missing error in response', function () {
+it('throws an exception when the response omits an error', function () {
     $response = [
         'took' => 486,
         'errors' => true,
@@ -133,7 +133,7 @@
     );
 });
 
-test('exception can be thrown with missing items in response', function () {
+it('throws an exception when the response omits items', function () {
     $response = [
         'took' => 486,
         'errors' => true,

tests/Unit/Indices/AliasActionsTest.php

@@ -5,7 +5,7 @@
 use DirectoryTree\OpenSearchAdapter\Indices\Alias;
 use DirectoryTree\OpenSearchAdapter\Indices\AliasActions;
 
-test('alias actions can be built', function () {
+it('builds alias actions', function () {
     $actions = (new AliasActions)
         ->remove('posts_blue', 'posts')
         ->add('posts_green', new Alias('posts', isWriteIndex: true))
@@ -35,7 +35,7 @@
     ]);
 });
 
-test('add actions include alias routing and filters', function () {
+it('includes alias routing and filters in add actions', function () {
     $actions = (new AliasActions)->add(
         'posts',
         new Alias(

tests/Unit/Indices/AliasTest.php

@@ -4,21 +4,21 @@
 
 use DirectoryTree\OpenSearchAdapter\Indices\Alias;
 
-test('alias getters', function () {
+it('retrieves alias values', function () {
     $alias = new Alias('2030', ['term' => ['year' => 2030]], 'year');
 
     $this->assertSame('2030', $alias->name());
     $this->assertSame(['term' => ['year' => 2030]], $alias->filter());
     $this->assertSame('year', $alias->routing());
 });
 
-test('array casting without filter and routing', function () {
+it('casts to an array without a filter or routing', function () {
     $alias = new Alias('2030');
 
     $this->assertSame([], $alias->toArray());
 });
 
-test('array casting with filter and routing', function () {
+it('casts to an array with a filter and routing', function () {
     $alias = new Alias('2030', ['term' => ['year' => 2030]], 'year');
 
     $this->assertSame([
@@ -31,7 +31,7 @@
     ], $alias->toArray());
 });
 
-test('write index can be configured', function () {
+it('configures write index', function () {
     $alias = new Alias('2030', isWriteIndex: true);
 
     expect($alias->isWriteIndex())->toBeTrue()
@@ -40,7 +40,7 @@
         ]);
 });
 
-test('write index false is included in the payload', function () {
+it('includes a false write index in the payload', function () {
     $alias = new Alias('2030', isWriteIndex: false);
 
     expect($alias->isWriteIndex())->toBeFalse()

tests/Unit/Indices/FakeIndexManagerTest.php

@@ -8,11 +8,11 @@
 use DirectoryTree\OpenSearchAdapter\Indices\Settings;
 use DirectoryTree\OpenSearchAdapter\Testing\Fakes\FakeIndexManager;
 
-test('fake index manager implements the index manager contract', function () {
+it('implements the index manager contract', function () {
     expect(new FakeIndexManager)->toBeInstanceOf(IndexManagerInterface::class);
 });
 
-test('fake index manager tracks index existence', function () {
+it('tracks index existence', function () {
     $indices = new FakeIndexManager;
 
     expect($indices->exists('posts'))->toBeFalse();
@@ -24,7 +24,7 @@
     expect($indices->exists('posts'))->toBeTrue();
 });
 
-test('fake index manager records created indices', function () {
+it('records created indices', function () {
     $indices = new FakeIndexManager;
 
     $indices->create($index = new IndexBlueprint(
@@ -38,23 +38,23 @@
     expect($indices->exists('posts'))->toBeTrue();
 });
 
-test('fake index manager records mapping updates', function () {
+it('records mapping updates', function () {
     $indices = new FakeIndexManager;
 
     $indices->putMapping('posts', $mapping = (new Mapping)->keyword('status'));
 
     $indices->assertMappingPut('posts', $mapping);
 });
 
-test('fake index manager records settings updates', function () {
+it('records settings updates', function () {
     $indices = new FakeIndexManager;
 
     $indices->putSettings('posts', $settings = (new Settings)->index(['refresh_interval' => -1]));
 
     $indices->assertSettingsPut('posts', $settings);
 });
 
-test('fake index manager records open and close operations', function () {
+it('records open and close operations', function () {
     $indices = new FakeIndexManager;
 
     $indices
@@ -64,7 +64,7 @@
         ->assertOpened('posts');
 });
 
-test('fake index manager records deleted indices', function () {
+it('records deleted indices', function () {
     $indices = new FakeIndexManager(existing: ['posts']);
 
     $indices->delete('posts');
@@ -74,7 +74,7 @@
     expect($indices->exists('posts'))->toBeFalse();
 });
 
-test('fake index manager records aliases', function () {
+it('records aliases', function () {
     $indices = new FakeIndexManager;
 
     $alias = new Alias('published_posts', [
@@ -90,7 +90,7 @@
     ]);
 });
 
-test('fake index manager records deleted aliases', function () {
+it('records deleted aliases', function () {
     $indices = new FakeIndexManager;
 
     $indices->putAlias('posts', new Alias('published_posts'));
@@ -102,7 +102,7 @@
     expect($indices->getAliases('posts'))->toBe([]);
 });
 
-test('fake index manager applies atomic alias updates', function () {
+it('applies atomic alias updates', function () {
     $indices = new FakeIndexManager(existing: [
         'posts_blue',
         'posts_green',