File: test_parse_functionality.py

package info (click to toggle)
python-azure 20251202%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 786,344 kB
  • sloc: python: 6,510,493; ansic: 804; javascript: 287; sh: 204; makefile: 198; xml: 109
file content (335 lines) | stat: -rw-r--r-- 12,843 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
from ci_tools.parsing import parse_require, ParsedSetup
from packaging.specifiers import SpecifierSet
import os
from unittest.mock import patch

import pytest

package_root = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
test_folder = os.path.join(
    os.path.dirname(__file__),
)
scenarios_folder = os.path.join(os.path.dirname(__file__), "integration", "scenarios")
metapackage_scenario = os.path.join(scenarios_folder, "setup_py_metapackage")
setup_project_scenario = os.path.join(scenarios_folder, "setup_py_project_def")
pyproject_scenario = os.path.join(scenarios_folder, "pyproject_project_def")
pyproject_extension_scenario = os.path.join(scenarios_folder, "pyproject_project_def_with_extension")


def test_parse_require():
    test_scenarios = [
        ("ConfigArgParse>=0.12.0", "ConfigArgParse", ">=0.12.0"),
        ("msrest>=0.6.10", "msrest", ">=0.6.10"),
        ("azure-core<2.0.0,>=1.2.2", "azure-core", "<2.0.0,>=1.2.2"),
        ("msrest==0.6.10", "msrest", "==0.6.10"),
        ("msrest<0.6.10", "msrest", "<0.6.10"),
        ("msrest>0.6.9", "msrest", ">0.6.9"),
        ("azure-core<2.0.0,>=1.2.2", "azure-core", "<2.0.0,>=1.2.2"),
        ("azure-core[aio]<2.0.0,>=1.26.0", "azure-core", "<2.0.0,>=1.26.0"),
        ("azure-core[aio,cool_extra]<2.0.0,>=1.26.0", "azure-core", "<2.0.0,>=1.26.0"),
        ("azure-core[]", "azure-core", None),
    ]

    for scenario in test_scenarios:
        result = parse_require(scenario[0])
        assert result.name is not None
        if scenario[2] is not None:
            assert len(result.specifier) != 0
        assert result.name == scenario[1]
        assert str(result.specifier) == (scenario[2] or "")


def test_parse_require_with_no_spec():
    spec_scenarios = ["readme_renderer"]

    for scenario in spec_scenarios:
        result = parse_require(scenario)

        assert result.name == scenario
        assert len(result.specifier) == 0


@patch("ci_tools.parsing.parse_functions.read_setup_py_content")
def test_sdk_sample_setup(test_patch):
    test_patch.return_value = """
import re
import os.path
from io import open
from setuptools import find_packages, setup  # type: ignore

# Change the PACKAGE_NAME only to change folder and different name
PACKAGE_NAME = "azure-core"
PACKAGE_PPRINT_NAME = "Core"

# a-b-c => a/b/c
package_folder_path = PACKAGE_NAME.replace('-', '/')
# a-b-c => a.b.c
namespace_name = PACKAGE_NAME.replace('-', '.')

version = "1.21.0"
readme = "a buncha readme content"
changelog = "some other readme content"

setup(
    name=PACKAGE_NAME,
    version=version,
    include_package_data=True,
    description='Microsoft Azure {} Library for Python'.format(PACKAGE_PPRINT_NAME),
    long_description=readme + changelog,
    long_description_content_type='text/markdown',
    license='MIT License',
    author='Microsoft Corporation',
    author_email='azpysdkhelp@microsoft.com',
    url='https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core',
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        'Programming Language :: Python',
        "Programming Language :: Python :: 3 :: Only",
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
        'Programming Language :: Python :: 3.10',
        'License :: OSI Approved :: MIT License',
    ],
    zip_safe=False,
    packages=find_packages(exclude=[
        'tests',
        # Exclude packages that will be covered by PEP420 or nspkg
        'azure',
    ]),
    package_data={
        'pytyped': ['py.typed'],
    },
    python_requires=">=3.7",
    keywords=["azure sdk", "hello world"],
    install_requires=[
        'requests>=2.18.4',
        'six>=1.11.0',
        "typing-extensions>=4.0.1",
    ],
)
    """

    result = ParsedSetup.from_path(setup_project_scenario)

    assert result.name == "azure-core"
    assert result.version == "1.21.0"
    assert result.python_requires == ">=3.7"
    assert result.requires == ["requests>=2.18.4", "six>=1.11.0", "typing-extensions>=4.0.1"]
    assert result.is_new_sdk == True
    assert result.setup_filename == os.path.join(setup_project_scenario, "setup.py")
    assert "pytyped" in result.package_data
    assert result.include_package_data == True
    assert result.folder == setup_project_scenario
    assert len(result.classifiers) > 0
    assert result.classifiers[0] == "Development Status :: 5 - Production/Stable"
    assert result.classifiers[5] == "Programming Language :: Python :: 3.8"
    assert result.keywords[0] == "azure sdk"
    assert len(result.keywords) == 2


