Unit test and diagram changes

.gitignore

@@ -8,6 +8,7 @@ export.cfg
 
 #Build and Release ignores
 Bin/
+addons/
 
 #VSCode-specific ignores
 .vscode/

ChoukaBaraGame/Scenes/HUD/NotifiationText.gd

@@ -0,0 +1,19 @@
+extends Position2D
+
+onready var lable = get_node("Label")
+onready var tween = get_node("Tween")
+var notificationString = ""
+
+export var tween_duration  = 0.5
+export var notification_length = 3
+
+func _ready():
+	lable.text = notificationString
+	tween.connect("tween_all_completed", self, "_on_Tween_tween_all_completed")
+
+	tween.interpolate_property(self, 'scale' , scale ,Vector2(1,1), tween_duration, Tween.TRANS_LINEAR, Tween.EASE_OUT)
+	tween.interpolate_property(self, 'scale' ,Vector2(1,1), scale , tween_duration, Tween.TRANS_LINEAR, Tween.EASE_IN, notification_length)
+	tween.start()
+
+func _on_Tween_tween_all_completed():
+	self.queue_free()

ChoukaBaraGame/Scenes/HUD/NotifiationText.tscn

@@ -0,0 +1,29 @@
+[gd_scene load_steps=2 format=2]
+
+[ext_resource path="res://Scenes/HUD/NotifiationText.gd" type="Script" id=1]
+
+[node name="NotificationText" type="Position2D"]
+scale = Vector2( 0.5, 0.5 )
+script = ExtResource( 1 )
+
+[node name="Label" type="Label" parent="."]
+anchor_left = 0.5
+anchor_top = 1.0
+anchor_right = 0.5
+anchor_bottom = 1.0
+margin_left = -75.0
+margin_top = -30.0
+margin_right = 75.0
+grow_vertical = 0
+custom_colors/font_color = Color( 0.976471, 0.219608, 0.0196078, 1 )
+custom_colors/font_outline_modulate = Color( 0.988235, 0.988235, 0.988235, 1 )
+custom_colors/font_color_shadow = Color( 0, 0, 0, 1 )
+text = "Test Notification"
+align = 1
+valign = 1
+autowrap = true
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="Tween" type="Tween" parent="."]

ChoukaBaraGame/Scenes/Player/Pawn.tscn

@@ -106,3 +106,6 @@ anims/up = SubResource( 5 )
 [node name="Hurtbox" parent="." instance=ExtResource( 4 )]
 
 [node name="StateMachine" parent="." instance=ExtResource( 5 )]
+
+[node name="NotificationRoot" type="Position2D" parent="."]
+position = Vector2( 0, -35 )

ChoukaBaraGame/Scenes/Player/Player.tscn

@@ -1,7 +1,8 @@
-[gd_scene load_steps=4 format=2]
+[gd_scene load_steps=5 format=2]
 
 [ext_resource path="res://Scripts/Player/Player.gd" type="Script" id=1]
 [ext_resource path="res://Scenes/Player/HomeBase.tscn" type="PackedScene" id=2]
+[ext_resource path="res://Scripts/Player/CheckPlayerTurnValidity.gd" type="Script" id=3]
 
 [sub_resource type="NavigationPolygon" id=1]
 resource_local_to_scene = true
@@ -18,3 +19,6 @@ script = ExtResource( 1 )
 navpoly = SubResource( 1 )
 
 [node name="HomeBase" parent="." instance=ExtResource( 2 )]
+
+[node name="CheckPlayerTurnValidity" type="Node" parent="."]
+script = ExtResource( 3 )

ChoukaBaraGame/Scripts/Player/CheckPlayerTurnValidity.gd

