/**
* HangmanTest.java
*
* Test case for the game Hangman.
*
* Assignment 2 for COMP285.
*
* Show your Surname, Name and Student ID.
* e-mail Show your e-mail where to send feedback.
*
* Yiting Qin ID201062266
* email: 774044960@qq.com
*
* This test case should be generated by the JUnit wizard in Eclipse as a stub class.
* This is described in lecture slides 5. Eclipse and JUnit
* This wizard will also suggest to choose JUnit 4 library and so will make
* the test case functioning.
* After creating the stub test case, appropriate fragments of this file can be copied
* step-by-step into the stub when the need will occur.
*
*/
// JUnit 4 imports
import static org.junit.Assert.*;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.Ignore;
//Use @Ignore before a @Test annotation to temporary avoid running the test method.
//Otherwise, comment or delete @Ignore.
//This way we can e.g. concentrate on any one or several test methods
//to avoid cluttering the test results on the console.
//
//IT IS RECOMMENDED TO RUN ONLY ONE TEST METHOD. THEN ANOTHER ONE, ETC.
//
//Final version of the test case should have no active @Ignore annotations
//and run all test methods successfully.
//Java imports
import java.util.Arrays;
import java.util.Vector;
import java.util.List;
public class HangmanTest {
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() throws Exception {
Hangman.test = true; // Choose true for testing mode of
// Hangman an so using the mock version of input_next().
// Setting Hangman.WORDS in the same way as in Hangman.
// We do this because in one of the test methods we will change this
// setting and we want the original default setting will be recovered
// for the others test methods.
Hangman.WORDS = new String[] { “syzygy”, “erythropoeia”, “quicksilver” };
// Setting up an example list of input strings typically (but not
// always) consisting of one letter.
List
“z”, “y”, “g”, “abc”, “r”, “s”, “y”, “z”, “y”, “g”, “s”, “y”);
// Adding it to Vector Hangman.INPUT, thereby initialising it.
Hangman.INPUT.addAll(INPUT_as_list);
// Hangman.INPUT will be periodically emptied by tearDown(),
// so it will always be initialised identically.
// Thus, all test methods will use the same Hangman.INPUT.
// Inform on what is going on in the console.
System.out.println(“setUp initiated INPUT as :” + Hangman.INPUT
+ “\nand WORDS as ” + Arrays.asList(Hangman.WORDS) + “\n”);
// Vector INPUT considered as Enumeration to allow using
// hasMoreElements() and nextElement().
Hangman.INPUT_ENUMERATION = Hangman.INPUT.elements();
}
/**
* @throws java.lang.Exception
*/
@After
public void tearDown() throws Exception {
// Hangman.INPUT is periodically emptied by tearDown(),
// so it will always be initialised in setUp() identically.
Hangman.INPUT.clear();
Hangman.WORDS = null;
System.out
.println(“\ntearDown has released Vector INPUT and array WORDS\n”);
System.out
.println(“======================== END OF A TEST METHOD RUN ========================\n”);
}
/**
* Test method for {@link Hangman#playHangman()}.
*
* playHangman is the top level of functionality. Will offer user choice of
* playing again or quitting till exhausting the INPUT from setUp() with
* possibly some more default additional inputs “n” (guaranteeing eventual
* quitting the game and halting all test methods using the INPUT).
*/
// @Ignore
@Test
public void testPlayHangman() {
// fail(“Not yet implemented”);
System.out.println(“testPlayHangman() RUNNING …”);
System.out
.println(“Playing several rounds with \”syzygy\”, ”
+ “\n – each with the standard 10 lives, ”
+ “\n – with initial part of INPUT from setUp() used for the first round, ”
+ “\n – with the rest part of INPUT used for the second round,”
+ “\n etc.”);
/**
* Overriding (the originally stated by Hangman) list of WORDS to choose
* from. Here we let it consisting of ONE word “syzygy” for the test of
* several rounds of playing Hangman, always with the same word.
*
* This overridden (shortened) list of WORDS is used only in
* testPlayHangman().
*/
Hangman.WORDS = new String[] { “syzygy” };
System.out.println(“testPlayHangman() has overriden WORDS as :”
+ Arrays.asList(Hangman.WORDS) + “\n”);
// Running playHangman() with the INPUT which was set up above.
Hangman.playHangman();
// Testing how many rounds of play the INPUT will generate.
assertEquals(“Number of rounds played should be 3.”, 3,
Hangman.numRounds);
// This should be compared with the output on the console to see that
// play goes as required. That the number of rounds played should be 3
// (with the INPUT [rabc, yzt, s, y, z, y, g, abc, r, s, y, z, y, g, s,
// y]) can also be easily understood by imitating the play mentally.
// A similar testing which of these three rounds the user wins.
// Start with setting up expected PlayRoundResults as list
List
// Transforming it to a Vector expectedPlayRoundResults
Vector
expectedPlayRoundResults.addAll(expectedPlayRoundResults_as_list);
// Proper testing which of the rounds the user wins (the first and the
// second).
assertEquals(“Rounds the user has won should be [1, 2].”,
expectedPlayRoundResults, Hangman.PlayResults);
// This should be compared with the output on the console to see that
// plays goes as required and can also be easily understood by imitating
// the play mentally.
}
/**
* Test method for {@link Hangman#initialiseRound()}.
*
* Tests the returned String of this method; how this string value,
* {@link Hangman#word} and {@link Hangman#word_form} are interrelated in
* various ways (e.g. tests that the latter consists of star symbols * only,
* how lengths of these strings are related, whether these strings are null
* or not, etc.) and what is {@link Hangman#unluckyGuesses} after
* initialising.
*/
// @Ignore
@Test
public void testInitialiseRound() {
System.out.println(“testInitialiseRound() RUNNING …”);
// fail(“Not yet implemented”);
// THIS TEST METHOD TO BE IMPLEMENTED BY STUDENTS
// Costs 12 marks.
String r = Hangman.initialiseRound();
assertTrue(Arrays.asList(Hangman.WORDS).contains(r));
assertNotNull(Hangman.word);
assertNotNull(Hangman.word_form);
assertTrue(Hangman.word.length() == Hangman.word_form.length());
for (int i = 0; i < Hangman.word_form.length(); i++) { assertEquals('*', Hangman.word_form.charAt(i)); } assertTrue(Hangman.unluckyGuesses.size() == 0); } /** * Test method for * {@link Hangman#letUserGuessWord(java.lang.String, java.lang.String, int)} * by using {@link Hangman#INPUT} from {@link #setUp}. */ // @Ignore @Test public void testLetUserGuessWord() { System.out.println("testLetUserGuessWord() RUNNING ..."); // fail("Not yet implemented"); // The INPUT from setUp cannot guess "syzygy" if 0 lives are left. Hangman.unluckyGuesses.clear(); boolean success = Hangman.letUserGuessWord("syzygy", "******", 0); // The value of success should be false. assertTrue("Really can guess with 0 lifes left???", !success); System.out.println("So, letUserGuessword() is " + success + ". Round is finished!\n"); // Show the remaining part of INPUT. System.out.println("INPUT remaining should be: " + "[rabc, yzt, s, y, z, y, g, abc, r, s, y, z, y, g, s, y]"); // Clear unluckyGuesses Hangman.unluckyGuesses.clear(); System.out.println("Test that the INPUT remaining cannot guess " + "\"syzygy\" if 1 life is left."); success = Hangman.letUserGuessWord("syzygy", "******", 1); assertTrue("Really can Guess with 1 life?", !success); System.out.println("So, letUserGuessword() is " + success + ". Round is finished!\n"); System.out.println("INPUT remaining should be: " + "[g, abc, r, s, y, z, y, g, s, y]"); // Clear unluckyGuesses Hangman.unluckyGuesses.clear(); // The INPUT cannot guess "syzygy" if 2 life left. System.out.println("Test that the INPUT remaining can guess " + "\"syzygy\" if 2 lifes are left."); // STUDENTS SHOULD CONTINUE for letUserGuessWord("syzygy", "******", 2) // AND DO MORE TO EXHAUST THE INPUT. // Costs 11 marks. } /** * Test method for {@link Hangman#input_y_n_Char()}. * * With the given INPUT sequence (see setUp), repeat inputting sufficiently * many times to show that only 'y' or 'n' can be obtained by this method. * Evidently, 'n' will be obtained only after several times of 'y' when * INPUT will be exhausted. Please, demonstrate that by using * System.out.println() as well as the for loop to repeat an appropriate * assertion method many times. * */ // @Ignore @Test public void testInput_y_n_Char() { System.out.println("testInput_y_n_Char() RUNNING ..."); for (int i = 1; i <= 5; i++) { System.out.println("the " + i + "th y"); assertEquals('y', Hangman.input_y_n_Char()); } System.out.println("there is no y, so next should be n"); assertEquals('n', Hangman.input_y_n_Char()); // fail("Not yet implemented"); // EXPECTED SOLUTION BY STUDENTS. // Costs 10 marks. } /** * Test method for {@link Hangman#chooseWord(java.lang.String[])}. The * random method chooseWord(words) should always output one of the given * words. Use the given {@link Hangman#WORDS WORDS} fixed in * {@link HangmanTest#setUp} above to test this behaviour. */ // @Ignore @Test public void testChooseWord() { System.out.println("testChooseWord() RUNNING ..."); // TODO Auto-generated method stub // fail("Not yet implemented"); // TO BE IMPLEMENTED BY STUDENTS. // Costs 9 marks. String word = Hangman.chooseWord(Hangman.WORDS); assertTrue(Arrays.asList(Hangman.WORDS).contains(word)); } /** * Test method for {@link Hangman#starForm(java.lang.String)}. * * This test is NOT exhaustive enough and misses some important cases which * can show that, in fact, StarForm() is IMPLEMENTED WRONGLY. * * Thus, this test method should be extended and * {@link Hangman#starForm(java.lang.String)} appropriately corrected */ // @Ignore @Test public void testStarForm() { System.out.println("testStarForm() RUNNING ..."); // TODO Auto-generated method stub // fail("Not yet implemented"); assertEquals("****", Hangman.starForm("abad")); assertEquals("******", Hangman.starForm("abadaf")); assertEquals("************", Hangman.starForm("erythropoeia")); // THE REST OF THIS TEST TO BE IMPLEMENTED TO CATCH A WRONG // BEHAVIOUR OF starForm(). // Costs 7 marks assertEquals("**", Hangman.starForm("ab")); assertEquals("***", Hangman.starForm("abc")); assertEquals("****", Hangman.starForm("abbc")); } /** * Test method for {@link Hangman#occurs(char, java.lang.String)}. The * assertion method presented, although successfully passes, is * insufficient. The method {@link Hangman#occurs(char, java.lang.String)} * under test is actually WRONGLY IMPLEMENTED. Please add more assertions to * catch a wrong behaviour of this method. */ // @Ignore @Test public void testOccurs() { System.out.println("testOccurs() RUNNING ..."); assertTrue("occurs failed???", Hangman.occurs('c', "acbdckm")); assertTrue("occurs failed???", Hangman.occurs('c', "abbdckm")); // CONTINUE // Costs 5 marks } /** * Test method for * {@link Hangman#occursAsNew(char, java.lang.String, java.lang.String)} . */ // @Ignore @Test public void testOccursAsNew() { System.out.println("testOccursAsNew() RUNNING ..."); assertTrue(Hangman.occursAsNew('o', "good", "g**d")); assertTrue(Hangman.occursAsNew('d', "good", "goo*")); assertFalse(Hangman.occursAsNew('g', "good", "goo*")); assertFalse(Hangman.occursAsNew('w', "good", "goo*")); // NEXT LINES - EXPECTED SOLUTION BY STUDENTS // Costs 6 marks } /** * Test method for * {@link Hangman#amend(java.lang.String, java.lang.String, char)}. * * The method * {@link Hangman#amend(java.lang.String, java.lang.String, char)} under * test is actually WRONGLY IMPLEMENTED. Please add more assertions to catch * a wrong behaviour of this method and correct the method * {@link Hangman#amend(java.lang.String, java.lang.String, char)}. */ // @Ignore @Test public void testAmend() { System.out.println("testAmend() RUNNING ..."); // fail("Not yet implemented"); assertEquals("*aba", Hangman.amend("caba", "**b*", 'a')); // NEXT LINES - EXPECTED SOLUTION BY STUDENTS. // Costs 6 marks assertEquals("aab*", Hangman.amend("aabd", "**b*", 'a')); assertEquals("***d", Hangman.amend("abcd", "****", 'd')); } /** * Test method for {@link Hangman#inputChar()}. */ // @Ignore @Test public void testInputChar() { System.out.println("testInputChar() RUNNING ..."); // fail("Not yet implemented"); // INPUT as defined in setUp is // [rabc, yzt, s, y, z, y, g, abc, r, s, y, z, y, g, s, y]. // So, InputChar() will start reading rabc, yzt, s and will output // the character 's' because the string input "s" is the first one of // the length 1. This test method should confirm such an intended // behaviour of inputChar(). // NEXT LINES - EXPECTED SOLUTION BY STUDENTS. // Costs 6 marks for (int i = 0; i < Hangman.INPUT.size(); i++) { if (Hangman.INPUT.get(i).length() == 1) { assertEquals(Hangman.INPUT.get(i).charAt(0), Hangman.inputChar()); } } } /** * Test method for {@link Hangman#input_next()}. */ // @Ignore @Test public void testInput_next() { System.out.println("testInput_next() RUNNING ..."); // TODO Auto-generated method stub // fail("Not yet implemented"); // Implement this tests method by exhausting the INPUT and by // getting several default inputs "n" after INPUT is exhausted. // assertEquals() should be used for each consequitive input. // NEXT LINES - EXPECTED SOLUTION BY STUDENTS. // Costs 6 marks for (int i = 0; i < Hangman.INPUT.size(); i++) { assertEquals(Hangman.INPUT.get(i), Hangman.input_next()); } for (int i = 0; i < 3; i++) { assertEquals("n", Hangman.input_next()); } } }