rosasurfer / MQL-Tester-Action

:chart_with_upwards_trend:🐳Runs MQL programs via GitHub Actions

MQL Tester 🐳 Action

This GitHub Action runs MQL programs (such as Expert Advisors, indicators or scripts).

Usage

For full documentation, please read: GitHub Actions Documentation.

Latest release

uses: fx31337/mql-tester-action@v1

Specific release

uses: fx31337/mql-tester-action@v1.0.1

Note: Check Releases for more details.

Latest development version

uses: fx31337/mql-tester-action@master

Overriding default inputs

uses: fx31337/mql-tester-action@master
with:
    TestExpert: Dummy
    BtPair: EURUSD
    BtMonths: 1-2
    BtYears: 2021

Inputs

Main Inputs

Script

The name of the script to run.

TestExpert

The name of the Expert Advisor to test.

Backtest Inputs

BtPair (string)

Symbol pair to use. Default: EURUSD.

BtCurrency (string)

Base currency to use. Default: USD.

BtDeposit (int)

Deposit amount to use. Default: 10000.

BtDigits (int)

Specifies number of digits after decimal point for the current symbol prices (default: 5).

BtSpread (int)

Specifies spread to use in points (e.g. 10).

BtDays (int/string)

Specifies range of days in each month to test (default: 1-31).

BtMonths (int/string)

Specifies range of months in each year to test (default: 1).

BtYears (int/string)

Specifies year or range of years to test (default: 2019).

SetFile (string)

Specifies SET file to use for the test.

SetOpts (string)

Specifies comma-separated custom params to set for EA (e.g. SomeOption=1,AnotherOption=0).

TestPeriod (string)

Timeframe to use for the test (default: M30).

Test Results

BtDest (string)

Specifies directory to copy the results.

Default: /github/workspace (indicated by github.workspace variable).

TestReportName (string)

Specifies the name of the test report file.

Default: tester/Report.

Optimization Inputs

OptOptimize (bool)

Runs test in optimization mode.

BtTestModel (int)

Specifies type of backtest data being tested.

Values:

• 0 (default) - Every tick
• 1 - Control points
• 2 - Open prices only

TestLimitOpts (string)

Specifies EA limit test parameters in a sequence of comma-separated values (e.g. genetic=0,maxdrawdown_enable=1,maxdrawdown=20.00).

SetParams (string)

Specifies parameters to optimize in SET file (SetFile) in a sequence of comma-separated values.

Run Inputs

RunOnStart (string)

Runs command on startup (before the test).

Default: clean_sources (to remove source code files from the platform directory).

RunOnSet (string)

Runs command on SET configuration (e.g. file_get URL).

RunOnSuccess (string)

Runs command after successful test.

RunOnError (string)

Runs command on test error (including warnings).

RunOnExit (string)

Runs command on exit (after the test).

RunOnFail (string)

Runs command after test failure.

RunOnWarning (string)

Runs command on test warnings (excluding errors).

Result Inputs

OptFormatBrief (bool)

Converts test report file to brief text format. Default: false.

OptFormatJson (bool)

Converts test report file to JSON formatted file. Default: false.

Advanced Inputs

GitHubApiToken (string)

Specifies GitHub Personal access token (PAT) to increase API limits.

MtDest (string)

Destination path to install MetaTrader platform. Default is the working directory (e.g. /github/workspace).

MtVersion (string)

Version of the MetaTrader platform to install. Default: 4.0.0.1382.

OptTrace (bool)

Enables trace mode. It provides extensive debugging messages. Default: false.

OptVerbose (bool)

Enables verbose mode. It provides more detailed messages. Default: false.

Support

• For bugs/features, raise a new issue at GitHub.