forked from elastic/elasticsearch
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Mappings: Restrict murmur3 field type to sane options
Disabling doc values or trying to index hash values are not correct uses of this the murmur3 field type, and just cause problems. This disallows changing doc values or index options for 2.0+. closes elastic#10465
- Loading branch information
Showing
3 changed files
with
149 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
src/test/java/org/elasticsearch/index/mapper/core/Murmur3FieldMapperTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package org.elasticsearch.index.mapper.core; | ||
|
||
import org.apache.lucene.index.IndexOptions; | ||
import org.elasticsearch.Version; | ||
import org.elasticsearch.cluster.metadata.IndexMetaData; | ||
import org.elasticsearch.common.settings.ImmutableSettings; | ||
import org.elasticsearch.common.settings.Settings; | ||
import org.elasticsearch.common.xcontent.XContentFactory; | ||
import org.elasticsearch.index.IndexService; | ||
import org.elasticsearch.index.mapper.DocumentMapper; | ||
import org.elasticsearch.index.mapper.DocumentMapperParser; | ||
import org.elasticsearch.index.mapper.Mapper; | ||
import org.elasticsearch.index.mapper.MapperParsingException; | ||
import org.elasticsearch.test.ElasticsearchSingleNodeTest; | ||
import org.junit.Before; | ||
|
||
public class Murmur3FieldMapperTests extends ElasticsearchSingleNodeTest { | ||
|
||
IndexService indexService; | ||
DocumentMapperParser parser; | ||
|
||
@Before | ||
public void before() { | ||
indexService = createIndex("test"); | ||
parser = indexService.mapperService().documentMapperParser(); | ||
} | ||
|
||
public void testDocValuesSettingNotAllowed() throws Exception { | ||
String mapping = XContentFactory.jsonBuilder().startObject().startObject("type") | ||
.startObject("properties").startObject("field") | ||
.field("type", "murmur3") | ||
.field("doc_values", false) | ||
.endObject().endObject().endObject().endObject().string(); | ||
try { | ||
parser.parse(mapping); | ||
fail("expected a mapper parsing exception"); | ||
} catch (MapperParsingException e) { | ||
assertTrue(e.getMessage().contains("Setting [doc_values] cannot be modified")); | ||
} | ||
|
||
// even setting to the default is not allowed, the setting is invalid | ||
mapping = XContentFactory.jsonBuilder().startObject().startObject("type") | ||
.startObject("properties").startObject("field") | ||
.field("type", "murmur3") | ||
.field("doc_values", true) | ||
.endObject().endObject().endObject().endObject().string(); | ||
try { | ||
parser.parse(mapping); | ||
fail("expected a mapper parsing exception"); | ||
} catch (MapperParsingException e) { | ||
assertTrue(e.getMessage().contains("Setting [doc_values] cannot be modified")); | ||
} | ||
} | ||
|
||
public void testIndexSettingNotAllowed() throws Exception { | ||
String mapping = XContentFactory.jsonBuilder().startObject().startObject("type") | ||
.startObject("properties").startObject("field") | ||
.field("type", "murmur3") | ||
.field("index", "not_analyzed") | ||
.endObject().endObject().endObject().endObject().string(); | ||
try { | ||
parser.parse(mapping); | ||
fail("expected a mapper parsing exception"); | ||
} catch (MapperParsingException e) { | ||
assertTrue(e.getMessage().contains("Setting [index] cannot be modified")); | ||
} | ||
|
||
// even setting to the default is not allowed, the setting is invalid | ||
mapping = XContentFactory.jsonBuilder().startObject().startObject("type") | ||
.startObject("properties").startObject("field") | ||
.field("type", "murmur3") | ||
.field("index", "no") | ||
.endObject().endObject().endObject().endObject().string(); | ||
try { | ||
parser.parse(mapping); | ||
fail("expected a mapper parsing exception"); | ||
} catch (MapperParsingException e) { | ||
assertTrue(e.getMessage().contains("Setting [index] cannot be modified")); | ||
} | ||
} | ||
|
||
public void testDocValuesSettingBackcompat() throws Exception { | ||
Settings settings = ImmutableSettings.builder().put(IndexMetaData.SETTING_VERSION_CREATED, Version.V_1_4_2.id).build(); | ||
indexService = createIndex("test_bwc", settings); | ||
parser = indexService.mapperService().documentMapperParser(); | ||
String mapping = XContentFactory.jsonBuilder().startObject().startObject("type") | ||
.startObject("properties").startObject("field") | ||
.field("type", "murmur3") | ||
.field("doc_values", false) | ||
.endObject().endObject().endObject().endObject().string(); | ||
|
||
DocumentMapper docMapper = parser.parse(mapping); | ||
Murmur3FieldMapper mapper = (Murmur3FieldMapper)docMapper.mappers().getMapper("field"); | ||
assertFalse(mapper.hasDocValues()); | ||
} | ||
|
||
public void testIndexSettingBackcompat() throws Exception { | ||
Settings settings = ImmutableSettings.builder().put(IndexMetaData.SETTING_VERSION_CREATED, Version.V_1_4_2.id).build(); | ||
indexService = createIndex("test_bwc", settings); | ||
parser = indexService.mapperService().documentMapperParser(); | ||
String mapping = XContentFactory.jsonBuilder().startObject().startObject("type") | ||
.startObject("properties").startObject("field") | ||
.field("type", "murmur3") | ||
.field("index", "not_analyzed") | ||
.endObject().endObject().endObject().endObject().string(); | ||
|
||
DocumentMapper docMapper = parser.parse(mapping); | ||
Murmur3FieldMapper mapper = (Murmur3FieldMapper)docMapper.mappers().getMapper("field"); | ||
assertEquals(IndexOptions.DOCS, mapper.fieldType().indexOptions()); | ||
} | ||
|
||
// TODO: add more tests | ||
} |