Skip to content

Latest commit

 

History

History
170 lines (131 loc) · 8.26 KB

README.md

File metadata and controls

170 lines (131 loc) · 8.26 KB
Raw

Run Tests Test Coverage Scrutinizer Code Quality Build Live

Installation

Dependencies

Make sure the following software is installed:

  • docker (version 18.06.0+)
  • docker compose plugin (version 1.22.0+)

To run unit tests on your machine:

  • Composer (2.0.5+)

Setup

First, you will need to clone this repository. Then inside the clone, you will need to create installation-specific copies of the following files:

  • config/env.sample → config/env
  • config/config.specific.sample.php → config/config.specific.php

The sample versions have sensible defaults, but update the copies as necessary. The options must be consistent between the various configuration files.

Populate the mysql database

To initialize the database or update it with new patches, run:

docker compose run --rm flyway

To modify the database, add a file called V<VERSION_NUMBER>__<NAME>.sql into db/patches and rerun the command.

You can optionally start up phpMyAdmin to inspect your mysql database in a web browser at http://localhost/pma/:

docker compose up --build -d pma

Start up the services

Then you can start up the persistent game services

docker compose up --build -d traefik smr

For development, it may be desirable to automatically pick up source code changes without rebuilding the docker image. Simply use the smr-dev service instead of smr, i.e.:

docker compose up --build -d traefik smr-dev

Runtime

Permissions

In order to create an admin account you should first create a standard account via the register form, then run the following command to give that account admin permissions:

db/init_admin.sh

The account should now have an "Admin Tools" link on the left whilst logged in, which will allow you to assign any extra permissions to yourself and others.

Creating a Game

To create a game you will have to have assigned yourself the "1.6 Universe Generator" and then access this link via the admin tools to create the game. Once you are happy with the game you need to edit the "game" table and set the "enabled" flag for your game to 'TRUE' in order for it to appear in the list of games to join.

Coding Style

This is the coding style that should be used for any new code, although currently not all code currently follows these guidelines (the guidelines are also likely to require extension).

  • Opening races should be placed on the same line with a single space before

  • Single line if statements should still include braces

     if (true) {
 }

  • Variable names should be camelCase normally, except when in templates when they should be UpperCamelCase (to enforce some mental separation between the two contexts).

     $applicationVar = 'value';
 $TemplateVar = 'value';

  • Function names should be camelCase, class names should be UpperCamelCase

     function exampleFunction() {

 }

 class ExampleClass {
 	public function exampleMethod() {
 	}
 }

  • Associative array indices should be UpperCamelCase

     $container['SectorID'] = $sectorID;

SMR-isms

File inclusion

Classes should be added to src/lib/Smr to take advantage of the PSR-4 autoloader. Engine files and their associated templates should be placed in src/engine and src/templates respectively (see Page::process for how they will be included).

Links

If possible use a function from Globals or a relevant object to generate links (e.g. Globals::getCurrentSectorHREF() or $otherPlayer->getExamineTraderHREF()). This is usually clearer and allows hooking into the hotkey system. To create a link you first create a "container" using the Page class:

$container = Page::create($file);

You can then call $container->href() to get a HREF, which will load the given page or Smr\Session::generateSN($container) to get just the sn. Along with this you can also assign extra values to $container which will be available on the next page under $var.

$container = Page::create('sector_move_processing.php');
$container['target_sector'] = 1;
$link = $container->href();

Request variables

For any page which takes input through POST or GET, these values must be accessed using Smr\Session::getRequestVar() and relatives, which will store the value in $var. This is required because auto-refresh updates of the page will not resend these inputs, but they are still required to render the page correctly.

Abstract vs normal classes

This initially started out to be used in the "standard" way for NPCs but that idea has since been discarded. Now all core/shared "Default" code should be in the abstract version, with the normal class child implementing game type specific functionality/overrides, for instance "lib/Semi Wars/SmrAccount" which is used to make every account appear to be a "vet" account when playing semi wars.

Unit testing

SMR uses PHPUnit to run unit tests.

Setup

  1. Ensure the MySQL container is running, and ready for any integration tests that touch the database:
    • composer start:test-services
  2. Run composer run test to execute the full suite of tests.
  3. Add new tests as needed in the /test directory.

Setting up your IDE to run tests

This information applies to IDEA-based IDEs, e.g. IntelliJ, PHPStorm. For other vendors, please refer to your vendor's documentation for running PHPUnit tests against a remote container.

  • In order to perform these next steps in IntelliJ, you must have the following Jetbrains-provided plugins installed:
  • PHP
  • PHP Docker
Configure a remote PHP interpreter for the project
  1. File > Settings > Languages & Frameworks > PHP. In the CLI Interpreter area, click the ... button
  2. Press the "+" button in the top left, and select From Docker, Vagrant, VM, WSL, Remote...
  3. In the new window, choose Docker Compose, and in the Service area, select phpunit. Press "OK".
  4. It will check the configuration by starting up the Docker container, and gathering PHP information. Once that's finished, you should be on a configuration screen for the new interpreter. It should have the PHP information from the Docker container, and also the Xdebug information.
  5. In the Environment variables box on the new intepreter's screen, paste in the values from /test/env in the project directory.
  6. The rest of the default settings should be fine, so you can press "Apply".
  7. On the settings navigation tree, underneath PHP, click the Composer item: In the CLI Interpreter drop down, select the new interpreter you've created. Press "Apply".
  8. On the settings navigation tree, underneath PHP, click the Test Frameworks item.
  9. Click the + button to create an entry, select the newly created interpreter from the drop down, and press "OK".
  10. In the PHPUnit library section, set the Path to script value to /smr/vendor/autoload.php
  11. In the Test Runner section, set the Default configuration file to /smr/phpunit.xml
  12. Press "OK", and you should be good to go for executing tests inside the IDE.

Writing integration tests

  1. To create an integration test that uses the database, your test should extend SmrTest\BaseIntegrationSpec. This will ensure that any test data that gets written to the database will be cleaned up after each test.
  • The SMR database uses MyISAM for a storage engine, so we cannot simply rollback transactions after each test. Instead, the BaseIntegrationSpec will check for any tables that are populated from the flyway migration during startup, and truncate all other tables after your test.