sparkybe-onap-service/src/test/java/org/onap/aai/sparky/analytics/AveragingRingBufferTest.java

   1 /**
   2  * ============LICENSE_START===================================================
   3  * SPARKY (AAI UI service)
   4  * ============================================================================
   5  * Copyright © 2017 AT&T Intellectual Property.
   6  * Copyright © 2017 Amdocs
   7  * All rights reserved.
   8  * ============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=====================================================
  21  *
  22  * ECOMP and OpenECOMP are trademarks
  23  * and service marks of AT&T Intellectual Property.
  24  */
  25
  26 package org.onap.aai.sparky.analytics;
  27
  28 import static org.junit.Assert.assertEquals;
  29
  30 import java.security.SecureRandom;
  31
  32 import org.junit.Before;
  33 import org.junit.Test;
  34 import org.junit.runner.RunWith;
  35 import org.mockito.runners.MockitoJUnitRunner;
  36 import org.onap.aai.sparky.analytics.AveragingRingBuffer;
  37
  38 /**
  39  * The Class AveragingRingBufferTest.
  40  */
  41 @RunWith(MockitoJUnitRunner.class)
  42 public class AveragingRingBufferTest {
  43
  44   protected SecureRandom random = new SecureRandom();
  45
  46   /**
  47    * Inits the.
  48    *
  49    * @throws Exception the exception
  50    */
  51   @Before
  52   public void init() throws Exception {
  53     // nothing at the moment
  54   }
  55
  56   /**
  57    * Validate pre index roll averaging.
  58    */
  59   @Test
  60   public void validatePreIndexRollAveraging() {
  61
  62     AveragingRingBuffer arb = new AveragingRingBuffer(5);
  63     assertEquals(0, arb.getAvg());
  64
  65     /*
  66      * On initial buffer fill, the average will be re-calculated on the fly for the first nth data
  67      * points until the data buffer has been filled the first time, and then the buffer
  68      * automatically recalculates the average every time the buffer index rolls over, to the keep
  69      * the average relative to the last "nth" data points.
  70      */
  71
  72     // [ 1, 0, 0, 0, 0 ], sum = 1, avg = 1/1 =1
  73     arb.addSample(1);
  74     assertEquals(1, arb.getAvg());
  75
  76     // [ 1, 2, 0, 0, 0 ], sum = 3, avg = 3/2 = 1
  77     arb.addSample(2);
  78     assertEquals(1, arb.getAvg());
  79
  80     // [ 1, 2, 3, 0, 0 ], sum = 6, avg = 6/3 = 2
  81     arb.addSample(3);
  82     assertEquals(2, arb.getAvg());
  83
  84     // [ 1, 2, 3, 4, 0 ], sum = 10, avg = 10/4 = 2
  85     arb.addSample(4);
  86     assertEquals(2, arb.getAvg());
  87
  88     // [ 1, 2, 3, 4, 5 ], sum = 15, avg = 15/5 = 3
  89     arb.addSample(5);
  90     assertEquals(3, arb.getAvg());
  91
  92   }
  93
  94   /**
  95    * Validate post index roll averaging.
  96    */
  97   @Test
  98   public void validatePostIndexRollAveraging() {
  99
 100     AveragingRingBuffer arb = new AveragingRingBuffer(5);
 101     arb.addSample(1);
 102     arb.addSample(2);
 103     arb.addSample(3);
 104     arb.addSample(4);
 105     arb.addSample(5);
 106
 107     /*
 108      * The behavior switches, and now doesn't re-calculate the average until each nth data point, to
 109      * reduce the computational over-head of re-calculating on each value.
 110      */
 111
 112     // [ 10, 2, 3, 4, 5 ],
 113     arb.addSample(10);
 114     assertEquals(3, arb.getAvg());
 115
 116     // [ 10, 20, 3, 4, 5 ],
 117     arb.addSample(20);
 118     assertEquals(3, arb.getAvg());
 119
 120     // [ 10, 20, 30, 4, 5 ],
 121     arb.addSample(30);
 122     assertEquals(3, arb.getAvg());
 123
 124     // [ 10, 20, 30, 40, 5 ],
 125     arb.addSample(40);
 126     assertEquals(3, arb.getAvg());
 127
 128     // [ 10, 20, 30, 40, 50 ], s=150, avg=150/5=30
 129     arb.addSample(50);
 130     assertEquals(30, arb.getAvg());
 131
 132   }
 133
 134 }