Merge pull request #8 from sebright/census-context-proto

Serializes CensusContextImpl as a Protocol Buffer.

Author: dinooliva

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "proto"]
+	path = proto
+	url = https://github.com/google/census-proto

BUILD

@@ -26,8 +26,10 @@ java_library(
     srcs = glob(["core_native/java/com/google/census/*.java"]),
     deps = [
         ":census-core",
+        "//proto:census_context-proto-java",
         "@guava//jar",
         "@jsr305//jar",
+        "@protobuf//jar",
     ],
 )
 

WORKSPACE

@@ -24,7 +24,18 @@ maven_jar(
     artifact = "junit:junit:4.11",
 )
 
+maven_jar(
+    name = "protobuf",
+    artifact = "com.google.protobuf:protobuf-java:3.0.0",
+)
+
 maven_jar(
     name = "truth",
     artifact = "com.google.truth:truth:0.28",
-)
+)
+
+git_repository(
+    name = "io_bazel",
+    remote = "https://github.com/bazelbuild/bazel",
+    tag = "0.3.1",
+)

core/java/com/google/census/Census.java

@@ -41,7 +41,12 @@ public static CensusContext getCurrent() {
     return CONTEXT_FACTORY.getCurrent();
   }
 
-  /** Creates a {@link CensusContext} from the given on-the-wire encoded representation. */
+  /**
+   * Creates a {@link CensusContext} from the given on-the-wire encoded representation.
+   *
+   * <p>Should be the inverse of {@link CensusContext#serialize()}. The serialized representation
+   * should be based on the {@link CensusContext} protobuf representation.
+   */
   @Nullable
   public static CensusContext deserialize(ByteBuffer buffer) {
     return CONTEXT_FACTORY.deserialize(buffer);

core/java/com/google/census/CensusContext.java

@@ -49,6 +49,9 @@ public final CensusContext with(
   /**
    * Serializes the {@link CensusContext} into the on-the-wire representation.
    *
+   * <p>The inverse of {@link CensusContextFactory#deserialize()} and should be based on the
+   * {@link CensusContext} protobuf representation.
+   *
    * @return serialized bytes.
    */
   public abstract ByteBuffer serialize();

core/java/com/google/census/CensusContextFactory.java

@@ -14,14 +14,17 @@
 package com.google.census;
 
 import java.nio.ByteBuffer;
-
 import javax.annotation.Nullable;
 
 /**
  * Factory class for {@link CensusContext}.
  */
 public abstract class CensusContextFactory {
-  /** Creates a new {@link CensusContext} built from the given on-the-wire encoded representation.
+  /**
+   * Creates a {@link CensusContext} from the given on-the-wire encoded representation.
+   *
+   * <p>Should be the inverse of {@link CensusContext#serialize()}. The serialized representation
+   * should be based on the {@link CensusContext} protobuf representation.
    *
    * @param buffer on-the-wire representation of a {@link CensusContext}
    * @return a {@link CensusContext} deserialized from {@code buffer}

core/javatests/com/google/census/CensusContextFactoryTest.java

@@ -15,14 +15,11 @@
 
 import static com.google.common.truth.Truth.assertThat;
 
-import static java.nio.charset.StandardCharsets.UTF_8;
-
+import java.nio.ByteBuffer;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
 
-import java.nio.ByteBuffer;
-
 /**
  * Tests for {@link CensusContextFactory}.
  */
@@ -33,12 +30,6 @@ public void testDeserializeEmpty() {
     assertThat(Census.deserialize(ByteBuffer.wrap(new byte[0]))).isEqualTo(Census.getDefault());
   }
 
-  @Test
-  public void testDeserializeBadData() {
-    assertThat(Census.deserialize(ByteBuffer.wrap("\2as\3df\2".getBytes(UTF_8))))
-        .isNull();
-  }
-
   @Test
   public void testGetCurrent() {
     assertThat(Census.getCurrent()).isEqualTo(Census.getDefault());

core/javatests/com/google/census/CensusContextTest.java

@@ -147,7 +147,7 @@ public void testMultipleThreadsWithContext() throws Exception {
   // Tests for Object overrides.
   @Test
   public void testEquals() {
-    assertThat(DEFAULT).isEqualTo(DEFAULT);
+    assertThat(DEFAULT).isEqualTo(DEFAULT.builder().build());
     assertThat(DEFAULT.with(K1, V1)).isEqualTo(DEFAULT.with(K1, V1));
     assertThat(DEFAULT.with(K1, V1, K2, V2)).isEqualTo(DEFAULT.with(K1, V1, K2, V2));
     assertThat(DEFAULT.with(K1, V1, K2, V2)).isEqualTo(DEFAULT.with(K2, V2, K1, V1));

core_native/java/com/google/census/CensusContextFactoryImpl.java

@@ -15,30 +15,28 @@
 
 import java.nio.ByteBuffer;
 import java.util.HashMap;
-
 import javax.annotation.Nullable;
 
 /** Native Implementation of {@link CensusContextFactory} */
 final class CensusContextFactoryImpl extends CensusContextFactory {
   static final CensusContextImpl DEFAULT = new CensusContextImpl(new HashMap<String, String>(0));
 
   /**
-   * The serialized tags are of the form:
-   * {@code (<tag prefix> + 'key' + <tag delim> + 'value')}
+   * Deserializes a {@link CensusContextImpl} from a serialized {@link CensusContextProto}.
+   *
+   * <p>The encoded tags are of the form: {@code <tag prefix> + 'key' + <tag delim> + 'value'}*
    */
   @Override
   @Nullable
   public CensusContextImpl deserialize(ByteBuffer buffer) {
     return CensusSerializer.deserialize(buffer);
   }
 
-  /** Returns the current thread-local {@link CensusContext}. */
   @Override
   public CensusContext getCurrent() {
     return CensusCurrentContext.get();
   }
 
-  /** Returns the default {@link CensusContext}. */
   @Override
   public CensusContext getDefault() {
     return DEFAULT;

core_native/java/com/google/census/CensusContextImpl.java

@@ -34,6 +34,11 @@ public CensusContextImpl record(MetricMap stats) {
     return this;
   }
 
+  /**
+   * Serializes a {@link CensusContextImpl} into {@link CensusContextProto} serialized format.
+   *
+   * <p>The encoded tags are of the form: {@code <tag prefix> + 'key' + <tag delim> + 'value'}*
+   */
   @Override
   public ByteBuffer serialize() {
     return CensusSerializer.serialize(this);