Skip to main content

InfluxDBRequestHandlerMock

This item only works when running on the server. Server

In-memory stand-in for HttpPromise.request used to test InfluxDB writes without making real HTTP calls. Inject its InfluxDBRequestHandlerMock.Handler wherever an InfluxDBRequestHandler is expected -- into InfluxDBClient.new, via InfluxDBService.SetRequestHandler, or use InfluxDBClient.newMock, which wires one up for you.

Every request handed to the mock is recorded for inspection. By default each request resolves with a 204 success response; call InfluxDBRequestHandlerMock.SetResponder to control the response (for example to simulate a failure). 

local requestMock = InfluxDBRequestHandlerMock.new()
local client = InfluxDBClient.new(config, requestMock.Handler)
-- ...write some points...
print(#requestMock:GetRequests())

Types​

Responder​

</>
type Responder = (request: HttpPromise.HTTPRequest) → Promise<HttpPromise.HTTPResponse>

A responder controls how the mock answers a request, so a test can resolve or reject however it needs.

Functions​

isInfluxDBRequestHandlerMock​

</>
InfluxDBRequestHandlerMock.isInfluxDBRequestHandlerMock(value: any) → boolean

Returns whether the given value is an InfluxDBRequestHandlerMock.

new​

</>
InfluxDBRequestHandlerMock.new() → InfluxDBRequestHandlerMock

Constructs a new InfluxDBRequestHandlerMock.

SetResponder​

</>
InfluxDBRequestHandlerMock.SetResponder(
responder: Responder?
) → ()

Sets a responder invoked for each subsequent request, letting a test resolve or reject however it needs. Pass nil to restore the default 204 success response.

GetRequests​

</>
InfluxDBRequestHandlerMock.GetRequests(self: InfluxDBRequestHandlerMock) → {HttpPromise.HTTPRequest}

Returns every request handed to the mock, in order.

GetLastRequest​

</>
InfluxDBRequestHandlerMock.GetLastRequest(self: InfluxDBRequestHandlerMock) → HttpPromise.HTTPRequest?

Returns the most recent request handed to the mock, or nil if there have been none.

Show raw api
{
    "functions": [
        {
            "name": "isInfluxDBRequestHandlerMock",
            "desc": "Returns whether the given value is an [InfluxDBRequestHandlerMock].",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/influxdbclient/src/Server/Mocks/InfluxDBRequestHandlerMock.lua"
            }
        },
        {
            "name": "new",
            "desc": "Constructs a new InfluxDBRequestHandlerMock.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InfluxDBRequestHandlerMock"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 75,
                "path": "src/influxdbclient/src/Server/Mocks/InfluxDBRequestHandlerMock.lua"
            }
        },
        {
            "name": "SetResponder",
            "desc": "Sets a responder invoked for each subsequent request, letting a test resolve or reject however it\nneeds. Pass nil to restore the default 204 success response.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBRequestHandlerMock"
                },
                {
                    "name": "responder",
                    "desc": "",
                    "lua_type": "Responder?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 108,
                "path": "src/influxdbclient/src/Server/Mocks/InfluxDBRequestHandlerMock.lua"
            }
        },
        {
            "name": "GetRequests",
            "desc": "Returns every request handed to the mock, in order.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBRequestHandlerMock"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ HttpPromise.HTTPRequest }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 119,
                "path": "src/influxdbclient/src/Server/Mocks/InfluxDBRequestHandlerMock.lua"
            }
        },
        {
            "name": "GetLastRequest",
            "desc": "Returns the most recent request handed to the mock, or nil if there have been none.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBRequestHandlerMock"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HttpPromise.HTTPRequest?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 128,
                "path": "src/influxdbclient/src/Server/Mocks/InfluxDBRequestHandlerMock.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "Responder",
            "desc": "A responder controls how the mock answers a request, so a test can resolve or reject however it needs.",
            "lua_type": "(request: HttpPromise.HTTPRequest) -> Promise<HttpPromise.HTTPResponse>",
            "source": {
                "line": 38,
                "path": "src/influxdbclient/src/Server/Mocks/InfluxDBRequestHandlerMock.lua"
            }
        }
    ],
    "name": "InfluxDBRequestHandlerMock",
    "desc": "In-memory stand-in for [HttpPromise.request] used to test InfluxDB writes without making real HTTP\ncalls. Inject its [InfluxDBRequestHandlerMock.Handler] wherever an [InfluxDBRequestHandler] is\nexpected -- into [InfluxDBClient.new], via [InfluxDBService.SetRequestHandler], or use\n[InfluxDBClient.newMock], which wires one up for you.\n\nEvery request handed to the mock is recorded for inspection. By default each request resolves with a\n204 success response; call [InfluxDBRequestHandlerMock.SetResponder] to control the response (for\nexample to simulate a failure).\n\n```lua\nlocal requestMock = InfluxDBRequestHandlerMock.new()\nlocal client = InfluxDBClient.new(config, requestMock.Handler)\n-- ...write some points...\nprint(#requestMock:GetRequests())\n```",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 22,
        "path": "src/influxdbclient/src/Server/Mocks/InfluxDBRequestHandlerMock.lua"
    }
}