Merge remote-tracking branch 'refs/remotes/origin/BDD-tesztek-Cucumber'

doc/BDD tesztek készítése - Cucumber.md

@@ -0,0 +1,48 @@
+# BDD tesztek - Cucumber
+
+## Szerelő javít tesztek
+
+### Cső megjavítása
+- Van egy elromlott cső, amin áll egy szerelő, és ezt megpróbálja megjavítani.
+- Ezután a csőnek megjavítottnak kell lennie.
+
+### Pumpa megjavítása
+- Van egy elromlott pumpa, amin áll egy szerelő, és ezt megpróbálja megjavítani.
+- Ezután a pumpának megjavítottnak kell lennie.
+
+## Szabotőr akciók egy csövön tesztek
+
+### Cső elrontása
+- Van egy nem elromlott cső, amin áll egy szabotőr, és ezt megpróbálja elrontani.
+- Ezután a csőnek elromlottnak kell lennie.
+
+### Cső csúszóssá tevése
+- Van egy cső, amin áll egy szabotőr, és ezt megpróbálja csúszóssá tenni.
+- Ezután a csőnek csúszósnak kell lennie.
+
+### Cső ragadóssá tevése
+- Van egy cső, amin áll egy szabotőr, és ezt megpróbálja ragadóssá tenni.
+- Ezután a csőnek ragadósnak kell lennie.
+
+## Szerelő akciók egy ciszternán tesztek
+
+### Cső elvétele
+- Van egy ciszterna, amin áll egy szerelő, és megpróbál elvenni egy csövet a ciszternából.
+- Ezután a ciszternában már csak 4 csőnek kell lennie, és a szerelőnél, kell aktív elemnek lennie.
+
+### Pumpa elvétele
+- Van egy ciszterna, amin áll egy szerelő, és megpróbál elvenni egy pumpát a ciszternából.
+- Ezután a ciszternában már nem szabad pumpának lennie, és a szerelőnél, kell aktív elemnek lennie.
+
+## Játékosok mozgatása tesztek
+
+### Egy játékos egy csőre lép
+- Egy szerelő a kezdőpozíciójában, éppen egy ciszternán áll. Tudván, hogy jobbra tőle egy üres cső található, átlép arra a mezőre.
+- Az **assertEquals** összehasonlító függvénnyel ellenőrzi a teszt végén, hogy a szerelő jelenlegi mezője, amelyen tartózkodik valóban megváltozott-e a szomszédos csőre, illetve a szomszédos csövön beállítódik-e, hogy rajta tartózkodik a szerelő.
+
+### Két játékos egy azonos pumpára lép
+- Egy szerelő a kezdőpozíciójában, éppen egy ciszternán áll. Emellett egy másik játékost, a teszt esetében egy szabotőrt a ciszternától kettővel odébb lévő csőre van elhelyezve. A ciszterna és a cső közé egy pumpa lett letéve, amelyen egyszerre több játékos is tartózkodhat. Mindkét játékos átlép a mezőjükről a szomszédos pumpára.
+- Az **assertEquals** összehasonlító függvénnyel ellenőrzi a teszt végén, hogy mind a szerelő és mind a szabötőr jelenlegi mezője, amelyen tartózkodnak valóban megváltozott-e a szomszédos pumpára, illetve a szomszédos pumpán beállítódik-e, hogy rajta tartózkodik a mindkét játékos.
+
+## Összefoglalás
+A szerintünk átfogó és részletes tesztek megírása után végre is hajtottuk őket, és mindegyikre az elvárt viselkedést kaptuk. A legfontosabb funkciókat többnyire sikerült letesztelni, azonban nehézségeket okozott pár helyen a Getter/Setter függvények hiánya, amely miatt pár esetet nem lehetett/nehezebb volt megvizsgálni. De a végrehajtott tesztek alapján a program helyesen funkcionálónak tűnik.

pom.xml

@@ -1,7 +1,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
-	
+
 	<version>1.0-SNAPSHOT</version>
     <dependencies>
         <dependency>
@@ -35,22 +35,40 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 	</properties>
 
+	<dependencies>
+		<!-- Cucumber Dependency -->
+		<dependency>
+			<groupId>io.cucumber</groupId>
+			<artifactId>cucumber-java</artifactId>
+			<version>7.17.0</version>
+			<scope>test</scope>
+		</dependency>
+
+		<!-- https://mvnrepository.com/artifact/io.cucumber/cucumber-junit -->
+		<dependency>
+			<groupId>io.cucumber</groupId>
+			<artifactId>cucumber-junit</artifactId>
+			<version>7.17.0</version>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+
 	<build>
 		<plugins>
