|
| 1 | +#!/usr/bin/env python |
| 2 | +# -*- coding: utf-8 -*- |
| 3 | +# Copyright (c) 2025 LG Electronics Inc. |
| 4 | +# SPDX-License-Identifier: Apache-2.0 |
| 5 | + |
| 6 | +import os |
| 7 | +import logging |
| 8 | +import subprocess |
| 9 | +import json |
| 10 | +import fosslight_util.constant as constant |
| 11 | +import fosslight_dependency.constant as const |
| 12 | +from fosslight_dependency.package_manager.Npm import Npm |
| 13 | +from fosslight_dependency.dependency_item import DependencyItem, change_dependson_to_purl |
| 14 | +from fosslight_util.oss_item import OssItem |
| 15 | +from fosslight_dependency._package_manager import get_url_to_purl |
| 16 | +from fosslight_dependency.package_manager.Npm import check_multi_license, check_unknown_license |
| 17 | + |
| 18 | +logger = logging.getLogger(constant.LOGGER_NAME) |
| 19 | + |
| 20 | + |
| 21 | +class Yarn(Npm): |
| 22 | + |
| 23 | + def __init__(self, input_dir, output_dir): |
| 24 | + super().__init__(input_dir, output_dir) |
| 25 | + self.package_manager_name = const.YARN |
| 26 | + self.yarn_version = None |
| 27 | + |
| 28 | + def detect_yarn_version(self): |
| 29 | + """Detect Yarn version (1.x = Classic, 2+ = Berry)""" |
| 30 | + if self.yarn_version is not None: |
| 31 | + return self.yarn_version |
| 32 | + |
| 33 | + try: |
| 34 | + result = subprocess.run('yarn -v', shell=True, capture_output=True, text=True, encoding='utf-8') |
| 35 | + if result.returncode == 0: |
| 36 | + version_str = result.stdout.strip() |
| 37 | + major_version = int(version_str.split('.')[0]) |
| 38 | + self.yarn_version = major_version |
| 39 | + logger.info(f"Detected Yarn version: {version_str} (major: {major_version})") |
| 40 | + return major_version |
| 41 | + except Exception as e: |
| 42 | + logger.warning(f"Failed to detect Yarn version: {e}") |
| 43 | + return None |
| 44 | + |
| 45 | + def start_license_checker(self): |
| 46 | + ret = True |
| 47 | + license_checker_cmd = f'license-checker --production --json --out {self.input_file_name}' |
| 48 | + custom_path_option = ' --customPath ' |
| 49 | + node_modules = 'node_modules' |
| 50 | + |
| 51 | + self.detect_yarn_version() |
| 52 | + |
| 53 | + # For Yarn Berry (2+), check if using PnP mode |
| 54 | + is_pnp_mode = False |
| 55 | + if self.yarn_version and self.yarn_version >= 2: |
| 56 | + # Check if .pnp.cjs exists (PnP mode indicator) |
| 57 | + if os.path.exists('.pnp.cjs') or os.path.exists('.pnp.js'): |
| 58 | + is_pnp_mode = True |
| 59 | + logger.info("Detected Yarn Berry with PnP mode") |
| 60 | + |
| 61 | + if not os.path.isdir(node_modules): |
| 62 | + logger.info("node_modules directory does not exist.") |
| 63 | + self.flag_tmp_node_modules = True |
| 64 | + |
| 65 | + # For PnP mode, try to force node_modules creation |
| 66 | + if is_pnp_mode: |
| 67 | + logger.info("Attempting to create node_modules for PnP project...") |
| 68 | + yarn_install_cmd = 'YARN_NODE_LINKER=node-modules yarn install --production --ignore-scripts' |
| 69 | + logger.info(f"Executing: {yarn_install_cmd}") |
| 70 | + else: |
| 71 | + yarn_install_cmd = 'yarn install --production --ignore-scripts' |
| 72 | + logger.info(f"Executing: {yarn_install_cmd}") |
| 73 | + |
| 74 | + cmd_ret = subprocess.call(yarn_install_cmd, shell=True) |
| 75 | + if cmd_ret != 0: |
| 76 | + logger.error(f"{yarn_install_cmd} failed") |
| 77 | + if is_pnp_mode: |
| 78 | + logger.error("Yarn Berry PnP mode detected. Consider setting 'nodeLinker: node-modules' in .yarnrc.yml") |
| 79 | + return False |
| 80 | + else: |
| 81 | + logger.info(f"Successfully executed {yarn_install_cmd}") |
| 82 | + |
| 83 | + self.make_custom_json(self.tmp_custom_json) |
| 84 | + |
| 85 | + cmd = license_checker_cmd + custom_path_option + self.tmp_custom_json |
| 86 | + cmd_ret = subprocess.call(cmd, shell=True) |
| 87 | + if cmd_ret != 0: |
| 88 | + logger.error(f"It returns the error: {cmd}") |
| 89 | + logger.error("Please check if the license-checker is installed.(sudo npm install -g license-checker)") |
| 90 | + ret = False |
| 91 | + else: |
| 92 | + self.append_input_package_list_file(self.input_file_name) |
| 93 | + if os.path.exists(self.tmp_custom_json): |
| 94 | + os.remove(self.tmp_custom_json) |
| 95 | + |
| 96 | + return ret |
| 97 | + |
| 98 | + def parse_oss_information(self, f_name): |
| 99 | + with open(f_name, 'r', encoding='utf8') as json_file: |
| 100 | + json_data = json.load(json_file) |
| 101 | + |
| 102 | + _licenses = 'licenses' |
| 103 | + _repository = 'repository' |
| 104 | + _private = 'private' |
| 105 | + |
| 106 | + keys = [key for key in json_data] |
| 107 | + purl_dict = {} |
| 108 | + for i in range(0, len(keys)): |
| 109 | + dep_item = DependencyItem() |
| 110 | + oss_item = OssItem() |
| 111 | + d = json_data.get(keys[i - 1]) |
| 112 | + oss_init_name = d['name'] |
| 113 | + oss_item.name = f'{const.NPM}:{oss_init_name}' |
| 114 | + |
| 115 | + if d[_licenses]: |
| 116 | + license_name = d[_licenses] |
| 117 | + else: |
| 118 | + license_name = '' |
| 119 | + |
| 120 | + oss_item.version = d['version'] |
| 121 | + package_path = d['path'] |
| 122 | + |
| 123 | + private_pkg = False |
| 124 | + if _private in d: |
| 125 | + if d[_private]: |
| 126 | + private_pkg = True |
| 127 | + |
| 128 | + oss_item.download_location = f"{self.dn_url}{oss_init_name}/v/{oss_item.version}" |
| 129 | + dn_loc = f"{self.dn_url}{oss_init_name}" |
| 130 | + dep_item.purl = get_url_to_purl(oss_item.download_location, self.package_manager_name) |
| 131 | + purl_dict[f'{oss_init_name}({oss_item.version})'] = dep_item.purl |
| 132 | + if d[_repository]: |
| 133 | + dn_loc = d[_repository] |
| 134 | + elif private_pkg: |
| 135 | + dn_loc = '' |
| 136 | + |
| 137 | + oss_item.homepage = dn_loc |
| 138 | + |
| 139 | + if private_pkg: |
| 140 | + oss_item.download_location = oss_item.homepage |
| 141 | + oss_item.comment = 'private' |
| 142 | + if self.package_name == f'{oss_init_name}({oss_item.version})': |
| 143 | + oss_item.comment = 'root package' |
| 144 | + elif self.direct_dep and len(self.relation_tree) > 0: |
| 145 | + if f'{oss_init_name}({oss_item.version})' in self.relation_tree[self.package_name]: |
| 146 | + oss_item.comment = 'direct' |
| 147 | + else: |
| 148 | + oss_item.comment = 'transitive' |
| 149 | + |
| 150 | + if f'{oss_init_name}({oss_item.version})' in self.relation_tree: |
| 151 | + dep_item.depends_on_raw = self.relation_tree[f'{oss_init_name}({oss_item.version})'] |
| 152 | + |
| 153 | + # For Yarn, use 'package.json' instead of yarn.lock for license info |
| 154 | + manifest_file_path = os.path.join(package_path, 'package.json') |
| 155 | + multi_license, license_comment, multi_flag = check_multi_license(license_name, manifest_file_path) |
| 156 | + |
| 157 | + if multi_flag: |
| 158 | + oss_item.comment = license_comment |
| 159 | + license_name = multi_license |
| 160 | + else: |
| 161 | + license_name = license_name.replace(",", "") |
| 162 | + license_name = check_unknown_license(license_name, manifest_file_path) |
| 163 | + oss_item.license = license_name |
| 164 | + |
| 165 | + dep_item.oss_items.append(oss_item) |
| 166 | + self.dep_items.append(dep_item) |
| 167 | + |
| 168 | + if self.direct_dep: |
| 169 | + self.dep_items = change_dependson_to_purl(purl_dict, self.dep_items) |
| 170 | + return |
| 171 | + |
| 172 | + def parse_rel_dependencies(self, rel_name, rel_ver, rel_dependencies): |
| 173 | + """Override to handle missing packages and packages without version""" |
| 174 | + _dependencies = 'dependencies' |
| 175 | + _version = 'version' |
| 176 | + _peer = 'peerMissing' |
| 177 | + _missing = 'missing' |
| 178 | + |
| 179 | + for rel_dep_name in rel_dependencies.keys(): |
| 180 | + # Optional, non-installed dependencies are listed as empty objects |
| 181 | + if rel_dependencies[rel_dep_name] == {}: |
| 182 | + continue |
| 183 | + if _peer in rel_dependencies[rel_dep_name]: |
| 184 | + if rel_dependencies[rel_dep_name][_peer]: |
| 185 | + continue |
| 186 | + # Skip missing packages (not installed) |
| 187 | + if _missing in rel_dependencies[rel_dep_name]: |
| 188 | + if rel_dependencies[rel_dep_name][_missing]: |
| 189 | + continue |
| 190 | + # Skip if version key doesn't exist |
| 191 | + if _version not in rel_dependencies[rel_dep_name]: |
| 192 | + continue |
| 193 | + |
| 194 | + if f'{rel_name}({rel_ver})' not in self.relation_tree: |
| 195 | + self.relation_tree[f'{rel_name}({rel_ver})'] = [] |
| 196 | + elif f'{rel_dep_name}({rel_dependencies[rel_dep_name][_version]})' in self.relation_tree[f'{rel_name}({rel_ver})']: |
| 197 | + continue |
| 198 | + self.relation_tree[f'{rel_name}({rel_ver})'].append(f'{rel_dep_name}({rel_dependencies[rel_dep_name][_version]})') |
| 199 | + if _dependencies in rel_dependencies[rel_dep_name]: |
| 200 | + self.parse_rel_dependencies(rel_dep_name, rel_dependencies[rel_dep_name][_version], |
| 201 | + rel_dependencies[rel_dep_name][_dependencies]) |
| 202 | + |
| 203 | + def parse_direct_dependencies(self): |
| 204 | + if not self.direct_dep: |
| 205 | + return |
| 206 | + try: |
| 207 | + # For Yarn, check if package.json exists (not yarn.lock) |
| 208 | + # input_package_list_file[0] is the license-checker output file path |
| 209 | + manifest_dir = os.path.dirname(self.input_package_list_file[0]) |
| 210 | + package_json_path = os.path.join(manifest_dir, 'package.json') |
| 211 | + |
| 212 | + if os.path.isfile(package_json_path): |
| 213 | + ret, err_msg = self.parse_transitive_relationship() |
| 214 | + if not ret: |
| 215 | + self.direct_dep = False |
| 216 | + logger.warning(f'It cannot print direct/transitive dependency: {err_msg}') |
| 217 | + else: |
| 218 | + logger.info('Direct/transitive support is not possible because the package.json file does not exist.') |
| 219 | + self.direct_dep = False |
| 220 | + except Exception as e: |
| 221 | + logger.warning(f'Cannot print direct/transitive dependency: {e}') |
| 222 | + self.direct_dep = False |
0 commit comments