Support unity package manager (#197)

Signed-off-by: jiyeong.seok <[email protected]>

Author: dd-jy

src/fosslight_dependency/_analyze_dependency.py

@@ -18,6 +18,7 @@
 from fosslight_dependency.package_manager.Go import Go
 from fosslight_dependency.package_manager.Nuget import Nuget
 from fosslight_dependency.package_manager.Helm import Helm
+from fosslight_dependency.package_manager.Unity import Unity
 import fosslight_util.constant as constant
 
 logger = logging.getLogger(constant.LOGGER_NAME)
@@ -53,6 +54,8 @@ def analyze_dependency(package_manager_name, input_dir, output_dir, pip_activate
         package_manager = Nuget(input_dir, output_dir)
     elif package_manager_name == const.HELM:
         package_manager = Helm(input_dir, output_dir)
+    elif package_manager_name == const.UNITY:
+        package_manager = Unity(input_dir, output_dir)
     else:
         logger.error(f"Not supported package manager name: {package_manager_name}")
         ret = False

src/fosslight_dependency/_help.py

@@ -23,6 +23,7 @@
         Go (Go)
         Nuget (.NET)
         Helm (Kubernetes)
+        Unity (Unity)
 
     Options:
         Optional

src/fosslight_dependency/constant.py

@@ -22,6 +22,7 @@
 GO = 'go'
 NUGET = 'nuget'
 HELM = 'helm'
+UNITY = 'unity'
 
 # Supported package name and manifest file
 SUPPORT_PACKAE = {
@@ -36,7 +37,8 @@
     CARTHAGE: 'Cartfile.resolved',
     GO: 'go.mod',
     NUGET: ['packages.config', os.path.join('obj', 'project.assets.json')],
-    HELM: 'Chart.yaml'
+    HELM: 'Chart.yaml',
+    UNITY: os.path.join('Library', 'PackageManager', 'ProjectCache')
 }
 
 # default android app name

src/fosslight_dependency/package_manager/Unity.py

@@ -0,0 +1,101 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2024 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+import os
+import logging
+import re
+import yaml
+import fosslight_util.constant as constant
+import fosslight_dependency.constant as const
+from fosslight_dependency._package_manager import PackageManager
+from fosslight_dependency._package_manager import check_and_run_license_scanner, get_url_to_purl
+
+logger = logging.getLogger(constant.LOGGER_NAME)
+proprietary_license = 'Proprietary License'
+unclassifed_license = 'UnclassifiedLicense'
+license_md = 'LICENSE.md'
+third_party_md = 'Third Party Notices.md'
+
+
+class Unity(PackageManager):
+    package_manager_name = const.UNITY
+
+    input_file_name = const.SUPPORT_PACKAE.get(package_manager_name)
+    packageCache_dir = os.path.join('Library', 'PackageCache')
+    mirror_url = 'https://github.com/needle-mirror/'
+    unity_internal_url = 'https://github.cds.internal.unity3d.com'
+    third_notice_txt = 'third_party_notice.txt'
+
+    def __init__(self, input_dir, output_dir):
+        super().__init__(self.package_manager_name, '', input_dir, output_dir)
+        self.append_input_package_list_file(self.input_file_name)
+
+    def parse_oss_information(self, f_name):
+        comment = ''
+
+        with open(f_name, 'r', encoding='utf8') as f:
+            f_yml = yaml.safe_load(f)
+            resolvedPkg = f_yml['m_ResolvedPackages']
+
+        try:
+            sheet_list = []
+
+            for pkg_data in resolvedPkg:
+                oss_name = pkg_data['name']
+                oss_version = pkg_data['version']
+
+                oss_packagecache_dir = os.path.join(self.packageCache_dir, f'{oss_name}@{oss_version}')
+                license_f = os.path.join(oss_packagecache_dir, license_md)
+                if os.path.isfile(license_f):
+                    license_name = check_and_run_license_scanner(self.platform,
+                                                                 self.license_scanner_bin,
+                                                                 license_f)
+                    if license_name == unclassifed_license or license_name == '':
+                        with open(license_f, 'r', encoding='utf-8') as f:
+                            for line in f:
+                                matched_l = re.search(r'Unity\s[\s\w]*\sLicense', line)
+                                if matched_l:
+                                    license_name = matched_l[0]
+                                    break
+                else:
+                    license_name = proprietary_license
+
+                third_f = os.path.join(oss_packagecache_dir, third_party_md)
+                if os.path.isfile(third_f):
+                    with open(third_f, 'r', encoding='utf-8') as f:
+                        third_notice = f.readlines()
+                    with open(self.third_notice_txt, 'a+', encoding='utf-8') as tf:
+                        for line in third_notice:
+                            tf.write(line)
+                            tf.flush()
+
+                homepage = pkg_data['repository']['url']
+                if homepage and homepage.startswith('git@'):
+                    homepage = homepage.replace('git@', 'https://')
+                if homepage is None or homepage.startswith(self.unity_internal_url):
+                    if license_name != proprietary_license:
+                        homepage = f'{self.mirror_url}{oss_name}'
+                if homepage is None:
+                    homepage = ''
+
+                dn_loc = homepage
+                purl = get_url_to_purl(dn_loc, self.package_manager_name)
+                if purl == 'None':
+                    purl = ''
+
+                comment_list = []
+                if self.direct_dep:
+                    if pkg_data['isDirectDependency']:
+                        comment_list.append('direct')
+                    else:
+                        comment_list.append('transitive')
+
+                comment = ','.join(comment_list)
+                sheet_list.append([purl, oss_name, oss_version, license_name, dn_loc, homepage,
+                                  '', '', comment, ''])
+        except Exception as e:
+            logger.error(f"Fail to parse unity oss information: {e}")
+
+        return sheet_list

src/fosslight_dependency/run_dependency_scanner.py

@@ -161,7 +161,7 @@ def run_dependency_scanner(package_manager='', input_dir='', output_dir_file='',
                 logger.warning("Dependency scanning terminated because the package manager was not found.")
                 ret = False
     else:
-        found_package_manager[package_manager] = ''
+        found_package_manager[package_manager] = ["manual detect ('-m option')"]
 
     pass_key = 'PASS'
     success_pm = []