rohitghatol / locust-graphql-client

GraphQL Client for Locust

GraphQL Client for Locust

Locust is a python performance test library. Locust supports http client out of the box. This library provides the GraphQL Client for Locust.

This GraphQL Client is based on Prisma's Simple GraphQL Client for Python (https://github.com/prisma/python-graphql-client)

API

class GraphQLClient:
 def execute(self, label, query, variables=None, type ='graphql'):

####Arguments

• type = Locust Request Type. Default value is 'graphql'
• label = Locust Name
• query = GraphQL Query
• variables = GraphQL Variables. Default value is None

Usage

from locust import HttpLocust, TaskSet, task
from locustgraphqlclient import GraphQLLocust


class UserBehavior(TaskSet):
    def on_start(self):
        """ on_start is called when a Locust start before any task is scheduled """
        self.login()

    def on_stop(self):
        """ on_stop is called when the TaskSet is stopping """
        self.logout()

    def login(self):
        query = '''
        mutation login($username: String!, $password: String!) {
          login(username: $username, password: $password) {
            access_token
          }
        }'''
        variables = {
            'username': 'gm',
            'password': 'centric8'
        }
        result = self.client.execute("login", query, variables)

        # Inject the Access Token in the Client, so subsequent requests can be made
        self.client.inject_token(result['data']['login']['access_token'])

    def logout(self):
        # Reset the Access Token in the Client, so no subsequent requests can be made
        self.client.inject_token('')

    @task(2)
    def index(self):
        query = '''
                    query products {
                      products {
                        id
                        name
                        image
                      }
                    }'''
        result = self.client.execute("products", query)

    @task(1)
    def profile(self):
        query = '''
                    query me {
                      me {
                        id
                        username
                        firstName
                        lastName                    
                      }
                    }'''
        result = self.client.execute("me", query)


class WebsiteUser(GraphQLLocust):
    task_set = UserBehavior
    min_wait = 5000
    max_wait = 9000

locust-graphql-client's Issues

Support passthrough HTTP Headers

We have a firewall which requires a header value to bypass, and I cannot send a header with my GQL request to do this.

Expected:

self.client.execute("myGQLQuery", query, headers={"x-firewall-bypass": "true"})

Result:

/ERROR/locust.core: execute() got an unexpected keyword argument 'headers'

client.execute() should return json instead of string

data = client(query, variables)
result = json.loads(data)

Instead of client.execute() returning a string, it should return a json

Rename Locust to User due to Breaking Change

I get this error message:

ImportError: The Locust class has been renamed to User in version 1.0. For more info see: https://docs.locust.io/en/latest/changelog.html#changelog-1-0

And it's coming from here

I believe that it's just a simple renaming of the class or at the very least the setup.py should be version locked to a version of locust that this lib supports via install_requires.

https://docs.locust.io/en/latest/changelog.html#changelog-1-0

Let me know for anything missed!