CollectionController.feature

Feature: Collection Controller

  # collection:update ==========================================================

  Scenario: Update a collection mappings and settings
    Given an index "nyc-open-data"
    And I "create" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "properties": { "name": { "type": "keyword" } } } |
      | settings | { "index": { "blocks": { "write": true } } }        |
    When I "update" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "properties": { "age": { "type": "integer" } } } |
      | settings | { "index": { "blocks": { "write": false } } }      |
    And I can create the following document:
      | body | {} |
    And I get mappings of collection "nyc-open-data":"green-taxi"
    And I should receive a result matching:
      | properties | { "name": { "type": "keyword" }, "age": { "type": "integer" } } |

  Scenario: Update a collection and search document
    Given an index "nyc-open-data"
    And I "create" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "dynamic": "true", "properties": { "name": { "type": "keyword" }, "metadata": {"properties": {}, "dynamic": "false"} } } |
    And I "create" the following multiple documents:
      | _id          | body        |
      | "document-1" | {"age": 2} |
    And I refresh the collection
    When I "update" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "properties": { "age": { "type": "long" } } } |
    When I search documents with the following query:
      """
      {
        "match": {
          "age": 2
        }
      }
      """
    And I execute the search query
    Then I should receive a "hits" array of objects matching:
      | _id          | _source      |
      | "document-1" | { "age": 2 } |

  # collection:truncate ========================================================

  Scenario: Truncate a collection
    Given an index "nyc-open-data"
    When I "create" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "dynamic": "strict", "properties": { "name": { "type": "keyword" } } } |
    And an existing collection "nyc-open-data":"green-taxi"
    And I "create" the following multiple documents:
      | _id          | body                    |
      | "document-1" | { "name": "document1" } |
      | "document-2" | { "name": "document2" } |
    When I successfully execute the action "collection":"truncate" with args:
      | index      | "nyc-open-data" |
      | collection | "green-taxi"    |
    And The document "document-1" should not exist
    And The document "document-2" should not exist
    And I successfully execute the action "collection":"getMapping" with args:
      | index             | "nyc-open-data" |
      | collection        | "green-taxi"    |
      | includeKuzzleMeta | true            |
    And I should receive a result matching:
      | dynamic | "strict" |
    And The property "properties" of the result should match:
      | name | { "type": "keyword" } |
    And The property "properties._kuzzle_info.properties" of the result should match:
      | author    | { "type": "keyword" } |
      | updater   | { "type": "keyword" } |
      | createdAt | { "type": "date" }    |
      | updatedAt | { "type": "date" }    |


  # collection:getSettings =====================================================
  
  Scenario: Get collection settings
    Given an index "nyc-open-data"
    And I "create" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "dynamic": "strict", "properties": { "name": { "type": "keyword" } } } |
    When I successfully execute the action "collection":"getSettings" with args:
      | index      | "nyc-open-data" |
      | collection | "green-taxi"    |
    Then I should receive a result matching:
      | number_of_shards | "1" |

  # collection:delete ==========================================================

  Scenario: Delete a collection
    Given an index "nyc-open-data"
    And a collection "nyc-open-data":"green-taxi"
    When I successfully execute the action "collection":"delete" with args:
      | index      | "nyc-open-data" |
      | collection | "green-taxi"    |
    Then I should not see the collection "nyc-open-data":"green-taxi"

  # collection:create ==========================================================

  Scenario: Create a new collection with mappings and settings
    Given an index "nyc-open-data"
    When I "create" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "dynamic": "strict", "properties": { "name": { "type": "keyword" } } } |
      | settings | { "index": { "blocks": { "write": true } } }                             |
    Then I should see the collection "nyc-open-data":"green-taxi"
    And I can not create the following document:
      | body | {} |
    And I get mappings of collection "nyc-open-data":"green-taxi"
    And I should receive a result matching:
      | dynamic    | "strict"                          |
      | properties | { "name": { "type": "keyword" } } |

  Scenario: Re-create a new collection with mappings and settings
    Given an index "nyc-open-data"
    When I "create" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "dynamic": "strict", "properties": { "name": { "type": "keyword" } } } |
      | settings | { "index": { "blocks": { "write": true } } }                             |
    And I "create" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "properties": { "age": { "type": "integer" } } } |
      | settings | { "index": { "blocks": { "write": false } } }      |
    Then I should see the collection "nyc-open-data":"green-taxi"
    And I can create the following document:
      | body | {} |
    And I get mappings of collection "nyc-open-data":"green-taxi"
    And I should receive a result matching:
      | dynamic    | "strict"                                                        |
      | properties | { "name": { "type": "keyword" }, "age": { "type": "integer" } } |

  Scenario: Create a new collection with incorrect mappings
    Given an index "nyc-open-data"
    When I "create" the collection "nyc-open-data":"green-taxi" with:
      | mappings | { "dynamik": "strict" } |
    Then I should receive an error matching:
      | id | "services.storage.invalid_mapping" |

  Scenario: Create a collection with the same name as the kuzzle hidden one
    Given an index "nyc-open-data"
    When I "create" the collection "nyc-open-data":"_kuzzle_keep" with:
      | mappings | "mappings" |
    Then I should receive an error matching:
      | id | "services.storage.collection_reserved" |

  Scenario: Create a collection with illegal character
    When I "create" the collection "nyc-open-data":"%users" with:
      | mappings | "mappings" |
    Then I should receive an error matching:
      | id | "services.storage.invalid_collection_name" |
    When I "create" the collection "nyc-open-data":"&users" with:
      | mappings | "mappings" |
    Then I should receive an error matching:
      | id | "services.storage.invalid_collection_name" |
    When I "create" the collection "nyc-open-data":"us.ers" with:
      | mappings | "mappings" |
    Then I should receive an error matching:
      | id | "services.storage.invalid_collection_name" |

  # Deprecated since 2.1.0
  Scenario: Create a new collection with mappings
    Given an index "nyc-open-data"
    When I successfully execute the action "collection":"create" with args:
      | index      | "nyc-open-data"                                                          |
      | collection | "green-taxi"                                                             |
      | body       | { "dynamic": "strict", "properties": { "name": { "type": "keyword" } } } |
    Then I should receive a result matching:
      | acknowledged | true |
    And I should see the collection "nyc-open-data":"green-taxi"
    And I get mappings of collection "nyc-open-data":"green-taxi"
    Then I should receive a result matching:
      | dynamic    | "strict"                          |
      | properties | { "name": { "type": "keyword" } } |

  # Deprecated since 2.1.0
  Scenario: Re-create an existing collection with mappings
    Given an index "nyc-open-data"
    When I successfully execute the action "collection":"create" with args:
      | index      | "nyc-open-data"                                                          |
      | collection | "green-taxi"                                                             |
      | body       | { "dynamic": "strict", "properties": { "name": { "type": "keyword" } } } |
    And I successfully execute the action "collection":"create" with args:
      | index      | "nyc-open-data"                                                         |
      | collection | "green-taxi"                                                            |
      | body       | { "dynamic": "strict", "properties": { "age": { "type": "integer" } } } |
    And I get mappings of collection "nyc-open-data":"green-taxi"
    Then I should receive a result matching:
      | dynamic    | "strict"                                                       |
      | properties | { "name": { "type": "keyword" }, "age": { "type": "integer"} } |

  # collection:list ============================================================

  Scenario: List collections
    Given an index "nyc-open-data"
    And a collection "nyc-open-data":"yellow-taxi"
    And a collection "nyc-open-data":"green-taxi"
    And a collection "nyc-open-data":"green-taxi"
    And I list "stored" collections in index "nyc-open-data"
    Then I should receive a "collections" array of objects matching:
      | name          | type     |
      | "green-taxi"  | "stored" |
      | "yellow-taxi" | "stored" |

  # collection:exists ==========================================================

  Scenario: Test if a collection exists
    Given an index "nyc-open-data"
    And a collection "nyc-open-data":"yellow-taxi"
    When I successfully execute the action "collection":"exists" with args:
    | index | "nyc-open-data" |
    | collection | "yellow-taxi" |
    Then The result should be "true"
    When I successfully execute the action "collection":"exists" with args:
    | index | "nyc-open-data" |
    | collection | "green-taxi" |
    Then The result should be "false"