@@ -0,0 +1,36 @@
+extends Node
+
+func CheckPlayerTurnForGara(garaList:Array) -> bool:
+	var parent = get_parent()
+	var children = parent.get_children()
+	var crieteria = funcref(self,"_GetPawns")
+	var pawnChildren = _filter(children,crieteria)
+
+	var canPlayerMovePawn = false
+	for pawn in pawnChildren:
+		var canPawnMove = false
+		var previousGara:int = 0
+		for n in range(garaList.size()):
+			if(n != 0):
+				previousGara = garaList[n-1]
+			var currentGara:int =  garaList[n]
+			var garaToCheck = previousGara + currentGara
+			canPawnMove = (pawn as Pawn).canMoveSelectedTurn(garaToCheck,false)
+		if(canPawnMove):
+			canPlayerMovePawn = true
+			break
+
+	return canPlayerMovePawn
+
+func _GetPawns(child) -> bool:
+	return child is Pawn;
+
+func _filter(list: Array, matches_criteria: FuncRef) -> Array:
+	# Usually better to add filtered elements to new array
+	# because removing elements while iterating over a list
+	# causes weird behaviour
+	var filtered: Array = []
+	for element in list:
+		if matches_criteria.call_func(element):
+			filtered.append(element)
+	return filtered	

ChoukaBaraGame/Scripts/Player/Pawn.gd

@@ -7,6 +7,8 @@ signal pawn_unselected
 
 signal movement_round_complete
 
+var notification_scene = preload("res://Scenes/HUD/NotifiationText.tscn")
+
 onready var tween : Tween = $Tween
 onready var ray : RayCast2D = $RayCast2D
 onready var animationPlayer : AnimationPlayer = $AnimationPlayer
@@ -15,6 +17,7 @@ onready var hitboxCollision = $Hitbox/CollisionShape2D
 onready var hitbox = $Hitbox
 onready var hurtbox = $Hurtbox
 onready var hurtboxCollision = $Hurtbox/CollisionShape2D
+onready var notificationRoot = $NotificationRoot
 
 var pawnHit = false
 var speed : int = 2
@@ -75,7 +78,7 @@ func resetAnimation() -> void:
 
 func select_pawn(pawn:Pawn) -> void:
 	PlayerInfo.active_player.selectedPawn = pawn
-	sprite.scale = Vector2(1.5,1.5)
+	sprite.scale = Vector2(1.5,1.5)	
 	emit_signal("pawn_selected")
 
 func unselect_pawn() -> void:
@@ -105,9 +108,23 @@ func _on_hurtbox_area_entered(areaEntered:Area2D):
 		PlayerInfo.active_player.canEnterInnerCircle = true
 		PlayerInfo.active_player.needsReRoll = true
 
-func canMoveSelectedTurn(gara:int)-> bool:
-	if(PlayerInfo.active_player.canEnterInnerCircle):
-		return true;
-	elif (currentLocation + gara < GameUtility.distanceToInnerCircle):
-		return true
-	return false
+func canMoveSelectedTurn(gara:int, showNotification: bool = true)-> bool:
+	var positionToBeMoved = currentLocation + gara
+	var notification = ""
+	var result = true
+	if(not PlayerInfo.active_player.canEnterInnerCircle && not (positionToBeMoved <= GameUtility.distanceToGoal)):
+		notification = "Cannot enter goal as steps is greaer than goal distance"
+		result = false
+	elif (not (positionToBeMoved < GameUtility.distanceToInnerCircle)):
+		notification = "Cannot enter inner circle as Player HIT not performed"
+		result = false
+
+	if (showNotification && not notification.empty()):
+		showNotification(notification)
+
+	return result
+
+func showNotification(notificationText:String):
+	var notification_instance = notification_scene.instance()
+	notification_instance.notificationString = notificationText
+	notificationRoot.add_child(notification_instance)

ChoukaBaraGame/Scripts/StateMachine/GameStateMachine/MovePawn.gd

@@ -2,11 +2,9 @@ extends IState
 
 func enter(logic_root):
 	.enter(logic_root)
-	if(not PlayerInfo.garaList.empty() && PlayerInfo.active_player.selectedPawn.canMoveSelectedTurn(PlayerInfo.garaList.front())):
+	if(canEnter()):
 		yield(GameUtility.select_destination(PlayerInfo.garaList.pop_front(),PlayerInfo.active_player.selectedPawn,true),"completed")		
 		yield(get_tree(), "idle_frame")
