LinkTest.java

/*
 * Copyright 2010 Outerthought bvba
 *
 * Licensed 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.lilyproject.repository.impl.test;

import java.util.HashMap;
import java.util.Map;

import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.lilyproject.bytes.api.DataOutput;
import org.lilyproject.bytes.impl.DataInputImpl;
import org.lilyproject.bytes.impl.DataOutputImpl;
import org.lilyproject.repository.api.IdGenerator;
import org.lilyproject.repository.api.Link;
import org.lilyproject.repository.api.RecordId;
import org.lilyproject.repository.impl.id.IdGeneratorImpl;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

public class LinkTest {
    private IdGenerator idGenerator;

    @Before
    public void setUp() throws Exception {
        idGenerator = new IdGeneratorImpl();
    }

    @Test
    public void testPlainRecordId() {
        RecordId recordId = idGenerator.newRecordId("123");

        Link link = Link.newBuilder().recordId(recordId).create();
        assertTrue(link.copyAll());
        assertEquals(recordId, link.getMasterRecordId());

        assertEquals("USER.123", link.toString());
        assertEquals(link, Link.fromString(link.toString(), idGenerator));
        DataOutput dataOutput = new DataOutputImpl();
        link.write(dataOutput);
        assertEquals(link, Link.read(new DataInputImpl(dataOutput.toByteArray()), idGenerator));

        RecordId ctx = idGenerator.newRecordId("0");
        RecordId resolved = link.resolve(ctx, idGenerator);
        assertEquals(recordId, resolved);

        // test the copy all
        Map<String, String> varProps = new HashMap<String, String>();
        varProps.put("a", "1");
        varProps.put("b", "2");

        ctx = idGenerator.newRecordId(ctx, varProps);
        resolved = link.resolve(ctx, idGenerator);
        assertEquals(recordId, resolved.getMaster());
        assertEquals(2, resolved.getVariantProperties().size());
    }

    @Test public void testFromStringWithDots() {
        String idStr = "USER.AB\\.CD";
        Link link = Link.fromString(idStr, idGenerator);
        assertEquals("USER.AB\\.CD", link.toString());

        String variantStr = ".foo\\.com=bar\\.com";
        Link variantLink = Link.fromString(variantStr, idGenerator);

        String fullStr = "USER.AB\\.CD.foo\\.com=bar\\.com";
        Link fullLink = Link.fromString(fullStr, idGenerator);


    }

    @Test
    public void testFromString_WithTable() {
        String idString = "mytable:USER.1234";
        Link link = Link.fromString(idString, idGenerator);

        assertEquals("mytable", link.getTable());
        assertEquals("USER.1234", link.getMasterRecordId().toString());
    }

    @Test
    public void testFromString_NoTable() {
        String idString = "USER.1234";
        Link link = Link.fromString(idString, idGenerator);

        assertNull(link.getTable());
        assertEquals("USER.1234", link.getMasterRecordId().toString());
    }

    @Test
    public void testFromString_WithTable_WithColonsInId() {
        String idString = "mytable:USER.12:34";
        Link link = Link.fromString(idString, idGenerator);

        assertEquals("mytable", link.getTable());
        assertEquals("USER.12:34", link.getMasterRecordId().toString());
    }

    @Test
    public void testFromString_NoTable_WithColonsInId() {
        String idString = "USER.12:34";
        Link link = Link.fromString(idString, idGenerator);

        assertNull(link.getTable());
        assertEquals("USER.12:34", link.getMasterRecordId().toString());
    }

    @Test
    public void testRecordIdWithVarProps() {
        Map<String, String> varProps = new HashMap<String, String>();
        varProps.put("lang", "en");
        varProps.put("branch", "dev");

        RecordId masterRecordId = idGenerator.newRecordId("123");
        RecordId recordId = idGenerator.newRecordId(masterRecordId, varProps);

        Link link = Link.newBuilder().recordId(recordId).copyAll(false).create();
        assertEquals(masterRecordId, link.getMasterRecordId());
        assertEquals("USER.123.!*,branch=dev,lang=en", link.toString());
        assertEquals(link, Link.fromString(link.toString(), idGenerator));
        DataOutput dataOutput = new DataOutputImpl();
        link.write(dataOutput);
        assertEquals(link, Link.read(new DataInputImpl(dataOutput.toByteArray()), idGenerator));


        assertEquals(2, link.getVariantProps().size());
        assertEquals(Link.PropertyMode.SET, link.getVariantProps().get("lang").getMode());
        assertEquals("en", link.getVariantProps().get("lang").getValue());

        Map<String, String> ctxVarProps = new HashMap<String, String>();
        varProps.put("a", "1");
        varProps.put("b", "2");
        varProps.put("lang", "nl");

        RecordId ctx = idGenerator.newRecordId(idGenerator.newRecordId("0"), ctxVarProps);
        RecordId resolved = link.resolve(ctx, idGenerator);

        // Nothing from the context should have been copied
        assertEquals(2, resolved.getVariantProperties().size());
        assertEquals("en", resolved.getVariantProperties().get("lang"));
        assertEquals("dev", resolved.getVariantProperties().get("branch"));
    }

    @Test
    public void testIndividualRemove() {
        RecordId recordId = idGenerator.newRecordId("123");

        Link link = Link.newBuilder().recordId(recordId).remove("lang").set("x", "1").create();
        assertEquals("USER.123.-lang,x=1", link.toString());
        assertEquals(link, Link.fromString(link.toString(), idGenerator));
        DataOutput dataOutput = new DataOutputImpl();
        link.write(dataOutput);
        assertEquals(link, Link.read(new DataInputImpl(dataOutput.toByteArray()), idGenerator));


        Map<String, String> ctxVarProps = new HashMap<String, String>();
        ctxVarProps.put("lang", "en");
        ctxVarProps.put("branch", "dev");

        RecordId ctx = idGenerator.newRecordId(idGenerator.newRecordId("0"), ctxVarProps);
        RecordId resolved = link.resolve(ctx, idGenerator);

        assertNull(resolved.getVariantProperties().get("lang"));
        assertEquals("dev", resolved.getVariantProperties().get("branch"));
        assertEquals("1", resolved.getVariantProperties().get("x"));
        assertEquals(2, resolved.getVariantProperties().size());
    }

    @Test
    public void testIndividualCopy() {
        RecordId recordId = idGenerator.newRecordId("123");

        Link link = Link.newBuilder().recordId(recordId).copyAll(false).copy("branch").set("x", "1").create();
        assertEquals("USER.123.!*,+branch,x=1", link.toString());
        assertEquals(link, Link.fromString(link.toString(), idGenerator));
        DataOutput dataOutput = new DataOutputImpl();
        link.write(dataOutput);
        assertEquals(link, Link.read(new DataInputImpl(dataOutput.toByteArray()), idGenerator));


        Map<String, String> ctxVarProps = new HashMap<String, String>();
        ctxVarProps.put("lang", "en");
        ctxVarProps.put("branch", "dev");

        RecordId ctx = idGenerator.newRecordId(idGenerator.newRecordId("0"), ctxVarProps);
        RecordId resolved = link.resolve(ctx, idGenerator);

        assertNull(resolved.getVariantProperties().get("lang"));
        assertEquals("dev", resolved.getVariantProperties().get("branch"));
        assertEquals("1", resolved.getVariantProperties().get("x"));
        assertEquals(2, resolved.getVariantProperties().size());
    }

    @Test
    public void testLinkToSelf() {
        Link link = Link.newBuilder().create();
        assertNull(link.getMasterRecordId());
        assertEquals(".", link.toString());
        assertEquals(link, Link.fromString(link.toString(), idGenerator));
        DataOutput dataOutput = new DataOutputImpl();
        link.write(dataOutput);
        assertEquals(link, Link.read(new DataInputImpl(dataOutput.toByteArray()), idGenerator));


        Map<String, String> varProps = new HashMap<String, String>();
        varProps.put("lang", "en");
        varProps.put("branch", "dev");

        RecordId recordId = idGenerator.newRecordId(idGenerator.newRecordId("123"), varProps);

        RecordId resolved = link.resolve(recordId, idGenerator);

        assertEquals(recordId, resolved);
    }

    @Test
    public void testLinkToMaster() {
        Link link = Link.newBuilder().copyAll(false).create();
        assertNull(link.getMasterRecordId());
        assertEquals(".!*", link.toString());
        assertEquals(link, Link.fromString(link.toString(), idGenerator));
        DataOutput dataOutput = new DataOutputImpl();
        link.write(dataOutput);
        assertEquals(link, Link.read(new DataInputImpl(dataOutput.toByteArray()), idGenerator));


        Map<String, String> varProps = new HashMap<String, String>();
        varProps.put("lang", "en");
        varProps.put("branch", "dev");

        RecordId recordId = idGenerator.newRecordId(idGenerator.newRecordId("123"), varProps);

        RecordId resolved = link.resolve(recordId, idGenerator);

        assertEquals(recordId.getMaster(), resolved);
    }

    @Test
    public void testImmutability() {
        Map<String, String> varProps = new HashMap<String, String>();
        varProps.put("lang", "en");
        varProps.put("branch", "dev");

        RecordId masterRecordId = idGenerator.newRecordId("123");
        RecordId recordId = idGenerator.newRecordId(masterRecordId, varProps);

        Link link = Link.newBuilder().recordId(recordId).copyAll(false).create();

        try {
            link.getVariantProps().put("z", null);
            fail("expected exception");
        } catch (UnsupportedOperationException e) {
            // ok
        }

        try {
            link.getMasterRecordId().getVariantProperties().put("z", "z");
            fail("expected exception");
        } catch (UnsupportedOperationException e) {
            // ok
        }

        try {
            recordId.getVariantProperties().put("z", "z");
            fail("expected exception");
        } catch (UnsupportedOperationException e) {
            // ok
        }
    }

    @Test
    public void testEquals() {
        RecordId recordId1 = idGenerator.newRecordId("123");
        RecordId recordId2 = idGenerator.newRecordId("678");
        Link link1 = Link.newBuilder().recordId(recordId1).copyAll(false).create();
        Link link2 = Link.newBuilder().recordId(recordId2).copyAll(false).create();

        Assert.assertEquals(link1, link1);
        Assert.assertFalse(link1.equals(link2));

        Map<String, String> varProps1 = new HashMap<String, String>();
        varProps1.put("lang", "en");
        varProps1.put("branch", "dev");

        Map<String, String> varProps2 = new HashMap<String, String>();
        varProps1.put("lang", "fr");
        varProps1.put("branch", "dev");

        RecordId recordId3 = idGenerator.newRecordId("123", varProps1);
        RecordId recordId4 = idGenerator.newRecordId("123", varProps2);
        Link link3 = Link.newBuilder().recordId(recordId3).copyAll(false).create();
        Link link4 = Link.newBuilder().recordId(recordId4).copyAll(false).create();

        Assert.assertEquals(link3, link3);
        Assert.assertFalse(link3.equals(link4));
    }

    @Test
    public void testLinkBuilder_WithTable() {
        RecordId recordId = idGenerator.newRecordId("42");
        Link link = Link.newBuilder()
                        .recordId(recordId)
                        .table("mytable")
                        .create();

        assertEquals(recordId, link.getMasterRecordId());
        assertEquals("mytable", link.getTable());
    }

    @Test
    public void testLinkBuilder_WithoutTable() {
        RecordId recordId = idGenerator.newRecordId("42");
        Link link = Link.newBuilder()
                         .recordId(recordId)
                         .create();

        assertEquals(recordId, link.getMasterRecordId());
        assertEquals(null, link.getTable());
    }
}