diff options
author | Håkon Hallingstad <hakon@verizonmedia.com> | 2019-01-29 21:37:12 +0100 |
---|---|---|
committer | Håkon Hallingstad <hakon@verizonmedia.com> | 2019-01-29 21:37:12 +0100 |
commit | 25267c426ea5d10a41f7876535160156a073af2f (patch) | |
tree | c81dcc15dcd6d4c8b0d9acb14b95b49e30b5598a /vespajlib | |
parent | 5dbacf2ff71a530b62f862b43d9893b47d52e075 (diff) |
Port Slime injection to Java
Diffstat (limited to 'vespajlib')
6 files changed, 527 insertions, 9 deletions
diff --git a/vespajlib/src/main/java/com/yahoo/slime/Injector.java b/vespajlib/src/main/java/com/yahoo/slime/Injector.java new file mode 100644 index 00000000000..3e507cf29c2 --- /dev/null +++ b/vespajlib/src/main/java/com/yahoo/slime/Injector.java @@ -0,0 +1,84 @@ +// Copyright 2019 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.slime; + +/** + * @author hakonhall + */ +public class Injector { + /** + * Inject a slime sub-structure described by an Inspector into a slime + * structure where the insertion point is described by an + * Inserter. This will copy all the values represented by the + * Inspector into the position described by the Inserter. Note that + * this can be used to either copy data from one Slime structure to + * another, or to copy data internally within a single slime + * structure. If the Inspector contains the insertion point it will + * only be expanded once to avoid infinite recursion. + * + * @param inspector what to inject + * @param inserter where to inject + **/ + public void inject(Inspector inspector, Inserter inserter) { + if (inspector.valid()) { + injectValue(inserter, inspector, null); + } + } + + private void injectValue(Inserter inserter, Inspector inspector, Inspector guard) { + switch (inspector.type()) { + case NIX: inserter.insertNIX(); break; + case BOOL: inserter.insertBOOL(inspector.asBool()); break; + case LONG: inserter.insertLONG(inspector.asLong()); break; + case DOUBLE: inserter.insertDOUBLE(inspector.asDouble()); break; + case STRING: inserter.insertSTRING(inspector.asString()); break; + case DATA: inserter.insertDATA(inspector.asData()); break; + case ARRAY: injectArray(inserter, inspector, guard); break; + case OBJECT: injectObject(inserter, inspector, guard); break; + default: throw new IllegalArgumentException("Unknown type " + inspector.type()); + } + } + + private void injectArray(Inserter inserter, Inspector inspector, Inspector guard) { + Cursor cursor = inserter.insertARRAY(); + ArrayTraverser arrayTraverser = new NestedInjector(cursor, guard != null ? guard : cursor); + inspector.traverse(arrayTraverser); + } + + private void injectObject(Inserter inserter, Inspector inspector, Inspector guard) { + Cursor cursor = inserter.insertOBJECT(); + ObjectTraverser objectTraverser = new NestedInjector(cursor, guard != null ? guard : cursor); + inspector.traverse(objectTraverser); + } + + private class NestedInjector implements ArrayTraverser, ObjectTraverser { + private final Cursor cursor; + private final Inspector guard; + + public NestedInjector(Cursor cursor, Inspector guard) { + this.cursor = cursor; + this.guard = guard; + } + + @Override + public void entry(int idx, Inspector inspector) { + if (inspector == guard) { + return; + } + + var inserter = new ArrayInserter(); + inserter.adjust(cursor); + injectValue(inserter, inspector, guard); + } + + @Override + public void field(String name, Inspector inspector) { + if (inspector == guard) { + return; + } + + var inserter = new ObjectInserter(); + inserter.adjust(cursor, name); + injectValue(inserter, inspector, guard); + } + } +} diff --git a/vespajlib/src/main/java/com/yahoo/slime/Inspector.java b/vespajlib/src/main/java/com/yahoo/slime/Inspector.java index 99489faca47..ca2e678c152 100644 --- a/vespajlib/src/main/java/com/yahoo/slime/Inspector.java +++ b/vespajlib/src/main/java/com/yahoo/slime/Inspector.java @@ -131,4 +131,11 @@ public interface Inspector { */ Inspector field(String name); + /** + * Tests whether this is equal to Inspector. + * + * @param that inspector. + * @return true if they are equal. + */ + boolean equalTo(Inspector that); } diff --git a/vespajlib/src/main/java/com/yahoo/slime/ObjectInserter.java b/vespajlib/src/main/java/com/yahoo/slime/ObjectInserter.java index 3e0073beccd..450b5271db4 100644 --- a/vespajlib/src/main/java/com/yahoo/slime/ObjectInserter.java +++ b/vespajlib/src/main/java/com/yahoo/slime/ObjectInserter.java @@ -1,6 +1,8 @@ // Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. package com.yahoo.slime; +import java.util.Optional; + /** * Helper class for inserting values into an ObjectValue. * For justification read Inserter documentation. @@ -8,18 +10,64 @@ package com.yahoo.slime; final class ObjectInserter implements Inserter { private Cursor target; private int symbol; + private Optional<String> symbolName = Optional.empty(); + public final ObjectInserter adjust(Cursor c, int sym) { target = c; symbol = sym; + symbolName = Optional.empty(); + return this; + } + + public final ObjectInserter adjust(Cursor c, String name) { + target = c; + symbol = -1; + symbolName = Optional.of(name); return this; } - public final Cursor insertNIX() { return target.setNix(symbol); } - public final Cursor insertBOOL(boolean value) { return target.setBool(symbol, value); } - public final Cursor insertLONG(long value) { return target.setLong(symbol, value); } - public final Cursor insertDOUBLE(double value) { return target.setDouble(symbol, value); } - public final Cursor insertSTRING(String value) { return target.setString(symbol, value); } - public final Cursor insertSTRING(byte[] utf8) { return target.setString(symbol, utf8); } - public final Cursor insertDATA(byte[] value) { return target.setData(symbol, value); } - public final Cursor insertARRAY() { return target.setArray(symbol); } - public final Cursor insertOBJECT() { return target.setObject(symbol); } + + public final Cursor insertNIX() { + return symbolName.map(name -> target.setNix(name)) + .orElseGet(() -> target.setNix(symbol)); + } + + public final Cursor insertBOOL(boolean value) { + return symbolName.map(name -> target.setBool(name, value)) + .orElseGet(() -> target.setBool(symbol, value)); + } + + public final Cursor insertLONG(long value) { + return symbolName.map(name -> target.setLong(name, value)) + .orElseGet(() -> target.setLong(symbol, value)); + } + + public final Cursor insertDOUBLE(double value) { + return symbolName.map(name -> target.setDouble(name, value)) + .orElseGet(() -> target.setDouble(symbol, value)); + } + + public final Cursor insertSTRING(String value) { + return symbolName.map(name -> target.setString(name, value)) + .orElseGet(() -> target.setString(symbol, value)); + } + + public final Cursor insertSTRING(byte[] utf8) { + return symbolName.map(name -> target.setString(name, utf8)) + .orElseGet(() -> target.setString(symbol, utf8)); + } + + public final Cursor insertDATA(byte[] value) { + return symbolName.map(name -> target.setData(name, value)) + .orElseGet(() -> target.setData(symbol, value)); + } + + public final Cursor insertARRAY() { + return symbolName.map(name -> target.setArray(name)) + .orElseGet(() -> target.setArray(symbol)); + } + + public final Cursor insertOBJECT() { + return symbolName.map(name -> target.setObject(name)) + .orElseGet(() -> target.setObject(symbol)); + } } diff --git a/vespajlib/src/main/java/com/yahoo/slime/Value.java b/vespajlib/src/main/java/com/yahoo/slime/Value.java index 51a8262333b..183c659c35a 100644 --- a/vespajlib/src/main/java/com/yahoo/slime/Value.java +++ b/vespajlib/src/main/java/com/yahoo/slime/Value.java @@ -3,6 +3,7 @@ package com.yahoo.slime; import java.io.ByteArrayOutputStream; +import java.util.Arrays; /** * Common implementation for all value types. @@ -84,4 +85,82 @@ abstract class Value implements Cursor { return "null"; } } + + private static class Equal { + protected final Inspector rhsInspector; + + protected boolean equal = true; + + public Equal(Inspector rhsInspector) { this.rhsInspector = rhsInspector; } + + public boolean isEqual() { return equal; } + } + + private static class EqualArray extends Equal implements ArrayTraverser { + public EqualArray(Inspector rhsInspector) { super(rhsInspector); } + + @Override + public void entry(int idx, Inspector inspector) { + if (equal) { + equal = inspector.equalTo(rhsInspector.entry(idx)); + } + } + } + + private static class EqualObject extends Equal implements ObjectTraverser { + public EqualObject(Inspector rhsInspector) { super(rhsInspector); } + + @Override + public void field(String name, Inspector inspector) { + if (equal) { + equal = inspector.equalTo(rhsInspector.field(name)); + } + } + } + + @Override + public boolean equalTo(Inspector that) { + boolean equal = type() == that.type(); + + if (equal) { + switch (type()) { + case NIX: + break; + case BOOL: + equal = asBool() == that.asBool(); + break; + case LONG: + equal = asLong() == that.asLong(); + break; + case DOUBLE: + equal = Double.compare(asDouble(), that.asDouble()) == 0; + break; + case STRING: + equal = asString().equals(that.asString()); + break; + case DATA: + equal = Arrays.equals(asData(), that.asData()); + break; + case ARRAY: + { + var traverser = new EqualArray(that); + traverse(traverser); + equal = traverser.isEqual() && (entries() == that.entries()); + } + break; + case OBJECT: + { + var traverser = new EqualObject(that); + traverse(traverser); + equal = traverser.isEqual() && (fields() == that.fields()); + } + break; + default: + assert(false); + break; + } + } + + return equal; + } } diff --git a/vespajlib/src/test/java/com/yahoo/slime/InjectorTest.java b/vespajlib/src/test/java/com/yahoo/slime/InjectorTest.java new file mode 100644 index 00000000000..cfafe5ede04 --- /dev/null +++ b/vespajlib/src/test/java/com/yahoo/slime/InjectorTest.java @@ -0,0 +1,177 @@ +// Copyright 2019 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.slime; + +import org.junit.Before; +import org.junit.Test; + +import java.nio.charset.StandardCharsets; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +/** + * @author hakonhall + */ +public class InjectorTest { + private static class SourceFixture { + public final Slime empty = new Slime(); + public final Slime nixValue = new Slime(); + public final Slime boolValue = new Slime(); + public final Slime longValue = new Slime(); + public final Slime doubleValue = new Slime(); + public final Slime stringValue = new Slime(); + public final Slime dataValue = new Slime(); + public final Slime arrayValue = new Slime(); + public final Slime objectValue = new Slime(); + + SourceFixture() { + nixValue.setNix(); + boolValue.setBool(true); + longValue.setLong(10); + doubleValue.setDouble(20.0); + stringValue.setString("string"); + dataValue.setData("data".getBytes(StandardCharsets.UTF_8)); + Cursor arr = arrayValue.setArray(); + arr.addLong(1); + arr.addLong(2); + arr.addLong(3); + Cursor obj = objectValue.setObject(); + obj.setLong("a", 1); + obj.setLong("b", 2); + obj.setLong("c", 3); + } + } + + private static class DestinationFixture { + public final Slime slime1 = new Slime(); + public final Slime slime2 = new Slime(); + public final Slime slime3 = new Slime(); + public final Slime slime4 = new Slime(); + public final Slime slime5 = new Slime(); + public final Slime slime6 = new Slime(); + public final Slime slime7 = new Slime(); + public final Slime slime8 = new Slime(); + public final Slime slime9 = new Slime(); + } + + private final SourceFixture f1 = new SourceFixture(); + private final DestinationFixture f2 = new DestinationFixture(); + + private final Injector injector = new Injector(); + + @Before + public void setUp() { + } + + private void inject(Inspector inspector, Inserter inserter) { + injector.inject(inspector, inserter); + } + + private Inserter slimeInserter(Slime slime) { + var inserter = new SlimeInserter(); + inserter.adjust(slime); + return inserter; + } + + private Inserter arrayInserter(Cursor cursor) { + var inserter = new ArrayInserter(); + inserter.adjust(cursor); + return inserter; + } + + private Inserter objectInserter(Cursor cursor, String name) { + var inserter = new ObjectInserter(); + inserter.adjust(cursor, name); + return inserter; + } + + private void assertEqualTo(Inspector left, Inspector right) { + assertTrue("'" + left + "' not equal to '" + right + "'", left.equalTo(right)); + } + + @Test + public void injectIntoSlime() { + assertTrue(f1.empty.get().valid()); // explicit nix + + inject(f1.empty.get(), slimeInserter(f2.slime1)); + inject(f1.nixValue.get(), slimeInserter(f2.slime2)); + inject(f1.boolValue.get(), slimeInserter(f2.slime3)); + inject(f1.longValue.get(), slimeInserter(f2.slime4)); + inject(f1.doubleValue.get(), slimeInserter(f2.slime5)); + inject(f1.stringValue.get(), slimeInserter(f2.slime6)); + inject(f1.dataValue.get(), slimeInserter(f2.slime7)); + inject(f1.arrayValue.get(), slimeInserter(f2.slime8)); + inject(f1.objectValue.get(), slimeInserter(f2.slime9)); + + assertEquals(f1.empty.get().toString(), f2.slime1.get().toString()); + assertEquals(f1.nixValue.get().toString(), f2.slime2.get().toString()); + assertEquals(f1.boolValue.get().toString(), f2.slime3.get().toString()); + assertEquals(f1.longValue.get().toString(), f2.slime4.get().toString()); + assertEquals(f1.doubleValue.get().toString(), f2.slime5.get().toString()); + assertEquals(f1.stringValue.get().toString(), f2.slime6.get().toString()); + assertEquals(f1.dataValue.get().toString(), f2.slime7.get().toString()); + assertEquals(f1.arrayValue.get().toString(), f2.slime8.get().toString()); + assertEqualTo(f1.objectValue.get(), f2.slime9.get()); + + } + + @Test + public void injectIntoArray() { + f2.slime1.setArray(); + inject(f1.empty.get(), arrayInserter(f2.slime1.get())); + inject(f1.nixValue.get(), arrayInserter(f2.slime1.get())); + inject(f1.boolValue.get(), arrayInserter(f2.slime1.get())); + inject(f1.longValue.get(), arrayInserter(f2.slime1.get())); + inject(f1.doubleValue.get(), arrayInserter(f2.slime1.get())); + inject(f1.stringValue.get(), arrayInserter(f2.slime1.get())); + inject(f1.dataValue.get(), arrayInserter(f2.slime1.get())); + inject(f1.arrayValue.get(), arrayInserter(f2.slime1.get())); + inject(f1.objectValue.get(), arrayInserter(f2.slime1.get())); + + assertEquals(f1.empty.get().toString(), f2.slime1.get().entry(0).toString()); + assertEquals(f1.nixValue.get().toString(), f2.slime1.get().entry(1).toString()); + assertEquals(f1.boolValue.get().toString(), f2.slime1.get().entry(2).toString()); + assertEquals(f1.longValue.get().toString(), f2.slime1.get().entry(3).toString()); + assertEquals(f1.doubleValue.get().toString(), f2.slime1.get().entry(4).toString()); + assertEquals(f1.stringValue.get().toString(), f2.slime1.get().entry(5).toString()); + assertEquals(f1.dataValue.get().toString(), f2.slime1.get().entry(6).toString()); + assertEquals(f1.arrayValue.get().toString(), f2.slime1.get().entry(7).toString()); + assertEqualTo(f1.objectValue.get(), f2.slime1.get().entry(8)); + } + + @Test + public void injectIntoObject() { + f2.slime1.setObject(); + inject(f1.empty.get(), objectInserter(f2.slime1.get(), "a")); + inject(f1.nixValue.get(), objectInserter(f2.slime1.get(), "b")); + inject(f1.boolValue.get(), objectInserter(f2.slime1.get(), "c")); + inject(f1.longValue.get(), objectInserter(f2.slime1.get(), "d")); + inject(f1.doubleValue.get(), objectInserter(f2.slime1.get(), "e")); + inject(f1.stringValue.get(), objectInserter(f2.slime1.get(), "f")); + inject(f1.dataValue.get(), objectInserter(f2.slime1.get(), "g")); + inject(f1.arrayValue.get(), objectInserter(f2.slime1.get(), "h")); + inject(f1.objectValue.get(), objectInserter(f2.slime1.get(), "i")); + + assertEquals(f1.empty.get().toString(), f2.slime1.get().field("a").toString()); + assertEquals(f1.nixValue.get().toString(), f2.slime1.get().field("b").toString()); + assertEquals(f1.boolValue.get().toString(), f2.slime1.get().field("c").toString()); + assertEquals(f1.longValue.get().toString(), f2.slime1.get().field("d").toString()); + assertEquals(f1.doubleValue.get().toString(), f2.slime1.get().field("e").toString()); + assertEquals(f1.stringValue.get().toString(), f2.slime1.get().field("f").toString()); + assertEquals(f1.dataValue.get().toString(), f2.slime1.get().field("g").toString()); + assertEquals(f1.arrayValue.get().toString(), f2.slime1.get().field("h").toString()); + assertEqualTo(f1.objectValue.get(), f2.slime1.get().field("i")); + } + + @Test + public void invalidInjectionIsIgnored() { + inject(f1.arrayValue.get(), slimeInserter(f2.slime1)); + assertEquals(3, f2.slime1.get().entries()); + inject(f1.longValue.get(), arrayInserter(f2.slime1.get())); + assertEquals(4, f2.slime1.get().entries()); + inject(f1.doubleValue.get(), arrayInserter(f2.slime1.get())); + assertEquals(5, f2.slime1.get().entries()); + inject(f1.nixValue.get().field("bogus"), arrayInserter(f2.slime1.get())); + assertEquals(5, f2.slime1.get().entries()); + } +}
\ No newline at end of file diff --git a/vespajlib/src/test/java/com/yahoo/slime/ValueTest.java b/vespajlib/src/test/java/com/yahoo/slime/ValueTest.java new file mode 100644 index 00000000000..a0e3c8029ca --- /dev/null +++ b/vespajlib/src/test/java/com/yahoo/slime/ValueTest.java @@ -0,0 +1,123 @@ +// Copyright 2019 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.slime; + +import org.junit.Test; + +import java.nio.charset.StandardCharsets; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +/** + * @author hakonhall + */ +public class ValueTest { + @Test + public void verifyObjectEquality() { + Slime slimeLeft = new Slime(); + Cursor left = slimeLeft.setObject(); + left.setString("a", "A"); + left.setString("b", "B"); + + Slime slimeRight = new Slime(); + Cursor right = slimeRight.setObject(); + right.setString("b", "B"); + right.setString("a", "A"); + + assertTrue(left.equalTo(right)); + assertTrue(right.equalTo(left)); + assertTrue(left.equalTo(left)); + + right.setString("c", "C"); + assertFalse(left.equalTo(right)); + assertFalse(right.equalTo(left)); + } + + @Test + public void verifyArrayEquality() { + Slime slimeLeft = new Slime(); + Cursor left = slimeLeft.setArray(); + left.addArray().addString("a"); + left.addArray().addString("b"); + + Slime slimeRight = new Slime(); + Cursor right = slimeRight.setArray(); + right.addArray().addString("a"); + right.addArray().addString("b"); + + assertTrue(left.equalTo(right)); + assertTrue(right.equalTo(left)); + assertTrue(left.equalTo(left)); + + right.addArray().addString("c"); + assertFalse(left.equalTo(right)); + assertFalse(right.equalTo(left)); + + // Order matters + Slime slimeRight2 = new Slime(); + Cursor right2 = slimeRight2.setObject(); + right2.addArray().addString("b"); + right2.addArray().addString("a"); + assertFalse(left.equalTo(right2)); + assertFalse(right2.equalTo(left)); + } + + @Test + public void verifyPrimitiveEquality() { + Slime left = new Slime(); + Cursor leftObject = left.setObject(); + populateWithPrimitives(leftObject, true); + + Slime right = new Slime(); + Cursor rightObject = right.setObject(); + populateWithPrimitives(rightObject, true); + + assertEqualTo(left.get().field("bool"), right.get().field("bool")); + assertEqualTo(left.get().field("nix"), right.get().field("nix")); + assertEqualTo(left.get().field("long"), right.get().field("long")); + assertEqualTo(left.get().field("string"), right.get().field("string")); + assertEqualTo(left.get().field("data"), right.get().field("data")); + assertEqualTo(left.get(), right.get()); + + assertNotEqualTo(left.get().field("bool"), right.get().field("nix")); + assertNotEqualTo(left.get().field("nix"), right.get().field("string")); + assertNotEqualTo(left.get().field("string"), right.get().field("data")); + assertNotEqualTo(left.get().field("bool"), right.get().field("data")); + assertNotEqualTo(left.get().field("bool"), right.get().field("long")); + } + + @Test + public void verifyPrimitiveNotEquality() { + Slime left = new Slime(); + Cursor leftObject = left.setObject(); + populateWithPrimitives(leftObject, true); + + Slime right = new Slime(); + Cursor rightObject = right.setObject(); + populateWithPrimitives(rightObject, false); + + assertNotEqualTo(left.get().field("bool"), right.get().field("bool")); + assertEqualTo(left.get().field("nix"), right.get().field("nix")); + assertNotEqualTo(left.get().field("long"), right.get().field("long")); + assertNotEqualTo(left.get().field("string"), right.get().field("string")); + assertNotEqualTo(left.get().field("data"), right.get().field("data")); + assertNotEqualTo(left.get(), right.get()); + } + + private void populateWithPrimitives(Cursor cursor, boolean enabled) { + cursor.setBool("bool", enabled ? true : false); + cursor.setNix("nix"); + cursor.setLong("long", enabled ? 1 : 0); + cursor.setString("string", enabled ? "enabled" : "disabled"); + cursor.setDouble("double", enabled ? 1.5 : 0.5); + cursor.setData("data", (enabled ? "edata" : "ddata").getBytes(StandardCharsets.UTF_8)); + } + + private void assertEqualTo(Inspector left, Inspector right) { + assertTrue("'" + left + "' is not equal to '" + right + "'", left.equalTo(right)); + } + + private void assertNotEqualTo(Inspector left, Inspector right) { + assertTrue("'" + left + "' is equal to '" + right + "'", !left.equalTo(right)); + } +}
\ No newline at end of file |