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.

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

Website update, fixed broken links #1869

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Taurus

Quick links: [Taurus Documentation](http://gettaurus.org/docs/) | [Knowledge Base](http://gettaurus.org/kb/) | [Support Forum](https://groups.google.com/forum/#!forum/codename-taurus)
Quick links: [Taurus Documentation](https://gettaurus.org/docs/) | [Knowledge Base](https://gettaurus.org/kb/) | [GitHub Issues](https://github.com/Blazemeter/taurus/issues)

## Purpose
Hides the complexity of performance and functional tests with an automation-friendly convenience wrapper. Taurus relies on JMeter, Gatling, Locust.io, and Selenium WebDriver as its underlying tools. Free and open source under Apache 2.0 License.
Expand All @@ -14,7 +14,7 @@ Just install it using PyPi:
pip install bzt
```

More detailed instructions for Linux, Mac OS and Windows available [here](http://gettaurus.org/docs/Installation.md).
For more detailed instructions for Linux, Mac OS and Windows, see [Installing and Upgrading](https://gettaurus.org/docs/Installation.md).

## Getting Started

Expand All @@ -36,7 +36,7 @@ scenarios:
- http://blazedemo.com/vacation.html
```

Then run `bzt test.yml`. After the tool finishes, observe resulting summary stats in console log (more reporting options [here](http://gettaurus.org/docs/Reporting.md)). All artifact files from the run will be placed in the directory mentioned in console log. Read more on command-line tool usage [here](http://gettaurus.org/docs/CommandLine.md).
Then run `bzt test.yml`. After the tool finishes, observe resulting summary stats in console log (for more reporting options, see [Generating Test Reports](https://gettaurus.org/docs/Reporting.md)). All artifact files from the run will be placed in the directory mentioned in console log. Read more on command-line tool usage [Command-Line Tool](https://gettaurus.org/docs/CommandLine.md).

![Analytics](https://ga-beacon.appspot.com/UA-63369152-1/taurus/readme)

2 changes: 1 addition & 1 deletion bzt/modules/jmeter.py
Original file line number Diff line number Diff line change
Expand Up @@ -1248,7 +1248,7 @@ class JTLErrorsReader(object):
url_xpath = GenericTranslator().css_to_xpath("java\\.net\\.URL")

def __init__(self, filename, parent_logger, err_msg_separator=None, label_converter=None):
# http://stackoverflow.com/questions/9809469/python-sax-to-lxml-for-80gb-xml/9814580#9814580
# https://stackoverflow.com/questions/9809469/python-sax-to-lxml-for-80gb-xml/9814580#9814580
super(JTLErrorsReader, self).__init__()
self.log = parent_logger.getChild(self.__class__.__name__)
self.parser = etree.XMLPullParser(events=('end',))
Expand Down
2 changes: 1 addition & 1 deletion bzt/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -1884,7 +1884,7 @@ def str_representer(dumper, data):


def humanize_bytes(byteval):
# from http://stackoverflow.com/questions/1094841/reusable-library-to-get-human-readable-version-of-file-size/
# from https://stackoverflow.com/questions/1094841/reusable-library-to-get-human-readable-version-of-file-size/
# 25613067#25613067
_suffixes = [' ', 'K', 'M', 'G', 'T', 'P']

Expand Down
2 changes: 1 addition & 1 deletion pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Each PR must conform to [Developer's Guide](http://gettaurus.org/docs/DeveloperGuide/#Rules-for-Contributing).
Each PR must conform to [Developer's Guide](https://gettaurus.org/docs/DeveloperGuide/#Rules-for-Contributing).

Quick checklist:
- [ ] Description of PR explains the context of change
Expand Down
4 changes: 2 additions & 2 deletions site/dat/docs/Apiritif.md
Original file line number Diff line number Diff line change
Expand Up @@ -857,7 +857,7 @@ Typing actions are the following:
- `typeByX(X\_name): "text\_to\_type"` clears `X` value and then types text.
- `typeSecretByXX\_name): "secret"` hides the secret value in the action logging
- `submitByX(X\_name)`
- `keysByX(X\_name): value` sends keystrokes to `X`. `value` can be formed like this: `KEY\_ENTER`. See docs for it [here](http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.common.keys).
- `keysByX(X\_name): value` sends keystrokes to `X`. `value` can be formed like this: `KEY\_ENTER`. See also [Selenium with Python > WebDriver API > Special Keys](https://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.common.keys).

`X` here is for one of [locators](#Locators).

Expand Down Expand Up @@ -1066,7 +1066,7 @@ Note: The capabilities are a way in which the remote service filters and selects
- acceptInsecureCerts
- platformName — commonly used for mobile devices

Full capabilities list is [here](https://www.selenium.dev/documentation/webdriver/capabilities/).
For the full capabilities list, see [Selenium WebDriver Browser Options](https://www.selenium.dev/documentation/webdriver/drivers/options/).

Note: Currently it is possible to perform basic tests in mobile browsers using the available actions commands, in the future more commands related to mobile will be incorporated to allow a better interactivity.

Expand Down
4 changes: 2 additions & 2 deletions site/dat/docs/BlazemeterReporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Like it always happens with tools that focused on _executing_ tests, they are unable to provide
sufficient reporting functionality. As professional user, you need some centralized storage to
be able to access test results in convenient and interactive way, compare different executions,
see trends over time and collaborate with your colleagues. [BlazeMeter.com](http://blazemeter.com)
see trends over time and collaborate with your colleagues. [BlazeMeter.com](https://blazemeter.com)
offers such service, it has both commercial and free of charge versions.

![BlazeMeter Report](blazemeter-rsz.png)
Expand All @@ -17,7 +17,7 @@ system browser, see `browser-open` option for more tuning.

The official policy for BlazeMeter reports uploaded from Taurus, is that anonymous reports are
kept for 7 days and if you're using your own account, then reports are kept according to the
retention policy of your account. For details see BlazeMeter service [website](https://blazemeter.com/).
retention policy of your account. For details see the [BlazeMeter service website](https://blazemeter.com/).

## Personalized Usage

Expand Down
2 changes: 1 addition & 1 deletion site/dat/docs/Changelog2017.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

## 1.9.6 <sup>27 sep 2017</sup>
- add `pytest` executor type
- add [Molotov](https://github.com/loads/molotov)-based executor type: `molotov`
- add [Molotov](https://github.com/tarekziade/molotov)-based executor type: `molotov`
- support `-cloud -func` combination for launching cloud functional tests
- use Gatling 2.3.0 by default
- use JMeter 3.3 by default
Expand Down
2 changes: 1 addition & 1 deletion site/dat/docs/Changelog2018.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@
- remote webdriver support added: selenium grid, appium, local or remote browsers or thirdparty compatible services
- add capabilities for remote webdriver - browser, version, javascript, platform, os_version, selenium, device, app
- new browsers: Chrome-Android and Safari-iOS with local appium or remote webdriver support
- keysBy* - Special keys are allowed using the prefix KEY_ List: http://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.common.keys
- keysBy* - Special keys are allowed using the prefix KEY_ List: https://selenium-python.readthedocs.io/api.html#module-selenium.webdriver.common.keys
- new Selenium actions were added: selectBy*, doubleClickBy*, mouseDownBy*, mouseUpBy*, assertTextBy*, assertValueBy*, assertTitle
- add `headless` switch for selenium-based tests (Chrome and Firefox)
- move assertions inside transactions in Apiritif codegen
Expand Down
6 changes: 3 additions & 3 deletions site/dat/docs/Cloud.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cloud Provisioning

The default mode for taurus is to use `local` provisioning, which means all the tools will be started on local machine. This is not much scalable, so there is a way to delegate actual tool execution into [BlazeMeter cloud](http://blazemeter.com/). Even free accounts can execute cloud tests, according to BlazeMeter's free-tier plan.
The default mode for taurus is to use `local` provisioning, which means all the tools will be started on local machine. This is not much scalable, so there is a way to delegate actual tool execution into [BlazeMeter cloud](https://blazemeter.com/). Even free accounts can execute cloud tests, according to BlazeMeter's free-tier plan.

It is done by setting `cloud` provisioning like this:

Expand Down Expand Up @@ -79,7 +79,7 @@ modules:

Accounts, Workspaces and Projects are BlazeMeter's features that help to exactly specify the access rights and support
shared access to tests and BM features. You can learn more about Workspaces and Projects from BlazeMeter docs, e.g.
an article [Workspaces and Projects](https://guide.blazemeter.com/hc/en-us/articles/213685389-Workspaces-and-Projects-Workspaces-and-Projects).
an article [Workspaces and Projects](https://help.blazemeter.com/docs/guide/administration-workspaces-and-projects.html).

With Taurus, it is possible to specify both names and identifiers for all entities listed.

Expand Down Expand Up @@ -326,4 +326,4 @@ Please note that for `cloud` provisioning actual Taurus execution will be done o
* you should not use `-report` commmand-line option or `blazemeter` reporter, all reports will be collected automatically by BlazeMeter
* only following config sections are passed into cloud: `scenarios`, `execution`, `services`
* `shellexec` module has `artifacts-dir` set as `default-cwd`
* cloud workers execute Taurus under isolated [virtualenv](https://virtualenv.readthedocs.org/en/latest/)
* cloud workers execute Taurus under isolated [virtualenv](https://virtualenv.pypa.io/en/latest/user_guide.html)
4 changes: 2 additions & 2 deletions site/dat/docs/CommandLine.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Note that per-user config will not be copied into artifact directories, so those

There is special shorthand for JMeter JMX test plans: if a config filename ends with `.jmx`, an execution for JMeter with existing script will be generated. This allows using Taurus just like `bzt test1.jmx test2.jmx`.

A helper tool to validate YAML: [http://wiki.ess3.net/yaml/](http://wiki.ess3.net/yaml/)
A helper tool to validate YAML: [https://wiki.ess3.net/yaml/](https://wiki.ess3.net/yaml/)

## Command-Line Options Override

Expand Down Expand Up @@ -109,7 +109,7 @@ target URL as a command-line argument.
bzt http://blazedemo.com/
```

This command will launch a quick test targeting [http://blazedemo.com/](http://blazedemo.com/). You can combine
This command will launch a quick test targeting [https://blazedemo.com/](https://blazedemo.com/). You can combine
it with other CLI options and aliases, such as `-report`, `-cloud` and others.

## Artifacts
Expand Down
2 changes: 1 addition & 1 deletion site/dat/docs/ConfigSyntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ modules:

Available settings are:

- `artifacts-dir` - path template where to save [artifact](ArtifactsDir.md) files, uses [strftime template syntax](http://strftime.org/)
- `artifacts-dir` - path template where to save [artifact](ArtifactsDir.md) files, uses [strftime template syntax](https://strftime.org/)
- `check-interval` - polling interval that used by engine after startup and until shutdown to determine if test is need to be stopped
- `aggregator` - module alias for top-level [results aggregator](Reporting.md#results-reading-and-aggregating-facility) to be used for collecting results and passing it to reporters
- `default-executor` - module alias for executor that will be used by default for [executions](ExecutionSettings.md)
Expand Down
2 changes: 1 addition & 1 deletion site/dat/docs/ExecutionSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ settings:
```

You may contribute your efforts in supporting requests-scenarios for your favorite tool by discussing this on
[project forum](https://groups.google.com/forum/#!forum/codename-taurus).
[GitHub Issues](https://github.com/Blazemeter/taurus/issues).

## Load Profile

Expand Down
2 changes: 1 addition & 1 deletion site/dat/docs/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
1. [Swagger to YAML converter](Swagger.md)
1. [SoapUI support](SoapUI.md)
1. [Keywords Index](KeywordIndex.md)
1. [Troubleshooting, Support and Feedback](https://groups.google.com/forum/#!forum/codename-taurus)
1. [Troubleshooting, Support and Feedback](https://github.com/Blazemeter/taurus/issues)
1. [Artifacts Directory Information](ArtifactsDir.md)

## Developer Documentation
Expand Down
63 changes: 31 additions & 32 deletions site/dat/docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Before Taurus and after Python installation, check if you have the following mod
pip install --upgrade wheel setuptools Cython
```

The simplest Taurus installation requires you to use `pip` package manager:
The simplest Taurus installation uses the `pip` package manager:

```
pip install bzt
Expand All @@ -17,35 +17,36 @@ and for upgrade:
pip install --upgrade bzt
```

Keep in mind that some additional software can be required depend on the test type
Keep in mind that some additional software can be required depending on the test type
(Java, specific Python tools like Locust, etc.).
Below you can see some specific info for different operating systems.
Below, you see specific installation info for different operating systems.

## Unstable features
We use the following mark
The following note indicates a features will be released soon:

_This is available only in [unstable snapshot](https://gettaurus.org/install/Installation/#Latest-Unstable-Snapshot)._

for the features that will be released soon but at the moment
can't be installed from PyPi and available in the pointed topic only.
At the moment, this feature can't be installed from PyPi and is available from the linked page only.

## Linux

You will need Python 3.7+ and Java installed. To install Taurus on Linux, do the following instructions:
First verify that you have installed Python 3.7+ and Java.

To install Taurus on Linux, follow these steps:

```
sudo apt-get update
sudo apt-get install python3 default-jre-headless python3-tk python3-pip python3-dev libxml2-dev libxslt-dev zlib1g-dev net-tools
sudo python3 -m pip install bzt
```
Upgrading to latest is as simple as this:
To upgrading to the latest release:

```
sudo python3 -m pip install --upgrade bzt
```

Alternatively, you can install using virtualenv, and you won't need sudo privileges for Taurus.
Please see [virtualenv](https://virtualenv.pypa.io/en/stable/installation/) instructions for setting up
Alternatively, you can install it using virtualenv, and you won't need sudo privileges for Taurus.
Please see [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) instructions for setting up
your Python virtual environments, if you haven't done so already.

Then, to install Taurus, type:
Expand All @@ -61,22 +62,22 @@ pip install --upgrade bzt
```

## Mac OS
### Install Homebrew Package
You can use [brew](https://brew.sh/) package manager to install Taurus:
### Install the Homebrew Package
Use the [brew](https://brew.sh/) package manager to install Taurus:
```bash
brew install bzt
```
and to update it:
```bash
brew upgrade bzt
```
If your brew auto update is switched off don't forget to manage it manually.
If your brew auto update is switched off, manage it manually.

NOTE: There is an issue with brew installation connected with numpy.
In order to avoid this problem we suggest installing Taurus using `pip` tool.
In order to avoid this problem, we suggest installing Taurus using the `pip` tool.

To install Taurus with `pip` you need command line developers tools and Python 3.7+ installed.
Then you need to install `Cython` if it is not installed using the following command:
To install Taurus with `pip`, you need the command line developers tools and Python 3.7+ installed.
Then install `Cython`, if it is not yet installed, using the following command:
```
pip3 install Cython
```
Expand All @@ -96,11 +97,9 @@ pip3 install --upgrade bzt

Preparation steps:

1. Get Python 3.7+ from [http://www.python.org/downloads](http://www.python.org/downloads) and install it, don't forget to enable "Add python.exe to Path" checkbox.
1. Get Python 3.7+ from [https://www.python.org/downloads](https://www.python.org/downloads) and install it. Enable the "Add python.exe to Path" checkbox.
2. Get the latest Java from [https://www.java.com/download/](https://www.java.com/download/) and install it.
3. Get the latest [Microsoft Visual C++](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=16) and install it.

Please check that the 'Desktop Development with C++' box is checked during installation.
3. Get the latest [Microsoft Visual C++](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Release) and install it. Verify that the 'Desktop Development with C++' box is checked during installation.

![Windows Tools Installation](win-tools-install.png)

Expand All @@ -116,7 +115,7 @@ python -m pip install bzt

## Docker Image

Taurus has [Docker image](https://hub.docker.com/r/blazemeter/taurus/) that allows you to run tool as container.
Taurus provides a [Docker image](https://hub.docker.com/r/blazemeter/taurus/) that lets you run the tool as container.

To use it, create a directory, for example `/tmp/my-test`, put all configs and additional files like JMXses there,
then start Docker like this:
Expand All @@ -125,14 +124,14 @@ then start Docker like this:
docker run -it --rm -v /tmp/my-test:/bzt-configs blazemeter/taurus my-config.yml
```

Make note that `/tmp/my-test` was passed in `-v` Docker option, it's crucial.
Here's [what happens](https://github.com/Blazemeter/taurus/blob/master/Dockerfile) inside the container:
1. Directory `/tmp/my-test` is mounted as `/bzt-configs`
1. Current directory changed to `/bzt-configs`
1. Taurus is started with the config files you specified: `bzt /bzt-configs/my-config.yml
Note that `/tmp/my-test` was passed in the `-v` Docker option, it's crucial.
Here's [what happens inside the container](https://github.com/Blazemeter/taurus/blob/master/Dockerfile):
1. The directory `/tmp/my-test` is mounted as `/bzt-configs`.
1. The current directory is changed to `/bzt-configs`.
1. Taurus is started with the config files you specified: `bzt /bzt-configs/my-config.yml`.

You can also specify multiple config files in the `docker run` command with wildcards or as
separate arguments like so:
separate arguments, as shown in the following example:

```
docker run -it --rm -v /tmp/my-test:/bzt-configs blazemeter/taurus *.yml
Expand All @@ -142,16 +141,16 @@ docker run -it --rm -v /tmp/my-test:/bzt-configs blazemeter/taurus my-config-1.j
### Additional Taurus Command-Line Options

You can still pass [command-line options](https://github.com/Blazemeter/taurus/blob/master/site/dat/docs/CommandLine.md)
to Taurus through the Docker image. To do so, add the command line option at the end of the `docker run` command like so:
to Taurus through the Docker image. To do so, add the following command line option at the end of the `docker run` command:

```bash
docker run -it --rm -v /tmp/my-test:/bzt-configs blazemeter/taurus my-config-1.yml -o scenarios.sample.data-sources.0=data.csv
```


### Accessing Taurus Artifacts
If you want to receive Taurus artifacts from a container, just mount some directory as `/tmp/artifacts` and
files will get there. Following example gives you artifacts in `/tmp/my-run-artifacts` directory.
If you want to receive Taurus artifacts from a container, mount a directory such as `/tmp/artifacts` and
files will be stored there. The following example stores artifacts in the `/tmp/my-run-artifacts` directory:

```bash
docker run -it --rm -v /tmp:/bzt-configs -v /tmp/my-run-artifacts:/tmp/artifacts blazemeter/taurus
Expand All @@ -161,5 +160,5 @@ UNSTABLE_SNAPSHOT

## Data Collection Disclaimer

We have [Usage Statistics](/bzt-usage-stats) on our website. That's why we collect the name of desktop OS,
where you have run Taurus.
We may display anonymous [Usage Statistics](/bzt-usage-stats) on our website.
That's why we collect the name of desktop OS, where you have run Taurus.
4 changes: 2 additions & 2 deletions site/dat/docs/JMeter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# JMeter Executor

This executor type is used by default, it uses [Apache JMeter](http://jmeter.apache.org/) as underlying tool.
This executor type is used by default, it uses [Apache JMeter](https://jmeter.apache.org/) as underlying tool.

## JMeter Location & Auto-Installation

Expand Down Expand Up @@ -818,7 +818,7 @@ This example will set initial value of `${foo}` to be "BAR", but after first ite
changed to "BAZ".

#### HTTP Authorization
See [RFC2617](https://tools.ietf.org/html/rfc2617) for http authorization details
See [RFC2617](https://datatracker.ietf.org/doc/html/rfc2617) for http authorization details

You can use three follow forms for such purposes:
```yaml
Expand Down
Loading