API Examples (REST)

from locust import HttpUser, task, between

class QuickstartUser(HttpUser):
    # The simulated user will pause for a duration between 5 and 9 seconds before executing the tasks.
    wait_time = between(5, 9)

    def on_start(self):
        # Initializing the Authorization header with the bearer token.
        self.client.headers.update({'Authorization': 'Bearer TOKEN_HERE'})

    @task(1)
    def index_page(self):
        # Making four GET requests every wait_time duration.
        self.client.get("/api/hosts")
        self.client.get("/api/tests")
        self.client.get("/api/result/1488")
        self.client.get("/api/result/1463")

import random
from locust import HttpUser, task, between

class AdvancedUser(HttpUser):
    wait_time = between(5, 9)

    def get_results(self):
        self.results = []

        # Retrieve all results and store their unique IDs for subsequent tasks.
        response = self.client.get("/api/results")
        for result in response.json():
            self.results.append(result['id'])

    def on_start(self):
        # Distribute start times among users.
        self.wait()

        # Initialize the Bearer authentication token.
        self.client.headers.update({'Authorization': 'Bearer TOKEN_HERE'})

        # Fetch and store all potential results.
        self.get_results()

    @task(1)
    def read_hosts(self):
        self.client.get("/api/hosts")

    @task(2)
    def read_tests(self):
        self.client.get("/api/tests")

    @task(5)
    def read_results(self):
        # Fetch a random result based on the previously retrieved list.
        self.client.get("/api/result/" + str(random.choice(self.results)))

    @task(1)
    def crud_host(self):
        # Create a new Host and extract its details from the response.
        response = self.client.post("/api/hosts/create", {'url': 'www.test.com', 'port': '443', 'protocol': 'https'})
        host = response.json()

        # Clean up by deleting the recently created host.
        self.client.post("/api/hosts/delete", {"host_id": host['host_id']})