@patch("ci_tools.parsing.parse_functions.read_setup_py_content")
def test_parse_recognizes_extensions(test_patch):
    test_patch.return_value = """
import re
import os.path
from io import open
import glob
from setuptools import find_packages, setup, Extension  # type: ignore
# Change the PACKAGE_NAME only to change folder and different name
PACKAGE_NAME = "azure-storage-extensions"
PACKAGE_PPRINT_NAME = "Storage Extensions"
# a-b-c => a/b/c
package_folder_path = PACKAGE_NAME.replace('-', '/')
# a-b-c => a.b.c
namespace_name = PACKAGE_NAME.replace('-', '.')
version = "1.21.0"
readme = "a buncha readme content"
changelog = "some other readme content"
setup(
    name=PACKAGE_NAME,
    version=version,
    include_package_data=True,
    description='Microsoft Azure {} Library for Python'.format(PACKAGE_PPRINT_NAME),
    long_description=readme + changelog,
    long_description_content_type='text/markdown',
    license='MIT License',
    author='Microsoft Corporation',
    author_email='azpysdkhelp@microsoft.com',
    url='https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core',
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        'Programming Language :: Python',
        "Programming Language :: Python :: 3 :: Only",
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
        'Programming Language :: Python :: 3.10',
        'License :: OSI Approved :: MIT License',
    ],
    zip_safe=False,
    packages=find_packages(exclude=[
        'tests',
        # Exclude packages that will be covered by PEP420 or nspkg
        'azure',
    ]),
    ext_package='azure.storage.extensions',
    ext_modules=[
        Extension('crc64', glob.glob(os.path.join(package_folder_path, 'crc64', '*.c')))
    ],
    package_data={
        'pytyped': ['py.typed'],
    },
    python_requires=">=3.7",
    install_requires=[
        'requests>=2.18.4',
        'six>=1.11.0',
        "typing-extensions>=4.0.1",
    ],
)
    """

    result = ParsedSetup.from_path(setup_project_scenario)

    assert result.name == "azure-storage-extensions"
    assert result.version == "1.21.0"
    assert result.python_requires == ">=3.7"
    assert result.requires == ["requests>=2.18.4", "six>=1.11.0", "typing-extensions>=4.0.1"]
    # todo resolve this conflict assert result.is_new_sdk == True
    assert result.setup_filename == os.path.join(setup_project_scenario, "setup.py")
    assert "pytyped" in result.package_data
    assert result.include_package_data == True
    assert result.folder == setup_project_scenario
    assert len(result.classifiers) > 0
    assert result.classifiers[0] == "Development Status :: 5 - Production/Stable"
    assert result.classifiers[5] == "Programming Language :: Python :: 3.8"
    assert result.ext_package == "azure.storage.extensions"
    assert result.ext_modules is not None
    assert result.is_pyproject == False
    assert len(result.ext_modules) == 1
    assert str(type(result.ext_modules[0])) == "<class 'setuptools.extension.Extension'>"


def test_metapackage_detection():
    parsed_project = ParsedSetup.from_path(metapackage_scenario)
    assert parsed_project.is_metapackage == True
    assert parsed_project.name == "azure-keyvault"