-#	else:
-#		Update HUD to display error for not able to enter Inner Circle
 
 	emit_signal("finished","SelectPawn")
 
@@ -15,3 +13,12 @@ func exit():
 		PlayerInfo.active_player.selectedPawn.resetAnimation()
 		PlayerInfo.active_player.selectedPawn.call_deferred("enableHitBox",false)	
 		PlayerInfo.active_player.selectedPawn.unselect_pawn()
+
+func canEnter() -> bool:
+	var activePlayer = PlayerInfo.active_player
+	var canSelectedPawnMoveResult = activePlayer.selectedPawn.canMoveSelectedTurn(PlayerInfo.garaList.front())
+	var canPlayerMoveAnyPawnResult = activePlayer.canPlayerMoveAnyPawn(PlayerInfo.garaList)
+	if(not PlayerInfo.garaList.empty() && (canSelectedPawnMoveResult as bool)):
+		return true
+
+	return false

ChoukaBaraGame/UnitTests/PlayerTests/test_player.gd

@@ -0,0 +1,34 @@
+extends "res://addons/gut/test.gd"
+
+var PlayerScene: PackedScene = preload("res://Scenes/Player/Player.tscn")
+var player = PlayerScene.instance()
+
+func before_all():
+	gut.p("Runs once before all tests")
+	var child = add_child(player)
+	PlayerInfo.active_player = player
+
+func before_each():
+	gut.p("Runs before each test.")
+
+func after_each():
+	gut.p("Runs after each test.")
+
+func after_all():
+	gut.p("Runs once after all tests")
+	player.free()
+
+func test_player_is_not_null():
+	assert_not_null(player)
+
+func test_CheckScript_is_not_null():
+	var checkScript = player.get_node("CheckPlayerTurnValidity").get_script()
+	assert_not_null(checkScript)
+
+func test_player_gara_should_fail_when_no_pawn_can_move():
+	var garaList = [8,8,8,8,8,8,8,8,8,2]
+	var checkNodeScript = player.get_node("CheckPlayerTurnValidity")
+
+	var result = checkNodeScript.CheckPlayerTurnForGara(garaList)
+
+	assert_false(result,"Should pass when no pawns are able to move")

ChoukaBaraGame/UnitTests/UnitTestMaster.tscn

@@ -0,0 +1,16 @@
+[gd_scene load_steps=2 format=2]
+
+[ext_resource path="res://addons/gut/plugin_control.gd" type="Script" id=1]
+
+[node name="Gut" type="Control"]
+margin_right = 740.0
+margin_bottom = 250.0
+rect_min_size = Vector2( 740, 250 )
+script = ExtResource( 1 )
+__meta__ = {
+"_edit_use_anchors_": false
+}
+_run_on_load = true
+_should_maximize = true
+_include_subdirectories = true
+_directory1 = "res://UnitTests"

ChoukaBaraGame/debug.log

@@ -0,0 +1,2 @@
+[1230/191809.452:ERROR:settings.cc(325)] Settings version is not 1
+[0102/130853.266:ERROR:settings.cc(325)] Settings version is not 1

ChoukaBaraGame/project.godot

@@ -67,6 +67,7 @@ GameUtility="*res://Scripts/Game/GameUtility.gd"
 
 [debug]
 
+gdscript/warnings/exclude_addons=false
 gdscript/completion/autocomplete_setters_and_getters=true
 gdscript/warnings/unused_class_variable=true
 gdscript/warnings/unsafe_property_access=true
@@ -82,6 +83,10 @@ window/size/resizable=false
 window/stretch/mode="2d"
 window/stretch/aspect="keep"
 
+[editor_plugins]
+
+enabled=PoolStringArray( "gut" )
+
 [input]
 
 right={

README.md

@@ -10,6 +10,8 @@ The game to be created is an old indian board game called Chouka-Bara
 
 The game is going to be in 2D and built in the godot Game engine
 
+This project uses GUT(Godot Unit Test) plugin fom the Asset Liberary, Install The Plugin from AssetLib after loading the project to run Unit Tests  
+
 Reference Project 
 
 	https://kidscancode.org/godot_recipes/2d/grid_movement/