adventure-land-test-helpers v1.0.0

adventure-land-test-helpers

Adventure Land MMORPG test stubs and mock data for unit testing player scripts. For a linting tool, see the ESLint plugin.

Installation

$ npm install adventure-land-test-helpers --save-dev

Usage

All test helpers work with standard JavaScript object access syntax.

const AdventureLandTestHelpers = require('adventure-land-test-helpers');
const { mocks, stubs } = AdventureLandTestHelpers;

let monster = mocks.data.MockMonster;
stubs.classic.is_monster(monster); // The "classic" stub will always return true.

Alternately, stubs may be injected into the global scope to mimic the game environment.

const AdventureLandTestHelpers = require('adventure-land-test-helpers');
const { injectIntoScope, stubs } = AdventureLandTestHelpers;

injectIntoScope(stubs.random, this);
is_monster(); // The "random" stub will return true or false.

API

Inject into Scope

• Path: AdventureLandTestHelpers.injectIntoScope
• Description: Inject functions into the desired scope, useful for creating global stubs.

// Inject stubs into the global scope...
const AdventureLandTestHelpers = require('adventure-land-test-helpers');
const { injectIntoScope, stubs } = AdventureLandTestHelpers;
injectIntoScope(stubs.random, this);

// ...then call one of the Adventure Land game functions.
is_monster();

Mock Data

• Path: AdventureLandTestHelpers.mocks.data
• Description: Mock game data that can be useful when testing scripts.

Classic Stubs

• Path: AdventureLandTestHelpers.stubs.classic
• Description: Stubbed game runner functions that return the same value every time when called.

Random Stubs

• Path: AdventureLandTestHelpers.stubs.classic
• Description: Stubbed game runner functions that return a random possible value when called.

Stubbed Functions

• Path: AdventureLandTestHelpers.stubs.classic, AdventureLandTestHelpers.stubs.random
• Description: Stubbed game runner functions.

Sources

1. Official Adventure Land MMORPG source code by Kaan Soral.
2. Unofficial Adventure Land MMORPG code documentation by NexusNull.