-		    <plugin>
-			  <artifactId>maven-assembly-plugin</artifactId>
-			  <configuration>
-				<archive>
-				  <manifest>
-					<mainClass>Main</mainClass>
-				  </manifest>
-				</archive>
-				<descriptorRefs>
-				  <descriptorRef>jar-with-dependencies</descriptorRef>
-				</descriptorRefs>
-			  </configuration>
+			<plugin>
+				<artifactId>maven-assembly-plugin</artifactId>
+				<configuration>
+					<archive>
+						<manifest>
+							<mainClass>Main</mainClass>
+						</manifest>
+					</archive>
+					<descriptorRefs>
+						<descriptorRef>jar-with-dependencies</descriptorRef>
+					</descriptorRefs>
+				</configuration>
 			</plugin>
-			
+
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-resources-plugin</artifactId>

src/main/java/ActionHandler.java → src/main/java/drukmakoriSzerelok/ActionHandler.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.*;
 
 /**

src/main/java/Active.java → src/main/java/drukmakoriSzerelok/Active.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 /**
  * Absztrakt osztaly, A jatek aktev elemeinek absztrakt ososztaly, amelybol leszarmazik a pumpa, illetve a cso.
  * Itt szerepelnek a kozos tulajdonsagaik az aktiv elemeknek, ilyen a mozgathatosag es az elromlas is.

src/main/java/BlankField.java → src/main/java/drukmakoriSzerelok/BlankField.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 import java.util.UUID;
 

src/main/java/Field.java → src/main/java/drukmakoriSzerelok/Field.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 import java.util.List;
 

src/main/java/Fixer.java → src/main/java/drukmakoriSzerelok/Fixer.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 
 /**

src/main/java/Fountain.java → src/main/java/drukmakoriSzerelok/Fountain.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 import java.util.List;
 import java.util.UUID;

src/main/java/Game.java → src/main/java/drukmakoriSzerelok/Game.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 
 /**

src/main/java/GameField.java → src/main/java/drukmakoriSzerelok/GameField.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.awt.*;
 import java.util.ArrayList;
 import javax.swing.*;

src/main/java/GameFrame.java → src/main/java/drukmakoriSzerelok/GameFrame.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.awt.*;
 import java.awt.event.*;
 import java.awt.geom.AffineTransform;

src/main/java/HelpFrame.java → src/main/java/drukmakoriSzerelok/HelpFrame.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.awt.*;
 import javax.swing.*;
 

src/main/java/Main.java → src/main/java/drukmakoriSzerelok/Main.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.io.*;
 
 /**

src/main/java/MainMenu.java → src/main/java/drukmakoriSzerelok/MainMenu.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.awt.*;
 import java.awt.event.*;
 import java.io.File;

src/main/java/Map.java → src/main/java/drukmakoriSzerelok/Map.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 import java.util.List;
 

src/main/java/Pipe.java → src/main/java/drukmakoriSzerelok/Pipe.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Random;

src/main/java/Player.java → src/main/java/drukmakoriSzerelok/Player.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 import java.util.Random;
 

src/main/java/Pump.java → src/main/java/drukmakoriSzerelok/Pump.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Random;

src/main/java/Saboteur.java → src/main/java/drukmakoriSzerelok/Saboteur.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.ArrayList;
 import java.util.Random;
 

src/main/java/SettingsFrame.java → src/main/java/drukmakoriSzerelok/SettingsFrame.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.awt.*;
 import java.awt.event.*;
 import java.util.ArrayList;

src/main/java/Steppable.java → src/main/java/drukmakoriSzerelok/Steppable.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 /**
  * Interfesz, amelyet megvalosito osztalyok a kor vegen frissulnek es uj allapotba lepnek.
  */

src/main/java/Tank.java → src/main/java/drukmakoriSzerelok/Tank.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 import java.util.*;
 
 /**

src/main/java/Wait.java → src/main/java/drukmakoriSzerelok/Wait.java

@@ -1,3 +1,5 @@
+package drukmakoriSzerelok;
+
 /**
  * Várakozast iranyito es vegrehajto osztaly.
  */

src/test/java/cucumberTest/CucumberTestRunner.java

