Module rt

Implements the base riak_test API, providing the ability to control nodes in a Riak cluster as well as perform commonly reused operations.

Description

Implements the base riak_test API, providing the ability to control nodes in a Riak cluster as well as perform commonly reused operations. Please extend this module with new functions that prove useful between multiple independent tests.

Function Index

check_singleton_node/1Ensure that the specified node is a singleton node/cluster -- a node that owns 100% of the ring.
claimant_according_to/1Return a list of nodes that own partitions according to the ring retrieved from the specified node.
deploy_nodes/1Deploy a set of freshly installed Riak nodes, returning a list of the nodes deployed.
down/2Have Node mark OtherNode as down.
join/2Have Node send a join request to PNode
leave/1Have the specified node leave the cluster.
members_according_to/1Return a list of cluster members according to the ring retrieved from the specified node.
owners_according_to/1Return a list of nodes that own partitions according to the ring retrieved from the specified node.
remove/2Have Node remove OtherNode from the cluster.
start/1Start the specified Riak node.
status_of_according_to/2Return the cluster status of Member according to the ring retrieved from Node.
stop/1Stop the specified Riak node.
wait_until_all_members/1Wait until all nodes in the list Nodes believe each other to be members of the cluster.
wait_until_all_members/2Wait until all nodes in the list Nodes believes all nodes in the list Members are members of the cluster.
wait_until_no_pending_changes/1Given a list of nodes, wait until all nodes believe there are no on-going or pending ownership transfers.
wait_until_nodes_ready/1Given a list of nodes, wait until all nodes are considered ready.
wait_until_pingable/1Wait until the specified node is pingable.
wait_until_ready/1Wait until the specified node is considered ready by riak_core.
wait_until_ring_converged/1Given a list of nodes, wait until all nodes believe the ring has converged (ie.
wait_until_unpingable/1Wait until the specified node is no longer pingable.

Function Details

check_singleton_node/1

check_singleton_node(Node) -> any()

Ensure that the specified node is a singleton node/cluster -- a node that owns 100% of the ring.

claimant_according_to/1

claimant_according_to(Node) -> any()

Return a list of nodes that own partitions according to the ring retrieved from the specified node.

deploy_nodes/1

deploy_nodes(NumNodes::integer()) -> [node()]

Deploy a set of freshly installed Riak nodes, returning a list of the nodes deployed.

down/2

down(Node, OtherNode) -> any()

Have Node mark OtherNode as down

join/2

join(Node, PNode) -> any()

Have Node send a join request to PNode

leave/1

leave(Node) -> any()

Have the specified node leave the cluster

members_according_to/1

members_according_to(Node) -> any()

Return a list of cluster members according to the ring retrieved from the specified node.

owners_according_to/1

owners_according_to(Node) -> any()

Return a list of nodes that own partitions according to the ring retrieved from the specified node.

remove/2

remove(Node, OtherNode) -> any()

Have Node remove OtherNode from the cluster

start/1

start(Node) -> any()

Start the specified Riak node

status_of_according_to/2

status_of_according_to(Member, Node) -> any()

Return the cluster status of Member according to the ring retrieved from Node.

stop/1

stop(Node) -> any()

Stop the specified Riak node

wait_until_all_members/1

wait_until_all_members(Nodes) -> any()

Wait until all nodes in the list Nodes believe each other to be members of the cluster.

wait_until_all_members/2

wait_until_all_members(Nodes, Members) -> any()

Wait until all nodes in the list Nodes believes all nodes in the list Members are members of the cluster.

wait_until_no_pending_changes/1

wait_until_no_pending_changes(Nodes::[node()]) -> ok | fail

Given a list of nodes, wait until all nodes believe there are no on-going or pending ownership transfers.

wait_until_nodes_ready/1

wait_until_nodes_ready(Nodes) -> any()

Given a list of nodes, wait until all nodes are considered ready. See wait_until_ready/1 for definition of ready.

wait_until_pingable/1

wait_until_pingable(Node) -> any()

Wait until the specified node is pingable

wait_until_ready/1

wait_until_ready(Node) -> any()

Wait until the specified node is considered ready by riak_core. As of Riak 1.0, a node is ready if it is in the valid or leaving states. A ready node is guaranteed to have current preflist/ownership information.

wait_until_ring_converged/1

wait_until_ring_converged(Nodes) -> any()

Given a list of nodes, wait until all nodes believe the ring has converged (ie. riak_core_ring:is_ready returns true).

wait_until_unpingable/1

wait_until_unpingable(Node) -> any()

Wait until the specified node is no longer pingable


Generated by EDoc, Jan 10 2012, 17:33:57.