hugegraph-client/src/test/java/org/apache/hugegraph/functional/IndexLabelTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * 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.apache.hugegraph.functional;

import java.util.Date;
import java.util.List;

import org.apache.hugegraph.driver.SchemaManager;
import org.apache.hugegraph.structure.schema.IndexLabel;
import org.apache.hugegraph.testutil.Assert;
import org.apache.hugegraph.testutil.Utils;
import org.apache.hugegraph.util.DateUtil;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import com.google.common.collect.ImmutableList;

public class IndexLabelTest extends BaseFuncTest {

    @Before
    public void setup() {
        BaseFuncTest.initPropertyKey();
    }

    @After
    public void teardown() throws Exception {
        BaseFuncTest.clearData();
    }

    @Test
    public void testAddIndexLabelWithUserData() {
        SchemaManager schema = schema();
        BaseFuncTest.initVertexLabel();

        IndexLabel personByCity = schema.indexLabel("personByCity")
                                        .onV("person")
                                        .by("city")
                                        .secondary()
                                        .userdata("type", "secondary")
                                        .ifNotExist()
                                        .create();
        Assert.assertEquals(2, personByCity.userdata().size());
        Assert.assertEquals("secondary", personByCity.userdata().get("type"));
        String time = (String) personByCity.userdata().get("~create_time");
        Date createTime = DateUtil.parse(time);
        Utils.assertBeforeNow(createTime);

        IndexLabel personByAge = schema.indexLabel("personByAge")
                                       .onV("person")
                                       .by("age")
                                       .range()
                                       .userdata("type", "secondary")
                                       .userdata("type", "range")
                                       .ifNotExist()
                                       .create();
        Assert.assertEquals(2, personByAge.userdata().size());
        Assert.assertEquals("range", personByAge.userdata().get("type"));
        time = (String) personByAge.userdata().get("~create_time");
        createTime = DateUtil.parse(time);
        Utils.assertBeforeNow(createTime);
    }

    @Test
    public void testAppendIndexLabelWithUserData() {
        SchemaManager schema = schema();
        BaseFuncTest.initVertexLabel();

        IndexLabel personByCity = schema.indexLabel("personByCity")
                                        .onV("person")
                                        .by("city")
                                        .secondary()
                                        .ifNotExist()
                                        .create();
        Assert.assertEquals(1, personByCity.userdata().size());
        String time = (String) personByCity.userdata().get("~create_time");
        Date createTime = DateUtil.parse(time);
        Utils.assertBeforeNow(createTime);

        personByCity = schema.indexLabel("personByCity")
                             .userdata("type", "secondary")
                             .append();
        Assert.assertEquals(2, personByCity.userdata().size());
        Assert.assertEquals("secondary", personByCity.userdata().get("type"));
        time = (String) personByCity.userdata().get("~create_time");
        Assert.assertEquals(createTime, DateUtil.parse(time));
    }

    @Test
    public void testEliminateIndexLabelWithUserData() {
        SchemaManager schema = schema();
        BaseFuncTest.initVertexLabel();

        IndexLabel personByCity = schema.indexLabel("personByCity")
                                        .onV("person")
                                        .by("city")
                                        .secondary()
                                        .userdata("type", "secondary")
                                        .userdata("icon", "picture")
                                        .ifNotExist()
                                        .create();
        Assert.assertEquals(3, personByCity.userdata().size());
        Assert.assertEquals("secondary", personByCity.userdata().get("type"));
        Assert.assertEquals("picture", personByCity.userdata().get("icon"));
        String time = (String) personByCity.userdata().get("~create_time");
        Date createTime = DateUtil.parse(time);
        Utils.assertBeforeNow(createTime);

        personByCity = schema.indexLabel("personByCity")
                             .userdata("type", "secondary")
                             .eliminate();
        Assert.assertEquals(2, personByCity.userdata().size());
        Assert.assertEquals("picture", personByCity.userdata().get("icon"));
        time = (String) personByCity.userdata().get("~create_time");
        Assert.assertEquals(createTime, DateUtil.parse(time));
    }

