test.c

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2013 Philip Thrasher
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 *
 * TODO:
 *   1. Add more tests.
 *   2. Add comments.
 */

#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <assert.h>
#include "ringbuffer.h"

ringBuffer_typedef(int, intBuffer);

void passByReference(intBuffer* myBuffer_ptr) {

  assert(isBufferEmpty(myBuffer_ptr));

  bufferWrite(myBuffer_ptr,38);
  bufferWrite(myBuffer_ptr,73);

  assert(isBufferFull(myBuffer_ptr));

  int first;
  bufferRead(myBuffer_ptr,first);
  assert(first == 38);

  int second;
  bufferRead(myBuffer_ptr,second);
  assert(second == 73);

  bufferWrite(myBuffer_ptr,42);
  
  bufferWritePeek(myBuffer_ptr) = 17;
  bufferWritePeek(myBuffer_ptr) = 43;
  bufferWriteSkip(myBuffer_ptr);
  
  bufferWrite(myBuffer_ptr,44); // test wrap around -- this should overwrite 42

  int third;
  third = bufferReadPeek(myBuffer_ptr);
  assert(third == 43);
  third = bufferReadPeek(myBuffer_ptr);
  assert(third == 43);
  
  bufferReadSkip(myBuffer_ptr);

  int* fourth_ptr = &bufferReadPeek(myBuffer_ptr);
  assert(*fourth_ptr == 44);
}

void testPeek(void) {
  intBuffer peekBuffer;
  bufferInit(peekBuffer,16,int);

  for (int i = 0; i < 16; i++) {
    /* Add 100 so the value is different from its index */
    int valueToWrite = i + 100;
    bufferWrite(&peekBuffer,valueToWrite);
  }

  int testValue;
  bufferPeekBack(&peekBuffer, 0, testValue);
  assert(testValue == 115);

  bufferPeekBack(&peekBuffer, 1, testValue);
  assert(testValue == 114);

  bufferPeekBack(&peekBuffer, 5, testValue);
  assert(testValue == 110);

  bufferPeekForward(&peekBuffer, 0, testValue);
  assert(testValue == 100);

  bufferPeekForward(&peekBuffer, 1, testValue);
  assert(testValue == 101);

  bufferPeekForward(&peekBuffer, 5, testValue);
  assert(testValue == 105);
}

void testReset(void) {
  intBuffer resetBuffer;
  bufferInit(resetBuffer,16,int);

  for (int i = 0; i < 16; i++) {
    int valueToWrite = i + 100;
    bufferWrite(&resetBuffer,valueToWrite);
  }

  assert(bufferFreeSpace(&resetBuffer) == 0);

  bufferReset(&resetBuffer);

  assert(bufferFreeSpace(&resetBuffer) == 16);
}

int main() {
  // Declare vars.
  intBuffer myBuffer;

  bufferInit(myBuffer,2,int);


  assert(isBufferEmpty(&myBuffer));
  assert(bufferUsedSpace(&myBuffer) == 0);
  assert(bufferFreeSpace(&myBuffer) == 2);

  bufferWrite(&myBuffer,37);
  bufferWrite(&myBuffer,72);

  assert(!isBufferEmpty(&myBuffer));
  assert(bufferUsedSpace(&myBuffer) == 2);
  assert(bufferFreeSpace(&myBuffer) == 0);

  int first;
  bufferRead(&myBuffer,first);
  assert(first == 37);

  int second;
  bufferRead(&myBuffer,second);
  assert(second == 72);

  passByReference(&myBuffer);
  testPeek();
  testReset();

  printf("All tests passed.\n");
  return 0;
}