forked from aboutcode-org/scancode-toolkit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswift.py
More file actions
496 lines (401 loc) · 17.6 KB
/
swift.py
File metadata and controls
496 lines (401 loc) · 17.6 KB
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
# Copyright (c) nexB Inc. and others. All rights reserved.
# ScanCode is a trademark of nexB Inc.
# SPDX-License-Identifier: Apache-2.0
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
# See https://github.com/nexB/scancode-toolkit for support or download.
# See https://aboutcode.org for more information about nexB OSS projects.
#
import io
import json
import logging
import os
from urllib import parse
from packagedcode import models
from packageurl import PackageURL
"""
Handle the resolved file and JSON dump of the manifest for Swift packages.
https://docs.swift.org/package-manager/PackageDescription/PackageDescription.html
Run the commands below before running the scan:
- To create a parsable JSON version of the Package.swift manifest, run this: ``swift package dump-package > Package.swift.json``
- To create the Package.resolved lock file, run this: ``swift package resolve``
"""
SCANCODE_DEBUG_PACKAGE = os.environ.get("SCANCODE_DEBUG_PACKAGE", False)
TRACE = SCANCODE_DEBUG_PACKAGE
def logger_debug(*args):
pass
logger = logging.getLogger(__name__)
if TRACE:
import sys
logging.basicConfig(stream=sys.stdout)
logger.setLevel(logging.DEBUG)
def logger_debug(*args):
return logger.debug(" ".join(isinstance(a, str) and a or repr(a) for a in args))
class BaseSwiftDatafileHandler(models.DatafileHandler):
@classmethod
def assemble(cls, package_data, resource, codebase, package_adder):
swift_manifest_resource = None
swift_show_dependencies_resource = None
swift_resolved_package_resource = None
processed_package = None
add_datafile_paths = []
add_datasource_ids = []
processed_dependencies = []
for r in resource.siblings(codebase):
if r.name in ("Package.swift.json", "Package.swift.deplock"):
swift_manifest_resource = r
elif r.name in ("Package.resolved", ".package.resolved"):
swift_resolved_package_resource = r
elif r.name == "swift-show-dependencies.deplock":
swift_show_dependencies_resource = r
# If only Package.resolved is available then yield all dependency as package.
if (
not swift_manifest_resource
and not swift_show_dependencies_resource
and resource.name in ("Package.resolved", ".package.resolved")
):
processed_package = package_data
processed_dependencies = package_data.dependencies
# If no manifest but have dependency graph from `deplock` then use it construct top-level package.
elif (
not swift_manifest_resource
and resource.name == "swift-show-dependencies.deplock"
):
processed_package = package_data
processed_dependencies = package_data.dependencies
# If manifest is available then use the manifest to construct top-level package.
elif swift_manifest_resource and resource.name in (
"Package.swift.json",
"Package.swift.deplock",
):
processed_dependencies = package_data.dependencies
# Dependencies from `swift-show-dependencies.deplock` supersedes dependencies from other datafiles.
if swift_show_dependencies_resource:
swift_show_dependencies_package_data = models.PackageData.from_dict(
swift_show_dependencies_resource.package_data[0]
)
processed_dependencies = (
swift_show_dependencies_package_data.dependencies
)
# Use dependencies from `Package.resolved` when `swift-show-dependencies.deplock` is not present.
elif swift_resolved_package_resource:
swift_resolved_package_data = (
swift_resolved_package_resource.package_data
)
resolved_dependencies = []
for package in swift_resolved_package_data:
version = package.get("version")
name = package.get("name")
purl = PackageURL(
type=cls.default_package_type, name=name, version=version
)
resolved_dependencies.append(
models.DependentPackage(
purl=purl.to_string(),
scope="dependencies",
is_runtime=True,
is_optional=False,
is_pinned=True,
extracted_requirement=version,
)
)
for dependency in processed_dependencies[:]:
dependency_purl = PackageURL.from_string(dependency.purl)
if dependency_purl.name == name:
processed_dependencies.remove(dependency)
processed_dependencies.extend(resolved_dependencies)
processed_package = package_data
if swift_show_dependencies_resource:
add_datafile_paths.append(swift_show_dependencies_resource.path)
add_datasource_ids.append(
SwiftShowDependenciesDepLockHandler.datasource_id
)
elif swift_resolved_package_resource:
add_datafile_paths.append(swift_resolved_package_resource.path)
add_datasource_ids.append(SwiftPackageResolvedHandler.datasource_id)
if processed_package and processed_package.purl:
package = models.Package.from_package_data(
package_data=processed_package,
datafile_path=resource.path,
)
package.datafile_paths.extend(add_datafile_paths)
package.datasource_ids.extend(add_datasource_ids)
package.populate_license_fields()
yield package
parent = resource.parent(codebase)
cls.assign_package_to_resources(
package=package,
resource=parent,
codebase=codebase,
package_adder=package_adder,
)
if processed_dependencies:
yield from models.Dependency.from_dependent_packages(
dependent_packages=processed_dependencies,
datafile_path=resource.path,
datasource_id=processed_package.datasource_id,
package_uid=package.package_uid,
)
yield resource
class SwiftShowDependenciesDepLockHandler(BaseSwiftDatafileHandler):
datasource_id = "swift_package_show_dependencies"
path_patterns = ("*/swift-show-dependencies.deplock",)
default_package_type = "swift"
default_primary_language = "Swift"
description = "Swift dependency graph created by DepLock"
documentation_url = "https://forums.swift.org/t/swiftpm-show-dependencies-without-fetching-dependencies/51154"
@classmethod
def _parse(cls, swift_dependency_relation, package_only=False):
if TRACE:
logger_debug(
f"SwiftShowDependenciesDepLockHandler: deplock: package: {swift_dependency_relation}"
)
dependencies = get_flatten_dependencies(
dependency_tree=swift_dependency_relation.get("dependencies")
)
package_data = dict(
datasource_id=cls.datasource_id,
type=cls.default_package_type,
primary_language=cls.default_primary_language,
# ``namespace`` is derived from repo URL and same is not available in dependency graph
# See related issue: https://github.com/nexB/scancode-toolkit/issues/3793
name=swift_dependency_relation.get("name"),
dependencies=dependencies,
)
return models.PackageData.from_data(package_data, package_only)
@classmethod
def parse(cls, location, package_only=False):
with io.open(location, encoding="utf-8") as loc:
swift_dependency_relation = json.load(loc)
yield cls._parse(swift_dependency_relation, package_only)
class SwiftManifestJsonHandler(BaseSwiftDatafileHandler):
datasource_id = "swift_package_manifest_json"
path_patterns = ("*/Package.swift.json", "*/Package.swift.deplock")
default_package_type = "swift"
default_primary_language = "Swift"
description = "JSON dump of Package.swift created by DepLock or with ``swift package dump-package > Package.swift.json``"
documentation_url = "https://docs.swift.org/package-manager/PackageDescription/PackageDescription.html"
@classmethod
def _parse(cls, swift_manifest, package_only=False):
if TRACE:
logger_debug(
f"SwiftManifestJsonHandler: manifest: package: {swift_manifest}"
)
dependencies = get_dependencies(swift_manifest.get("dependencies"))
platforms = swift_manifest.get("platforms", [])
package_data = dict(
datasource_id=cls.datasource_id,
type=cls.default_package_type,
primary_language=cls.default_primary_language,
namespace=None,
name=swift_manifest.get("name"),
dependencies=dependencies,
extra_data={"platforms": platforms},
)
return models.PackageData.from_data(package_data, package_only)
@classmethod
def parse(cls, location, package_only=False):
with io.open(location, encoding="utf-8") as loc:
swift_manifest = json.load(loc)
yield cls._parse(swift_manifest, package_only)
class SwiftPackageResolvedHandler(BaseSwiftDatafileHandler):
datasource_id = "swift_package_resolved"
path_patterns = ("*/Package.resolved", "*/.package.resolved")
default_package_type = "swift"
default_primary_language = "swift"
description = "Resolved full dependency lockfile for Package.swift created with ``swift package resolve``"
documentation_url = (
"https://docs.swift.org/package-manager/PackageDescription/"
"PackageDescription.html#package-dependency"
)
@classmethod
def parse(cls, location, package_only=False):
with io.open(location, encoding="utf-8") as loc:
package_resolved = json.load(loc)
resolved_doc_version = package_resolved.get("version")
if resolved_doc_version in [2, 3]:
yield from packages_from_resolved_v2_and_v3(package_resolved)
if resolved_doc_version == 1:
yield from packages_from_resolved_v1(package_resolved)
def packages_from_resolved_v2_and_v3(package_resolved):
pinned = package_resolved.get("pins", [])
for dependency in pinned:
name = dependency.get("identity")
kind = dependency.get("kind")
location = dependency.get("location")
state = dependency.get("state", {})
version = None
namespace = None
if location and kind == "remoteSourceControl":
namespace, name = get_namespace_and_name(location)
version = state.get("version")
if not version:
version = state.get("revision")
package_data = dict(
datasource_id=SwiftPackageResolvedHandler.datasource_id,
type=SwiftPackageResolvedHandler.default_package_type,
primary_language=SwiftPackageResolvedHandler.default_primary_language,
namespace=namespace,
name=name,
version=version,
)
yield models.PackageData.from_data(package_data, False)
def packages_from_resolved_v1(package_resolved):
object = package_resolved.get("object", {})
pinned = object.get("pins", [])
for dependency in pinned:
name = dependency.get("package")
repository_url = dependency.get("repositoryURL")
state = dependency.get("state", {})
version = None
namespace = None
if repository_url:
namespace, name = get_namespace_and_name(repository_url)
version = state.get("version")
if not version:
version = state.get("revision")
package_data = dict(
datasource_id=SwiftPackageResolvedHandler.datasource_id,
type=SwiftPackageResolvedHandler.default_package_type,
primary_language=SwiftPackageResolvedHandler.default_primary_language,
namespace=namespace,
name=name,
version=version,
)
yield models.PackageData.from_data(package_data, False)
def get_dependencies(dependencies):
dependent_packages = []
for dependency in dependencies or []:
source = dependency.get("sourceControl")
if not source:
continue
source = source[0]
namespace = None
name = source.get("identity")
version = None
is_pinned = False
location = source.get("location")
if remote := location.get("remote"):
namespace, name = get_namespace_and_name(remote[0].get("urlString"))
requirement = source.get("requirement")
if exact := requirement.get("exact"):
version = exact[0]
is_pinned = True
elif range := requirement.get("range"):
bound = range[0]
lower_bound = bound.get("lowerBound")
upper_bound = bound.get("upperBound")
version = f"vers:swift/>={lower_bound}|<{upper_bound}"
purl = PackageURL(
type="swift",
namespace=namespace,
name=name,
version=version if is_pinned else None,
)
dependent_packages.append(
models.DependentPackage(
purl=purl.to_string(),
scope="dependencies",
is_runtime=True,
is_optional=False,
is_pinned=is_pinned,
extracted_requirement=version,
)
)
return dependent_packages
def get_namespace_and_name(url):
parsed_url = parse.urlparse(url)
hostname = parsed_url.hostname
path = parsed_url.path.replace(".git", "")
canonical_name = hostname + path
return canonical_name.rsplit("/", 1)
def get_flatten_dependencies(dependency_tree):
"""
Get the list of dependencies from the dependency graph where each
element is a DependentPackage containing its 1st order dependencies.
"""
dependencies = []
transitive_dependencies = []
# process direct dependency
for dependency in dependency_tree:
transitives = dependency.get("dependencies", [])
transitive_dependencies.append(transitives)
parent_child_dep = get_dependent_package_from_subtree(
dependency=dependency,
is_top_level_dependency=True,
)
dependencies.append(parent_child_dep)
# process all transitive dependencies
while transitive_dependencies:
transitive_dependency_tree = transitive_dependencies.pop(0)
if not transitive_dependency_tree:
continue
for transitive in transitive_dependency_tree:
dependencies_of_transitive_dependency = transitive.get("dependencies", [])
# add nested dependencies in transitive_dependencies queue for processing
transitive_dependencies.append(dependencies_of_transitive_dependency)
parent_child_dep = get_dependent_package_from_subtree(
dependency=transitive,
is_top_level_dependency=False,
)
dependencies.append(parent_child_dep)
return dependencies
def get_dependent_package_from_subtree(dependency, is_top_level_dependency):
"""
Get the DependentPackage for a ``dependency`` subtree along with its 1st
order dependencies. Set `is_direct` to True if the subtree is a direct
dependency for the top-level package.
"""
dependencies_of_parent = []
repository_url = dependency.get("url")
version = dependency.get("version")
transitives = dependency.get("dependencies", [])
namespace, name = get_namespace_and_name(repository_url)
purl = PackageURL(
type="swift",
namespace=namespace,
name=name,
version=version,
)
for transitive in transitives:
transitive_repository_url = transitive.get("url")
transitive_version = transitive.get("version")
transitive_namespace, transitive_name = get_namespace_and_name(
transitive_repository_url
)
transitive_purl = PackageURL(
type="swift",
namespace=transitive_namespace,
name=transitive_name,
version=transitive_version,
)
child_dependency = models.DependentPackage(
purl=transitive_purl.to_string(),
scope="dependencies",
extracted_requirement=transitive_version,
is_runtime=False,
is_optional=False,
is_pinned=True,
is_direct=True,
).to_dict()
dependencies_of_parent.append(child_dependency)
parent_package_data_mapping = dict(
datasource_id=SwiftShowDependenciesDepLockHandler.datasource_id,
type=SwiftShowDependenciesDepLockHandler.default_package_type,
primary_language=SwiftShowDependenciesDepLockHandler.default_primary_language,
namespace=namespace,
name=name,
version=version,
dependencies=dependencies_of_parent,
is_virtual=True,
)
parent_dependency = models.PackageData.from_data(parent_package_data_mapping)
return models.DependentPackage(
purl=purl.to_string(),
scope="dependencies",
extracted_requirement=version,
is_runtime=False,
is_optional=False,
is_pinned=True,
is_direct=is_top_level_dependency,
resolved_package=parent_dependency,
)