# Grizzly - `/ˈɡɹɪzli/`
<img align="right" src="https://raw.githubusercontent.com/Biometria-se/grizzly/main/docs/content/assets/logo/grizzly_grasshopper_brown_256px.png" alt="grizzly logo">
<span>
###### Framework
###### Command Line Interface
###### Editor Support / Language Server
###### Editor Support / Visual Studio Code Extension
</span>
**Grizzly is a framework to be able to easily define load scenarios, and is primarily built on-top of two other frameworks.**
> [Locust](https://locust.io): Define user behaviour with Python code, and swarm your system with millions of simultaneous users.
> [Behave](https://behave.readthedocs.io/): Uses tests written in a natural language style, backed up by Python code.
**`behave` is <del>ab</del>used for being able to define `locust` load test scenarios using [gherkin](https://cucumber.io/docs/gherkin). A feature can contain more than one scenario and all scenarios will run in parallell. This makes it possible to implement load test scenarios without knowing python or how to use `locust`.**
[Locust](https://en.wikipedia.org/wiki/Locust) are a group of certain species of short-horned grasshoppers in the family Arcididae that have a swarming phase.
The name grizzly was chosen based on the grasshopper [Melanoplus punctulatus](https://en.wikipedia.org/wiki/Melanoplus_punctulatus), also known as __grizzly__ spur-throat grasshopper. This species [prefers living in trees](https://www.sciencedaily.com/releases/2005/07/050718234418.htm) over grass, which is a hint to [Biometria](https://www.biometria.se/)<sup>1</sup>, where `grizzly` originally was created.
<sup>1</sup> _Biometria is a member owned and central actor within the swedish forestry that performs unbiased measurement of lumber flowing between forest and industry so that all of Swedens forest owners can feel confident selling their lumber._
## Documentation
More detailed documentation can be found [here](https://biometria-se.github.io/grizzly) and the easiest way to get started is to check out the [example](https://biometria-se.github.io/grizzly/example/).
## Features
A number of features that we thought `locust` was missing out-of-the-box has been implemented in `grizzly`.
### Test data
Support for synchronous handling of test data (variables). This is extra important when running `locust` distributed and there is a need for each worker and user to have unique test data, that cannot be re-used.
The solution is heavily inspired by [Karol Brejnas locust experiments - feeding the locust](https://medium.com/locust-io-experiments/locust-experiments-feeding-the-locusts-cf09e0f65897). A producer is running on the master (or local) node and keeps track of what has been sent to the consumer running on a worker (or local) node. The two communicates over a dedicated [ZeroMQ](https://zeromq.org) connection.
When the consumer wants new test data, it sends a message to the server that it is available and for which scenario it is going to run. The producer then responds with unique test data that can be used.
### Statistics
Listeners for both InfluxDB and Azure Application Insights are included. The later is more or less [`appinsights_listener.py`](https://github.com/SvenskaSpel/locust-plugins/blob/master/locust_plugins/appinsights_listener.py), from the good guys at [Svenska Spel](https://github.com/SvenskaSpel), but with typing.
They are useful when history of test runs is needed, or when wanting to correlate load tests with other events in the targeted environment.
### Load test users
`locust` comes with a simple user for loading an HTTP(S) endpoint and due to the nature of how the integration between `behave` and `locust` works in `grizzly`, it is not possible to directly use `locust.user.users` provided users, even for HTTP(S) targets.
* `RestApiUser`: send requests to REST API endpoinds, supports authentication with username+password or client secret
* `ServiceBusUser`: send to and receive from Azure Service Bus queues and topics
* `MessageQueueUser`: send and receive from IBM MQ queues
* `BlobStorageUser`: send and receive files to Azure Blob Storage
* `IotHubUser`: send/put files to Azure IoT Hub
### Request log
All failed requests are logged to a file which includes both header and body, both for request and response.
## Installation
```bash
pip3 install grizzly-loadtester
pip3 install grizzly-loadtester-cli
```
Do not forget to try the [example](https://biometria-se.github.io/grizzly/example/) which also serves as a boilerplate scenario project, or create a new grizzly project with:
```bash
grizzly-cli init my-grizzly-project
```
## Development
The easiest way to start contributing to this project is to have [Visual Studio Code](https://code.visualstudio.com/) (with "Remote - Containers" extension) and [docker](https://www.docker.com/) installed. The project comes with a `devcontainer`, which encapsulates everything needed for a development environment.
It is also possible to use a python virtual environment, but then you would have to manually download and install IBM MQ libraries, and install `grizzly` dependencies.
```bash
sudo mkdir /opt/mqm && cd /opt/mqm && wget https://ibm.biz/IBM-MQC-Redist-LinuxX64targz -O - | tar xzf -
export LD_LIBRARY_PATH="/opt/mqm/lib64:${LD_LIBRARY_PATH}"
cd ~/
git clone https://github.com/Biometria-se/grizzly.git
cd grizzly/
python -m venv .venv
source .venv/bin/activate
python -m pip install -e .[dev,ci,mq,docs]
```
Raw data
{
"_id": null,
"home_page": null,
"name": "grizzly-loadtester",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "locust, behave, load, loadtest, performance, traffic generator",
"author": null,
"author_email": "biometria <opensource@biometria.se>",
"download_url": "https://files.pythonhosted.org/packages/d3/99/5a04e9c3dca8aac9c363394ebd6793f171eecbf4a14a3872b5afed39c288/grizzly-loadtester-3.1.1.tar.gz",
"platform": null,
"description": "# Grizzly - `/\u02c8\u0261\u0279\u026azli/`\n\n<img align=\"right\" src=\"https://raw.githubusercontent.com/Biometria-se/grizzly/main/docs/content/assets/logo/grizzly_grasshopper_brown_256px.png\" alt=\"grizzly logo\">\n<span>\n\n###### Framework\n\n\n\n\n\n###### Command Line Interface\n\n\n\n\n\n###### Editor Support / Language Server\n\n\n\n\n###### Editor Support / Visual Studio Code Extension\n\n\n\n</span>\n\n**Grizzly is a framework to be able to easily define load scenarios, and is primarily built on-top of two other frameworks.**\n\n> [Locust](https://locust.io): Define user behaviour with Python code, and swarm your system with millions of simultaneous users.\n\n> [Behave](https://behave.readthedocs.io/): Uses tests written in a natural language style, backed up by Python code.\n\n**`behave` is <del>ab</del>used for being able to define `locust` load test scenarios using [gherkin](https://cucumber.io/docs/gherkin). A feature can contain more than one scenario and all scenarios will run in parallell. This makes it possible to implement load test scenarios without knowing python or how to use `locust`.**\n\n[Locust](https://en.wikipedia.org/wiki/Locust) are a group of certain species of short-horned grasshoppers in the family Arcididae that have a swarming phase.\n\nThe name grizzly was chosen based on the grasshopper [Melanoplus punctulatus](https://en.wikipedia.org/wiki/Melanoplus_punctulatus), also known as __grizzly__ spur-throat grasshopper. This species [prefers living in trees](https://www.sciencedaily.com/releases/2005/07/050718234418.htm) over grass, which is a hint to [Biometria](https://www.biometria.se/)<sup>1</sup>, where `grizzly` originally was created.\n\n<sup>1</sup> _Biometria is a member owned and central actor within the swedish forestry that performs unbiased measurement of lumber flowing between forest and industry so that all of Swedens forest owners can feel confident selling their lumber._\n\n## Documentation\n\nMore detailed documentation can be found [here](https://biometria-se.github.io/grizzly) and the easiest way to get started is to check out the [example](https://biometria-se.github.io/grizzly/example/).\n\n\n## Features\n\nA number of features that we thought `locust` was missing out-of-the-box has been implemented in `grizzly`.\n\n### Test data\n\nSupport for synchronous handling of test data (variables). This is extra important when running `locust` distributed and there is a need for each worker and user to have unique test data, that cannot be re-used.\n\nThe solution is heavily inspired by [Karol Brejnas locust experiments - feeding the locust](https://medium.com/locust-io-experiments/locust-experiments-feeding-the-locusts-cf09e0f65897). A producer is running on the master (or local) node and keeps track of what has been sent to the consumer running on a worker (or local) node. The two communicates over a dedicated [ZeroMQ](https://zeromq.org) connection.\n\nWhen the consumer wants new test data, it sends a message to the server that it is available and for which scenario it is going to run. The producer then responds with unique test data that can be used.\n\n### Statistics\n\nListeners for both InfluxDB and Azure Application Insights are included. The later is more or less [`appinsights_listener.py`](https://github.com/SvenskaSpel/locust-plugins/blob/master/locust_plugins/appinsights_listener.py), from the good guys at [Svenska Spel](https://github.com/SvenskaSpel), but with typing.\n\nThey are useful when history of test runs is needed, or when wanting to correlate load tests with other events in the targeted environment.\n\n### Load test users\n\n`locust` comes with a simple user for loading an HTTP(S) endpoint and due to the nature of how the integration between `behave` and `locust` works in `grizzly`, it is not possible to directly use `locust.user.users` provided users, even for HTTP(S) targets.\n\n* `RestApiUser`: send requests to REST API endpoinds, supports authentication with username+password or client secret\n* `ServiceBusUser`: send to and receive from Azure Service Bus queues and topics\n* `MessageQueueUser`: send and receive from IBM MQ queues\n* `BlobStorageUser`: send and receive files to Azure Blob Storage\n* `IotHubUser`: send/put files to Azure IoT Hub\n\n### Request log\n\nAll failed requests are logged to a file which includes both header and body, both for request and response.\n\n## Installation\n\n```bash\npip3 install grizzly-loadtester\npip3 install grizzly-loadtester-cli\n```\n\nDo not forget to try the [example](https://biometria-se.github.io/grizzly/example/) which also serves as a boilerplate scenario project, or create a new grizzly project with:\n\n```bash\ngrizzly-cli init my-grizzly-project\n```\n\n## Development\n\nThe easiest way to start contributing to this project is to have [Visual Studio Code](https://code.visualstudio.com/) (with \"Remote - Containers\" extension) and [docker](https://www.docker.com/) installed. The project comes with a `devcontainer`, which encapsulates everything needed for a development environment.\n\nIt is also possible to use a python virtual environment, but then you would have to manually download and install IBM MQ libraries, and install `grizzly` dependencies.\n\n```bash\nsudo mkdir /opt/mqm && cd /opt/mqm && wget https://ibm.biz/IBM-MQC-Redist-LinuxX64targz -O - | tar xzf -\nexport LD_LIBRARY_PATH=\"/opt/mqm/lib64:${LD_LIBRARY_PATH}\"\ncd ~/\ngit clone https://github.com/Biometria-se/grizzly.git\ncd grizzly/\npython -m venv .venv\nsource .venv/bin/activate\npython -m pip install -e .[dev,ci,mq,docs]\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Traffic generator based on locust and behave",
"version": "3.1.1",
"project_urls": {
"Code": "https://github.com/biometria-se/grizzly/",
"Documentation": "https://biometria-se.github.io/grizzly/",
"Tracker": "https://github.com/Biometria-se/grizzly/issues"
},
"split_keywords": [
"locust",
" behave",
" load",
" loadtest",
" performance",
" traffic generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d037b56e79f7c1bbe16b0f6da7274558a26e05cd2b1929e5d37749a07a6bf31a",
"md5": "f0e493c743f5e2a696dc68c0cfaeeb65",
"sha256": "be540a09b08be273d1c57b0789af76d2996c50196da3bef2e98aae8b1a080425"
},
"downloads": -1,
"filename": "grizzly_loadtester-3.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0e493c743f5e2a696dc68c0cfaeeb65",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 252456,
"upload_time": "2024-10-14T17:12:57",
"upload_time_iso_8601": "2024-10-14T17:12:57.622634Z",
"url": "https://files.pythonhosted.org/packages/d0/37/b56e79f7c1bbe16b0f6da7274558a26e05cd2b1929e5d37749a07a6bf31a/grizzly_loadtester-3.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3995a04e9c3dca8aac9c363394ebd6793f171eecbf4a14a3872b5afed39c288",
"md5": "a1a964b4989120c93ffe5a6e22b03084",
"sha256": "1cc74e876c6e3dbc09eea65b021adbd67f555d11d1396464dd8203a40d224cd8"
},
"downloads": -1,
"filename": "grizzly-loadtester-3.1.1.tar.gz",
"has_sig": false,
"md5_digest": "a1a964b4989120c93ffe5a6e22b03084",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 696425,
"upload_time": "2024-10-14T17:12:59",
"upload_time_iso_8601": "2024-10-14T17:12:59.243321Z",
"url": "https://files.pythonhosted.org/packages/d3/99/5a04e9c3dca8aac9c363394ebd6793f171eecbf4a14a3872b5afed39c288/grizzly-loadtester-3.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-14 17:12:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "biometria-se",
"github_project": "grizzly",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "grizzly-loadtester"
}
JSON
