Test cases for PythonEnvironment.is_obsolete

Author: humitos

readthedocs/doc_builder/python_environments.py

@@ -8,7 +8,7 @@
 import logging
 import os
 import shutil
-from builtins import object
+from builtins import object, open
 
 from django.conf import settings
 
@@ -130,7 +130,7 @@ def is_obsolete(self):
                 environment_conf = json.load(fpath)
             env_python_version = environment_conf['python']['version']
             env_build_image = environment_conf['build']['image']
-        except (TypeError, KeyError, ValueError):
+        except (IOError, TypeError, KeyError, ValueError):
             log.error('Unable to read/parse environment.json file')
             return False
 

readthedocs/rtd_tests/tests/test_doc_building.py

@@ -14,18 +14,22 @@
 from builtins import str
 
 import mock
+import pytest
 from django.test import TestCase
 from docker.errors import APIError as DockerAPIError
 from docker.errors import DockerException
-from mock import Mock, PropertyMock, patch
+from mock import Mock, PropertyMock, mock_open, patch
 
 from readthedocs.builds.constants import BUILD_STATE_CLONING
 from readthedocs.builds.models import Version
+from readthedocs.doc_builder.config import ConfigWrapper
 from readthedocs.doc_builder.environments import (
     BuildCommand, DockerBuildCommand, DockerEnvironment, LocalEnvironment)
 from readthedocs.doc_builder.exceptions import BuildEnvironmentError
+from readthedocs.doc_builder.python_environments import Virtualenv
 from readthedocs.projects.models import Project
 from readthedocs.rtd_tests.mocks.environment import EnvironmentMockGroup
+from readthedocs.rtd_tests.tests.test_config_wrapper import create_load
 
 DUMMY_BUILD_ID = 123
 SAMPLE_UNICODE = u'HérÉ îß sömê ünïçó∂é'
@@ -831,3 +835,108 @@ def test_command_oom_kill(self):
         self.assertEqual(
             str(cmd.output),
             u'Command killed due to excessive memory consumption\n')
+
+
+
+
+class TestAutoWipeEnvironment(TestCase):
+    fixtures = ['test_data']
+
+    def setUp(self):
+        self.pip = Project.objects.get(slug='pip')
+        self.version = self.pip.versions.get(slug='0.8')
+
+    def test_is_obsolete_without_env_json_file(self):
+        yaml_config = create_load()()[0]
+        config = ConfigWrapper(version=self.version, yaml_config=yaml_config)
+
+        with patch('os.path.exists') as exists:
+            exists.return_value = False
+            python_env = Virtualenv(
+                version=self.version,
+                build_env=None,
+                config=config,
+            )
+
+        self.assertFalse(python_env.is_obsolete)
+
+    def test_is_obsolete_with_invalid_env_json_file(self):
+        yaml_config = create_load()()[0]
+        config = ConfigWrapper(version=self.version, yaml_config=yaml_config)
+
+        with patch('os.path.exists') as exists:
+            exists.return_value = True
+            python_env = Virtualenv(
+                version=self.version,
+                build_env=None,
+                config=config,
+            )
+
+        self.assertFalse(python_env.is_obsolete)
+
+    def test_is_obsolete_with_json_different_python_version(self):
+        config_data = {
+            'build': {
+                'image': '2.0',
+            },
+            'python': {
+                'version': 2.7,
+            },
+        }
+        yaml_config = create_load(config_data)()[0]
+        config = ConfigWrapper(version=self.version, yaml_config=yaml_config)
+
+        python_env = Virtualenv(
+            version=self.version,
+            build_env=None,
+            config=config,
+        )
+        env_json_data = '{"build": {"image": "readthedocs/build:2.0"}, "python": {"version": 3.5}}'
+        with patch('os.path.exists') as exists, patch('readthedocs.doc_builder.python_environments.open', mock_open(read_data=env_json_data)) as _open:  # noqa
+            exists.return_value = True
+            self.assertTrue(python_env.is_obsolete)
+
+    @pytest.mark.xfail(reason='build.image is not being considered yet')
+    def test_is_obsolete_with_json_different_build_image(self):
+        config_data = {
+            'build': {
+                'image': 'latest',
+            },
+            'python': {
+                'version': 2.7,
+            },
+        }
+        yaml_config = create_load(config_data)()[0]
+        config = ConfigWrapper(version=self.version, yaml_config=yaml_config)
+
+        python_env = Virtualenv(
+            version=self.version,
+            build_env=None,
+            config=config,
+        )
+        env_json_data = '{"build": {"image": "readthedocs/build:2.0"}, "python": {"version": 2.7}}'
+        with patch('os.path.exists') as exists, patch('readthedocs.doc_builder.python_environments.open', mock_open(read_data=env_json_data)) as _open:  # noqa
+            exists.return_value = True
+            self.assertTrue(python_env.is_obsolete)
+
+    def test_is_obsolete_with_json_same_data_as_version(self):
+        config_data = {
+            'build': {
+                'image': '2.0',
+            },
+            'python': {
+                'version': 3.5,
+            },
+        }
+        yaml_config = create_load(config_data)()[0]
+        config = ConfigWrapper(version=self.version, yaml_config=yaml_config)
+
+        python_env = Virtualenv(
+            version=self.version,
+            build_env=None,
+            config=config,
+        )
+        env_json_data = '{"build": {"image": "readthedocs/build:2.0"}, "python": {"version": 3.5}}'
+        with patch('os.path.exists') as exists, patch('readthedocs.doc_builder.python_environments.open', mock_open(read_data=env_json_data)) as _open:  # noqa
+            exists.return_value = True
+            self.assertFalse(python_env.is_obsolete)