Testing by developer - Revision history

Victoria La: stub example was wrong - was copy of autoloader, just replace with link for now will ask Thoun

2026-04-19T14:38:48Z

stub example was wrong - was copy of autoloader, just replace with link for now will ask Thoun

@@ Line 108: / Line 108: @@
 '''tests/stubs/BgaFrameworkStubs.php'''
-declare(strict_types=1);
+That is where you stub framework classes and methods, example here
 ====Create first tests====

2026-03-14T15:20:18Z

← Older revision		Revision as of 17:20, 14 March 2026
Line 31:		Line 31:
	Tests have their own src/tests/tsconfig.json		Tests have their own src/tests/tsconfig.json
	File src/tests/setup.ts contains framework and global stubs that tests need.		File src/tests/setup.ts contains framework and global stubs that tests need.
	The config is very verbose so I did not copy it here, if interested check project "~~fate~~" or bga-~~fate~~ on github.		The config is very verbose so I did not copy it here, if interested check project "dojoless" or bga-dojoless on github (https://github.com/elaskavaia/bga-dojoless).

	===PHP===		===PHP===

2026-03-14T13:07:15Z

js testing

← Older revision		Revision as of 15:07, 14 March 2026
Line 25:		Line 25:
	===JavaScript===		===JavaScript===

	I ~~have~~ not ~~tried~~ it. ~~If you~~ have ~~any success please add instructions~~ here. ~~Theoretically its is possible to hook something like selenium to studio games~~		I did not try for pure java script, it works for typescript.
			You need dev dependency on mocha, jsdom and sinon and some other build tools.
			Typescript code lives in src/.
			Test code lives in src/tests/.
			Tests have their own src/tests/tsconfig.json
			File src/tests/setup.ts contains framework and global stubs that tests need.
			The config is very verbose so I did not copy it here, if interested check project "fate" or bga-fate on github.

	===PHP===		===PHP===

2026-03-12T09:59:26Z

Install PHPunit

← Older revision		Revision as of 11:59, 12 March 2026
Line 35:		Line 35:
	composer require --dev phpunit/phpunit ^13		composer require --dev phpunit/phpunit ^13

	We don't want the phpunit cache to be sync/commited, so add <code>".phpunit.cache"</code> to sftp.json ignore list. You can push the unit tests to the FTP, no need to ignore them. If someone maintains your game in the future, he willl be able to use them to make sure nothing breaks on an update!		We don't want the phpunit cache to be sync/commited, so add <code>".phpunit.cache"</code> to sftp.json ignore list. You can push the unit tests to the FTP, no need to ignore them. If someone maintains your game in the future, he willl be able to use them to make sure nothing breaks on an update!
			If you have a .gitignore, add <code>.phpunit.cache</code> to it.
	If you have a .gitignore, add <code>phpunit</code> to it.

	Then add this to your .bashrc (alias function to be able to test phpunit easily)		Then add this to your .bashrc (alias function to be able to test phpunit easily)

2026-03-12T09:58:53Z

Setup minimal files

@@ Line 53: / Line 53: @@
 ====Setup minimal files====
-In the tests folder of your project (create it if needed), add :
+Create these files:
 '''tests/bootstrap.php'''

2026-03-12T09:52:33Z

Install PHPunit

← Older revision		Revision as of 11:52, 12 March 2026
Line 34:		Line 34:
	cd /home/<yourusername>/php-composer		cd /home/<yourusername>/php-composer
	composer require --dev phpunit/phpunit ^13		composer require --dev phpunit/phpunit ^13

			We don't want the phpunit cache to be sync/commited, so add <code>".phpunit.cache"</code> to sftp.json ignore list. You can push the unit tests to the FTP, no need to ignore them. If someone maintains your game in the future, he willl be able to use them to make sure nothing breaks on an update!

			If you have a .gitignore, add <code>phpunit</code> to it.

	Then add this to your .bashrc (alias function to be able to test phpunit easily)		Then add this to your .bashrc (alias function to be able to test phpunit easily)
Line 47:		Line 51:
	phpunit tests/BoardManagerTest.php		phpunit tests/BoardManagerTest.php
	phpunit --filter testGivesExtraTime		phpunit --filter testGivesExtraTime


	====Setup minimal files====		====Setup minimal files====

2026-03-12T09:43:01Z

Create first tests

← Older revision		Revision as of 11:43, 12 March 2026
Line 229:		Line 229:

	self::assertSame('Bga\\Games\\Reversi\\States\\EndScore', $state->onEnteringState());		self::assertSame('Bga\\Games\\Reversi\\States\\EndScore', $state->onEnteringState());
	}

	~~public function testReturnsEndScoreWhenActivePlayerHasNoDisc(): void~~
	{
	~~$game = $this->createGame();~~
	~~$this->attachBoardManager($game, $this->createBoardManagerStub(10, [2 => 5]));~~

	~~$state = new NextPlayer($game);~~

	~~self::assertSame('Bga\\Games\\Reversi\\States\\EndScore', $state->onEnteringState());~~
	}

	~~public function testReturnsEndScoreWhenNeitherPlayerCanMove(): void~~
	{
	~~$game = $this->createGame(playerAfterId: 2);~~
	~~$this->attachBoardManager($game, $this->createBoardManagerStub(5, [1 => 4, 2 => 4], []));~~

	~~$state = new NextPlayer($game);~~

	~~self::assertSame('Bga\\Games\\Reversi\\States\\EndScore', $state->onEnteringState());~~
	}

	~~public function testPassesTurnWhenActivePlayerCannotMoveButOpponentCan(): void~~
	{
	~~$game = $this->createGameMock(playerAfterId: 2);~~
	~~$game->expects(self::never())->method('giveExtraTime');~~
	~~$this->attachBoardManager($game, $this->createBoardManagerStub(5, [1 => 4, 2 => 4], [2 => [4 => [3 => true]]]));~~

	~~$state = new NextPlayer($game);~~

	~~self::assertSame(NextPlayer::class, $state->onEnteringState());~~
	}		}

2026-03-12T09:41:50Z

Running the tests

← Older revision		Revision as of 11:41, 12 March 2026
Line 324:		Line 324:
	If you want to run a single test		If you want to run a single test
	phpunit --filter testGivesExtraTime		phpunit --filter testGivesExtraTime

			<i>If you came here from Reversi Tutorial, go back to it https://en.doc.boardgamearena.com/Tutorial_reversi#Optional:_add_unit_tests</i>

	== Play testing on studio ==		== Play testing on studio ==

2026-03-12T09:40:26Z

Create first tests

@@ Line 315: / Line 315: @@
 </pre>
-You can hook up phpunit and write unit tests for php, for that you need stubs for framework functions and classes.
+If you want to run a single test file
-* Install php-cli (you need a verson that bga runs - consult https://en.doc.boardgamearena.com/Studio#Software_Versions)
+If you want to run a single test
-* Install phpunit matching this specific php version (the latest does not work), if you use composer DO not install it in the game directory - install it somewhere else
+  phpunit --filter testGivesExtraTime
 == Play testing on studio ==

2026-03-12T09:38:16Z

Setup minimal files