description: entity-cursor-iterateOnce

schemaVersion: '1.5'

createEntities:
  - client:
      id: &client0 client0
      observeEvents: [ commandStartedEvent ]
  - database:
      id: &database0 database0
      client: *client0
      databaseName: &database0Name database0
  - collection:
      id: &collection0 collection0
      database: *database0
      collectionName: &collection0Name coll0

initialData:
  - databaseName: *database0Name
    collectionName: *collection0Name
    documents:
      - _id: 1
      - _id: 2
      - _id: 3

tests:
  - description: iterateOnce
    operations:
      - name: createFindCursor
        object: *collection0
        arguments:
          filter: {}
          batchSize: 2
        saveResultAsEntity: &cursor0 cursor0
      - name: iterateUntilDocumentOrError
        object: *cursor0
        expectResult: { _id: 1 }
      - name: iterateUntilDocumentOrError
        object: *cursor0
        expectResult: { _id: 2 }
      # This operation could be iterateUntilDocumentOrError, but we use iterateOne to ensure that drivers support it.
      - name: iterateOnce
        object: *cursor0
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              command:
                find: *collection0Name
                filter: {}
                batchSize: 2
              commandName: find
              databaseName: *database0Name
          - commandStartedEvent:
              command:
                getMore: { $$type: long }
                collection: *collection0Name
              commandName: getMore