StatsTrackTest.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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.zookeeper.test;
import org.apache.zookeeper.StatsTrack;
import org.junit.Assert;
import org.junit.Test;
public class StatsTrackTest {
public static class OldStatsTrack {
private int count;
private long bytes;
private String countStr = "count";
private String byteStr = "bytes";
/**
* a default constructor for
* stats
*/
public OldStatsTrack() {
this(null);
}
/**
* the stat string should be of the form count=int,bytes=long
* if stats is called with null the count and bytes are initialized
* to -1.
* @param stats the stat string to be initialized with
*/
public OldStatsTrack(String stats) {
if (stats == null) {
stats = "count=-1,bytes=-1";
}
String[] split = stats.split(",");
if (split.length != 2) {
throw new IllegalArgumentException("invalid string " + stats);
}
count = Integer.parseInt(split[0].split("=")[1]);
bytes = Long.parseLong(split[1].split("=")[1]);
}
/**
* get the count of nodes allowed as part of quota
*
* @return the count as part of this string
*/
public int getCount() {
return this.count;
}
/**
* set the count for this stat tracker.
*
* @param count
* the count to set with
*/
public void setCount(int count) {
this.count = count;
}
/**
* get the count of bytes allowed as part of quota
*
* @return the bytes as part of this string
*/
public long getBytes() {
return this.bytes;
}
/**
* set the bytes for this stat tracker.
*
* @param bytes
* the bytes to set with
*/
public void setBytes(long bytes) {
this.bytes = bytes;
}
@Override
/*
* returns the string that maps to this stat tracking.
*/
public String toString() {
return countStr + "=" + count + "," + byteStr + "=" + bytes;
}
}
@Test
public void testBackwardCompatibility() {
StatsTrack quota = new StatsTrack();
quota.setCount(4);
quota.setCountHardLimit(4);
quota.setBytes(9L);
quota.setByteHardLimit(15L);
Assert.assertEquals("count=4,bytes=9=;byteHardLimit=15;countHardLimit=4", quota.toString());
OldStatsTrack ost = new OldStatsTrack(quota.toString());
Assert.assertTrue("bytes are set", ost.getBytes() == 9L);
Assert.assertTrue("num count is set", ost.getCount() == 4);
Assert.assertEquals("count=4,bytes=9", ost.toString());
}
@Test
public void testUpwardCompatibility() {
OldStatsTrack ost = new OldStatsTrack(null);
ost.setCount(2);
ost.setBytes(5);
Assert.assertEquals("count=2,bytes=5", ost.toString());
StatsTrack st = new StatsTrack(ost.toString());
Assert.assertEquals("count=2,bytes=5", st.toString());
Assert.assertEquals(5, st.getBytes());
Assert.assertEquals(2, st.getCount());
Assert.assertEquals(-1, st.getByteHardLimit());
Assert.assertEquals(-1, st.getCountHardLimit());
}
// ------------------------------------------------------------------
// Hardening against malformed quota-stats data (ZOOKEEPER quota-poison):
// a StatsTrack parsed on the transaction-apply path must never throw, or
// it kills the SyncRequestProcessor critical thread and, since the trigger
// txn is durable, the dataDir becomes unbootable on replay.
// ------------------------------------------------------------------
@Test
public void testMalformedValueNoDelimiterDoesNotThrow() {
// "x" has no '=' -> previously ArrayIndexOutOfBoundsException at kv[1]
StatsTrack st = new StatsTrack("x");
Assert.assertEquals(-1, st.getCount());
Assert.assertEquals(-1, st.getBytes());
}
@Test
public void testMalformedNonNumericValueDoesNotThrow() {
// "count=abc" -> previously NumberFormatException
StatsTrack st = new StatsTrack("count=abc");
Assert.assertEquals(-1, st.getCount());
}
@Test
public void testMalformedFromBytesDoesNotThrow() {
StatsTrack st = new StatsTrack("x".getBytes());
Assert.assertEquals(-1, st.getCount());
Assert.assertEquals(-1, st.getBytes());
}
@Test
public void testNullBytesDoesNotThrow() {
// null payload (jute length -1) must not NPE new String(null, ...)
StatsTrack st = new StatsTrack((byte[]) null);
Assert.assertEquals(-1, st.getCount());
Assert.assertEquals(-1, st.getBytes());
}
@Test
public void testPartiallyMalformedKeepsGoodEntries() {
// good entries survive, only the bad pair is skipped
StatsTrack st = new StatsTrack("count=5,bytes=zzz");
Assert.assertEquals(5, st.getCount());
Assert.assertEquals(-1, st.getBytes());
}
@Test
public void testEmptyAndNullDoNotThrow() {
Assert.assertEquals(-1, new StatsTrack("").getCount());
Assert.assertEquals(-1, new StatsTrack((String) null).getCount());
}
@Test
public void testHardLimitRoundTripStillWorks() {
// Guards the compatibility sentinel trailing '=' produced by toString():
// parsing must recover every field, including the hard limits.
StatsTrack quota = new StatsTrack();
quota.setCount(4);
quota.setCountHardLimit(4);
quota.setBytes(9L);
quota.setByteHardLimit(15L);
String serialized = quota.toString();
Assert.assertEquals("count=4,bytes=9=;byteHardLimit=15;countHardLimit=4", serialized);
StatsTrack reparsed = new StatsTrack(serialized);
Assert.assertEquals(4, reparsed.getCount());
Assert.assertEquals(9L, reparsed.getBytes());
Assert.assertEquals(15L, reparsed.getByteHardLimit());
Assert.assertEquals(4, reparsed.getCountHardLimit());
}
@Test
public void testIsValidStatsData() {
// well-formed, including the compatibility sentinel format
Assert.assertTrue(StatsTrack.isValidStatsData(new byte[0]));
Assert.assertTrue(StatsTrack.isValidStatsData("count=5,bytes=10".getBytes()));
Assert.assertTrue(StatsTrack.isValidStatsData(
"count=4,bytes=9=;byteHardLimit=15;countHardLimit=4".getBytes()));
// malformed -> rejected at prep time
Assert.assertFalse(StatsTrack.isValidStatsData(null));
Assert.assertFalse(StatsTrack.isValidStatsData("x".getBytes()));
Assert.assertFalse(StatsTrack.isValidStatsData("count=abc".getBytes()));
Assert.assertFalse(StatsTrack.isValidStatsData("=5".getBytes()));
Assert.assertFalse(StatsTrack.isValidStatsData("count=5,x".getBytes()));
}
}