Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add test_stopping event #2033

Merged
merged 6 commits into from
Mar 1, 2022
Merged

Add test_stopping event #2033

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f04442d
Add test_stopping event
Feb 25, 2022
f67f41b
Fixing unit test
marcinh Feb 25, 2022
2ed83cf
Add unit test
marcinh Feb 25, 2022
671fa20
Apply review comments
marcinh Feb 28, 2022
8636bde
Apply review comments #2
marcinh Feb 28, 2022
5dd6df4
Update description
marcinh Mar 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion examples/test_data_management.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,16 @@ def _(environment, **_kwargs):
).json()["data"]


@events.test_stop.add_listener
@events.test_stopping.add_listener
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you update the comment at the start of the file too!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

like this?

# 6. Test run stopping
# 7. User stop
# 8. Test run stop
# 9. (not shown in this example) Locust quit

def _(environment, **_kwargs):
print("stopping test run")


@events.test_stop.add_listener
def _(environment, **_kwargs):
print("test run stopped")


class MyUser(HttpUser):
host = "https://postman-echo.com"
wait_time = constant(180) # be nice to postman-echo
Expand Down
97 changes: 57 additions & 40 deletions locust/test/test_runners.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
import json
import os
import random
import time
import unittest
from collections import defaultdict
from contextlib import contextmanager
from operator import itemgetter

import gevent
Expand Down Expand Up @@ -116,7 +114,22 @@ class HeyAnException(Exception):
pass


class TestLocustRunner(LocustTestCase):
class LocustRunnerTestCase(LocustTestCase):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.runner_stopping = False
self.runner_stopped = False

def setUp(self):
super().setUp()
self.reset_state()

def reset_state(self):
self.runner_stopping = False
self.runner_stopped = False


class TestLocustRunner(LocustRunnerTestCase):
def test_cpu_warning(self):
_monitor_interval = runners.CPU_MONITOR_INTERVAL
runners.CPU_MONITOR_INTERVAL = 2.0
Expand Down Expand Up @@ -197,25 +210,23 @@ class MyUser(User):
def my_task(self):
pass

test_stop_run = [0, 0]
environment = Environment(user_classes=[User])
environment = Environment(user_classes=[MyUser])

@environment.events.test_stopping.add_listener
def on_test_stopping(*_, **__):
test_stop_run[0] += 1
self.runner_stopping = True

def on_test_stop(*args, **kwargs):
test_stop_run[1] += 1

environment.events.test_stopping.add_listener(on_test_stopping)
environment.events.test_stop.add_listener(on_test_stop)
@environment.events.test_stop.add_listener
def on_test_stop(*_, **__):
self.runner_stopped = True

runner = LocalRunner(environment)
runner.start(user_count=3, spawn_rate=3, wait=False)
self.assertEqual(0, test_stop_run[0])
self.assertEqual(0, test_stop_run[1])
self.assertFalse(self.runner_stopping)
self.assertFalse(self.runner_stopped)
runner.stop()
self.assertEqual(1, test_stop_run[0])
self.assertEqual(1, test_stop_run[1])
self.assertTrue(self.runner_stopping)
self.assertTrue(self.runner_stopped)

def test_stop_event_quit(self):
class MyUser(User):
Expand All @@ -225,19 +236,23 @@ class MyUser(User):
def my_task(self):
pass

test_stop_run = [0]
environment = Environment(user_classes=[User])
environment = Environment(user_classes=[MyUser])

def on_test_stop(*args, **kwargs):
test_stop_run[0] += 1
@environment.events.test_stopping.add_listener
def on_test_stopping(*_, **__):
self.runner_stopping = True

environment.events.test_stop.add_listener(on_test_stop)
@environment.events.test_stop.add_listener
def on_test_stop(*_, **__):
self.runner_stopped = True

runner = LocalRunner(environment)
runner.start(user_count=3, spawn_rate=3, wait=False)
self.assertEqual(0, test_stop_run[0])
self.assertFalse(self.runner_stopping)
self.assertFalse(self.runner_stopped)
runner.quit()
self.assertEqual(1, test_stop_run[0])
self.assertTrue(self.runner_stopping)
self.assertTrue(self.runner_stopped)

def test_stop_event_stop_and_quit(self):
class MyUser(User):
Expand All @@ -247,20 +262,24 @@ class MyUser(User):
def my_task(self):
pass

test_stop_run = [0]
environment = Environment(user_classes=[MyUser])

def on_test_stop(*args, **kwargs):
test_stop_run[0] += 1
@environment.events.test_stopping.add_listener
def on_test_stopping(*_, **__):
self.runner_stopping = True

environment.events.test_stop.add_listener(on_test_stop)
@environment.events.test_stop.add_listener
def on_test_stop(*_, **__):
self.runner_stopped = True

runner = LocalRunner(environment)
runner.start(user_count=3, spawn_rate=3, wait=False)
self.assertEqual(0, test_stop_run[0])
self.assertFalse(self.runner_stopping)
self.assertFalse(self.runner_stopped)
runner.stop()
runner.quit()
self.assertEqual(1, test_stop_run[0])
self.assertTrue(self.runner_stopping)
self.assertTrue(self.runner_stopped)

def test_change_user_count_during_spawning(self):
class MyUser(User):
Expand Down Expand Up @@ -1780,7 +1799,7 @@ def on_test_start(*args, **kwargs):
self.assertTrue(test_start_event_fired[0])


class TestMasterRunner(LocustTestCase):
class TestMasterRunner(LocustRunnerTestCase):
def setUp(self):
super().setUp()
self.environment = Environment(events=locust.events, catch_exceptions=False)
Expand Down Expand Up @@ -2230,33 +2249,31 @@ def my_task(self):
with mock.patch("locust.rpc.rpc.Server", mocked_rpc()) as server:
master = self.get_runner(user_classes=[TestUser])

run_count = [0, 0]

@self.environment.events.test_stopping.add_listener
def on_test_stopping(*a, **kw):
run_count[0] += 1
def on_test_stopping(*_, **__):
self.runner_stopping = True

@self.environment.events.test_stop.add_listener
def on_test_stop(*a, **kw):
run_count[1] += 1
def on_test_stop(*_, **__):
self.runner_stopped = True

for i in range(5):
server.mocked_send(Message("client_ready", __version__, "fake_client%i" % i))

master.start(7, 7)
self.assertEqual(5, len(server.outbox))
master.stop()
self.assertEqual(1, run_count[0])
self.assertEqual(1, run_count[1])
self.assertTrue(self.runner_stopping)
self.assertTrue(self.runner_stopped)

run_count = [0, 0]
self.reset_state()
for i in range(5):
server.mocked_send(Message("client_ready", __version__, "fake_client%i" % i))
master.start(7, 7)
master.stop()
master.quit()
self.assertEqual(1, run_count[0])
self.assertEqual(1, run_count[1])
self.assertTrue(self.runner_stopping)
self.assertTrue(self.runner_stopped)

def test_stop_event_quit(self):
"""
Expand Down