Backport version tests to 7.x

.travis.yml

@@ -7,12 +7,17 @@ env:
     - PIPENV_IGNORE_VIRTUALENVS=1
 before_install:
   - pip install pipenv
+  - docker pull readthedocs/build:7.0 || true
 install:
   - pipenv install
 script:
-  - pipenv run pytest
-  - docker build .
+  - docker build --cache-from readthedocs/build:7.0 -t readthedocs/build:7.0 .
+  - pipenv run pytest -m image_70
 
 branches:
   only:
     - master
+    - releases/5.x
+    - releases/6.x
+    - releases/7.x
+    - releases/8.x

CONTRIBUTING.rst

@@ -34,7 +34,7 @@ Python/Sphinx/etc operations to see if your changes have worked. For example::
 
     cd ~docs
     git clone https://github.com/readthedocs/template
-    cd template
+    cd template/docs
     make html
 
 Releases
@@ -46,20 +46,17 @@ are defined in the :doc:`README`.
 
 We follow `semantic versioning`_, but drop the bug fix level version number for
 our images, as this level of granularity is not important for any application of
-these images. Each release is tagged in Git, and the release version number is
-included in the Dockerfile version label (``LABEL version="2.0"``).
+these images.
 
 Releases should be merged into one of the ``releases/`` branches, for instance
-``releases/2.x``. The version label in the Dockerfile should be updated to the
-next version in the series, following semver rules. This commit should then also
-be tagged using the new version number.
+``releases/2.x``. This commit should then also be tagged using the new version number.
 
-If the version number in the Dockerfile was ``2.0.1`` before, and you implement
+If the version number was ``2.0.1`` before, and you implement
 a bug fix to the image, the new image will be ``2.0.2``. The output image from
 Docker Hub will still be ``2.0`` however. If a new feature is introduced, the
-new version tagged and in the Dockerfile will be ``2.1``.
+new version tagged will be ``2.1``.
 
-We don't care about bug fix version numbers here, as RTD will only ever have one
+We don't care about bug fix version numbers here, as Read the Docs will only ever have one
 main ``2.x`` image at a time. There is no need for us to run multiple bug fix
 versions at the same time.
 

Pipfile

@@ -9,4 +9,6 @@ name = "pypi"
 
 "dockerfile-parse" = "*"
 requests = "*"
-pytest = "*"
+pytest = "*"
+pytest-custom-exit-code = "*"
+docker = "*"

README.rst

@@ -24,19 +24,19 @@ repository:
     **Deprecated**
     Ubuntu 18.04 supporting Python 2.7, 3.5, 3.6, 3.7.
 
-`readthedocs/build:5.0`
+`readthedocs/build:6.0`
     ``stable``
-    Ubuntu 18.04 supporting Python 2.7, 3.6, 3.7 and pypy3.5-7.0.0.
+    Ubuntu 18.04 supporting Python 2.7, 3.5, 3.6, 3.7, 3.8 and PyPy3.5-7.0.0.
     This is the **stable** image supported by Read the Docs.
 
-`readthedocs/build:6.0`
+`readthedocs/build:7.0`
     ``latest``
     Ubuntu 18.04 supporting Python 2.7, 3.5, 3.6, 3.7, 3.8 and PyPy3.5-7.0.0.
     This is the **latest** default image used for documentation builds and supported by Read the Docs.
 
-`readthedocs/build:7.0`
+`readthedocs/build:8.0`
     ``testing``
-    Ubuntu 18.04 supporting Python 2.7, 3.5, 3.6, 3.7, 3.8 and PyPy3.5-7.0.0.
+    Ubuntu 20.04 supporting Python 2.7, 3.5, 3.6, 3.7, 3.8, 3.9.0rc1 and PyPy3.5-7.0.0.
     For internal development **testing** only, not available for public usage yet.
 
 .. _readthedocs/build: https://hub.docker.com/r/readthedocs/build/

tests/test_versions.py

