Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: PURL for PyPI packages from 'conda list' have the correct format now #471

Merged
merged 1 commit into from
Dec 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions cyclonedx_py/utils/conda.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ def conda_package_to_purl(pkg: CondaPackage) -> PackageURL:
Return the purl for the specified package.
See https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst#conda
"""
if pkg['channel'] == 'pypi' and pkg['platform'] == 'pypi':
return _conda_package_to_pypi_purl(pkg)

qualifiers = {
'build': pkg['build_string'],
'channel': pkg['channel'],
Expand All @@ -67,6 +70,19 @@ def conda_package_to_purl(pkg: CondaPackage) -> PackageURL:
return purl


def _conda_package_to_pypi_purl(pkg: CondaPackage) -> PackageURL:
"""
jkowalleck marked this conversation as resolved.
Show resolved Hide resolved
Return the purl for a pip-installed package in a conda environment.
These packages are listed as if from the pseudo-channel "pypi".
See https://github.com/package-url/purl-spec/blob/master/PURL-TYPES.rst#pypi
"""
name = pkg['name'].lower().replace('_', '-')
purl = PackageURL(
type='pypi', name=name, version=pkg['version']
)
return purl


def parse_conda_json_to_conda_package(conda_json_str: str) -> Optional[CondaPackage]:
try:
package_data = json.loads(conda_json_str)
Expand Down
252 changes: 252 additions & 0 deletions tests/fixtures/conda-list-issue462.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
[
jkowalleck marked this conversation as resolved.
Show resolved Hide resolved
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "main",
"channel": "pkgs/main",
"dist_name": "_libgcc_mutex-0.1-main",
"name": "_libgcc_mutex",
"platform": "linux-64",
"version": "0.1"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "1_gnu",
"channel": "pkgs/main",
"dist_name": "_openmp_mutex-5.1-1_gnu",
"name": "_openmp_mutex",
"platform": "linux-64",
"version": "5.1"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h7b6447c_0",
"channel": "pkgs/main",
"dist_name": "bzip2-1.0.8-h7b6447c_0",
"name": "bzip2",
"platform": "linux-64",
"version": "1.0.8"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h06a4308_0",
"channel": "pkgs/main",
"dist_name": "ca-certificates-2022.10.11-h06a4308_0",
"name": "ca-certificates",
"platform": "linux-64",
"version": "2022.10.11"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "py310h06a4308_0",
"channel": "pkgs/main",
"dist_name": "certifi-2022.9.24-py310h06a4308_0",
"name": "certifi",
"platform": "linux-64",
"version": "2022.9.24"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 1,
"build_string": "h1181459_1",
"channel": "pkgs/main",
"dist_name": "ld_impl_linux-64-2.38-h1181459_1",
"name": "ld_impl_linux-64",
"platform": "linux-64",
"version": "2.38"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 6,
"build_string": "h6a678d5_6",
"channel": "pkgs/main",
"dist_name": "libffi-3.4.2-h6a678d5_6",
"name": "libffi",
"platform": "linux-64",
"version": "3.4.2"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 1,
"build_string": "h1234567_1",
"channel": "pkgs/main",
"dist_name": "libgcc-ng-11.2.0-h1234567_1",
"name": "libgcc-ng",
"platform": "linux-64",
"version": "11.2.0"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 1,
"build_string": "h1234567_1",
"channel": "pkgs/main",
"dist_name": "libgomp-11.2.0-h1234567_1",
"name": "libgomp",
"platform": "linux-64",
"version": "11.2.0"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 1,
"build_string": "h1234567_1",
"channel": "pkgs/main",
"dist_name": "libstdcxx-ng-11.2.0-h1234567_1",
"name": "libstdcxx-ng",
"platform": "linux-64",
"version": "11.2.0"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h5eee18b_0",
"channel": "pkgs/main",
"dist_name": "libuuid-1.41.5-h5eee18b_0",
"name": "libuuid",
"platform": "linux-64",
"version": "1.41.5"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 3,
"build_string": "h5eee18b_3",
"channel": "pkgs/main",
"dist_name": "ncurses-6.3-h5eee18b_3",
"name": "ncurses",
"platform": "linux-64",
"version": "6.3"
},
{
"base_url": "https://conda.anaconda.org/pypi",
"build_number": 0,
"build_string": "pypi_0",
"channel": "pypi",
"dist_name": "numpy-1.23.5-pypi_0",
"name": "numpy",
"platform": "pypi",
"version": "1.23.5"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h7f8727e_0",
"channel": "pkgs/main",
"dist_name": "openssl-1.1.1s-h7f8727e_0",
"name": "openssl",
"platform": "linux-64",
"version": "1.1.1s"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "py310h06a4308_0",
"channel": "pkgs/main",
"dist_name": "pip-22.3.1-py310h06a4308_0",
"name": "pip",
"platform": "linux-64",
"version": "22.3.1"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 1,
"build_string": "h7a1cb2a_1",
"channel": "pkgs/main",
"dist_name": "python-3.10.8-h7a1cb2a_1",
"name": "python",
"platform": "linux-64",
"version": "3.10.8"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h5eee18b_0",
"channel": "pkgs/main",
"dist_name": "readline-8.2-h5eee18b_0",
"name": "readline",
"platform": "linux-64",
"version": "8.2"
},
{
"base_url": "https://conda.anaconda.org/pypi",
"build_number": 0,
"build_string": "pypi_0",
"channel": "pypi",
"dist_name": "seawater-3.3.4-pypi_0",
"name": "seawater",
"platform": "pypi",
"version": "3.3.4"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "py310h06a4308_0",
"channel": "pkgs/main",
"dist_name": "setuptools-65.5.0-py310h06a4308_0",
"name": "setuptools",
"platform": "linux-64",
"version": "65.5.0"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h5082296_0",
"channel": "pkgs/main",
"dist_name": "sqlite-3.40.0-h5082296_0",
"name": "sqlite",
"platform": "linux-64",
"version": "3.40.0"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h1ccaba5_0",
"channel": "pkgs/main",
"dist_name": "tk-8.6.12-h1ccaba5_0",
"name": "tk",
"platform": "linux-64",
"version": "8.6.12"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h04d1e81_0",
"channel": "pkgs/main",
"dist_name": "tzdata-2022g-h04d1e81_0",
"name": "tzdata",
"platform": "noarch",
"version": "2022g"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "pyhd3eb1b0_0",
"channel": "pkgs/main",
"dist_name": "wheel-0.37.1-pyhd3eb1b0_0",
"name": "wheel",
"platform": "noarch",
"version": "0.37.1"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h5eee18b_0",
"channel": "pkgs/main",
"dist_name": "xz-5.2.8-h5eee18b_0",
"name": "xz",
"platform": "linux-64",
"version": "5.2.8"
},
{
"base_url": "https://repo.anaconda.com/pkgs/main",
"build_number": 0,
"build_string": "h5eee18b_0",
"channel": "pkgs/main",
"dist_name": "zlib-1.2.13-h5eee18b_0",
"name": "zlib",
"platform": "linux-64",
"version": "1.2.13"
}
]
26 changes: 26 additions & 0 deletions tests/test_parser_conda.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,32 @@ def test_conda_list_json(self) -> None:
self.assertEqual(0, len(c_idna.external_references.pop().hashes))
self.assertEqual(0, len(c_idna.hashes), f'{c_idna.hashes}')

def test_conda_list_json_mixed(self) -> None:
# conda environment which has both conda and pypi packages
# see https://github.com/CycloneDX/cyclonedx-python/issues/462
conda_list_output_file = os.path.join(os.path.dirname(__file__),
'fixtures/conda-list-issue462.json')

with (open(conda_list_output_file, 'r')) as conda_list_output_fh:
parser = CondaListJsonParser(conda_data=conda_list_output_fh.read())

self.assertEqual(25, parser.component_count())
components = parser.get_components()

c_libffi = next(filter(lambda c: c.name == 'libffi', components), None)
self.assertIsNotNone(c_libffi)
self.assertEqual('libffi', c_libffi.name)
self.assertEqual('3.4.2', c_libffi.version)
self.assertEqual('pkg:conda/[email protected]?build=h6a678d5_6&channel=pkgs/main&subdir=linux-64',
c_libffi.purl.to_string())

c_seawater = next(filter(lambda c: c.name == 'seawater', components), None)
self.assertIsNotNone(c_seawater)
self.assertEqual('seawater', c_seawater.name)
self.assertEqual('3.3.4', c_seawater.version)
self.assertEqual('pkg:pypi/[email protected]',
c_seawater.purl.to_string())

def test_conda_list_json_use_purl_bom_ref(self) -> None:
conda_list_output_file = os.path.join(os.path.dirname(__file__),
'fixtures/conda-list-output.json')
Expand Down