    @Test
    public void testRemoveIndexLabelSync() {
        SchemaManager schema = schema();

        schema.vertexLabel("player")
              .properties("name", "age")
              .create();
        IndexLabel playerByName = schema.indexLabel("playerByName")
                                        .on(true, "player")
                                        .secondary()
                                        .by("name")
                                        .create();

        Assert.assertNotNull(playerByName);
        // Remove index label sync
        schema.removeIndexLabel("playerByName");

        playerByName = schema.indexLabel("playerByName")
                             .onV("player")
                             .by("name")
                             .secondary()
                             .create();

        Assert.assertNotNull(playerByName);
        // Remove index label sync with timeout
        schema.removeIndexLabel("playerByName", 10);
    }

    @Test
    public void testRemoveIndexLabelAsync() {
        SchemaManager schema = schema();

        schema.vertexLabel("player")
              .properties("name", "age")
              .create();
        IndexLabel playerByName = schema.indexLabel("playerByName")
                                        .onV("player")
                                        .by("name")
                                        .secondary()
                                        .create();
        Assert.assertNotNull(playerByName);
        // Remove index label async
        schema.removeIndexLabelAsync("playerByName");
    }

    @Test
    public void testAddIndexLabelAsync() {
        SchemaManager schema = schema();

        schema.vertexLabel("player")
              .properties("name", "age")
              .create();
        IndexLabel playerByName = schema.indexLabel("playerByName")
                                        .onV("player")
                                        .by("name")
                                        .secondary()
                                        .build();
        long task = schema.addIndexLabelAsync(playerByName);
        waitUntilTaskCompleted(task);

        playerByName = schema.getIndexLabel(playerByName.name());
        Assert.assertNotNull(playerByName);
    }

    @Test
    public void testListByNames() {
        SchemaManager schema = schema();

        schema.vertexLabel("player").properties("name", "age").create();
        IndexLabel playerByName = schema.indexLabel("playerByName")
                                        .onV("player")
                                        .by("name")
                                        .secondary()
                                        .create();
        IndexLabel playerByAge = schema.indexLabel("playerByAge")
                                       .onV("player")
                                       .by("age")
                                       .range()
                                       .create();

        List<IndexLabel> indexLabels;

        indexLabels = schema.getIndexLabels(ImmutableList.of("playerByName"));
        Assert.assertEquals(1, indexLabels.size());
        assertContains(indexLabels, playerByName);

        indexLabels = schema.getIndexLabels(ImmutableList.of("playerByAge"));
        Assert.assertEquals(1, indexLabels.size());
        assertContains(indexLabels, playerByAge);

        indexLabels = schema.getIndexLabels(ImmutableList.of("playerByName",
                                                             "playerByAge"));
        Assert.assertEquals(2, indexLabels.size());
        assertContains(indexLabels, playerByName);
        assertContains(indexLabels, playerByAge);
    }

    @Test
    public void testResetVertexLabelId() {
        SchemaManager schema = schema();
        schema.vertexLabel("player")
              .properties("name", "age")
              .create();
        IndexLabel playerByName = schema.indexLabel("playerByName")
                                        .onV("player")
                                        .by("name")
                                        .secondary()
                                        .create();
        Assert.assertTrue(playerByName.id() > 0);
        playerByName.resetId();
        Assert.assertEquals(0L, playerByName.id());
    }

    @Test
    public void testSetCheckExist() {
        SchemaManager schema = schema();
        schema.vertexLabel("player")
              .properties("name", "age")
              .create();
        IndexLabel playerByName = schema.indexLabel("playerByName")
                                        .onV("player")
                                        .by("name")
                                        .secondary()
                                        .create();
        Assert.assertTrue(playerByName.checkExist());
        playerByName.checkExist(false);
        Assert.assertFalse(playerByName.checkExist());
    }
}