From 9c25e720ad7b6d7d1c750b88f6f6ea909202b356 Mon Sep 17 00:00:00 2001 From: Skyler Kehren Date: Wed, 26 Feb 2020 08:02:12 +0200 Subject: [PATCH] Cleanup integration testing docs Removes `test-integration` script Removes integration from `test` script Add installation instructions for `screeps-server-mockup` in docs --- README.md | 4 +--- docs/in-depth/testing.md | 24 +++++++++++++++++++++++- package.json | 3 +-- 3 files changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e00e06b..b28fc33 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,7 @@ You will need: - [Node.JS](https://nodejs.org/en/download) (>= 8.0.0) - A Package Manager ([Yarn](https://yarnpkg.com/en/docs/getting-started) or [npm](https://docs.npmjs.com/getting-started/installing-node)) - - Rollup CLI (Optional, install via `npm install -g rollup`) - - Build tools (`apt install build-essential` for Ubuntu, [Visual Studio](https://www.visualstudio.com/vs/) for Windows, etc) - + - Rollup CLI (Optional, install via `npm install -g rollup`) Download the latest source [here](https://github.com/screepers/screeps-typescript-starter/archive/master.zip) and extract it to a folder. diff --git a/docs/in-depth/testing.md b/docs/in-depth/testing.md index 37582b9..3de0d15 100644 --- a/docs/in-depth/testing.md +++ b/docs/in-depth/testing.md @@ -42,13 +42,35 @@ magnitude, it is recommended to prefer unit tests wherever possible. ## Integration Testing +### Installing Screeps Server Mockup + +Before starting to use integration testing, you must install [screeps-server-mockup](https://github.com/screepers/screeps-server-mockup) to your project. +Please view that repository for more instruction on installation. + +You will also need to add scripts to run integration tests. + +In `package.json`, add a new `test-integration` script and add the new integration testing to the main `test` script. + +```json + "scripts": { + ... + "test": "npm run test-unit && npm run test-integration", + "test-integration": "npm run build && rollup -c rollup.test-integration-config.js && mocha dist/test-integration.bundle.js", + ... + } +``` + +Now you can run integration tests by using the `test-integration` script or run both unit and integration tests using the `test` script. + +### Integration Testing with Screeps Server Mockup + Integration testing is for code that depends heavily on having a full game environment. Integration tests are completely representative of the real game (in fact they run with an actual Screeps server). This comes at the cost of performance and very involved setup when creating specific scenarios. Server testing support is implmented via -[screeps-server-mockup](https://github.com/Hiryus/screeps-server-mockup). View +[screeps-server-mockup](https://github.com/screepers/screeps-server-mockup). View this repository for more information on the API. By default the test helper will create a "stub" world with a 3x3 grid of rooms diff --git a/package.json b/package.json index 9f61cab..40bc813 100644 --- a/package.json +++ b/package.json @@ -10,9 +10,8 @@ "push-main": "rollup -c --environment DEST:main", "push-pserver": "rollup -c --environment DEST:pserver", "push-sim": "rollup -c --environment DEST:sim", - "test": "npm run test-unit && npm run test-integration", + "test": "npm run test-unit", "test-unit": "rollup -c rollup.test-unit-config.js && mocha dist/test-unit.bundle.js", - "test-integration": "npm run build && rollup -c rollup.test-integration-config.js && mocha dist/test-integration.bundle.js", "watch-main": "rollup -cw --environment DEST:main", "watch-pserver": "rollup -cw --environment DEST:pserver", "watch-sim": "rollup -cw --environment DEST:sim"