#SE2832 Lab 1: Testing a Circular Queue with JUnit

##1. Introduction

This is your first verification lab. Its purpose is to help you to start thinking about how to test existing software. From doing this, you will review the
concepts of JUnit as well as begin to see some of the patterns necessary to ensure correct operation of software.

##2. Lab Objectives

• Review the Java queue data structure
• Develop JUnit test cases to properly verify the operation of a basic Java data structure.
• Use independent learning to understand the operation of a circular queue.

##3. Problem Overview One commonly used low level data structure is the circular queue or circular buffer. It is often used in systems which requires fast adds and removes, as unlike other forms of queues, additions and removals can be designed to be atomic without the useage of blocks.

For this lab, you have been provided with a full implementation for a Java circular queue class. However, this code
has not been tested and will most likely contain errors. You are responsible for developing JUnit tests to ensure that this class operates properly. If there are problems with the implementation, you will need to go into the source code and perform the appropriate fixes. It is possible that there are some methods which are not implemented in the source code. If the methods are not implemented, it is acceptable for the code to simply throw an UnsupportedOperationException. The queue, as it is structured, is perfectly capable of holding null references. Therefore, you should make certain that null can be added to the queue.

##4. Deliverables Add a file called write-up.md. In the write up include your name, email, and a casual discussion about the following the questions: What sort of strategy did you use to come up with your test cases? How did you know when you were finished?

Testing Style Guides

• In general, a unit test should test one single concept. In general, you should not have a single JUnit test with large number of asserts.

• Write your test cases using the following structure:

  //Arrange - this is where you setup your test, declaring variables, establishing state, etc.

  //Act - this is where you execute your code

  //Assert - here you issue your assert(s)

• Your test names should follow the pattern MethodNameShouldExpectedBehaviorWhenStateUnderTest

  e.g.

   ```checkAgeShouldThrowNullPointerWhenNullPersonPassedIn```
   ```sizeShouldReturnZeroWhenListIsEmpty```
  

Grading

• Did you follow the style guides?
• Did you find all the errors in the queue?
• How well organized and thought out are the tests?