This is an automated email from the ASF dual-hosted git repository. fschumacher pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/jmeter.git
commit cecd1b9254c1fb0101bdca20ca571d6654d42ca8 Author: Felix Schumacher <[email protected]> AuthorDate: Sat Aug 3 13:05:38 2019 +0200 Markup changes, small fixes and ant to gradle Try to change markup to comply with best practices for markdown. Small fixes like adding a 'k' to change 'lie' to 'like'. Change command examples from ant to gradle. Still missing are the required changes to the properties files for proxy usage. --- README.md | 137 +++++++++++++++++++++++++++++--------------------------------- 1 file changed, 63 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 63bef0c..a3642a8 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [](https://www.javadoc.io/doc/org.apache.jmeter/ApacheJMeter_core) [](https://twitter.com/intent/tweet?text=Powerful%20load%20testing%20with%20Apache%20JMeter:&url=https://jmeter.apache.org) -## What is it? +## What is it Apache JMeter may be used to test performance both on static and dynamic resources, Web dynamic applications. It can be used to simulate a heavy load on a server, group of servers, network or object to test its strength or to analyze overall performance under different load types. @@ -19,17 +19,18 @@ It can be used to simulate a heavy load on a server, group of servers, network o Apache JMeter features include: -Ability to load and performance test many different applications/server/protocol types: - - Web - HTTP, HTTPS (Java, NodeJS, PHP, ASP.NET,...) - - SOAP / REST Webservices - - FTP - - Database via JDBC - - LDAP - - Message-oriented Middleware (MOM) via JMS - - Mail - SMTP(S), POP3(S) and IMAP(S) - - Native commands or shell scripts - - TCP - - Java Objects +Ability to load and performance test many different applications/server/protocol types: + +- Web - HTTP, HTTPS (Java, NodeJS, PHP, ASP.NET,...) +- SOAP / REST Webservices +- FTP +- Database via JDBC +- LDAP +- Message-oriented Middleware (MOM) via JMS +- Mail - SMTP(S), POP3(S) and IMAP(S) +- Native commands or shell scripts +- TCP +- Java Objects Full featured Test IDE that allows fast Test Plan **recording (from Browsers or native applications), building and debugging.** @@ -53,53 +54,51 @@ and simultaneous sampling of different functions by separate thread groups. Caching and offline analysis/replaying of test results. Highly Extensible core: - - Pluggable Samplers allow unlimited testing capabilities. - - **Scriptable Samplers** (JSR223-compatible languages like Groovy) - - Several load statistics may be chosen with **pluggable timers**. - - Data analysis and **visualization plugins** allow great extensibility and personalization. - - Functions can be used to provide dynamic input to a test or provide data manipulation. - - Easy Continuous Integration through 3rd party Open Source libraries for Maven, Gradle and Jenkins +- Pluggable Samplers allow unlimited testing capabilities. +- **Scriptable Samplers** (JSR223-compatible languages like Groovy) +- Several load statistics may be chosen with **pluggable tiers**. +- Data analysis and **visualization plugins** allow great exensibility and personalization. +- Functions can be used to provide dynamic input to a test orprovide data manipulation. +- Easy Continuous Integration through 3rd party Open Source libraries for Maven, Gradle and Jenkins ## The Latest Version -Details of the latest version can be found on the JMeter Apache -Project web site (https://jmeter.apache.org/). +Details of the latest version can be found on the [JMeter Apache +Project web site](https://jmeter.apache.org/) ## Requirements The following requirements exist for running Apache JMeter: -* Java Interpreter: - - A fully compliant Java 8 Runtime Environment is required - for Apache JMeter to execute. A JDK with keytool utility is better suited - for Recording HTTPS websites. - Java 9 is not yet supported as of version 3.3. +- Java Interpreter: -* Optional jars: + A fully compliant Java 8 Runtime Environment is required + for Apache JMeter to execute. A JDK with `keytool` utility is better suited + for Recording HTTPS websites. - Some jars are not included with JMeter. - If required, these should be downloaded and placed in the lib directory +- Optional jars: - * JDBC - available from the database supplier - * JMS - available from the JMS provider - * [Bouncy Castle](http://www.bouncycastle.org/latest_releases.html) - - only needed for SMIME Assertion + Some jars are not included with JMeter. + If required, these should be downloaded and placed in he ib directory + - JDBC - available from the database supplier + - JMS - available from the JMS provider + - [Bouncy Castle](http://www.bouncycastle.org/test_releases.html) - + only needed for SMIME Assertion -* Java Compiler (OPTIONAL): +- Java Compiler (*OPTIONAL*): - A Java compiler is not needed since the distribution includes a - precompiled Java binary archive. _Note that a compiler is required - to build plugins for Apache JMeter._ + A Java compiler is not needed since the distribution cludes a + precompiled Java binary archive. + > **Note** that a compiler is required to build plugins for Apache JMeter. ## Installation Instructions -_Note that spaces in directory names can cause problems._ +> **Note** that spaces in directory names can cause problems. - * Release builds +- Release builds - Unpack the binary archive into a suitable directory structure. + Unpack the binary archive into a suitable directory structure. ## Running JMeter @@ -111,15 +110,15 @@ _Note that spaces in directory names can cause problems._ For Windows there are also some other scripts which you can drag-and-drop a JMX file onto: -* `jmeter-n.cmd` - runs the file as a non-GUI test -* `jmeter-n-r.cmd` - runs the file as a non-GUI remote (client-server) test -* `jmeter-t.cmd` - loads the file ready to run it as a GUI test +- `jmeter-n.cmd` - runs the file as a non-GUI test +- `jmeter-n-r.cmd` - runs the file as a non-GUI remote (client-server) test +- `jmeter-t.cmd` - loads the file ready to run it as a GUI test ## Documentation The documentation available as of the date of this release is -also included, in HTML format, in the `printable_docs/` directory, -and it may be browsed starting from the file called `index.html`. +also included, in HTML format, in the [printable_docs](printable_docs) directory, +and it may be browsed starting from the file called [index.html](printable_docs/index.html). ## Reporting a bug/enhancement @@ -132,11 +131,6 @@ See [Issue Tracking](https://jmeter.apache.org/issues.html) Unpack the source archive into a suitable directory structure. Most of the 3rd party library files can be extracted from the binary archive by unpacking it into the same directory structure. -You can also use Ant to download the required library files: - -```sh -ant download_jars -``` Any optional jars (see above) should be placed in `lib/opt` and/or `lib`. @@ -148,7 +142,7 @@ downloaded by other JMeter users._ If you are behind a proxy, you can set a few build properties in `build-local.properties` for ant to use the proxy: -``` +```properties proxy.use=true proxy.host=proxy.example.invalid proxy.port=8080 @@ -158,7 +152,8 @@ proxy.pass=your_password You might also want to skip some tests - that are failing without proper access to the internet - by adding some more properties into `build-local.properties`: -``` + +```properties skip.bug52310=true skip.bug60607=true skip.batchtest_Http4ImplPreemptiveBasicAuth=true @@ -171,24 +166,19 @@ skip.test_TestDNSCacheManager.testWithCustomResolverAnd1Server=true ### Test builds -JMeter is built using Ant. +JMeter is built using Gradle. Change to the top-level directory and issue the command: ```sh -ant download_jars -``` -_This only needs to be done once; it will download any missing 3rd party jars._ - -```sh -ant +./gradlew build ``` This will compile the application and enable you to run `jmeter` from the `bin` directory. ```sh -ant test [-Djava.awt.headless=true] +./gradlew check [-Djava.awt.headless=true] ``` This will compile and run the unit tests. @@ -197,20 +187,20 @@ does not have a suitable GUI display. ## Developer information -Building and contributing is explained in details at https://jmeter.apache.org/building.html +Building and contributing is explained in details at [building JMeter](https://jmeter.apache.org/building.html) -The code is maintained at GitHub: +The code is maintained at GitHub: -- https://github.com/apache/jmeter -- https://gitbox.apache.org/repos/asf/jmeter.git +- <https://github.com/apache/jmeter> +- <https://gitbox.apache.org/repos/asf/jmeter.git> ## Licensing and legal information For legal and licensing information, please see the following files: -* [LICENSE](LICENSE) +- [LICENSE](LICENSE) -* [NOTICE](NOTICE) +- [NOTICE](NOTICE) ## Cryptographic Software Notice @@ -236,17 +226,16 @@ code and source code. The following provides more details on the included software that may be subject to export controls on cryptographic software: - Apache JMeter interfaces with the - Java Secure Socket Extension (JSSE) API to provide - - - HTTPS support +Apache JMeter interfaces with the +Java Secure Socket Extension (JSSE) API to provide - Apache JMeter interfaces (via Apache HttpClient4) with the - Java Cryptography Extension (JCE) API to provide +- HTTPS support - - NTLM authentication +Apache JMeter interfaces (via Apache HttpClient4) with the +Java Cryptography Extension (JCE) API to provide - Apache JMeter does not include any implementation of JSSE or JCE. +- NTLM authentication +Apache JMeter does not include any implementation of JSSE or JCE. **Thank you for using Apache JMeter.**
