description: removeKeyAltName

schemaVersion: "1.8"

runOnRequirements:
  - csfle: true

createEntities:
  - client:
      id: &client0 client0
      observeEvents:
        - commandStartedEvent
  - clientEncryption:
      id: &clientEncryption0 clientEncryption0
      clientEncryptionOpts:
        keyVaultClient: *client0
        keyVaultNamespace: keyvault.datakeys
        kmsProviders:
          local: { key: { $$placeholder: 1 } }
  - database:
      id: &database0 database0
      client: *client0
      databaseName: &database0Name keyvault
  - collection:
      id: &collection0 collection0
      database: *database0
      collectionName: &collection0Name datakeys

initialData:
  - databaseName: *database0Name
    collectionName: *collection0Name
    documents:
      - &local_key_doc
        _id: &local_key_id { $binary: { base64: bG9jYWxrZXlsb2NhbGtleQ==, subType: "04" } }
        keyAltNames: [alternate_name, local_key]
        keyMaterial: { $binary: { base64: ABKBldDEoDW323yejOnIRk6YQmlD9d3eQthd16scKL75nz2LjNL9fgPDZWrFFOlqlhMCFaSrNJfGrFUjYk5JFDO7soG5Syb50k1niJoKg4ilsj0L4mpimFUtTpOr2nzZOeQtvAksEXc7gsFgq8gV7t/U3lsaXPY7I0t42DfSE8EGlPdxRjFdHnxh+OR8h7U9b8Qs5K5UuhgyeyxaBZ1Hgw==, subType: "00" } }
        creationDate: { $date: { $numberLong: "1641024000000" } }
        updateDate: { $date: { $numberLong: "1641024000000" } }
        status: 1
        masterKey:
          provider: local

tests:
  - description: remove keyAltName from non-existent data key
    operations:
      - name: removeKeyAltName
        object: *clientEncryption0
        arguments:
          # First 3 letters of local_key_id replaced with 'A' (value: "#alkeylocalkey").
          id: &non_existent_id { $binary: { base64: AAAjYWxrZXlsb2NhbGtleQ==, subType: "04" } }
          keyAltName: does_not_exist
        expectResult: { $$unsetOrMatches: null }
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              databaseName: *database0Name
              command:
                findAndModify: *collection0Name
                query: { _id: *non_existent_id }
                update: [{ $set: { keyAltNames: { $cond: [{ $eq: [$keyAltNames, [does_not_exist]] }, $$REMOVE, { $filter: { input: $keyAltNames, cond: { $ne: [$$this, does_not_exist] } } }] } } }]
                writeConcern: { w: majority }
    outcome:
      - collectionName: *collection0Name
        databaseName: *database0Name
        documents:
          - *local_key_doc

  - description: remove non-existent keyAltName from existing data key
    operations:
      - name: removeKeyAltName
        object: *clientEncryption0
        arguments:
          id: *local_key_id
          keyAltName: does_not_exist
        expectResult: *local_key_doc
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              databaseName: *database0Name
              command:
                findAndModify: *collection0Name
                query: { _id: *local_key_id }
                update: [{ $set: { keyAltNames: { $cond: [{ $eq: [$keyAltNames, [does_not_exist]] }, $$REMOVE, { $filter: { input: $keyAltNames, cond: { $ne: [$$this, does_not_exist] } } }] } } }]
                writeConcern: { w: majority }
    outcome:
      - collectionName: *collection0Name
        databaseName: *database0Name
        documents:
          - *local_key_doc

  - description: remove an existing keyAltName from an existing data key
    operations:
      - name: removeKeyAltName
        object: *clientEncryption0
        arguments:
          id: *local_key_id
          keyAltName: alternate_name
        expectResult: *local_key_doc
      - name: find
        object: *collection0
        arguments:
          filter: {}
          projection: { _id: 0, keyAltNames: 1 }
        expectResult:
          - keyAltNames: [local_key]
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              databaseName: *database0Name
              command:
                findAndModify: *collection0Name
                query: { _id: *local_key_id }
                update: [{ $set: { keyAltNames: { $cond: [{ $eq: [$keyAltNames, [alternate_name]] }, $$REMOVE, { $filter: { input: $keyAltNames, cond: { $ne: [$$this, alternate_name] } } }] } } }]
                writeConcern: { w: majority }
          - commandStartedEvent: { commandName: find }

  - description: remove the last keyAltName from an existing data key
    operations:
      - name: removeKeyAltName
        object: *clientEncryption0
        arguments:
          id: *local_key_id
          keyAltName: alternate_name
        expectResult: *local_key_doc
      - name: removeKeyAltName
        object: *clientEncryption0
        arguments:
          id: *local_key_id
          keyAltName: local_key
        expectResult:
          _id: *local_key_id
          keyAltNames: [local_key]
          keyMaterial: { $$type: binData }
          creationDate: { $$type: date }
          updateDate: { $$type: date }
          status: 1
          masterKey:
            provider: local
    expectEvents:
      - client: *client0
        events:
          - commandStartedEvent:
              databaseName: *database0Name
              command:
                findAndModify: *collection0Name
                query: { _id: *local_key_id }
                update: [{ $set: { keyAltNames: { $cond: [{ $eq: [$keyAltNames, [alternate_name]] }, $$REMOVE, { $filter: { input: $keyAltNames, cond: { $ne: [$$this, alternate_name] } } }] } } }]
                writeConcern: { w: majority }
          - commandStartedEvent:
              databaseName: *database0Name
              command:
                findAndModify: *collection0Name
                query: { _id: *local_key_id }
                update: [{ $set: { keyAltNames: { $cond: [{ $eq: [$keyAltNames, [local_key]] }, $$REMOVE, { $filter: { input: $keyAltNames, cond: { $ne: [$$this, local_key] } } }] } } }]