@@ -0,0 +1,162 @@
+import pytest
+from docker import APIClient
+
+from .utils import run_command_in_container
+
+
+@pytest.mark.image_master
+@pytest.mark.parametrize(
+    'command,expected_output',
+    [
+        # python
+        ('python2 --version', 'Python 2.7.18'),
+        ('python3.5 --version', 'Python 3.5.10'),
+        ('python3.6 --version', 'Python 3.6.12'),
+        ('python3.7 --version', 'Python 3.7.9'),
+        ('python3.8 --version', 'Python 3.8.6'),
+        ('pypy3.5 --version', 'Python 3.5.3 (928a4f70d3de7d17449456946154c5da6e600162, Feb 09 2019, 11:50:43)\n[PyPy 7.0.0 with GCC 8.2.0]'),
+        # pip
+        ('python2 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/2.7.18/lib/python2.7/site-packages/pip (python 2.7)"),
+        ('python3.5 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/3.5.10/lib/python3.5/site-packages/pip (python 3.5)"),
+        ('python3.6 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/3.6.12/lib/python3.6/site-packages/pip (python 3.6)"),
+        ('python3.7 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/3.7.9/lib/python3.7/site-packages/pip (python 3.7)"),
+        ('python3.8 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/3.8.6/lib/python3.8/site-packages/pip (python 3.8)"),
+        # setuptools
+        ('python2 -c "import setuptools; print(setuptools.__version__)"', "44.0.0"),
+        ('python3.5 -c "import setuptools; print(setuptools.__version__)"', "45.1.0"),
+        ('python3.6 -c "import setuptools; print(setuptools.__version__)"', "45.1.0"),
+        ('python3.7 -c "import setuptools; print(setuptools.__version__)"', "45.1.0"),
+        ('python3.8 -c "import setuptools; print(setuptools.__version__)"', "45.1.0"),
+        # virtualenv
+        ('python2 -m virtualenv --version', '16.7.9'),
+        ('python3.5 -m virtualenv --version', '16.7.9'),
+        ('python3.6 -m virtualenv --version', '16.7.9'),
+        ('python3.7 -m virtualenv --version', '16.7.9'),
+        ('python3.8 -m virtualenv --version', '16.7.9'),
+        # others
+        ('node --version', 'v10.19.0'),
+        ('npm --version', '6.14.4'),
+        ('conda --version', 'conda 4.6.14'),
+        ('cargo --version', 'cargo 1.46.0 (149022b1d 2020-07-17)'),
+        ('git --version', 'git version 2.25.1'),
+    ]
+)
+def test_command_versions_image_master(command, expected_output):
+    cmd_output = run_command_in_container('readthedocs/build:master', command)
+    assert cmd_output == expected_output
+
+
+@pytest.mark.image_70
+@pytest.mark.parametrize(
+    'command,expected_output',
+    [
+        # python
+        ('python2 --version', 'Python 2.7.18'),
+        ('python3.5 --version', 'Python 3.5.10'),
+        ('python3.6 --version', 'Python 3.6.12'),
+        ('python3.7 --version', 'Python 3.7.9'),
+        ('python3.8 --version', 'Python 3.8.6'),
+        ('pypy3.5 --version', 'Python 3.5.3 (928a4f70d3de7d17449456946154c5da6e600162, Feb 09 2019, 11:50:43)\n[PyPy 7.0.0 with GCC 8.2.0]'),
+        # pip
+        ('python2 -m pip --version', "pip 20.0.2 from /home/docs/.pyenv/versions/2.7.18/lib/python2.7/site-packages/pip (python 2.7)"),
+        ('python3.5 -m pip --version', "pip 20.0.2 from /home/docs/.pyenv/versions/3.5.10/lib/python3.5/site-packages/pip (python 3.5)"),
+        ('python3.6 -m pip --version', "pip 20.0.2 from /home/docs/.pyenv/versions/3.6.12/lib/python3.6/site-packages/pip (python 3.6)"),
+        ('python3.7 -m pip --version', "pip 20.0.2 from /home/docs/.pyenv/versions/3.7.9/lib/python3.7/site-packages/pip (python 3.7)"),
+        ('python3.8 -m pip --version', "pip 20.0.2 from /home/docs/.pyenv/versions/3.8.6/lib/python3.8/site-packages/pip (python 3.8)"),
+        # setuptools
+        ('python2 -c "import setuptools; print(setuptools.__version__)"', "44.0.0"),
+        ('python3.5 -c "import setuptools; print(setuptools.__version__)"', "45.2.0"),
+        ('python3.6 -c "import setuptools; print(setuptools.__version__)"', "45.2.0"),
+        ('python3.7 -c "import setuptools; print(setuptools.__version__)"', "45.2.0"),
+        ('python3.8 -c "import setuptools; print(setuptools.__version__)"', "45.2.0"),
+        # virtualenv
+        ('python2 -m virtualenv --version', 'virtualenv 20.0.7 from /home/docs/.pyenv/versions/2.7.18/lib/python2.7/site-packages/virtualenv/__init__.pyc'),
+        ('python3.5 -m virtualenv --version', 'virtualenv 20.0.7 from /home/docs/.pyenv/versions/3.5.10/lib/python3.5/site-packages/virtualenv/__init__.pyc'),
+        ('python3.6 -m virtualenv --version', 'virtualenv 20.0.7 from /home/docs/.pyenv/versions/3.6.12/lib/python3.6/site-packages/virtualenv/__init__.pyc'),
+        ('python3.7 -m virtualenv --version', 'virtualenv 20.0.7 from /home/docs/.pyenv/versions/3.7.9/lib/python3.7/site-packages/virtualenv/__init__.pyc'),
+        ('python3.8 -m virtualenv --version', 'virtualenv 20.0.7 from /home/docs/.pyenv/versions/3.8.6/lib/python3.8/site-packages/virtualenv/__init__.pyc'),
+        # others
+        ('node --version', 'v8.10.0'),
+        ('npm --version', '3.5.2'),
+        ('conda --version', 'conda 4.6.14'),
+        ('cargo --version', 'cargo 1.46.0 (149022b1d 2020-07-17)'),
+        ('git --version', 'git version 2.17.1'),
+    ]
+)
+def test_command_versions_image_70(command, expected_output):
+    cmd_output = run_command_in_container('readthedocs/build:7.0', command)
+    assert cmd_output == expected_output
+
+
+@pytest.mark.image_60
+@pytest.mark.parametrize(
+    'command,expected_output',
+    [
+        # python
+        ('python2 --version', 'Python 2.7.18'),
+        ('python3.5 --version', 'Python 3.5.10'),
+        ('python3.6 --version', 'Python 3.6.12'),
+        ('python3.7 --version', 'Python 3.7.9'),
+        ('python3.8 --version', 'Python 3.8.6'),
+        ('pypy3.5 --version', 'Python 3.5.3 (928a4f70d3de7d17449456946154c5da6e600162, Feb 09 2019, 11:50:43)\n[PyPy 7.0.0 with GCC 8.2.0]'),
+        # pip
+        ('python2 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/2.7.18/lib/python2.7/site-packages/pip (python 2.7)"),
+        ('python3.5 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/3.5.10/lib/python3.5/site-packages/pip (python 3.5)"),
+        ('python3.6 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/3.6.12/lib/python3.6/site-packages/pip (python 3.6)"),
+        ('python3.7 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/3.7.9/lib/python3.7/site-packages/pip (python 3.7)"),
+        ('python3.8 -m pip --version', "pip 20.0.1 from /home/docs/.pyenv/versions/3.8.6/lib/python3.8/site-packages/pip (python 3.8)"),
+        # setuptools
+        ('python2 -c "import setuptools; print(setuptools.__version__)"', "44.0.0"),
+        ('python3.5 -c "import setuptools; print(setuptools.__version__)"', "45.1.0"),
+        ('python3.6 -c "import setuptools; print(setuptools.__version__)"', "45.1.0"),
+        ('python3.7 -c "import setuptools; print(setuptools.__version__)"', "45.1.0"),
+        ('python3.8 -c "import setuptools; print(setuptools.__version__)"', "45.1.0"),
+        # virtualenv
+        ('python2 -m virtualenv --version', '16.7.9'),
+        ('python3.5 -m virtualenv --version', '16.7.9'),
+        ('python3.6 -m virtualenv --version', '16.7.9'),
+        ('python3.7 -m virtualenv --version', '16.7.9'),
+        ('python3.8 -m virtualenv --version', '16.7.9'),
+        # others
+        ('node --version', 'v8.10.0'),
+        ('npm --version', '3.5.2'),
+        ('conda --version', 'conda 4.6.14'),
+        ('git --version', 'git version 2.17.1'),
+    ]
+)
+def test_command_versions_image_60(command, expected_output):
+    cmd_output = run_command_in_container('readthedocs/build:6.0', command)
+    assert cmd_output == expected_output
+
+
+@pytest.mark.image_50
+@pytest.mark.parametrize(
+    'command,expected_output',
+    [
+        # python
+        ('python2 --version', 'Python 2.7.18'),
+        ('python3.6 --version', 'Python 3.6.12'),
+        ('python3.7 --version', 'Python 3.7.9'),
+        ('pypy3.5 --version', 'Python 3.5.3 (928a4f70d3de7d17449456946154c5da6e600162, Feb 09 2019, 11:50:43)\n[PyPy 7.0.0 with GCC 8.2.0]'),
+        # pip
+        ('python2 -m pip --version', "pip 19.1.1 from /home/docs/.pyenv/versions/2.7.18/lib/python2.7/site-packages/pip (python 2.7)"),
+        ('python3.6 -m pip --version', "pip 19.1.1 from /home/docs/.pyenv/versions/3.6.12/lib/python3.6/site-packages/pip (python 3.6)"),
+        ('python3.7 -m pip --version', "pip 19.1.1 from /home/docs/.pyenv/versions/3.7.9/lib/python3.7/site-packages/pip (python 3.7)"),
+        # setuptools
+        ('python2 -c "import setuptools; print(setuptools.__version__)"', "41.0.1"),
+        ('python3.6 -c "import setuptools; print(setuptools.__version__)"', "41.0.1"),
+        ('python3.7 -c "import setuptools; print(setuptools.__version__)"', "41.0.1"),
+        # virtualenv
+        ('python2 -m virtualenv --version', '16.6.0'),
+        ('python3.6 -m virtualenv --version', '16.6.0'),
+        ('python3.7 -m virtualenv --version', '16.6.0'),
+        # others
+        ('node --version', 'v8.10.0'),
+        ('npm --version', '3.5.2'),
+        ('conda --version', 'conda 4.6.14'),
+        ('git --version', 'git version 2.17.1'),
+    ]
+)
+def test_command_versions_image_50(command, expected_output):
+    cmd_output = run_command_in_container('readthedocs/build:5.0', command)
+    assert cmd_output == expected_output

tests/utils.py

@@ -0,0 +1,37 @@
+from docker import APIClient
+
+
+def run_command_in_container(container_image, command):
+    client = APIClient()
+
+    # Create the container
+    container = client.create_container(
+        image=container_image,
+        command=(
+            '/bin/sh -c "sleep {time}; exit {exit}"'.format(
+                time=60,
+                exit=42,
+            )
+        ),
+        detach=True,
+        user='docs',
+    )
+
+    # Start the container
+    container_id = container.get('Id')
+    client.start(container=container_id)
+
+    # Execute commands to verify versions
+    exec_cmd = client.exec_create(
+        container=container_id,
+        cmd=f"/bin/sh -c '{command}'",
+        stdout=True,
+        stderr=True,
+    )
+    cmd_output = client.exec_start(exec_id=exec_cmd['Id'], stream=False)
+    cmd_output = cmd_output.decode('utf-8', 'replace').strip()
+
+    # Kill container
+    client.kill(container_id)
+
+    return cmd_output