bot_army v1.0.0 BotArmy.LoadTest View Source
Manages a load test run.
Don't use this directly, call from mix bots.load_test
. See the documentation for the
available params.
This will start up the target number of bots. If bots die off, this will restart them in batches to return to the target number.
Bots run until calling stop
.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
Run just one bot and stop when finished. Useful for testing a bot out, or running a bot as a "task."
Starts up the bots.
Link to this section Functions
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
get_bot_count() View Source
init(state) View Source
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
,
except that it also sets a timeout. See the "Timeouts" section
in the module documentation for more information.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
one_off(opts) View Source
Run just one bot and stop when finished. Useful for testing a bot out, or running a bot as a "task."
Opts map:
tree
- [required] the tree defining the work to be done.bot
- [optional] a custom callback module implementingBotArmy.Bot
, otherwise usesBotArmy.Bot.Default
This wraps the provided tree so that it either errors if it fails, or performs
BotArmy.Actions.done
if it succeeds. This guarantees the tree won't run more
than once (unless you intentionally create a loop using one of the repeat
nodes).
run(opts) View Source
Starts up the bots.
Opts map:
n
- [optional] the number of bots to start up (defaults to 1)tree
- [required] the behavior tree for the bots to usebot
- [optional] a custom callback module implementingBotArmy.Bot
, otherwise usesBotArmy.Bot.Default
Note that you cannot call this if bots are already running (call BotArmy.LoadTest.stop
first).