Merge pull request #1 from locustio/master

sync from locust

CHANGELOG.md

@@ -1,5 +1,65 @@
 # Changelog
 
+## [1.2.1](https://github.com/locustio/locust/tree/1.2.1) (2020-08-20)
+
+[Full Changelog](https://github.com/locustio/locust/compare/1.2...1.2.1)
+
+**Fixed bugs:**
+
+- ValueError: StatsEntry.use\_response\_times\_cache must be set to True [\#1531](https://github.com/locustio/locust/issues/1531)
+
+**Merged pull requests:**
+
+- fix \#1531 \(ValueError: StatsEntry.use\_response\_times\_cache must be set to True\) [\#1534](https://github.com/locustio/locust/pull/1534) ([cyberw](https://github.com/cyberw))
+- Add missing parameter to render\_template to grey out UI fields [\#1533](https://github.com/locustio/locust/pull/1533) ([max-rocket-internet](https://github.com/max-rocket-internet))
+- Update repo README with new wording, locust example, screenshots [\#1532](https://github.com/locustio/locust/pull/1532) ([max-rocket-internet](https://github.com/max-rocket-internet))
+
+## [1.2](https://github.com/locustio/locust/tree/1.2) (2020-08-19)
+
+[Full Changelog](https://github.com/locustio/locust/compare/1.1.1...1.2)
+
+**Fixed bugs:**
+
+- Excessive precision of metrics in losust csv stats  [\#1501](https://github.com/locustio/locust/issues/1501)
+- WorkerRunner spawns heartbeat before setting worker\_state [\#1500](https://github.com/locustio/locust/issues/1500)
+- Negative min\_response\_time shown in stats [\#1487](https://github.com/locustio/locust/issues/1487)
+- Unhandled exception:  ConnectionResetError, Connection reset by peer \(FastHttpUser\) [\#1472](https://github.com/locustio/locust/issues/1472)
+
+**Closed issues:**
+
+- Change the position of dividers in command line report [\#1514](https://github.com/locustio/locust/issues/1514)
+- Allow negative hatch rate for ramping down [\#1488](https://github.com/locustio/locust/issues/1488)
+- Missing URL to download full csv history [\#1468](https://github.com/locustio/locust/issues/1468)
+- Support for completely custom load pattern / shape [\#1432](https://github.com/locustio/locust/issues/1432)
+- rename "hatch rate" to "spawn rate" [\#1405](https://github.com/locustio/locust/issues/1405)
+
+**Merged pull requests:**
+
+- Doc review changes [\#1528](https://github.com/locustio/locust/pull/1528) ([phil-davis](https://github.com/phil-davis))
+- Major rework of documentation & many small fixes [\#1527](https://github.com/locustio/locust/pull/1527) ([cyberw](https://github.com/cyberw))
+- Make hatch-rate parameter deprecated instead of killing it right away. [\#1526](https://github.com/locustio/locust/pull/1526) ([cyberw](https://github.com/cyberw))
+- Move dividers \(pipe characters\) in stats command line output. Also shrink percentiles output and remove 99.999 percentile by default Fixes \#1514 [\#1525](https://github.com/locustio/locust/pull/1525) ([cyberw](https://github.com/cyberw))
+- Grey out UI input fields when LoadTestShape is in use [\#1524](https://github.com/locustio/locust/pull/1524) ([max-rocket-internet](https://github.com/max-rocket-internet))
+- Rename hatch rate to spawn rate. Fixes \#1405 [\#1523](https://github.com/locustio/locust/pull/1523) ([cyberw](https://github.com/cyberw))
+- Keep csv files open [\#1522](https://github.com/locustio/locust/pull/1522) ([lhupfeldt](https://github.com/lhupfeldt))
+- Fix issue with non str, non Exception type failure messages [\#1517](https://github.com/locustio/locust/pull/1517) ([cyberw](https://github.com/cyberw))
+-  Add Feature: Download Report File [\#1516](https://github.com/locustio/locust/pull/1516) ([taojy123](https://github.com/taojy123))
+- Fix typos [\#1512](https://github.com/locustio/locust/pull/1512) ([phil-davis](https://github.com/phil-davis))
+- Fix typo of failure\_percentage in test\_stats.py [\#1511](https://github.com/locustio/locust/pull/1511) ([phil-davis](https://github.com/phil-davis))
+- Fix old HttpLocust reference in docs [\#1508](https://github.com/locustio/locust/pull/1508) ([phil-davis](https://github.com/phil-davis))
+- Adding ability to generate any custom load shape with LoadTestShape class [\#1505](https://github.com/locustio/locust/pull/1505) ([max-rocket-internet](https://github.com/max-rocket-internet))
+- Download full history - see issue 1468 [\#1504](https://github.com/locustio/locust/pull/1504) ([lhupfeldt](https://github.com/lhupfeldt))
+- Fix csv stats precision [\#1503](https://github.com/locustio/locust/pull/1503) ([vstepanov-lohika-tix](https://github.com/vstepanov-lohika-tix))
+- Allow ramping down of users [\#1502](https://github.com/locustio/locust/pull/1502) ([max-rocket-internet](https://github.com/max-rocket-internet))
+- Add 2 things to .gitignore [\#1498](https://github.com/locustio/locust/pull/1498) ([max-rocket-internet](https://github.com/max-rocket-internet))
+- Print valid URL when --web-host is not specified [\#1496](https://github.com/locustio/locust/pull/1496) ([dmitrytokarev](https://github.com/dmitrytokarev))
+- Replace time.time\(\) with time.monotonic\(\) [\#1492](https://github.com/locustio/locust/pull/1492) ([max-rocket-internet](https://github.com/max-rocket-internet))
+- Remove "Loadgen" from CPU warning log messages [\#1491](https://github.com/locustio/locust/pull/1491) ([max-rocket-internet](https://github.com/max-rocket-internet))
+- Fix small typo in docker docs [\#1490](https://github.com/locustio/locust/pull/1490) ([max-rocket-internet](https://github.com/max-rocket-internet))
+- fade into the running screen before getting a response from the server [\#1479](https://github.com/locustio/locust/pull/1479) ([camilojimenez](https://github.com/camilojimenez))
+- Refactoring stats to handle custom percentiles [\#1477](https://github.com/locustio/locust/pull/1477) ([vstepanov-lohika-tix](https://github.com/vstepanov-lohika-tix))
+- Handle connection reset error in fast http client [\#1475](https://github.com/locustio/locust/pull/1475) ([mkarlovich](https://github.com/mkarlovich))
+
 ## [1.1.1](https://github.com/locustio/locust/tree/1.1.1) (2020-07-07)
 
 [Full Changelog](https://github.com/locustio/locust/compare/1.1...1.1.1)
@@ -475,6 +535,7 @@
 - Allow None response time for requests [\#1088](https://github.com/locustio/locust/pull/1088) ([cyberw](https://github.com/cyberw))
 - Fixed issue with Total Requests Per Second plot [\#1060](https://github.com/locustio/locust/pull/1060) ([williamlhunter](https://github.com/williamlhunter))
 - Tox: Add flake8 tests to find Python syntax errors and undefined names [\#1039](https://github.com/locustio/locust/pull/1039) ([cclauss](https://github.com/cclauss))
+- Fix frontend bugs. [\#822](https://github.com/locustio/locust/pull/822) ([omittones](https://github.com/omittones))
 - Switch from using optparse to argparse for command line arguments [\#769](https://github.com/locustio/locust/pull/769) ([jdufresne](https://github.com/jdufresne))
 - Allow skipping the logging setup [\#738](https://github.com/locustio/locust/pull/738) ([Exide](https://github.com/Exide))
 - Added link to an Ansible role as a 3rd party tool. [\#704](https://github.com/locustio/locust/pull/704) ([tinx](https://github.com/tinx))
@@ -812,6 +873,7 @@
 - \(libev\) select: Invalid argument when trying to go past 1k users [\#121](https://github.com/locustio/locust/issues/121)
 - Command line option to specify the duration to run [\#71](https://github.com/locustio/locust/issues/71)
 - Setup/teardown hooks [\#59](https://github.com/locustio/locust/issues/59)
+- Define wait times by function instead of variable [\#18](https://github.com/locustio/locust/issues/18)
 
 **Merged pull requests:**
 
@@ -825,7 +887,6 @@
 - Change name of msgpack dependency. [\#841](https://github.com/locustio/locust/pull/841) ([vamega](https://github.com/vamega))
 - response time doesn't need to be cast to int, as this is implicit in … [\#830](https://github.com/locustio/locust/pull/830) ([efology](https://github.com/efology))
 - Add tasks sequence support [\#827](https://github.com/locustio/locust/pull/827) ([Ramshell](https://github.com/Ramshell))
-- Fix frontend bugs. [\#822](https://github.com/locustio/locust/pull/822) ([omittones](https://github.com/omittones))
 - Fix some typos in events.py [\#820](https://github.com/locustio/locust/pull/820) ([felixonmars](https://github.com/felixonmars))
 - Update all pypi.python.org URLs to pypi.org [\#818](https://github.com/locustio/locust/pull/818) ([jdufresne](https://github.com/jdufresne))
 - Update third-party-tools.rst [\#808](https://github.com/locustio/locust/pull/808) ([anhldbk](https://github.com/anhldbk))
@@ -874,7 +935,6 @@
 - make test is failing on 0.7 tags due to Flask 0.12 [\#637](https://github.com/locustio/locust/issues/637)
 - num-requests bug [\#512](https://github.com/locustio/locust/issues/512)
 - Run the tests for the specified time [\#196](https://github.com/locustio/locust/issues/196)
-- loglevel and logfile don't seem to work [\#25](https://github.com/locustio/locust/issues/25)
 - Remove support for plain sockets for master/slave communication [\#14](https://github.com/locustio/locust/issues/14)
 
 ## [v0.8](https://github.com/locustio/locust/tree/v0.8) (2017-09-19)
@@ -1015,7 +1075,6 @@
 - Suggest Python version  [\#231](https://github.com/locustio/locust/issues/231)
 - Changing locustfile.py on master via UI and having  master / slave replication [\#209](https://github.com/locustio/locust/issues/209)
 - Option to prevent stats from being reset when all locusts are hatched [\#205](https://github.com/locustio/locust/issues/205)
-- PUT requests are shown as GET [\#204](https://github.com/locustio/locust/issues/204)
 - Cannot simulate one single user [\#178](https://github.com/locustio/locust/issues/178)
 - Feature request: Stepped hatch rate [\#168](https://github.com/locustio/locust/issues/168)
 - Having a locust "die" or stop after one task [\#161](https://github.com/locustio/locust/issues/161)
@@ -1243,6 +1302,7 @@
 - multiple slaves of different server specs ? [\#210](https://github.com/locustio/locust/issues/210)
 - multiple url tests ? [\#208](https://github.com/locustio/locust/issues/208)
 - how to get the recorded data  [\#206](https://github.com/locustio/locust/issues/206)
+- PUT requests are shown as GET [\#204](https://github.com/locustio/locust/issues/204)
 - http proxy support [\#203](https://github.com/locustio/locust/issues/203)
 - error report is not included in `--logfile` nor is it available for download as a csv [\#202](https://github.com/locustio/locust/issues/202)
 - Stats get corrupted when the number of swarm users reaches the objective [\#201](https://github.com/locustio/locust/issues/201)
@@ -1447,13 +1507,16 @@
 
 [Full Changelog](https://github.com/locustio/locust/compare/v0.5...v0.5.1)
 
+**Closed issues:**
+
+- loglevel and logfile don't seem to work [\#25](https://github.com/locustio/locust/issues/25)
+
 ## [v0.5](https://github.com/locustio/locust/tree/v0.5) (2012-07-01)
 
 [Full Changelog](https://github.com/locustio/locust/compare/v0.4...v0.5)
 
 **Closed issues:**
 
-- Define wait times by function instead of variable [\#18](https://github.com/locustio/locust/issues/18)
 - Remove Confluence specific task ratio formatter [\#13](https://github.com/locustio/locust/issues/13)
 - Add HTTP request method \(GET/POST/PUT, etc\) to statistics table [\#3](https://github.com/locustio/locust/issues/3)
 

README.md

@@ -7,73 +7,68 @@
 [![PyPI](https://img.shields.io/pypi/pyversions/locust.svg)](https://pypi.org/project/locust/)
 [![GitHub contributors](https://img.shields.io/github/contributors/locustio/locust.svg)](https://github.com/locustio/locust/graphs/contributors)
 
-## Links
+Locust is an easy to use, scriptable and scalable performance testing tool. You define the behaviour of your users in regular Python code, instead of using a clunky UI or domain specific language. This makes Locust infinitely expandable and very developer friendly.
 
-* Website: <a href="https://locust.io">locust.io</a>
-* Documentation: <a href="https://docs.locust.io">docs.locust.io</a>
-* Code/issues: <a href="https://github.com/locustio/locust">Github</a>
-* Support/Questions: <a href="https://stackoverflow.com/questions/tagged/locust">StackOverflow</a>
-* Chat/discussion: [Slack signup](https://slack.locust.io/)
+## Features
 
-## Description
+#### Write user test scenarios in plain-old Python
 
-Locust is an easy-to-use, distributed, user load testing tool. It is intended for load-testing web sites (or other systems) and
-figuring out how many concurrent users a system can handle.
+If you want your users to loop, perform some conditional behaviour or do some calculations, you just use the regular programming constructs provided by Python. Locust runs every user inside its own greenlet (a lightweight process/coroutine). This enables you to write your tests like normal (blocking) Python code instead of having to use callbacks or some other mechanism. Because your scenarios are “just python” you can use your regular IDE, and version control your tests as regular code (as opposed to some other tools that use XML or binary formats)
 
-The idea is that during a test, a swarm of simulated users will attack your website. The behavior of each user is defined by you 
-using Python code, and the swarming process is monitored from a web UI in real-time. This will help you battle test and identify 
-bottlenecks in your code before letting real users in.
+```python
+from locust import HttpUser, task, between
 
-Locust is completely event-based, and therefore it's possible to support thousands of concurrent users on a single machine.
-In contrast to many other event-based apps it doesn't use callbacks. Instead it uses light-weight processes, through <a href="http://www.gevent.org/">gevent</a>.
-Each locust swarming your site is actually running inside its own process (or greenlet, to be correct).
-This allows you to write very expressive scenarios in Python without complicating your code with callbacks.
+class QuickstartUser(HttpUser):
+    wait_time = between(1, 2)
 
+    def on_start(self):
+        self.client.post("/login", json={"username":"foo", "password":"bar"})
 
-## Features
-* **Write user test scenarios in plain-old Python**<br>
- No need for clunky UIs or bloated XML—just code as you normally would. Based on coroutines instead
-of callbacks, your code looks and behaves like normal, blocking Python code.
+    @task
+    def index_page(self):
+        self.client.get("/hello")
+        self.client.get("/world")
+
+    @task(3)
+    def view_item(self):
+        for item_id in range(10):
+            self.client.get(f"/item?id={item_id}", name="/item")
+```
 
-* **Distributed & Scalable - supports hundreds of thousands of users**<br>
- Locust supports running load tests distributed over multiple machines.
- Being event-based, even one Locust node can handle thousands of users in a single process.
- Part of the reason behind this is that even if you simulate that many users, not all are actively hitting your system. Often, users are idle figuring out what to do next. Requests per second != number of users online.
+#### Distributed & Scalable - supports hundreds of thousands of users
 
-* **Web-based UI**<br>
- Locust has a neat HTML+JS that shows all relevant test details in real-time. And since the UI is web-based, it's cross-platform and easily extendable.
+Locust makes it easy to run load tests distributed over multiple machines. It is event-based (using [gevent](http://www.gevent.org/)), which makes it possible for a single process to handle many thousands concurrent users. While there may be other tools that are capable of doing more requests per second on a given hardware, the low overhead of each Locust user makes it very suitable for testing highly concurrent workloads.
 
-* **Can test any system**<br>
- Even though Locust is web-oriented, it can be used to test almost any system. Just write a client for what ever you wish to test and swarm it with users! It's super easy!
+#### Web-based UI
 
-* **Hackable**<br>
- Locust is very small and very hackable and we intend to keep it that way. All heavy-lifting of evented I/O and coroutines are delegated to gevent. The brittleness of alternative testing tools was the reason we created Locust.
+Locust has a user friendly web interface that shows the progress of your test in real-time. You can even change the load while the test is running. It can also be run without the UI, making it easy to use for CI/CD testing.
 
+<img src="https://raw.githubusercontent.com/locustio/locust/master/locust/static/img/ui-screenshot-charts.png" alt="Locust UI charts" width="200"/> <img src="https://raw.githubusercontent.com/locustio/locust/master/locust/static/img/ui-screenshot-stats.png" alt="Locust UI stats" width="200"/> <img src="https://raw.githubusercontent.com/locustio/locust/master/locust/static/img/ui-screenshot-workers.png" alt="Locust UI workers" width="200"/> <img src="https://raw.githubusercontent.com/locustio/locust/master/locust/static/img/ui-screenshot-start-test.png" alt="Locust UI start test" width="200"/>
 
-## Documentation
+#### Can test any system
 
-More info and documentation can be found at: <a href="https://docs.locust.io/">https://docs.locust.io/</a>
+Even though Locust primarily works with web sites/services, it can be used to test almost any system or protocol. Just [write a client](https://docs.locust.io/en/latest/testing-other-systems.html#testing-other-systems) for what you want to test, or [explore some created by the community](https://github.com/SvenskaSpel/locust-plugins#users).
 
-## Questions/help?
+## Hackable
 
-For questions about how to use Locust, feel free to stop by the Slack or ask questions on Stack Overflow tagged Locust.
+Locust is small and very flexible and we intend to keep it that way. If you want to [send reporting data to that database & graphing system you like](https://github.com/SvenskaSpel/locust-plugins/blob/master/locust_plugins/listeners.py), wrap calls to a REST API to handle the particulars of your system or run a [totally custom load pattern](https://docs.locust.io/en/latest/generating-custom-load-shape.html#generating-custom-load-shape), there is nothing stopping you!
 
-## Bug reporting
+## Links
 
-Open a Github issue and follow the template listed there.
+* Website: [locust.io](https://locust.io)
+* Documentation: [docs.locust.io](https://docs.locust.io)
+* Code/issues: [Github](https://github.com/locustio/locust)
+* Support/Questions: [StackOverflow](https://stackoverflow.com/questions/tagged/locust)
+* Chat/discussion: [Slack signup](https://slack.locust.io/)
 
 ## Authors
 
-- <a href="http://cgbystrom.com">Carl Bystr&ouml;m</a> (@<a href="https://twitter.com/cgbystrom">cgbystrom</a> on Twitter)
-- <a href="http://heyman.info">Jonatan Heyman</a> (@<a href="https://twitter.com/jonatanheyman">jonatanheyman</a> on Twitter)
-- Joakim Hamrén (@<a href="https://twitter.com/Jahaaja">Jahaaja</a>)
-- Hugo Heyman (@<a href="https://twitter.com/hugoheyman">hugoheyman</a>)
+* [Carl Bystr](http://cgbystrom.com) ([@cgbystrom](https://twitter.com/cgbystrom) on Twitter)
+* [Jonatan Heyman](http://heyman.info) ([@jonatanheyman](https://twitter.com/jonatanheyman) on Twitter)
+* [Joakim Hamrén](https://github.com/Jahaja) ([@Jahaaja](https://twitter.com/Jahaaja) on Twitter)
+* [Hugo Heyman](https://github.com/HeyHugo) ([@hugoheyman](https://twitter.com/hugoheyman) on Twitter)
+* [Lars Holmberg](https://github.com/cyberw)
 
 ## License
 
 Open source licensed under the MIT license (see _LICENSE_ file for details).
-
-
-## Supported Python Versions
-
-Locust is supported on Python 3.6, 3.7, 3.8.