def _verify_virtualenv_installer_instance_with(self, host_controller_class):
mock_host_controller = self.mox.CreateMock(host_controller_class)
mock_host_controller.feedback = self.mock_feedback
self.mox.ReplayAll()
virtualenv_installer_instance = VirtualEnvInstaller.create_with(self.virtualenv_installer_config,
mock_host_controller,
self.mock_file_system)
self.assertIsInstance(virtualenv_installer_instance, VirtualEnvInstaller)
def create_with(virtualenv_installer_config, host_controller):
file_system = FileSystem(host_controller)
permissions = AkvoPermissions(host_controller)
return VirtualEnvDeploymentHost(
virtualenv_installer_config, file_system,
DeploymentUserVerifier(permissions), permissions,
Internet(host_controller),
VirtualEnvInstaller.create_with(virtualenv_installer_config,
host_controller, file_system),
host_controller.feedback)
def create_with(virtualenv_installer_config, host_controller):
file_system = FileSystem(host_controller)
permissions = AkvoPermissions(host_controller)
return VirtualEnvDeploymentHost(virtualenv_installer_config,
file_system,
DeploymentUserVerifier(permissions),
permissions,
Internet(host_controller),
VirtualEnvInstaller.create_with(virtualenv_installer_config, host_controller, file_system),
host_controller.feedback)
def _verify_virtualenv_installer_instance_with(self,
host_controller_class):
mock_host_controller = self.mox.CreateMock(host_controller_class)
mock_host_controller.feedback = self.mock_feedback
self.mox.ReplayAll()
virtualenv_installer_instance = VirtualEnvInstaller.create_with(
self.virtualenv_installer_config, mock_host_controller,
self.mock_file_system)
self.assertIsInstance(virtualenv_installer_instance,
VirtualEnvInstaller)
def setUp(self):
super(VirtualEnvInstallerTest, self).setUp()
self.mock_host_controller = self.mox.CreateMock(RemoteHostController)
self.mock_file_system = self.mox.CreateMock(FileSystem)
self.mock_permissions = self.mox.CreateMock(AkvoPermissions)
self.mock_internet = self.mox.CreateMock(Internet)
self.mock_virtualenv = self.mox.CreateMock(VirtualEnv)
self.mock_feedback = self.mox.CreateMock(ExecutionFeedback)
self.mock_time_stamp_formatter = self.mox.CreateMock(
TimeStampFormatter)
self.virtualenv_installer_config = RSRVirtualEnvInstallerConfig.create_with(
CIDeploymentHostConfig.for_test(), "deployment_user")
self.pip_requirements_url = "http://some/path/to/pip_requirements.txt"
self.mock_host_controller.feedback = self.mock_feedback
self.virtualenv_installer = VirtualEnvInstaller(
self.virtualenv_installer_config, self.mock_host_controller,
self.mock_file_system, self.mock_permissions, self.mock_internet,
self.mock_virtualenv, self.mock_time_stamp_formatter)
def setUp(self):
super(VirtualEnvInstallerTest, self).setUp()
self.mock_host_controller = self.mox.CreateMock(RemoteHostController)
self.mock_file_system = self.mox.CreateMock(FileSystem)
self.mock_permissions = self.mox.CreateMock(AkvoPermissions)
self.mock_internet = self.mox.CreateMock(Internet)
self.mock_virtualenv = self.mox.CreateMock(VirtualEnv)
self.mock_feedback = self.mox.CreateMock(ExecutionFeedback)
self.mock_time_stamp_formatter = self.mox.CreateMock(TimeStampFormatter)
self.virtualenv_installer_config = RSRVirtualEnvInstallerConfig.create_with(CIDeploymentHostConfig.for_test(), "deployment_user")
self.pip_requirements_url = "http://some/path/to/pip_requirements.txt"
self.mock_host_controller.feedback = self.mock_feedback
self.virtualenv_installer = VirtualEnvInstaller(self.virtualenv_installer_config, self.mock_host_controller,
self.mock_file_system, self.mock_permissions, self.mock_internet,
self.mock_virtualenv, self.mock_time_stamp_formatter)
class VirtualEnvInstallerTest(mox.MoxTestBase):
def setUp(self):
super(VirtualEnvInstallerTest, self).setUp()
self.mock_host_controller = self.mox.CreateMock(RemoteHostController)
self.mock_file_system = self.mox.CreateMock(FileSystem)
self.mock_permissions = self.mox.CreateMock(AkvoPermissions)
self.mock_internet = self.mox.CreateMock(Internet)
self.mock_virtualenv = self.mox.CreateMock(VirtualEnv)
self.mock_feedback = self.mox.CreateMock(ExecutionFeedback)
self.mock_time_stamp_formatter = self.mox.CreateMock(TimeStampFormatter)
self.virtualenv_installer_config = RSRVirtualEnvInstallerConfig.create_with(CIDeploymentHostConfig.for_test(), "deployment_user")
self.pip_requirements_url = "http://some/path/to/pip_requirements.txt"
self.mock_host_controller.feedback = self.mock_feedback
self.virtualenv_installer = VirtualEnvInstaller(self.virtualenv_installer_config, self.mock_host_controller,
self.mock_file_system, self.mock_permissions, self.mock_internet,
self.mock_virtualenv, self.mock_time_stamp_formatter)
def test_can_create_instance_for_local_host(self):
"""fab.tests.environment.python.virtualenv_installer_test Can create VirtualEnvInstaller instance for a local host"""
self._verify_virtualenv_installer_instance_with(LocalHostController)
def test_can_create_instance_for_remote_host(self):
"""fab.tests.environment.python.virtualenv_installer_test Can create VirtualEnvInstaller instance for a remote host"""
self._verify_virtualenv_installer_instance_with(RemoteHostController)
def _verify_virtualenv_installer_instance_with(self, host_controller_class):
mock_host_controller = self.mox.CreateMock(host_controller_class)
mock_host_controller.feedback = self.mock_feedback
self.mox.ReplayAll()
virtualenv_installer_instance = VirtualEnvInstaller.create_with(self.virtualenv_installer_config,
mock_host_controller,
self.mock_file_system)
self.assertIsInstance(virtualenv_installer_instance, VirtualEnvInstaller)
def test_can_check_for_virtualenv_existence(self):
"""fab.tests.environment.python.virtualenv_installer_test Can check for virtualenv existence"""
self.mock_file_system.directory_exists(self.virtualenv_installer_config.rsr_env_path).AndReturn(True)
self.mox.ReplayAll()
self.assertTrue(self.virtualenv_installer.virtualenv_exists(), "Virtualenv should exist")
def test_can_delete_existing_virtualenv(self):
"""fab.tests.environment.python.virtualenv_installer_test Can delete existing virtualenv"""
self.mock_file_system.directory_exists(self.virtualenv_installer_config.rsr_env_path).AndReturn(True)
self._set_expectations_to_delete_virtualenv()
self.mox.ReplayAll()
self.virtualenv_installer.delete_existing_virtualenv()
def test_does_nothing_when_attempting_to_delete_nonexistent_virtualenv(self):
"""fab.tests.environment.python.virtualenv_installer_test Does nothing when attempting to delete a nonexistent virtualenv"""
self.mock_file_system.directory_exists(self.virtualenv_installer_config.rsr_env_path).AndReturn(False)
self.mox.ReplayAll()
self.virtualenv_installer.delete_existing_virtualenv()
def test_can_create_empty_virtualenv(self):
"""fab.tests.environment.python.virtualenv_installer_test Can create empty virtualenv"""
self._set_expectations_to_create_empty_virtualenv(existing_virtualenv=False)
self.virtualenv_installer.create_empty_virtualenv()
def test_will_delete_existing_virtualenv_when_creating_an_empty_virtualenv(self):
"""fab.tests.environment.python.virtualenv_installer_test Will delete existing virtualenv when creating an empty virtualenv"""
self._set_expectations_to_create_empty_virtualenv(existing_virtualenv=True)
self.virtualenv_installer.create_empty_virtualenv()
def test_can_ensure_virtualenv_exists_and_create_empty_virtualenv_if_none_exists(self):
"""fab.tests.environment.python.virtualenv_installer_test Can ensure virtualenv exists and create an empty virtualenv if none exists"""
self._set_expectations_to_create_empty_virtualenv(existing_virtualenv=False)
self.virtualenv_installer.ensure_virtualenv_exists()
def _set_expectations_to_create_empty_virtualenv(self, existing_virtualenv):
if existing_virtualenv:
self.mock_file_system.directory_exists(self.virtualenv_installer_config.rsr_env_path).MultipleTimes().AndReturn(True)
self._set_expectations_to_delete_virtualenv()
else:
self.mock_file_system.directory_exists(self.virtualenv_installer_config.rsr_env_path).MultipleTimes().AndReturn(False)
expected_virtualenv_creation_command = "virtualenv --distribute %s" % self.virtualenv_installer_config.rsr_env_path
self.mock_feedback.comment("Creating new virtualenv at %s" % self.virtualenv_installer_config.rsr_env_path)
self.mock_host_controller.run(expected_virtualenv_creation_command)
self.mock_virtualenv.list_installed_packages()
self.mox.ReplayAll()
def _set_expectations_to_delete_virtualenv(self):
self.mock_feedback.comment("Deleting existing virtualenv")
self.mock_file_system.delete_directory_with_sudo(self.virtualenv_installer_config.rsr_env_path)
def test_can_ensure_virtualenv_exists_and_confirm_an_existing_virtualenv(self):
"""fab.tests.environment.python.virtualenv_installer_test Can ensure virtualenv exists and confirm an existing virtualenv"""
self.mock_file_system.directory_exists(self.virtualenv_installer_config.rsr_env_path).AndReturn(True)
self.mock_feedback.comment("Found existing virtualenv at %s" % self.virtualenv_installer_config.rsr_env_path)
self.mock_virtualenv.list_installed_packages()
self.mox.ReplayAll()
self.virtualenv_installer.ensure_virtualenv_exists()
def test_can_remove_previously_downloaded_package_sources(self):
"""fab.tests.environment.python.virtualenv_installer_test Can remove previously downloaded package source files"""
python_package_sources_directory = os.path.join(self.virtualenv_installer_config.rsr_env_path, "src")
self.mock_file_system.directory_exists(python_package_sources_directory).AndReturn(True)
self.mock_feedback.comment("Removing previously downloaded Python package source files")
self.mock_file_system.delete_directory_with_sudo(python_package_sources_directory)
self.mox.ReplayAll()
self.virtualenv_installer.remove_previously_downloaded_package_sources()
def test_can_install_packages_from_given_pip_requirements_url(self):
"""fab.tests.environment.python.virtualenv_installer_test Can install packages from given pip requirements URL"""
self._clear_package_download_directory()
self._install_packages(quietly=False)
self.mox.ReplayAll()
self.virtualenv_installer.install_packages(self.pip_requirements_url)
def test_can_install_packages_quietly_from_given_pip_requirements_url(self):
"""fab.tests.environment.python.virtualenv_installer_test Can install packages quietly from given pip requirements URL"""
self._clear_package_download_directory()
self._install_packages(quietly=True)
self.mox.ReplayAll()
self.virtualenv_installer.install_packages(self.pip_requirements_url, quietly=True)
def _clear_package_download_directory(self):
self.mock_file_system.delete_directory_with_sudo(self.virtualenv_installer_config.package_download_dir)
self.mock_file_system.ensure_directory_exists_with_sudo(self.virtualenv_installer_config.package_download_dir)
self.mock_permissions.set_web_group_permissions_on_directory(self.virtualenv_installer_config.package_download_dir)
def _install_packages(self, quietly):
time_stamped_rsr_env_name = "%s_some_time_stamp" % self.virtualenv_installer_config.rsr_env_name
self.mock_feedback.comment("Installing packages in virtualenv at %s" % self.virtualenv_installer_config.rsr_env_path)
self.mock_internet.download_file_to_directory(self.virtualenv_installer_config.package_download_dir, self.pip_requirements_url)
self.mock_time_stamp_formatter.append_timestamp(self.virtualenv_installer_config.rsr_env_name).AndReturn(time_stamped_rsr_env_name)
self.mock_virtualenv.run_within_virtualenv(self._expected_pip_install_command(quietly, time_stamped_rsr_env_name))
self.mock_virtualenv.list_installed_packages()
def _expected_pip_install_command(self, quietly, time_stamped_rsr_env_name):
return "pip install %s-M -r %s --log=%s" % ("-q " if quietly else "",
self._expected_pip_requirements_file_path(),
self._expected_pip_log_file_path(time_stamped_rsr_env_name))
def _expected_pip_requirements_file_path(self):
pip_requirements_file = self.pip_requirements_url.split('/')[-1]
return os.path.join(self.virtualenv_installer_config.package_download_dir, pip_requirements_file)
def _expected_pip_log_file_path(self, time_stamped_rsr_env_name):
pip_log_file_name = "pip_install_%s.log" % time_stamped_rsr_env_name
return os.path.join(self.virtualenv_installer_config.virtualenvs_home, pip_log_file_name)
def test_can_ensure_virtualenv_symlinks_exist(self):
"""fab.tests.environment.python.virtualenv_installer_test Can ensure virtualenv symlinks exist"""
self._change_dir_to(self.virtualenv_installer_config.virtualenvs_home)
self.mock_file_system.ensure_symlink_exists("current", self.virtualenv_installer_config.rsr_env_name, with_sudo=True)
self.mox.ReplayAll()
self.virtualenv_installer.ensure_virtualenv_symlinks_exist()
def _change_dir_to(self, expected_dir):
self.mock_host_controller.cd(expected_dir).AndReturn(fabric.api.cd(expected_dir))
class VirtualEnvInstallerTest(mox.MoxTestBase):
def setUp(self):
super(VirtualEnvInstallerTest, self).setUp()
self.mock_host_controller = self.mox.CreateMock(RemoteHostController)
self.mock_file_system = self.mox.CreateMock(FileSystem)
self.mock_permissions = self.mox.CreateMock(AkvoPermissions)
self.mock_internet = self.mox.CreateMock(Internet)
self.mock_virtualenv = self.mox.CreateMock(VirtualEnv)
self.mock_feedback = self.mox.CreateMock(ExecutionFeedback)
self.mock_time_stamp_formatter = self.mox.CreateMock(
TimeStampFormatter)
self.virtualenv_installer_config = RSRVirtualEnvInstallerConfig.create_with(
CIDeploymentHostConfig.for_test(), "deployment_user")
self.pip_requirements_url = "http://some/path/to/pip_requirements.txt"
self.mock_host_controller.feedback = self.mock_feedback
self.virtualenv_installer = VirtualEnvInstaller(
self.virtualenv_installer_config, self.mock_host_controller,
self.mock_file_system, self.mock_permissions, self.mock_internet,
self.mock_virtualenv, self.mock_time_stamp_formatter)
def test_can_create_instance_for_local_host(self):
"""fab.tests.environment.python.virtualenv_installer_test Can create VirtualEnvInstaller instance for a local host"""
self._verify_virtualenv_installer_instance_with(LocalHostController)
def test_can_create_instance_for_remote_host(self):
"""fab.tests.environment.python.virtualenv_installer_test Can create VirtualEnvInstaller instance for a remote host"""
self._verify_virtualenv_installer_instance_with(RemoteHostController)
def _verify_virtualenv_installer_instance_with(self,
host_controller_class):
mock_host_controller = self.mox.CreateMock(host_controller_class)
mock_host_controller.feedback = self.mock_feedback
self.mox.ReplayAll()
virtualenv_installer_instance = VirtualEnvInstaller.create_with(
self.virtualenv_installer_config, mock_host_controller,
self.mock_file_system)
self.assertIsInstance(virtualenv_installer_instance,
VirtualEnvInstaller)
def test_can_check_for_virtualenv_existence(self):
"""fab.tests.environment.python.virtualenv_installer_test Can check for virtualenv existence"""
self.mock_file_system.directory_exists(
self.virtualenv_installer_config.rsr_env_path).AndReturn(True)
self.mox.ReplayAll()
self.assertTrue(self.virtualenv_installer.virtualenv_exists(),
"Virtualenv should exist")
def test_can_delete_existing_virtualenv(self):
"""fab.tests.environment.python.virtualenv_installer_test Can delete existing virtualenv"""
self.mock_file_system.directory_exists(
self.virtualenv_installer_config.rsr_env_path).AndReturn(True)
self._set_expectations_to_delete_virtualenv()
self.mox.ReplayAll()
self.virtualenv_installer.delete_existing_virtualenv()
def test_does_nothing_when_attempting_to_delete_nonexistent_virtualenv(
self):
"""fab.tests.environment.python.virtualenv_installer_test Does nothing when attempting to delete a nonexistent virtualenv"""
self.mock_file_system.directory_exists(
self.virtualenv_installer_config.rsr_env_path).AndReturn(False)
self.mox.ReplayAll()
self.virtualenv_installer.delete_existing_virtualenv()
def test_can_create_empty_virtualenv(self):
"""fab.tests.environment.python.virtualenv_installer_test Can create empty virtualenv"""
self._set_expectations_to_create_empty_virtualenv(
existing_virtualenv=False)
self.virtualenv_installer.create_empty_virtualenv()
def test_will_delete_existing_virtualenv_when_creating_an_empty_virtualenv(
self):
"""fab.tests.environment.python.virtualenv_installer_test Will delete existing virtualenv when creating an empty virtualenv"""
self._set_expectations_to_create_empty_virtualenv(
existing_virtualenv=True)
self.virtualenv_installer.create_empty_virtualenv()
def test_can_ensure_virtualenv_exists_and_create_empty_virtualenv_if_none_exists(
self):
"""fab.tests.environment.python.virtualenv_installer_test Can ensure virtualenv exists and create an empty virtualenv if none exists"""
self._set_expectations_to_create_empty_virtualenv(
existing_virtualenv=False)
self.virtualenv_installer.ensure_virtualenv_exists()
def _set_expectations_to_create_empty_virtualenv(self,
existing_virtualenv):
if existing_virtualenv:
self.mock_file_system.directory_exists(
self.virtualenv_installer_config.rsr_env_path).MultipleTimes(
).AndReturn(True)
self._set_expectations_to_delete_virtualenv()
else:
self.mock_file_system.directory_exists(
self.virtualenv_installer_config.rsr_env_path).MultipleTimes(
).AndReturn(False)
expected_virtualenv_creation_command = "virtualenv --distribute %s" % self.virtualenv_installer_config.rsr_env_path
self.mock_feedback.comment(
"Creating new virtualenv at %s" %
self.virtualenv_installer_config.rsr_env_path)
self.mock_host_controller.run(expected_virtualenv_creation_command)
self.mock_virtualenv.list_installed_packages()
self.mox.ReplayAll()
def _set_expectations_to_delete_virtualenv(self):
self.mock_feedback.comment("Deleting existing virtualenv")
self.mock_file_system.delete_directory_with_sudo(
self.virtualenv_installer_config.rsr_env_path)
def test_can_ensure_virtualenv_exists_and_confirm_an_existing_virtualenv(
self):
"""fab.tests.environment.python.virtualenv_installer_test Can ensure virtualenv exists and confirm an existing virtualenv"""
self.mock_file_system.directory_exists(
self.virtualenv_installer_config.rsr_env_path).AndReturn(True)
self.mock_feedback.comment(
"Found existing virtualenv at %s" %
self.virtualenv_installer_config.rsr_env_path)
self.mock_virtualenv.list_installed_packages()
self.mox.ReplayAll()
self.virtualenv_installer.ensure_virtualenv_exists()
def test_can_remove_previously_downloaded_package_sources(self):
"""fab.tests.environment.python.virtualenv_installer_test Can remove previously downloaded package source files"""
python_package_sources_directory = os.path.join(
self.virtualenv_installer_config.rsr_env_path, "src")
self.mock_file_system.directory_exists(
python_package_sources_directory).AndReturn(True)
self.mock_feedback.comment(
"Removing previously downloaded Python package source files")
self.mock_file_system.delete_directory_with_sudo(
python_package_sources_directory)
self.mox.ReplayAll()
self.virtualenv_installer.remove_previously_downloaded_package_sources(
)
def test_can_install_packages_from_given_pip_requirements_url(self):
"""fab.tests.environment.python.virtualenv_installer_test Can install packages from given pip requirements URL"""
self._clear_package_download_directory()
self._install_packages(quietly=False)
self.mox.ReplayAll()
self.virtualenv_installer.install_packages(self.pip_requirements_url)
def test_can_install_packages_quietly_from_given_pip_requirements_url(
self):
"""fab.tests.environment.python.virtualenv_installer_test Can install packages quietly from given pip requirements URL"""
self._clear_package_download_directory()
self._install_packages(quietly=True)
self.mox.ReplayAll()
self.virtualenv_installer.install_packages(self.pip_requirements_url,
quietly=True)
def _clear_package_download_directory(self):
self.mock_file_system.delete_directory_with_sudo(
self.virtualenv_installer_config.package_download_dir)
self.mock_file_system.ensure_directory_exists_with_sudo(
self.virtualenv_installer_config.package_download_dir)
self.mock_permissions.set_web_group_permissions_on_directory(
self.virtualenv_installer_config.package_download_dir)
def _install_packages(self, quietly):
time_stamped_rsr_env_name = "%s_some_time_stamp" % self.virtualenv_installer_config.rsr_env_name
self.mock_feedback.comment(
"Installing packages in virtualenv at %s" %
self.virtualenv_installer_config.rsr_env_path)
self.mock_internet.download_file_to_directory(
self.virtualenv_installer_config.package_download_dir,
self.pip_requirements_url)
self.mock_time_stamp_formatter.append_timestamp(
self.virtualenv_installer_config.rsr_env_name).AndReturn(
time_stamped_rsr_env_name)
self.mock_virtualenv.run_within_virtualenv(
self._expected_pip_install_command(quietly,
time_stamped_rsr_env_name))
self.mock_virtualenv.list_installed_packages()
def _expected_pip_install_command(self, quietly,
time_stamped_rsr_env_name):
return "pip install %s-M -r %s --log=%s" % (
"-q " if quietly else "",
self._expected_pip_requirements_file_path(),
self._expected_pip_log_file_path(time_stamped_rsr_env_name))
def _expected_pip_requirements_file_path(self):
pip_requirements_file = self.pip_requirements_url.split('/')[-1]
return os.path.join(
self.virtualenv_installer_config.package_download_dir,
pip_requirements_file)
def _expected_pip_log_file_path(self, time_stamped_rsr_env_name):
pip_log_file_name = "pip_install_%s.log" % time_stamped_rsr_env_name
return os.path.join(self.virtualenv_installer_config.virtualenvs_home,
pip_log_file_name)
def test_can_ensure_virtualenv_symlinks_exist(self):
"""fab.tests.environment.python.virtualenv_installer_test Can ensure virtualenv symlinks exist"""
self._change_dir_to(self.virtualenv_installer_config.virtualenvs_home)
self.mock_file_system.ensure_symlink_exists(
"current",
self.virtualenv_installer_config.rsr_env_name,
with_sudo=True)
self.mox.ReplayAll()
self.virtualenv_installer.ensure_virtualenv_symlinks_exist()
def _change_dir_to(self, expected_dir):
self.mock_host_controller.cd(expected_dir).AndReturn(
fabric.api.cd(expected_dir))
