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

Update devguide with information about Python 3 and venv #15833

Merged
merged 1 commit into from
Jan 27, 2020
Merged
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
15 changes: 11 additions & 4 deletions docs/devguide/contributing.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,23 @@ Another command properly formats go source files and adds a copyright header:
make fmt
--------------------------------------------------------------------------------

Both of these commands should be run before submitting a PR. You can view all
the available make targets with `make help`.

These commands have the following dependencies:

* Python >= {python}
* https://virtualenv.pypa.io/en/latest/[virtualenv] for Python
* Python https://docs.python.org/3/library/venv.html[venv module]
* https://github.com/magefile/mage[Mage]

Virtualenv can be installed with the command `easy_install virtualenv` or `pip
install virtualenv`. More details can be found
https://virtualenv.pypa.io/en/latest/installation.html[here]. Both of these commands should be run before submitting a PR. You can view all the available make targets with `make help`.
Python venv module is included in the standard library in Python 3. On Debian/Ubuntu
systems it also requires to install the `python3-venv` package, that includes
additional support scripts:

[source,shell]
--------------------------------------------------------------------------------
sudo apt-get install python3-venv
--------------------------------------------------------------------------------

[float]
[[build-target-env-vars]]
Expand Down
11 changes: 9 additions & 2 deletions docs/devguide/creating-beat-from-metricbeat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,17 @@ To create your own Beat, you must have Go {go-version} or later installed, and t
must be set up correctly. In addition, the following tools are required:

* https://www.python.org/downloads/[python]
* https://virtualenv.pypa.io/en/stable/[virtualenv]
* https://docs.python.org/3/library/venv.html[python venv module]
* https://github.com/magefile/mage[mage]

Virtualenv is easiest installed with your package manager or https://pip.pypa.io/en/stable/[pip].
Python venv module is already included in the standard library. In Ubuntu/Debian
it requires additional support scripts that can be installed with the
`python3-venv` package:

[source,bash]
----
sudo apt-get install python3-venv
----

[float]
==== Step 1 - Get the metricbeat source code
Expand Down
2 changes: 1 addition & 1 deletion docs/devguide/metricset-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ written in Go and have no dependencies. Integration tests are also written
in Go but require the service from which the module collects metrics to also be running.
System tests for Metricbeat also require the service to be running in most cases and are
written in Python based on our small Python test framework.
We use `virtualenv` to deal with Python dependencies.
We use https://docs.python.org/3/library/venv.html[venv] to deal with Python dependencies.
You can simply run the command `make python-env` and then `. build/python-env/bin/activate` .

You should use a combination of the three test types to test your metricsets because
Expand Down
3 changes: 2 additions & 1 deletion docs/devguide/modules-dev-guide.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ $ ./export_dashboards -yml '../../../filebeat/module/{module}/module.yml'
----

New Filebeat modules might not be compatible with Kibana 5.x. To export dashboards
that are compatible with 5.x, run the following command inside the developer virtualenv:
that are compatible with 5.x, run the following command inside the developer
virtual environment:

[source,shell]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/devguide/newbeat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ You now have a raw template of the Beat, but you still need to <<setting-up-beat
First you need to install the following tools:

* https://www.python.org/downloads/[Python]
* https://virtualenv.pypa.io/en/stable/[virtualenv]
* https://docs.python.org/3/library/venv.html[Python venv module]

To fetch dependencies and set up the Beat, run:

Expand Down
90 changes: 90 additions & 0 deletions docs/devguide/python.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
[[python-beats]]
== Python in Beats

Python is used for Beats development, it is the language used to implement
system tests and some other tools. Python dependencies are managed by the use of
virtual environments, supported by
https://docs.python.org/3/library/venv.html[venv].

Beats development requires Python >= {python}.

[[installing-python]]
=== Installing Python and venv

Python uses to be installed in many operating systems. If it is not installed in
your system you can follow the instructions available in https://www.python.org/downloads/

In Ubuntu/Debian systems, Python 3 can be installed with:

["source","sh"]
----
sudo apt-get install python3 python3-venv
----

There are packages for specific minor versions, so for example if Python 3.7
wants to be used, it can be installed with the following command:

["source","sh"]
----
sudo apt-get install python3.7 python3.7-venv
----

It is recommended to use Python >= {python}.

[[python-virtual-environments]]
=== Working with virtual environments

All `make` and `mage` targets manage their own virtual environments in a transparent
way, so for the most common operations required when contributing to beats,
nothing special needs to be done.

Virtual environments used by `make` can be found in most Beats directories under
`build/python-env`, they are created by targets that need it, or can be
explicitly created by running `make python-env`. The ones used by `mage` are
created when required under `build/ve`.

There are some environment variables that can be used to customize the creation
of these virtual environments:

* `PYTHON_EXE`: Python executable to be used in the virtual environment. It has
to exist in the path.
* `PYTHON_ENV`: Path to the virtual environment to use. If it doesn't exist, it
is created by `make` or `mage` targets when needed.

Virtual environments can also be used without `make` or `mage`, this is usual
for example when running individual system tests with `nosetests`. There are two
ways to run commands from the virtual environment:

* "Activating" the virtual environment in your current terminal running
`source ./build/python-env/bin/activate`. Virtual environment can be
deactivated by running `deactivate`.
* Directly running commands from the virtual environment path. For example
`nosetests` can be executed as `./build/python-env/bin/nosetests`.

To recreate a virtual environment, remove its directory. All virtual
environments are also removed with `make clean`.

[[python-older-versions]]
=== Working with older versions

Older versions of Beats were not compatible with Python 3, if you need to
temporary work on one of these versions of Beats, and you don't want to remove
your current virtual environments, you can use environment variables to run
commands in a temporary virtual environment.

For example you can run `make update` with Python 2.7 with the following
command:

["source","sh"]
-----
PYTHON_EXE=python2.7 PYTHON_ENV=/tmp/venv2 make update
-----

If you need to run tests you can also create a virtual environment and then
activate it to run commands from there:
["source","sh"]
-----
PYTHON_EXE=python2.7 PYTHON_ENV=/tmp/venv2 make python-env
source /tmp/venv2/bin/activate
...
-----
2 changes: 1 addition & 1 deletion docs/devguide/testing.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ All Go tests are in the same package as the tested code itself and have the post

==== Running Python Tests

The system tests require a testing binary to be available and the python environment to be set up. To create the testing binary run `make {beatname}.test`. This will create the test binary in the beat directory. To setup the testing environment `make python-env` can be run which will use `virtualenv` to load the dependencies. Then `nosetests` has to be run inside `tests/system`.
The system tests require a testing binary to be available and the python environment to be set up. To create the testing binary run `make {beatname}.test`. This will create the test binary in the beat directory. To setup the testing environment `make python-env` can be run which will use `venv` to load the dependencies. Then `nosetests` has to be run inside `tests/system`.

To automate all these steps into one `make system-tests` can be run. This creates the binary, the environment and runs all tests which do not require and external service.

Expand Down