Testing by developer

When you develop a game you obviously have to test it, this page collects the info about testing in one place

Manual Testing on BGA

For manual testing the most important things to know are:

• how to start/stop game in one click
• how to switch between players in one click
• how to save/restore the game state
• how to construct the game state automatically

All of these described here https://en.doc.boardgamearena.com/Tools_and_tips_of_BGA_Studio

There is also HUGE checklist of things you need to test manually which you may not even think about, defined here https://en.doc.boardgamearena.com/Pre-release_checklist

Manual Testing locally

HTML/CSS At this era the file sync is almost instant so you do not save much by doing this locally, however if internet is a challenge - here are some tips https://en.doc.boardgamearena.com/Tools_and_tips_of_BGA_Studio#Speed_up_CSS_development_and_layout

PHP You can run and debug php locally using tip https://en.doc.boardgamearena.com/BGA_Studio_Cookbook#Creating_a_test_class_to_run_PHP_locally

Automated Testing

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

PHP

Install PHPunit

Install PHPunit via composer somewhere in home directory, i.e.

  cd /home/<yourusername>/php-composer
  composer require --dev phpunit/phpunit ^11

Then add this to your .bashrc

 phpunit() {
 /home/<yourusername>/php-composer/vendor/bin/phpunit \
   -c "$PWD/phpunit.xml.dist" \
   --bootstrap "$PWD/tests/bootstrap.php" \
   "$@"
 }

With that, on a new terminal you should be able to run the tests with one of the following commands at the root of your project :

 phpunit
 phpunit tests/BoardManagerTest.php
 phpunit --filter testGivesExtraTime

You can hook up phpunit and write unit tests for php, for that you need stubs for framework functions and classes.

• Install php-cli (you need a verson that bga runs - consult https://en.doc.boardgamearena.com/Studio#Software_Versions)
• 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
• Create directory tests (at the root of the game, not in modules)
• Checkout/get stubs from github (see https://en.doc.boardgamearena.com/Setting_up_BGA_Development_environment_using_VSCode), i.e
  • git clone [email protected]:elaskavaia/bga-sharedcode.git
• So the main issue - php unit needs to find the parts of bga framework which is not available, in this example we will use stubs above
• Create autoload.php in modules/ directory

<?php

define("APP_GAMEMODULE_PATH", getenv('APP_GAMEMODULE_PATH')); 

spl_autoload_register(function ($class_name) {
  
    switch ($class_name) {
        case "APP_DbObject":
            //var_dump($class_name);
            //var_dump(APP_GAMEMODULE_PATH);
            include APP_GAMEMODULE_PATH."/module/table/table.game.php";
            break;
        default:
            include $class_name . ".php";
            break;
    }
});

?>

• Set env var APP_GAMEMODULE_PATH to point to where stubs are, in this case APP_GAMEMODULE_PATH=$HOME/git/bga-sharedcode/misc/
• Create a test in tests/ folder (see phpunit examples)

<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;

require_once "../mygame.game.php";

class GameUT extends MyGame {
    function __construct() {
        parent::__construct();
        include "../material.inc.php";
    }
    // override/stub methods here that access db and stuff
}

final class GameTest extends TestCase {
    public function testGameProgression() {
        $m = new GameUT();
        $this->assertEquals(0,$m->getGameProgression());
    }
    // more tests
}

• Run this from modules/ dir (this assumes env var above already set globally)

phpunit --bootstrap autoload.php tests/

Play testing on studio

To play test on studio you can use your test accounts dev0... dev9. You can give some of these account to other people just make sure you change the password. You should not encourage other people who are not developers to create studio account, this is against bga policy.