generate_requirements_test.py 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. #!/usr/bin/env python
  2. # Licensed to Cloudera, Inc. under one
  3. # or more contributor license agreements. See the NOTICE file
  4. # distributed with this work for additional information
  5. # regarding copyright ownership. Cloudera, Inc. licenses this file
  6. # to you under the Apache License, Version 2.0 (the
  7. # "License"); you may not use this file except in compliance
  8. # with the License. You may obtain a copy of the License at
  9. #
  10. # http://www.apache.org/licenses/LICENSE-2.0
  11. #
  12. # Unless required by applicable law or agreed to in writing, software
  13. # distributed under the License is distributed on an "AS IS" BASIS,
  14. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. # See the License for the specific language governing permissions and
  16. # limitations under the License.
  17. import os
  18. import platform
  19. import shutil
  20. import sys
  21. import tempfile
  22. from unittest import mock
  23. import pytest
  24. # Workaround for import error: add current directory to Python path
  25. # The package-style import (desktop.core.generate_requirements) fails,
  26. # so we modify the path to enable direct module import
  27. sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
  28. from generate_requirements import RequirementsGenerator
  29. class TestRequirementsGenerator:
  30. """Test cases for the RequirementsGenerator class."""
  31. def setup_method(self):
  32. """
  33. Setup test environment with temporary directory and mock requirement files.
  34. Stores original system values to restore after test.
  35. """
  36. # Store original system values to restore later
  37. self.original_arch = platform.machine
  38. self.original_version_info = sys.version_info
  39. self.temp_dir = tempfile.mkdtemp()
  40. # Create a temporary ext-py3 directory mimicking the structure used by RequirementsGenerator
  41. self.ext_py3_dir = os.path.join(self.temp_dir, "ext-py3")
  42. os.makedirs(self.ext_py3_dir)
  43. # Create empty placeholder files that simulate local requirement packages
  44. for req in ["boto-2.49.0", "django-axes-5.13.0", "django-babel", "pysaml2-7.3.1", "python-sasl-0.3.1"]:
  45. with open(os.path.join(self.ext_py3_dir, req), "w") as f:
  46. f.write("")
  47. def teardown_method(self):
  48. """Teardown after each test method."""
  49. shutil.rmtree(self.temp_dir)
  50. platform.machine = self.original_arch
  51. sys.version_info = self.original_version_info
  52. @mock.patch("generate_requirements.this_dir")
  53. @mock.patch("generate_requirements.platform.machine")
  54. @mock.patch("generate_requirements.sys.version_info")
  55. def test_init_sets_properties(self, mock_version_info, mock_machine, mock_this_dir):
  56. """Test that __init__ sets the class properties correctly."""
  57. mock_machine.return_value = "x86_64"
  58. mock_version_info.major = 3
  59. mock_version_info.minor = 9
  60. mock_this_dir.return_value = self.temp_dir
  61. generator = RequirementsGenerator()
  62. assert generator.arch == "x86_64"
  63. assert generator.python_version_string == "3.9"
  64. assert isinstance(generator.requirements, list)
  65. assert isinstance(generator.local_requirements, list)
  66. assert "x86_64" in generator.arch_requirements_map
  67. assert "aarch64" in generator.arch_requirements_map
  68. @mock.patch("generate_requirements.this_dir", create=True)
  69. @mock.patch("generate_requirements.shutil.copytree")
  70. def test_copy_local_requirements(self, mock_copytree, mock_this_dir):
  71. """Test that copy_local_requirements copies files and returns correct paths."""
  72. # Need to make this_dir return the string value directly, not a MagicMock
  73. mock_this_dir.__str__.return_value = self.temp_dir
  74. python_version_string = "3.9"
  75. with mock.patch.object(RequirementsGenerator, "__init__", return_value=None):
  76. generator = RequirementsGenerator()
  77. generator.local_requirements = ["boto-2.49.0", "django-axes-5.13.0"]
  78. result = generator.copy_local_requirements(python_version_string)
  79. mock_copytree.assert_called_once_with(f"{self.temp_dir}/ext-py3", f"{self.temp_dir}/{python_version_string}")
  80. assert len(result) == 2
  81. assert f"file://{self.temp_dir}/{python_version_string}/boto-2.49.0" in result
  82. assert f"file://{self.temp_dir}/{python_version_string}/django-axes-5.13.0" in result
  83. @mock.patch("generate_requirements.this_dir")
  84. @mock.patch("builtins.open", new_callable=mock.mock_open)
  85. def test_generate_requirements_x86_64(self, mock_open, mock_this_dir):
  86. """Test generating requirements for x86_64 architecture."""
  87. # Need to make this_dir return the string value directly, not a MagicMock
  88. mock_this_dir.__str__.return_value = self.temp_dir
  89. with mock.patch.object(RequirementsGenerator, "__init__", return_value=None):
  90. generator = RequirementsGenerator()
  91. generator.arch = "x86_64"
  92. generator.python_version_string = "3.9"
  93. generator.requirements = ["Django==4.1.13"]
  94. generator.local_requirements = []
  95. generator.arch_requirements_map = {
  96. "x86_64": {"default": ["cryptography==42.0.8"], "3.9": ["Markdown==3.8", "numpy==1.24.4", "setuptools==80.9.0"]}
  97. }
  98. # Mock copy_local_requirements for test isolation
  99. generator.copy_local_requirements = mock.MagicMock(return_value=[])
  100. generator.generate_requirements()
  101. # Verify file creation with correct path
  102. mock_open.assert_called_once_with(f"{self.temp_dir}/requirements-x86_64-3.9.txt", "w")
  103. # Verify correct requirements were written
  104. expected_requirements = "\n".join(["Django==4.1.13", "Markdown==3.8", "numpy==1.24.4", "setuptools==80.9.0"])
  105. mock_open().write.assert_called_once_with(expected_requirements)
  106. @mock.patch("generate_requirements.this_dir")
  107. def test_generate_requirements_unsupported_arch(self, mock_this_dir):
  108. """Test that generate_requirements raises an error for unsupported architectures."""
  109. # Need to make this_dir return the string value directly, not a MagicMock
  110. mock_this_dir.__str__.return_value = self.temp_dir
  111. with mock.patch.object(RequirementsGenerator, "__init__", return_value=None):
  112. generator = RequirementsGenerator()
  113. generator.arch = "unsupported_arch"
  114. generator.python_version_string = "3.9"
  115. generator.requirements = []
  116. generator.arch_requirements_map = {"x86_64": {"default": []}, "aarch64": {"default": []}}
  117. with pytest.raises(ValueError) as exc_info:
  118. generator.generate_requirements()
  119. assert "Unsupported architecture: unsupported_arch" in str(exc_info.value)
  120. @mock.patch("generate_requirements.this_dir")
  121. def test_get_file_name(self, mock_this_dir):
  122. """Test that get_file_name returns the correct file path."""
  123. # Need to make this_dir return the string value directly, not a MagicMock
  124. mock_this_dir.__str__.return_value = self.temp_dir
  125. with mock.patch.object(RequirementsGenerator, "__init__", return_value=None):
  126. generator = RequirementsGenerator()
  127. generator.arch = "x86_64"
  128. generator.python_version_string = "3.9"
  129. result = generator.get_file_name()
  130. assert result == f"{self.temp_dir}/requirements-x86_64-3.9.txt"
  131. @mock.patch("generate_requirements.this_dir")
  132. @mock.patch("builtins.open", new_callable=mock.mock_open)
  133. def test_generate_requirements_with_local_requirements(self, mock_open, mock_this_dir):
  134. """Test generating requirements including local requirements."""
  135. # Need to make this_dir return the string value directly, not a MagicMock
  136. mock_this_dir.__str__.return_value = self.temp_dir
  137. with mock.patch.object(RequirementsGenerator, "__init__", return_value=None):
  138. generator = RequirementsGenerator()
  139. generator.arch = "x86_64"
  140. generator.python_version_string = "3.9"
  141. generator.requirements = []
  142. generator.local_requirements = ["boto-2.49.0", "django-axes-5.13.0"]
  143. generator.arch_requirements_map = {"x86_64": {"default": [], "3.9": ["Markdown==3.8", "setuptools==80.9.0"]}}
  144. # Mock copy_local_requirements to return file paths
  145. local_reqs = [f"file://{self.temp_dir}/3.9/boto-2.49.0", f"file://{self.temp_dir}/3.9/django-axes-5.13.0"]
  146. generator.copy_local_requirements = mock.MagicMock(return_value=local_reqs)
  147. generator.generate_requirements()
  148. mock_open.assert_called_once_with(f"{self.temp_dir}/requirements-x86_64-3.9.txt", "w")
  149. expected_requirements = "\n".join(
  150. ["Markdown==3.8", "setuptools==80.9.0", f"file://{self.temp_dir}/3.9/boto-2.49.0", f"file://{self.temp_dir}/3.9/django-axes-5.13.0"]
  151. )
  152. mock_open().write.assert_called_once_with(expected_requirements)