Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add CI, convert to Arduino library #1

Merged
merged 3 commits into from
Jun 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .arduino-ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
compile:
platforms:
- uno

unittest:
platforms:
- uno
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.bin
Gemfile.lock
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
sudo: false
language: ruby
script:
- bundle install
- bundle exec arduino_ci_remote.rb
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
source 'https://rubygems.org'
gem 'arduino_ci', '~> 0.1.7'
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[![Build Status](https://travis-ci.org/sdesalas/Arduino-Queue.h.svg)](https://travis-ci.org/sdesalas/Arduino-Queue.h)
# Queue.h

[Generic](https://en.wikipedia.org/wiki/Generic_programming) C++ circular queue for Arduino embedded projects.
Expand Down
2 changes: 1 addition & 1 deletion queue_test.ino → examples/queue_test/queue_test.ino
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ void loop() {
Serial.print(queue.peek());
Serial.println("'.");
} else {
Serial.println("Nothing to process...");
Serial.println("Nothing to process...");
}
delay(2000);
}
10 changes: 10 additions & 0 deletions library.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name=Queue
version=0.0.1
author=Steven de Salas <steven@desalasworks.com>
maintainer=Steven de Salas <steven@desalasworks.com>
sentence=Generic C++ circular queue
paragraph=Works for any datatype and desired length
category=Data Storage
url=https://github.com/sdesalas/Arduino-Queue.h
architectures=*
includes=Queue.h
90 changes: 90 additions & 0 deletions test/queue-tests.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
#include <ArduinoUnitTests.h>
#include "../Queue.h"

int testSize = 4; // number of elements we'll use in our test queues

unittest(empty)
{
Queue<int> queue(testSize);
assertEqual(0, queue.count()); // initially empty
assertEqual(0, queue.peek()); // 0 happens to be the default int val
assertEqual(0, queue.pop());
assertEqual(0, queue.count()); // still empty
}

unittest(filling_and_emptying)
{
Queue<int> queue(testSize);
assertEqual(0, queue.count()); // initially empty
for (int i = 1; i <= testSize; ++i) {
queue.push(i * 11);
assertEqual(i, queue.count()); // count increases with pushes
}
for (int i = 1; i <= testSize; ++i) {
assertEqual(i * 11, queue.peek()); // verify FIFO
assertEqual(testSize + 1 - i, queue.count()); // verify count unchanged
assertEqual(i * 11, queue.pop()); // verify FIFO
assertEqual(testSize - i, queue.count()); // verify count changed
}
}

unittest(filling_and_clearing)
{
Queue<int> queue(testSize);
assertEqual(0, queue.count()); // initially empty
for (int i = 1; i <= testSize; ++i) {
queue.push(i * 11);
assertEqual(i, queue.count()); // count increases with pushes
}
assertEqual(testSize, queue.count()); // now full
queue.clear();
assertEqual(0, queue.count()); // again empty
}

unittest(overfilling)
{
Queue<int> queue(testSize);
assertEqual(0, queue.count()); // initially empty
for (int i = 1; i <= testSize; ++i) {
queue.push(i * 11);
}
assertEqual(testSize, queue.count()); // now full
for (int i = (testSize + 1); i <= testSize * 2; ++i) {
queue.push(i * 11);
assertEqual(testSize, queue.count()); // still full
}

for (int i = 1; i <= testSize; ++i) {
assertEqual(i * 11, queue.peek()); // verify FIFO
assertEqual(testSize + 1 - i, queue.count()); // verify count unchanged
assertEqual(i * 11, queue.pop()); // verify FIFO
assertEqual(testSize - i, queue.count()); // verify count changed
}
}

unittest(wrapping)
{
Queue<int> queue(testSize);
queue.push(0); // offset the queue so we have to wrap around
queue.push(1);
queue.pop();
queue.pop();

for (int i = 1; i <= testSize; ++i) {
queue.push(i * 11);
}
assertEqual(testSize, queue.count()); // now full
for (int i = (testSize + 1); i <= testSize * 2; ++i) {
queue.push(i * 11);
assertEqual(testSize, queue.count()); // still full
}

for (int i = 1; i <= testSize; ++i) {
assertEqual(i * 11, queue.peek()); // verify FIFO
assertEqual(testSize + 1 - i, queue.count()); // verify count unchanged
assertEqual(i * 11, queue.pop()); // verify FIFO
assertEqual(testSize - i, queue.count()); // verify count changed
}
}

unittest_main()