@@ -0,0 +1,12 @@
+package cucumberTest;
+
+import io.cucumber.junit.CucumberOptions;
+import org.junit.runner.RunWith;
+import io.cucumber.junit.Cucumber;
+
+
+@RunWith(Cucumber.class)
+@CucumberOptions()
+public class CucumberTestRunner {
+}
+

src/test/java/cucumberTest/FixerActionsOnTank.java

@@ -0,0 +1,57 @@
+package cucumberTest;
+
+import drukmakoriSzerelok.Game;
+import drukmakoriSzerelok.Tank;
+import drukmakoriSzerelok.Fixer;
+
+import io.cucumber.java.en.Given;
+import io.cucumber.java.en.Then;
+import io.cucumber.java.en.When;
+
+import static org.junit.Assert.assertEquals;
+
+public class FixerActionsOnTank {
+    private Tank tank = new Tank();
+    private Fixer fixer = new Fixer("fixer1","");
+
+    public FixerActionsOnTank(){
+        Game.Get().SetActivePlayer(fixer);
+    }
+
+    @Given("a tank")
+    public void a_tank() {
+        Game game = Game.Get();
+    }
+
+    @Given("the fixer currently standing on that tank")
+    public void the_fixer_currently_standing_on_that_tank() {
+        fixer.SetField(tank);
+        tank.AddPlayer(fixer);
+    }
+
+    @When("the saboteur tries to carry a pipe")
+    public void the_saboteur_tries_to_carry_a_pipe() {
+        fixer.CarryPipe(tank);
+    }
+
+    @When("the saboteur tries to carry a pump")
+    public void the_saboteur_tries_to_carry_a_pump() {
+        fixer.CarryPump(tank);
+    }
+
+    @Then("the tank should have {string} pipes")
+    public void the_tank_should_have_pipes(String answer){
+        assertEquals(answer, String.valueOf(tank.getNumberOfPipes()));
+    }
+
+    @Then("the tank should have {string} pumps")
+    public void the_tank_should_have_pumps(String answer){
+        assertEquals(answer, String.valueOf(tank.getNumberOfPumps()));
+    }
+
+    @Then("the fixer should {string}have an active field")
+    public void the_fixer_should_have_an_active_field(String answer){
+        var result = fixer.GetHasActive() ? "" : "not ";
+        assertEquals(answer, result);
+    }
+}

src/test/java/cucumberTest/FixerFixes.java

@@ -0,0 +1,65 @@
+package cucumberTest;
+
+import drukmakoriSzerelok.Fixer;
+import drukmakoriSzerelok.Game;
+import drukmakoriSzerelok.Pipe;
+import drukmakoriSzerelok.Pump;
+
+import io.cucumber.java.en.Given;
+import io.cucumber.java.en.Then;
+import io.cucumber.java.en.When;
+
+import static org.junit.Assert.assertEquals;
+
+class IsItBroken{
+    static String isItBroken(boolean status) {
+        return status ? "fixed" : "broken";
+    }
+}
+
+public class FixerFixes {
+    private Pipe pipe = new Pipe();
+    private Pump pump = new Pump();
+    private Fixer fixer = new Fixer("fixer1","");
+
+    private boolean result;
+
+    public FixerFixes(){
+        Game.Get().SetActivePlayer(fixer);
+    }
+
+    @Given("a broken pipe")
+    public void a_broken_pipe() {
+        pipe.SetIsBroken(true);
+        Game game = Game.Get();
+    }
+
+    @Given("a broken pump")
+    public void a_broken_pump() {
+        pump.SetIsBroken(true);
+        Game game = Game.Get();
+    }
+
+    @Given("the fixer currently standing on that pipe")
+    public void the_fixer_currently_standing_on_that_pipe() {
+        fixer.SetField(pipe);
+        pipe.AddPlayer(fixer);
+    }
+
+    @Given("the fixer currently standing on that pump")
+    public void the_fixer_currently_standing_on_that_pump() {
+        fixer.SetField(pump);
+        pump.AddPlayer(fixer);
+    }
+
+    @When("the fixer tries to repair that")
+    public void the_fixer_tries_to_repair_that(){
+        fixer.Fix(pipe);
+        result = ! pipe.GetIsBroken();
+    }
+
+    @Then("it should be {string}")
+    public void it_should_be(String answer){
+        assertEquals(answer, IsItBroken.isItBroken(result));
+    }
+}