gaspersic/java-design-patterns
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

#778 Implemented BSTIterator. Included comprehensive unit and integration tests. Refactored file structure to be friendly to future contributors with iterators of more data structures. Added JUnitPlatform to enable running test suite across all iterator implementations. Added README to /binarysearchtree to document what it does and how it works.

Browse Source
This commit is contained in:
Mitchell Irvin
2018-08-04 21:59:53 -04:00
parent facb9e51a6
commit 3e0cfa5684
17 changed files with 458 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
iterator/src/test/java/com/iluwatar/iterator/AppTest.java
View File

@ -1,39 +1,33 @@
/**
* The MIT License
* Copyright (c) 2014-2016 Ilkka Seppälä
* The MIT License Copyright (c) 2014-2016 Ilkka Seppälä
*
* 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
* 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 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.
* 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.
*/
package com.iluwatar.iterator;
import org.junit.jupiter.api.Test;
import org.junit.platform.runner.JUnitPlatform;
import org.junit.platform.suite.api.SelectPackages;
import org.junit.platform.suite.api.SuiteDisplayName;
import org.junit.runner.RunWith;
/**
*
* Application test
*
* Runs a test suite containing all tests within the com.iluwatar.iterator package
*/
@RunWith(JUnitPlatform.class)
@SuiteDisplayName("Iterator Test Suite")
@SelectPackages("com.iluwatar.iterator")
public class AppTest {
@Test
public void test() {
String[] args = {};
App.main(args);
}
}
}

98
iterator/src/test/java/com/iluwatar/iterator/binarysearchtree/BstIteratorTest.java Normal file
View File

@ -0,0 +1,98 @@
/**
* The MIT License Copyright (c) 2014-2016 Ilkka Seppälä
*
* 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.
*/
package com.iluwatar.iterator.binarysearchtree;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import com.iluwatar.iterator.AppTest;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.api.TestInstance.Lifecycle;
@TestInstance(Lifecycle.PER_CLASS)
class BstIteratorTest<T> extends AppTest {
private TreeNode<T> nonEmptyRoot;
private TreeNode<T> emptyRoot;
@BeforeAll
void createTrees() {
nonEmptyRoot = new TreeNode(Integer.valueOf(5));
nonEmptyRoot.setLeft(new TreeNode(3));
nonEmptyRoot.setRight(new TreeNode(7));
nonEmptyRoot.getLeft().setLeft(new TreeNode(1));
nonEmptyRoot.getLeft().setRight(new TreeNode(4));
nonEmptyRoot.getRight().setLeft(new TreeNode(6));
emptyRoot = null;
}
@Test
void nextWithEmptyTree() {
BstIterator iter = new BstIterator(emptyRoot);
assertThrows(IllegalStateException.class, iter::next,
"next() should throw an IllegalStateException if hasNext() is false.");
}
@Test
void nextWithPopulatedTree() {
BstIterator iter = new BstIterator(nonEmptyRoot);
assertEquals(iter.next().getVal(), 1, "First Node is 1.");
assertEquals(iter.next().getVal(), 3, "Second Node is 3.");
assertEquals(iter.next().getVal(), 4, "Third Node is 4.");
assertEquals(iter.next().getVal(), 5, "Fourth Node is 5.");
assertEquals(iter.next().getVal(), 6, "Fifth Node is 6.");
assertEquals(iter.next().getVal(), 7, "Sixth Node is 7.");
}
@Test
void hasNextWithEmptyTree() {
BstIterator iter = new BstIterator(emptyRoot);
assertFalse(iter.hasNext(), "hasNext() should return false for empty tree.");
}
@Test
void hasNextWithPopulatedTree() {
BstIterator iter = new BstIterator(nonEmptyRoot);
assertTrue(iter.hasNext(), "hasNext() should return true for populated tree.");
}
@Test
void nextAndHasNextAcrossEntirePopulatedTree() {
BstIterator iter = new BstIterator(nonEmptyRoot);
assertTrue(iter.hasNext(), "Iterator hasNext() should be true.");
assertEquals(iter.next().getVal(), 1, "First Node is 1.");
assertTrue(iter.hasNext(), "Iterator hasNext() should be true.");
assertEquals(iter.next().getVal(), 3, "Second Node is 3.");
assertTrue(iter.hasNext(), "Iterator hasNext() should be true.");
assertEquals(iter.next().getVal(), 4, "Third Node is 4.");
assertTrue(iter.hasNext(), "Iterator hasNext() should be true.");
assertEquals(iter.next().getVal(), 5, "Fourth Node is 5.");
assertTrue(iter.hasNext(), "Iterator hasNext() should be true.");
assertEquals(iter.next().getVal(), 6, "Fifth Node is 6.");
assertTrue(iter.hasNext(), "Iterator hasNext() should be true.");
assertEquals(iter.next().getVal(), 7, "Sixth Node is 7.");
assertFalse(iter.hasNext(), "Iterator hasNext() should be false, end of tree.");
}
}

55
iterator/src/test/java/com/iluwatar/iterator/binarysearchtree/TreeNodeTest.java Normal file
View File

@ -0,0 +1,55 @@
/**
* The MIT License Copyright (c) 2014-2016 Ilkka Seppälä
*
* 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.
*/
package com.iluwatar.iterator.binarysearchtree;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import org.junit.jupiter.api.Test;
/**
* Comprehensive tests for TreeNode POJO
* @param <T> generically typed for TreeNode
*/
public class TreeNodeTest<T> {
@Test
void treeNodeGetters() {
TreeNode<T> node = new TreeNode(1);
assertEquals(node.getVal(), 1);
assertNull(node.getLeft(), "Left child should be initialized as null.");
assertNull(node.getRight(), "Right child should be initialized as null.");
}
@Test
void treeNodeSetters() {
TreeNode<T> node = new TreeNode(3);
node.setLeft(new TreeNode(1));
assertEquals(node.getLeft().getVal(), 1, "Left node has a value of 1.");
node.setRight(new TreeNode(5));
assertEquals(node.getRight().getVal(), 5, "Right node has a value of 5");
}
@Test
void treeNodeToString() {
TreeNode<T> node = new TreeNode(3);
assertEquals(node.toString(), "3", "node.toString() should return string value.");
}
}

6
iterator/src/test/java/com/iluwatar/iterator/TreasureChestTest.java → iterator/src/test/java/com/iluwatar/iterator/list/TreasureChestTest.java
View File

@ -20,8 +20,12 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.iluwatar.iterator;
package com.iluwatar.iterator.list;
import com.iluwatar.iterator.list.Item;
import com.iluwatar.iterator.list.ItemIterator;
import com.iluwatar.iterator.list.ItemType;
import com.iluwatar.iterator.list.TreasureChest;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;