def test_parse_pyproject():
    # ensure that we can parse from a folder and a specific file
    parsed_project = ParsedSetup.from_path(pyproject_scenario)

    assert parsed_project.name == "azure-keyvault-keys"
    assert parsed_project.version == "0.0.1"
    assert parsed_project.requires == [
        "azure-common~=1.1",
        "azure-core<2.0.0,>=1.24.0",
        "cryptography>=2.1.4",
        "isodate>=0.6.1",
        "typing-extensions>=4.0.1",
    ]
    assert parsed_project.python_requires == ">=3.8"
    assert parsed_project.is_new_sdk == True
    assert parsed_project.is_pyproject == True
    assert parsed_project.package_data == {"py.typed": ["py.typed"]}
    assert parsed_project.include_package_data == True
    assert parsed_project.folder == pyproject_scenario
    assert parsed_project.is_metapackage == False
    assert parsed_project.namespace == "azure.keyvault.keys"


def test_parse_pyproject_extensions():
    # ensure that we can parse from a folder and a specific file
    parsed_project = ParsedSetup.from_path(pyproject_extension_scenario)

    assert parsed_project.name == "azure-keyvault-keys"
    assert parsed_project.version == "0.0.1b1"
    assert parsed_project.requires == [
        "azure-common~=1.1",
        "azure-core<2.0.0,>=1.24.0",
        "cryptography>=2.1.4",
        "isodate>=0.6.1",
        "typing-extensions>=4.0.1",
    ]
    assert parsed_project.python_requires == ">=3.8"
    assert parsed_project.is_new_sdk == True
    assert parsed_project.is_pyproject == True
    assert parsed_project.package_data == {"py.typed": ["py.typed"]}
    assert parsed_project.include_package_data == True
    assert parsed_project.folder == pyproject_extension_scenario
    assert parsed_project.namespace == "azure.keyvault.keys"
    assert parsed_project.ext_package == "azure.keyvault.keys"
    assert parsed_project.ext_modules is not None
    assert parsed_project.is_metapackage == False
    assert len(parsed_project.ext_modules) == 1
    assert str(type(parsed_project.ext_modules[0])) == "<class 'setuptools.extension.Extension'>"


def test_namespace_discovery_eventhub_checkpointstoreblob():
    """Test that namespace discovery works for azure-eventhub-checkpointstoreblob"""
    eventhub_path = os.path.join(
        os.path.dirname(__file__), "..", "..", "..", "sdk", "eventhub", "azure-eventhub-checkpointstoreblob"
    )

    # Check if the path exists (it should in the Azure SDK repo)
    if os.path.exists(eventhub_path):
        parsed_project = ParsedSetup.from_path(eventhub_path)

        assert parsed_project.name == "azure-eventhub-checkpointstoreblob"
        assert parsed_project.namespace == "azure.eventhub.extensions.checkpointstoreblob"
    else:
        pytest.skip("azure-eventhub-checkpointstoreblob not found in repository")


def test_namespace_discovery_fallback():
    """Test that namespace discovery falls back to simple replacement when no packages found"""
    # This tests the fallback behavior when no actual package structure is found
    from ci_tools.parsing.parse_functions import discover_namespace

    # Test with non-existent path
    result = discover_namespace("/non/existent/path")
    assert result is None


def test_namespace_discovery_with_extension_only():
    """Test namespace discovery logic with extension-only __init__.py files"""
    from ci_tools.parsing.parse_functions import _set_root_namespace
    import tempfile
    import os

    # Create a temporary __init__.py file with only extension content
    with tempfile.NamedTemporaryFile(mode="w", suffix="__init__.py", delete=False) as f:
        f.write("# comment\n")
        f.write('__path__ = __import__("pkgutil").extend_path(__path__, __name__)\n')
        temp_file = f.name

    try:
        result = _set_root_namespace(temp_file, "test.module")
        # Should return None because it only contains extension logic
        assert result is None
    finally:
        os.unlink(temp_file)


def test_namespace_discovery_with_substantial_content():
    """Test namespace discovery logic with substantial __init__.py content"""
    from ci_tools.parsing.parse_functions import _set_root_namespace
    import tempfile
    import os

    # Create a temporary __init__.py file with substantial content
    with tempfile.NamedTemporaryFile(mode="w", suffix="__init__.py", delete=False) as f:
        f.write("# comment\n")
        f.write("from ._version import VERSION\n")
        f.write("__version__ = VERSION\n")
        temp_file = f.name

    try:
        result = _set_root_namespace(temp_file, "test.module")
        # Should return the module name because it contains substantial content
        assert result == "test.module"
    finally:
        os.unlink(temp_file)