[ECR-4021] reflect proto changes for Block (#1350)

bullet-tooth · Ilya Bogdanov · commit 2cc97c19bcbe · 2020-01-09T12:18:57.000+03:00
diff --git a/exonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/Block.java b/exonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/Block.java
@@ -22,8 +22,10 @@
 import com.exonum.binding.core.blockchain.serialization.CoreTypeAdapterFactory;
 import com.exonum.binding.core.service.Schema;
 import com.google.auto.value.AutoValue;
+import com.google.common.collect.ImmutableMap;
 import com.google.gson.Gson;
 import com.google.gson.TypeAdapter;
+import com.google.protobuf.ByteString;
 
 /**
  * Exonum block header data structure.
@@ -90,6 +92,19 @@ public final boolean isEmpty() {
    */
   public abstract HashCode getStateHash();
 
+  /**
+   * Root hash of exceptions occurred in the block.
+   *
+   * @see Blockchain#getCallErrors()
+   */
+  public abstract HashCode getErrorHash();
+
+  /**
+   * Contains additional block headers of the block.
+   * The key is a block header; and the value is a header bytes value.
+   */
+  public abstract ImmutableMap<String, ByteString> getAdditionalHeaders();
+
   @Override
   public int hashCode() {
     // Use just the first 4 bytes of the SHA-256 hash of the binary object representation,
@@ -161,6 +176,19 @@ public abstract static class Builder {
      */
     public abstract Builder stateHash(HashCode blockchainStateHash);
 
+    /**
+     * Sets error hash.
+     *
+     * @see Blockchain#getCallErrors()
+     */
+    public abstract Builder errorHash(HashCode errorHash);
+
+    /**
+     * Sets additional block headers. Headers should have exactly the same order
+     * as its native equivalent. Changing headers order will lead to the block hash violation.
+     */
+    public abstract Builder additionalHeaders(ImmutableMap<String, ByteString> additionalHeaders);
+
     abstract Block autoBuild();
 
     /**
diff --git a/exonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/serialization/BlockSerializer.java b/exonum-java-binding/core/src/main/java/com/exonum/binding/core/blockchain/serialization/BlockSerializer.java
@@ -17,14 +17,21 @@
 package com.exonum.binding.core.blockchain.serialization;
 
 import static com.exonum.binding.common.serialization.StandardSerializers.protobuf;
+import static com.google.common.collect.ImmutableMap.toImmutableMap;
 
 import com.exonum.binding.common.hash.HashCode;
 import com.exonum.binding.common.hash.Hashing;
 import com.exonum.binding.common.serialization.Serializer;
 import com.exonum.binding.core.blockchain.Block;
 import com.exonum.core.messages.Blockchain;
+import com.exonum.core.messages.Blockchain.AdditionalHeaders;
+import com.exonum.core.messages.KeyValueSequenceOuterClass.KeyValue;
+import com.exonum.core.messages.KeyValueSequenceOuterClass.KeyValueSequence;
+import com.exonum.core.messages.KeyValueSequenceOuterClass.KeyValueSequence.Builder;
 import com.exonum.core.messages.Types;
 import com.exonum.core.messages.Types.Hash;
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.ImmutableMap;
 import com.google.protobuf.ByteString;
 
 public enum BlockSerializer implements Serializer<Block> {
@@ -42,6 +49,8 @@ public byte[] toBytes(Block value) {
         .setPrevHash(toHashProto(value.getPreviousBlockHash()))
         .setTxHash(toHashProto(value.getTxRootHash()))
         .setStateHash(toHashProto(value.getStateHash()))
+        .setErrorHash(toHashProto(value.getErrorHash()))
+        .setAdditionalHeaders(toHeadersProto(value.getAdditionalHeaders()))
         .build();
     return block.toByteArray();
   }
@@ -58,6 +67,8 @@ public Block fromBytes(byte[] binaryBlock) {
         .previousBlockHash(toHashCode(copiedBlocks.getPrevHash()))
         .txRootHash(toHashCode(copiedBlocks.getTxHash()))
         .stateHash(toHashCode(copiedBlocks.getStateHash()))
+        .errorHash(toHashCode(copiedBlocks.getErrorHash()))
+        .additionalHeaders(toHeadersMap(copiedBlocks.getAdditionalHeaders()))
         .build();
   }
 
@@ -72,4 +83,30 @@ private static HashCode toHashCode(Hash hash) {
     ByteString bytes = hash.getData();
     return HashCode.fromBytes(bytes.toByteArray());
   }
+
+  @VisibleForTesting
+  static ImmutableMap<String, ByteString> toHeadersMap(AdditionalHeaders headers) {
+    return headers.getHeaders().getEntryList()
+        .stream()
+        .collect(toImmutableMap(KeyValue::getKey, KeyValue::getValue));
+  }
+
+  @VisibleForTesting
+  static AdditionalHeaders toHeadersProto(ImmutableMap<String, ByteString> headers) {
+    Builder additionalHeadersBuilder = KeyValueSequence.newBuilder();
+
+    headers.forEach((k, v) -> additionalHeadersBuilder.addEntry(toProtoEntry(k, v)));
+
+    return AdditionalHeaders.newBuilder()
+        .setHeaders(additionalHeadersBuilder.build())
+        .build();
+  }
+
+  private static KeyValue toProtoEntry(String key, ByteString value) {
+    return KeyValue.newBuilder()
+        .setKey(key)
+        .setValue(value)
+        .build();
+  }
+
 }
diff --git a/exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/BlockTest.java b/exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/BlockTest.java
@@ -24,6 +24,7 @@
 import com.exonum.binding.common.hash.HashFunction;
 import com.exonum.binding.common.hash.Hashing;
 import com.exonum.binding.core.blockchain.Block.Builder;
+import com.google.common.collect.ImmutableMap;
 import nl.jqno.equalsverifier.EqualsVerifier;
 import nl.jqno.equalsverifier.Warning;
 import org.junit.jupiter.api.Test;
@@ -72,6 +73,8 @@ private static Builder aBlock() {
         .blockHash(hashFunction.hashLong(blockHeight))
         .previousBlockHash(hashFunction.hashLong(blockHeight - 1))
         .txRootHash(hashFunction.hashString("transactions at" + blockHeight, UTF_8))
-        .stateHash(hashFunction.hashString("state hash at " + blockHeight, UTF_8));
+        .stateHash(hashFunction.hashString("state hash at " + blockHeight, UTF_8))
+        .additionalHeaders(ImmutableMap.of())
+        .errorHash(HashCode.fromString("ab"));
   }
 }
diff --git a/exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/Blocks.java b/exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/Blocks.java
@@ -40,6 +40,8 @@ public static Block withProperHash(Block block) {
         .previousBlockHash(block.getPreviousBlockHash())
         .txRootHash(block.getTxRootHash())
         .stateHash(block.getStateHash())
+        .errorHash(block.getErrorHash())
+        .additionalHeaders(block.getAdditionalHeaders())
         .build();
   }
 
diff --git a/exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/serialization/BlockSerializerTest.java b/exonum-java-binding/core/src/test/java/com/exonum/binding/core/blockchain/serialization/BlockSerializerTest.java
@@ -16,14 +16,23 @@
 
 package com.exonum.binding.core.blockchain.serialization;
 
+import static com.exonum.binding.core.blockchain.serialization.BlockSerializer.toHeadersMap;
+import static com.exonum.binding.core.blockchain.serialization.BlockSerializer.toHeadersProto;
 import static org.hamcrest.CoreMatchers.equalTo;
+import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
 
 import com.exonum.binding.common.hash.HashCode;
 import com.exonum.binding.common.serialization.Serializer;
 import com.exonum.binding.core.blockchain.Block;
 import com.exonum.binding.core.blockchain.Blocks;
+import com.exonum.core.messages.Blockchain.AdditionalHeaders;
+import com.exonum.core.messages.KeyValueSequenceOuterClass.KeyValue;
+import com.exonum.core.messages.KeyValueSequenceOuterClass.KeyValueSequence;
+import com.google.common.collect.ImmutableMap;
+import com.google.protobuf.ByteString;
 import java.util.stream.Stream;
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 
@@ -49,6 +58,8 @@ private static Stream<Block> testSource() {
         .previousBlockHash(HashCode.fromString("bc"))
         .txRootHash(HashCode.fromString("cd"))
         .stateHash(HashCode.fromString("ab"))
+        .additionalHeaders(ImmutableMap.of())
+        .errorHash(HashCode.fromString("ef"))
         .build();
     Block block2 = Block.builder()
         .proposerId(Integer.MAX_VALUE)
@@ -58,9 +69,34 @@ private static Stream<Block> testSource() {
         .previousBlockHash(HashCode.fromString("bc"))
         .txRootHash(HashCode.fromString("cd"))
         .stateHash(HashCode.fromString("ab"))
+        .additionalHeaders(ImmutableMap.of("one", ByteString.copyFromUtf8("abcd01")))
+        .errorHash(HashCode.fromString("ef"))
         .build();
 
     return Stream.of(block1, block2)
         .map(Blocks::withProperHash);
   }
+
+  @Test
+  void headersMapStrictOrderRoundTripTest() {
+    KeyValue first = KeyValue.newBuilder()
+        .setKey("foo")
+        .setValue(ByteString.EMPTY)
+        .build();
+    KeyValue second = KeyValue.newBuilder()
+        .setKey("bar")
+        .setValue(ByteString.EMPTY)
+        .build();
+    AdditionalHeaders expected = AdditionalHeaders.newBuilder()
+        .setHeaders(KeyValueSequence.newBuilder()
+            .addEntry(first)
+            .addEntry(second)
+            .build())
+        .build();
+
+    AdditionalHeaders actual = toHeadersProto(toHeadersMap(expected));
+
+    assertThat(actual, is(expected));
+  }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@ public static Block withProperHash(Block block) {`
`40`	`40`	`.previousBlockHash(block.getPreviousBlockHash())`
`41`	`41`	`.txRootHash(block.getTxRootHash())`
`42`	`42`	`.stateHash(block.getStateHash())`
	`43`	`+ .errorHash(block.getErrorHash())`
	`44`	`+ .additionalHeaders(block.getAdditionalHeaders())`
`43`	`45`	`.build();`
`44`	`46`	`}`
`45`	`47`