Skip to content

Commit

Permalink
docs: add overview of what we are actually testing
Browse files Browse the repository at this point in the history
  • Loading branch information
@xavfernandez
xavfernandez committed Oct 21, 2019
1 parent b66decb commit bbc1b4f
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 17 deletions.
152 changes: 135 additions & 17 deletions docs/html/development/ci.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,10 @@
Continuous Integration
======================

Checks
======

`pip` CI runs different kind of tests:

- lint (defined in `.pre-commit-config.yaml`)
- docs
- vendoring (is the `src/_internal/_vendor` directory cleanly vendored)
- unit tests (present in `tests/unit`)
- "integration" tests
- package (test the packaging steps)


Tested interpreters
===================
Supported interpreters
======================

pip is tested on a variety of Python interpreters:
pip support a variety of Python interpreters:

- CPython 2.7
- CPython 3.5
Expand All @@ -39,6 +26,29 @@ and on different architectures:
- x64
- x86

so 42 hypothetical interpreters.


Checks
======

``pip`` CI runs different kind of tests:

- lint (defined in ``.pre-commit-config.yaml``)
- docs
- vendoring (is the ``src/_internal/_vendor`` directory cleanly vendored)
- unit tests (present in ``tests/unit``)
- "integration" tests (mostly present in ``tests/functional``)
- package (test the packaging steps)

Since lint, docs, vendoring and package tests only need to run on a pip
developer/contributor machine, they only need to be tested on the x64 variant
of the 3 different operating systems, and when an interpreter needs to be
specified it's ok to require the latest CPython interpreter.

So only unit tests and integration tests would need to be run with the different
interpreters.

Services
========

Expand All @@ -47,8 +57,116 @@ provides free executors for open source packages:

- `Travis CI`_ (Used for Linux)
- `Appveyor CI`_ (Windows only)
- 'Azure DevOps`_ (Linux, MacOS & Windows tests)
- `Azure DevOps CI`_ (Linux, MacOS & Windows tests)
- `GitHub Actions`_ (Linux, MacOS & Windows tests)

.. _`Travis CI`: https://travis-ci.org/
.. _`Appveyor CI`: https://www.appveyor.com/
.. _`Azure DevOps CI`: https://dev.azure.com/
.. _`GitHub Actions`: https://github.com/features/actions


Current run tests
=================

Developer tasks
---------------

======== =============== ================ =========== ============
OS docs lint vendoring packages
======== =============== ================ =========== ============
Linux Travis, Github Travis, Github Travis Azure
Windows Azure
MacOS Azure
======== =============== ================ =========== ============

Actual testing
--------------

+------------------------------+---------------+-----------------+
| **interpreter** | **unit** | **integration** |
+-----------+----------+-------+---------------+-----------------+
| | | CP2.7 | Azure | Azure |
| | +-------+---------------+-----------------+
| | | CP3.5 | Azure | |
| | +-------+---------------+-----------------+
| | | CP3.6 | Azure | |
| | +-------+---------------+-----------------+
| | x86 | CP3.7 | Azure | |
| | +-------+---------------+-----------------+
| | | CP3.8 | | |
| | +-------+---------------+-----------------+
| | | PyPy | | |
| | +-------+---------------+-----------------+
| | | PyPy3 | | |
| Windows +----------+-------+---------------+-----------------+
| | | CP2.7 | Appveyor | Appveyor |
| | +-------+---------------+-----------------+
| | | CP3.5 | Appveyor | Appveyor |
| | +-------+---------------+-----------------+
| | | CP3.6 | Appveyor | Appveyor |
| | +-------+---------------+-----------------+
| | x64 | CP3.7 | Azure | Azure |
| | +-------+---------------+-----------------+
| | | CP3.8 | | |
| | +-------+---------------+-----------------+
| | | PyPy | | |
| | +-------+---------------+-----------------+
| | | PyPy3 | | |
+-----------+----------+-------+---------------+-----------------+
| | | CP2.7 | | |
| | +-------+---------------+-----------------+
| | | CP3.5 | | |
| | +-------+---------------+-----------------+
| | | CP3.6 | | |
| | +-------+---------------+-----------------+
| | x86 | CP3.7 | | |
| | +-------+---------------+-----------------+
| | | CP3.8 | | |
| | +-------+---------------+-----------------+
| | | PyPy | | |
| | +-------+---------------+-----------------+
| | | PyPy3 | | |
| Linux +----------+-------+---------------+-----------------+
| | | CP2.7 | Travis,Azure | Travis,Azure |
| | +-------+---------------+-----------------+
| | | CP3.5 | Travis,Azure | Travis,Azure |
| | +-------+---------------+-----------------+
| | | CP3.6 | Travis,Azure | Travis,Azure |
| | +-------+---------------+-----------------+
| | x64 | CP3.7 | Travis,Azure | Travis,Azure |
| | +-------+---------------+-----------------+
| | | CP3.8 | Travis | Travis |
| | +-------+---------------+-----------------+
| | | PyPy | Travis | Travis |
| | +-------+---------------+-----------------+
| | | PyPy3 | Travis | Travis |
+-----------+----------+-------+---------------+-----------------+
| | | CP2.7 | | |
| | +-------+---------------+-----------------+
| | | CP3.5 | | |
| | +-------+---------------+-----------------+
| | | CP3.6 | | |
| | +-------+---------------+-----------------+
| | x86 | CP3.7 | | |
| | +-------+---------------+-----------------+
| | | CP3.8 | | |
| | +-------+---------------+-----------------+
| | | PyPy | | |
| | +-------+---------------+-----------------+
| | | PyPy3 | | |
| MacOS +----------+-------+---------------+-----------------+
| | | CP2.7 | Azure | Azure |
| | +-------+---------------+-----------------+
| | | CP3.5 | Azure | Azure |
| | +-------+---------------+-----------------+
| | | CP3.6 | Azure | Azure |
| | +-------+---------------+-----------------+
| | x64 | CP3.7 | Azure | Azure |
| | +-------+---------------+-----------------+
| | | CP3.8 | | |
| | +-------+---------------+-----------------+
| | | PyPy | | |
| | +-------+---------------+-----------------+
| | | PyPy3 | | |
+-----------+----------+-------+---------------+-----------------+
1 change: 1 addition & 0 deletions docs/html/development/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ or the `pypa-dev mailing list`_, to ask questions or get involved.

getting-started
contributing
ci
issue-triage
architecture/index
release-process
Expand Down

0 comments on commit bbc1b4f

Please sign in to comment.