fosslight-scanner 1.7.31__tar.gz → 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/PKG-INFO +1 -1
  2. fosslight_scanner-2.0.0/requirements.txt +10 -0
  3. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/setup.py +1 -1
  4. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner/_run_compare.py +14 -5
  5. fosslight_scanner-2.0.0/src/fosslight_scanner/common.py +210 -0
  6. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner/fosslight_scanner.py +44 -73
  7. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner.egg-info/PKG-INFO +1 -1
  8. fosslight_scanner-2.0.0/src/fosslight_scanner.egg-info/requires.txt +10 -0
  9. fosslight_scanner-1.7.31/requirements.txt +0 -11
  10. fosslight_scanner-1.7.31/src/fosslight_scanner/common.py +0 -298
  11. fosslight_scanner-1.7.31/src/fosslight_scanner.egg-info/requires.txt +0 -11
  12. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/LICENSE +0 -0
  13. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/MANIFEST.in +0 -0
  14. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/README.md +0 -0
  15. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/setup.cfg +0 -0
  16. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner/__init__.py +0 -0
  17. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner/_get_input.py +0 -0
  18. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner/_help.py +0 -0
  19. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner/_parse_setting.py +0 -0
  20. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner/cli.py +0 -0
  21. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner/resources/bom_compare.html +0 -0
  22. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner.egg-info/SOURCES.txt +0 -0
  23. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner.egg-info/dependency_links.txt +0 -0
  24. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner.egg-info/entry_points.txt +0 -0
  25. {fosslight_scanner-1.7.31 → fosslight_scanner-2.0.0}/src/fosslight_scanner.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: fosslight_scanner
3
- Version: 1.7.31
3
+ Version: 2.0.0
4
4
  Summary: FOSSLight Scanner
5
5
  Home-page: https://github.com/fosslight/fosslight_scanner
6
6
  Author: LG Electronics
@@ -0,0 +1,10 @@
1
+ future
2
+ pandas
3
+ openpyxl
4
+ progress
5
+ pyyaml
6
+ beautifulsoup4
7
+ fosslight_util>=2.0.0
8
+ fosslight_source>=2.0.0
9
+ fosslight_dependency>=4.0.0
10
+ fosslight_binary>=5.0.0
@@ -15,7 +15,7 @@ with open('requirements.txt', 'r', 'utf-8') as f:
15
15
  if __name__ == "__main__":
16
16
  setup(
17
17
  name='fosslight_scanner',
18
- version='1.7.31',
18
+ version='2.0.0',
19
19
  package_dir={"": "src"},
20
20
  packages=find_packages(where='src'),
21
21
  description='FOSSLight Scanner',
@@ -14,7 +14,8 @@ from pathlib import Path
14
14
  from bs4 import BeautifulSoup
15
15
  import fosslight_util.constant as constant
16
16
  from fosslight_util.compare_yaml import compare_yaml
17
- from fosslight_util.convert_excel_to_yaml import convert_excel_to_yaml
17
+ from fosslight_util.read_excel import read_oss_report
18
+ from fosslight_util.parsing_yaml import parsing_yml
18
19
 
19
20
  logger = logging.getLogger(constant.LOGGER_NAME)
20
21
  ADD = "add"
@@ -255,10 +256,18 @@ def run_compare(before_f, after_f, output_path, output_file, file_ext, _start_ti
255
256
 
256
257
  result_file = get_comparison_result_filename(output_path, output_file, file_ext, _start_time)
257
258
 
258
- if before_ext == XLSX_EXT:
259
- convert_excel_to_yaml(before_f, before_yaml)
260
- convert_excel_to_yaml(after_f, after_yaml)
261
- compared_result = compare_yaml(before_yaml, after_yaml)
259
+ before_basepath = os.path.dirname(before_f)
260
+ after_basepath = os.path.dirname(after_f)
261
+ if XLSX_EXT == before_ext:
262
+ before_fileitems = read_oss_report(before_f, "", before_basepath)
263
+ elif YAML_EXT == before_ext:
264
+ before_fileitems, _, _ = parsing_yml(before_yaml, before_basepath)
265
+ if XLSX_EXT == after_ext:
266
+ after_fileitems = read_oss_report(after_f, after_basepath)
267
+ elif YAML_EXT == after_ext:
268
+ after_fileitems, _, _ = parsing_yml(after_yaml, after_basepath)
269
+
270
+ compared_result = compare_yaml(before_fileitems, after_fileitems)
262
271
  if compared_result != '':
263
272
  count_compared_result(compared_result)
264
273
  ret, result_file = write_compared_result(result_file, compared_result, file_ext, before_yaml, after_yaml)
@@ -0,0 +1,210 @@
1
+ #!/usr/bin/env python
2
+ # -*- coding: utf-8 -*-
3
+ # FOSSLight Scanner
4
+ # Copyright (c) 2020 LG Electronics Inc.
5
+ # SPDX-License-Identifier: Apache-2.0
6
+ import os
7
+ import sys
8
+ import logging
9
+ import shutil
10
+ import copy
11
+ from fosslight_util.constant import LOGGER_NAME, FOSSLIGHT_SOURCE, FOSSLIGHT_BINARY, FOSSLIGHT_DEPENDENCY
12
+ from fosslight_util.write_scancodejson import write_scancodejson
13
+ from fosslight_util.oss_item import OssItem, FileItem
14
+
15
+ logger = logging.getLogger(LOGGER_NAME)
16
+ SRC_SHEET = 'SRC_FL_Source'
17
+ BIN_SHEET = 'BIN_FL_Binary'
18
+ BIN_EXT_HEADER = {
19
+ 'BIN_FL_Binary': [
20
+ 'ID', 'Binary Path', 'OSS Name', 'OSS Version', 'License',
21
+ 'Download Location', 'Homepage', 'Copyright Text', 'Exclude',
22
+ 'Comment', 'Vulnerability Link', 'TLSH', 'SHA1'
23
+ ]
24
+ }
25
+ BIN_HIDDEN_HEADER = {'TLSH', 'SHA1'}
26
+
27
+
28
+ def copy_file(source, destination):
29
+ copied_file = ""
30
+ try:
31
+ shutil.copy(source, destination)
32
+ if os.path.isdir(destination):
33
+ copied_file = os.path.join(destination, os.path.basename(source))
34
+ else:
35
+ copied_file = destination
36
+ except Exception as ex:
37
+ logger.debug(f"Failed to copy {source} to {destination}: {ex}")
38
+ return False, copied_file
39
+ return True, copied_file
40
+
41
+
42
+ def run_analysis(path_to_run, params, func, str_run_start, output, exe_path):
43
+ # This function will be replaced by call_analysis_api().
44
+ logger.info("## Start to run " + str_run_start)
45
+ return_value = ""
46
+ try:
47
+ if path_to_run:
48
+ logger.info(f"|--- Path to analyze : {path_to_run}")
49
+ os.chdir(output)
50
+ sys.argv = params
51
+ return_value = func()
52
+ os.chdir(exe_path)
53
+ else:
54
+ logger.info("Analyzing path is missing...")
55
+ except SystemExit:
56
+ pass
57
+ except Exception as ex:
58
+ logger.error(f"{str_run_start}:{ex}")
59
+ return return_value
60
+
61
+
62
+ def call_analysis_api(path_to_run, str_run_start, return_idx, func, *args, **kwargs):
63
+ # return_idx == -1 : Raw return value itself
64
+ logger.info(f"## Start to run {str_run_start}")
65
+ success = True
66
+ result = []
67
+ try:
68
+ if path_to_run:
69
+ logger.info(f"|--- Path to analyze : {path_to_run}")
70
+ result = func(*args, **kwargs)
71
+ else:
72
+ logger.info("Analyzing path is missing...")
73
+ except SystemExit:
74
+ success = False
75
+ except Exception as ex:
76
+ success = False
77
+ logger.error(f"{str_run_start}:{ex}")
78
+ try:
79
+ if success and result and return_idx >= 0:
80
+ if len(result) > return_idx:
81
+ result = result[return_idx]
82
+ else:
83
+ success = False
84
+ except Exception as ex:
85
+ logger.debug(f"Get return value:{ex}")
86
+ success = False
87
+ return success, result or []
88
+
89
+
90
+ def update_oss_item(scan_item, oss_name, oss_version, download_loc):
91
+ for file_items in scan_item.file_items.values():
92
+ for file_item in file_items:
93
+ if file_item.oss_items:
94
+ for oi in file_item.oss_items:
95
+ if oi.name == '' and oi.version == '' and oi.download_location == '':
96
+ oi.name = oss_name
97
+ oi.version = oss_version
98
+ oi.download_location = download_loc
99
+ else:
100
+ file_item.oss_items.append(OssItem(oss_name, oss_version, '', download_loc))
101
+ return scan_item
102
+
103
+
104
+ def create_scancodejson(all_scan_item_origin, ui_mode_report, src_path=""):
105
+ success = True
106
+ err_msg = ''
107
+ root_dir = ""
108
+ root_strip = ""
109
+ try:
110
+ src_path = os.path.abspath(src_path)
111
+ parent = os.path.basename(src_path)
112
+ root_strip = src_path.replace(parent, "")
113
+ root_dir = parent
114
+ except Exception:
115
+ root_dir = ""
116
+
117
+ try:
118
+ all_scan_item = copy.deepcopy(all_scan_item_origin)
119
+ if FOSSLIGHT_DEPENDENCY in all_scan_item.file_items:
120
+ del all_scan_item.file_items[FOSSLIGHT_DEPENDENCY]
121
+ if src_path:
122
+ fileitems_without_oss = []
123
+ for root, _, files in os.walk(src_path):
124
+ root = root.replace(root_strip, "")
125
+ for file in files:
126
+ fi_without_oss = FileItem('')
127
+ included = False
128
+ item_path = os.path.join(root, file)
129
+ item_path = item_path.replace(parent + os.path.sep, '', 1)
130
+
131
+ for file_items in all_scan_item.file_items.values():
132
+ for file_item in file_items:
133
+ if file_item.source_name_or_path:
134
+ if file_item.source_name_or_path == item_path:
135
+ included = True
136
+ break
137
+ if not included:
138
+ fi_without_oss.source_name_or_path = item_path
139
+ fileitems_without_oss.append(fi_without_oss)
140
+ if len(fileitems_without_oss) > 0:
141
+ all_scan_item.file_items[FOSSLIGHT_SOURCE].extend(fileitems_without_oss)
142
+ if root_dir:
143
+ for file_items in all_scan_item.file_items.values():
144
+ for fi in file_items:
145
+ if fi.source_name_or_path:
146
+ fi.source_name_or_path = os.path.join(root_dir, fi.source_name_or_path)
147
+ write_scancodejson(os.path.dirname(ui_mode_report), os.path.basename(ui_mode_report),
148
+ all_scan_item)
149
+ except Exception as ex:
150
+ err_msg = ex
151
+ success = False
152
+
153
+ return success, err_msg
154
+
155
+
156
+ def correct_scanner_result(all_scan_item):
157
+ duplicates = False
158
+
159
+ keys_needed = {FOSSLIGHT_SOURCE, FOSSLIGHT_BINARY}
160
+ is_contained = keys_needed.issubset(all_scan_item.file_items.keys())
161
+ if is_contained:
162
+ src_fileitems = all_scan_item.file_items[FOSSLIGHT_SOURCE]
163
+ bin_fileitems = all_scan_item.file_items[FOSSLIGHT_BINARY]
164
+ try:
165
+ remove_src_idx_list = []
166
+ for idx_src, src_fileitem in enumerate(src_fileitems):
167
+ src_fileitem.exclude = check_exclude_dir(src_fileitem.source_name_or_path, src_fileitem.exclude)
168
+ dup_flag = False
169
+ for bin_fileitem in bin_fileitems:
170
+ bin_fileitem.exclude = check_exclude_dir(bin_fileitem.source_name_or_path, bin_fileitem.exclude)
171
+ if src_fileitem.source_name_or_path == bin_fileitem.source_name_or_path:
172
+ dup_flag = True
173
+ src_all_licenses_non_empty = all(oss_item.license for oss_item in src_fileitem.oss_items)
174
+ bin_empty_license_exists = all(not oss_item.license for oss_item in bin_fileitem.oss_items)
175
+
176
+ if src_all_licenses_non_empty and bin_empty_license_exists:
177
+ exclude = bin_fileitem.oss_items[0].exclude
178
+ bin_fileitem.oss_items = []
179
+ for src_oss_item in src_fileitem.oss_items:
180
+ src_oss_item.exclude = exclude
181
+ bin_fileitem.oss_items.append(src_oss_item)
182
+ bin_fileitem.comment = 'Loaded from SRC OSS info'
183
+ if dup_flag:
184
+ remove_src_idx_list.append(idx_src)
185
+ if remove_src_idx_list:
186
+ duplicates = True
187
+ for i in sorted(remove_src_idx_list, reverse=True):
188
+ del src_fileitems[i]
189
+ except Exception as ex:
190
+ logger.warning(f"correct the scanner result:{ex}")
191
+
192
+ try:
193
+ if duplicates:
194
+ logger.info('Success to correct the src/bin scanner result')
195
+ except Exception as ex:
196
+ logger.warning(f"Corrected src/bin scanner result:{ex}")
197
+ return all_scan_item
198
+
199
+
200
+ def check_exclude_dir(source_name_or_path, file_item_exclude):
201
+ if file_item_exclude:
202
+ return True
203
+ _exclude_dirs = ["venv", "node_modules", "Pods", "Carthage"]
204
+ exclude = False
205
+
206
+ for exclude_dir in _exclude_dirs:
207
+ if exclude_dir in source_name_or_path.split(os.path.sep):
208
+ exclude = True
209
+ break
210
+ return exclude
@@ -24,13 +24,13 @@ from fosslight_util.set_log import init_log
24
24
  from fosslight_util.timer_thread import TimerThread
25
25
  import fosslight_util.constant as constant
26
26
  from fosslight_util.output_format import check_output_format
27
- from fosslight_prechecker._precheck import run_lint as prechecker_lint
28
- from fosslight_util.write_excel import merge_excels, merge_cover_comment
29
27
  from fosslight_util.cover import CoverItem
28
+ from fosslight_util.oss_item import ScannerItem
29
+ from fosslight_util.output_format import write_output_file
30
30
 
31
31
  from .common import (
32
- copy_file, call_analysis_api, overwrite_excel,
33
- merge_yamls, correct_scanner_result, create_scancodejson
32
+ call_analysis_api, update_oss_item,
33
+ correct_scanner_result, create_scancodejson
34
34
  )
35
35
  from ._run_compare import run_compare
36
36
 
@@ -50,13 +50,13 @@ _start_time = ""
50
50
  _executed_path = ""
51
51
  SRC_DIR_FROM_LINK_PREFIX = "fosslight_src_dir_"
52
52
  SCANNER_MODE = [
53
- "all", "compare", "reuse", "prechecker", "binary",
53
+ "all", "compare", "binary",
54
54
  "bin", "src", "source", "dependency", "dep"
55
55
  ]
56
56
 
57
57
 
58
58
  def run_dependency(path_to_analyze, output_file_with_path, params="", path_to_exclude=[]):
59
- result_list = []
59
+ result = []
60
60
 
61
61
  package_manager = ""
62
62
  pip_activate_cmd = ""
@@ -90,7 +90,7 @@ def run_dependency(path_to_analyze, output_file_with_path, params="", path_to_ex
90
90
  timer.start()
91
91
 
92
92
  try:
93
- success, result = call_analysis_api(
93
+ success, scan_item = call_analysis_api(
94
94
  path_to_analyze, "Dependency Analysis",
95
95
  1, run_dependency_scanner,
96
96
  package_manager,
@@ -101,11 +101,11 @@ def run_dependency(path_to_analyze, output_file_with_path, params="", path_to_ex
101
101
  github_token, path_to_exclude=path_to_exclude
102
102
  )
103
103
  if success:
104
- result_list = result.get('SRC_FL_Dependency')
104
+ result = scan_item
105
105
  except Exception as ex:
106
106
  logger.warning(f"Run dependency: {ex}")
107
107
 
108
- return result_list or []
108
+ return result
109
109
 
110
110
 
111
111
  def source_analysis_wrapper(*args, **kwargs):
@@ -130,7 +130,8 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
130
130
  source_time_out=120, binary_simple=False):
131
131
  final_excel_dir = output_path
132
132
  success = True
133
- temp_output_fiiles = []
133
+ all_cover_items = []
134
+ all_scan_item = ScannerItem(PKG_NAME, _start_time)
134
135
  if not remove_src_data:
135
136
  success, final_excel_dir, result_log = init(output_path)
136
137
 
@@ -150,17 +151,7 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
150
151
  if success:
151
152
  output_files = {"SRC": f"fosslight_src_{_start_time}{output_extension}",
152
153
  "BIN": f"fosslight_bin_{_start_time}{output_extension}",
153
- "DEP": f"fosslight_dep_{_start_time}{output_extension}",
154
- "PRECHECKER": f"fosslight_lint_{_start_time}.yaml"}
155
- if run_prechecker:
156
- output_prechecker = os.path.join(_output_dir, output_files["PRECHECKER"])
157
- success, result = call_analysis_api(src_path, "Prechecker Lint",
158
- -1, prechecker_lint,
159
- abs_path, False, output_prechecker,
160
- exclude_path=path_to_exclude)
161
- success_file, copied_file = copy_file(output_prechecker, output_path)
162
- if success_file:
163
- temp_output_fiiles.append(copied_file)
154
+ "DEP": f"fosslight_dep_{_start_time}{output_extension}"}
164
155
 
165
156
  if run_src:
166
157
  try:
@@ -180,6 +171,9 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
180
171
  source_print_matched_text=source_print_matched_text,
181
172
  source_time_out=source_time_out
182
173
  )
174
+ if success:
175
+ all_scan_item.file_items.update(result[2].file_items)
176
+ all_cover_items.append(result[2].cover)
183
177
 
184
178
  else: # Run fosslight_source by using docker image
185
179
  src_output = os.path.join("output", output_files["SRC"])
@@ -195,16 +189,22 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
195
189
  logger.warning(f"Failed to run source analysis: {ex}")
196
190
 
197
191
  if run_bin:
198
- success, _ = call_analysis_api(src_path, "Binary Analysis",
199
- 1, binary_analysis.find_binaries,
200
- abs_path,
201
- os.path.join(_output_dir, output_files["BIN"]),
202
- "", db_url, binary_simple,
203
- correct_mode, correct_fpath,
204
- path_to_exclude=path_to_exclude)
192
+ success, result = call_analysis_api(src_path, "Binary Analysis",
193
+ 1, binary_analysis.find_binaries,
194
+ abs_path,
195
+ os.path.join(_output_dir, output_files["BIN"]),
196
+ "", db_url, binary_simple,
197
+ correct_mode, correct_fpath,
198
+ path_to_exclude=path_to_exclude)
199
+ if success:
200
+ all_scan_item.file_items.update(result.file_items)
201
+ all_cover_items.append(result.cover)
205
202
 
206
203
  if run_dep:
207
- run_dependency(src_path, os.path.join(_output_dir, output_files["DEP"]), dep_arguments, path_to_exclude)
204
+ dep_scanitem = run_dependency(src_path, os.path.join(_output_dir, output_files["DEP"]),
205
+ dep_arguments, path_to_exclude)
206
+ all_scan_item.file_items.update(dep_scanitem.file_items)
207
+ all_cover_items.append(dep_scanitem.cover)
208
208
 
209
209
  else:
210
210
  return
@@ -215,46 +215,23 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
215
215
  try:
216
216
  output_file_without_ext = os.path.join(final_excel_dir, output_file)
217
217
  final_report = f"{output_file_without_ext}{output_extension}"
218
- merge_files = [output_files["SRC"], output_files["BIN"], output_files["DEP"]]
219
218
  cover = CoverItem(tool_name=PKG_NAME,
220
219
  start_time=_start_time,
221
220
  input_path=abs_path,
222
221
  exclude_path=path_to_exclude,
223
222
  simple_mode=False)
224
- cover.comment = merge_cover_comment(_output_dir, merge_files)
225
-
226
- if output_extension == ".xlsx":
227
- tmp_dir = f"tmp_{datetime.now().strftime('%y%m%d_%H%M')}"
228
- exist_src = False
229
- exist_bin = False
230
- if correct_mode:
231
- os.makedirs(os.path.join(_output_dir, tmp_dir), exist_ok=True)
232
- if os.path.exists(os.path.join(_output_dir, output_files['SRC'])):
233
- exist_src = True
234
- shutil.copy2(os.path.join(_output_dir, output_files['SRC']), os.path.join(_output_dir, tmp_dir))
235
- if os.path.exists(os.path.join(_output_dir, output_files['BIN'])):
236
- exist_bin = True
237
- shutil.copy2(os.path.join(_output_dir, output_files['BIN']), os.path.join(_output_dir, tmp_dir))
238
- if exist_src or exist_bin:
239
- correct_scanner_result(_output_dir, output_files, output_extension, exist_src, exist_bin)
240
-
241
- if remove_src_data:
242
- overwrite_excel(_output_dir, default_oss_name, "OSS Name")
243
- overwrite_excel(_output_dir, default_oss_version, "OSS Version")
244
- overwrite_excel(_output_dir, url, "Download Location")
245
- success, err_msg = merge_excels(_output_dir, final_report, merge_files, cover)
246
-
247
- if correct_mode:
248
- if exist_src:
249
- shutil.move(os.path.join(_output_dir, tmp_dir, output_files['SRC']),
250
- os.path.join(_output_dir, output_files['SRC']))
251
- if exist_bin:
252
- shutil.move(os.path.join(_output_dir, tmp_dir, output_files['BIN']),
253
- os.path.join(_output_dir, output_files['BIN']))
254
- shutil.rmtree(os.path.join(_output_dir, tmp_dir), ignore_errors=True)
255
- elif output_extension == ".yaml":
256
- success, err_msg = merge_yamls(_output_dir, merge_files, final_report,
257
- remove_src_data, default_oss_name, default_oss_version, url)
223
+ merge_comment = []
224
+ for ci in all_cover_items:
225
+ merge_comment.append(str(f'[{ci.tool_name}] {ci.comment}'))
226
+ cover.comment = '\n'.join(merge_comment)
227
+ all_scan_item.cover = cover
228
+
229
+ if correct_mode:
230
+ all_scan_item = correct_scanner_result(all_scan_item)
231
+
232
+ if remove_src_data:
233
+ all_scan_item = update_oss_item(all_scan_item, default_oss_name, default_oss_version, url)
234
+ success, err_msg, final_report = write_output_file(output_file_without_ext, output_extension, all_scan_item)
258
235
  if success:
259
236
  if os.path.isfile(final_report):
260
237
  logger.info(f'Generated the result file: {final_report}')
@@ -266,7 +243,7 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
266
243
 
267
244
  if ui_mode:
268
245
  ui_mode_report = f"{output_file_without_ext}.json"
269
- success, err_msg = create_scancodejson(final_report, output_extension, ui_mode_report, src_path)
246
+ success, err_msg = create_scancodejson(all_scan_item, ui_mode_report, src_path)
270
247
  if success and os.path.isfile(ui_mode_report):
271
248
  logger.info(f'Generated the ui mode result file: {ui_mode_report}')
272
249
  else:
@@ -412,19 +389,13 @@ def run_main(mode_list, path_arg, dep_arguments, output_file_or_dir, file_format
412
389
  run_src = False
413
390
  run_bin = False
414
391
  run_dep = False
415
- run_prechecker = False
416
392
  remove_downloaded_source = False
417
393
 
418
394
  if "all" in mode_list or (not mode_list):
419
395
  run_src = True
420
396
  run_bin = True
421
397
  run_dep = True
422
- run_prechecker = False
423
- if "prechecker" in mode_list or "reuse" in mode_list:
424
- run_prechecker = True
425
398
  else:
426
- if "prechecker" in mode_list or "reuse" in mode_list:
427
- run_prechecker = True
428
399
  if "binary" in mode_list or "bin" in mode_list:
429
400
  run_bin = True
430
401
  if "source" in mode_list or "src" in mode_list:
@@ -432,7 +403,7 @@ def run_main(mode_list, path_arg, dep_arguments, output_file_or_dir, file_format
432
403
  if "dependency" in mode_list or "dep" in mode_list:
433
404
  run_dep = True
434
405
 
435
- if run_dep or run_src or run_bin or run_prechecker:
406
+ if run_dep or run_src or run_bin:
436
407
  if src_path == "" and url_to_analyze == "":
437
408
  src_path, dep_arguments, url_to_analyze = get_input_mode(_executed_path, mode_list)
438
409
 
@@ -454,7 +425,7 @@ def run_main(mode_list, path_arg, dep_arguments, output_file_or_dir, file_format
454
425
 
455
426
  if src_path != "":
456
427
  run_scanner(src_path, dep_arguments, output_path, keep_raw_data,
457
- run_src, run_bin, run_dep, run_prechecker,
428
+ run_src, run_bin, run_dep, '',
458
429
  remove_downloaded_source, {}, output_file,
459
430
  output_extension, num_cores, db_url,
460
431
  default_oss_name, default_oss_version, url_to_analyze,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: fosslight-scanner
3
- Version: 1.7.31
3
+ Version: 2.0.0
4
4
  Summary: FOSSLight Scanner
5
5
  Home-page: https://github.com/fosslight/fosslight_scanner
6
6
  Author: LG Electronics
@@ -0,0 +1,10 @@
1
+ future
2
+ pandas
3
+ openpyxl
4
+ progress
5
+ pyyaml
6
+ beautifulsoup4
7
+ fosslight_util>=2.0.0
8
+ fosslight_source>=2.0.0
9
+ fosslight_dependency>=4.0.0
10
+ fosslight_binary>=5.0.0
@@ -1,11 +0,0 @@
1
- future
2
- pandas
3
- openpyxl
4
- progress
5
- pyyaml
6
- beautifulsoup4
7
- fosslight_util~=1.4.48
8
- fosslight_source~=1.7.8
9
- fosslight_dependency~=3.15.1
10
- fosslight_binary~=4.1.30
11
- fosslight_prechecker==3.0.27
@@ -1,298 +0,0 @@
1
- #!/usr/bin/env python
2
- # -*- coding: utf-8 -*-
3
- # FOSSLight Scanner
4
- # Copyright (c) 2020 LG Electronics Inc.
5
- # SPDX-License-Identifier: Apache-2.0
6
- import os
7
- import sys
8
- import logging
9
- import shutil
10
- import pandas as pd
11
- import yaml
12
-
13
- import fosslight_util.constant as constant
14
- from fosslight_util.parsing_yaml import parsing_yml
15
- from fosslight_util.write_yaml import create_yaml_with_ossitem
16
- from fosslight_util.write_scancodejson import write_scancodejson
17
- from fosslight_util.read_excel import read_oss_report
18
- from fosslight_util.output_format import write_output_file
19
- from fosslight_util.oss_item import OssItem
20
-
21
- logger = logging.getLogger(constant.LOGGER_NAME)
22
- SRC_SHEET = 'SRC_FL_Source'
23
- BIN_SHEET = 'BIN_FL_Binary'
24
- BIN_EXT_HEADER = {
25
- 'BIN_FL_Binary': [
26
- 'ID', 'Binary Path', 'OSS Name', 'OSS Version', 'License',
27
- 'Download Location', 'Homepage', 'Copyright Text', 'Exclude',
28
- 'Comment', 'Vulnerability Link', 'TLSH', 'SHA1'
29
- ]
30
- }
31
- BIN_HIDDEN_HEADER = {'TLSH', 'SHA1'}
32
-
33
-
34
- def copy_file(source, destination):
35
- copied_file = ""
36
- try:
37
- shutil.copy(source, destination)
38
- if os.path.isdir(destination):
39
- copied_file = os.path.join(destination, os.path.basename(source))
40
- else:
41
- copied_file = destination
42
- except Exception as ex:
43
- logger.debug(f"Failed to copy {source} to {destination}: {ex}")
44
- return False, copied_file
45
- return True, copied_file
46
-
47
-
48
- def run_analysis(path_to_run, params, func, str_run_start, output, exe_path):
49
- # This function will be replaced by call_analysis_api().
50
- logger.info("## Start to run " + str_run_start)
51
- return_value = ""
52
- try:
53
- if path_to_run:
54
- logger.info(f"|--- Path to analyze : {path_to_run}")
55
- os.chdir(output)
56
- sys.argv = params
57
- return_value = func()
58
- os.chdir(exe_path)
59
- else:
60
- logger.info("Analyzing path is missing...")
61
- except SystemExit:
62
- pass
63
- except Exception as ex:
64
- logger.error(f"{str_run_start}:{ex}")
65
- return return_value
66
-
67
-
68
- def call_analysis_api(path_to_run, str_run_start, return_idx, func, *args, **kwargs):
69
- # return_idx == -1 : Raw return value itself
70
- logger.info(f"## Start to run {str_run_start}")
71
- success = True
72
- result = []
73
- try:
74
- if path_to_run:
75
- logger.info(f"|--- Path to analyze : {path_to_run}")
76
- result = func(*args, **kwargs)
77
- else:
78
- logger.info("Analyzing path is missing...")
79
- except SystemExit:
80
- success = False
81
- except Exception as ex:
82
- success = False
83
- logger.error(f"{str_run_start}:{ex}")
84
- try:
85
- if success and result and return_idx >= 0:
86
- if len(result) > return_idx:
87
- result = result[return_idx]
88
- else:
89
- success = False
90
- except Exception as ex:
91
- logger.debug(f"Get return value:{ex}")
92
- success = False
93
- return success, result or []
94
-
95
-
96
- def overwrite_excel(excel_file_path, oss_name, column_name='OSS Name'):
97
- if oss_name:
98
- try:
99
- files = os.listdir(excel_file_path)
100
- for file in files:
101
- if file.endswith(".xlsx"):
102
- file_path = os.path.join(excel_file_path, file)
103
- excel_file = pd.ExcelFile(file_path, engine='openpyxl')
104
-
105
- for sheet_name in excel_file.sheet_names:
106
- try:
107
- df = pd.read_excel(file_path, sheet_name=sheet_name, engine='openpyxl')
108
- if column_name in df.columns:
109
- updated = (df[column_name] == '') | (df[column_name].isnull())
110
- df.loc[updated, column_name] = oss_name
111
- df.to_excel(file_path, sheet_name=sheet_name, index=False)
112
- except Exception as ex:
113
- logger.debug(f"overwrite_sheet {sheet_name}:{ex}")
114
- except Exception as ex:
115
- logger.debug(f"overwrite_excel:{ex}")
116
-
117
-
118
- def merge_yamls(_output_dir, merge_yaml_files, final_report, remove_src_data=False,
119
- default_oss_name='', default_oss_version='', url=''):
120
- success = True
121
- err_msg = ''
122
-
123
- oss_total_list = []
124
- yaml_dict = {}
125
- try:
126
- for mf in merge_yaml_files:
127
- if os.path.exists(os.path.join(_output_dir, mf)):
128
- oss_list, _, _ = parsing_yml(os.path.join(_output_dir, mf), _output_dir)
129
-
130
- if remove_src_data:
131
- existed_yaml = {}
132
- for oi in oss_list:
133
- oi.name = default_oss_name if oi.name == '' else oi.name
134
- oi.version = default_oss_version if oi.version == '' else oi.version
135
- oi.download_location = url if oi.download_location == '' else oi.download_location
136
- create_yaml_with_ossitem(oi, existed_yaml)
137
- with open(os.path.join(_output_dir, mf), 'w') as f:
138
- yaml.dump(existed_yaml, f, default_flow_style=False, sort_keys=False)
139
-
140
- oss_total_list.extend(oss_list)
141
-
142
- if oss_total_list != []:
143
- for oti in oss_total_list:
144
- create_yaml_with_ossitem(oti, yaml_dict)
145
- with open(os.path.join(_output_dir, final_report), 'w') as f:
146
- yaml.dump(yaml_dict, f, default_flow_style=False, sort_keys=False)
147
- else:
148
- success = False
149
- err_msg = "Output file is not created as no oss items detected."
150
- except Exception as ex:
151
- err_msg = ex
152
- success = False
153
-
154
- return success, err_msg
155
-
156
-
157
- def create_scancodejson(final_report, output_extension, ui_mode_report, src_path=""):
158
- success = True
159
- err_msg = ''
160
-
161
- oss_total_list = []
162
- root_dir = ""
163
- root_strip = ""
164
- try:
165
- src_path = os.path.abspath(src_path)
166
- parent = os.path.basename(src_path)
167
- root_strip = src_path.replace(parent, "")
168
- root_dir = parent
169
- except Exception:
170
- root_dir = ""
171
-
172
- try:
173
- item_without_oss = OssItem("")
174
- oss_total_list = get_osslist(os.path.dirname(final_report), os.path.basename(final_report),
175
- output_extension, '')
176
- if src_path:
177
- for root, dirs, files in os.walk(src_path):
178
- root = root.replace(root_strip, "")
179
- for file in files:
180
- item_path = os.path.join(root, file)
181
- item_path = item_path.replace(parent + os.path.sep, '', 1)
182
- included = any(item_path in x.source_name_or_path for x in oss_total_list)
183
- if not included:
184
- item_without_oss.source_name_or_path = item_path
185
- if len(item_without_oss.source_name_or_path) > 0:
186
- oss_total_list.append(item_without_oss)
187
- if root_dir:
188
- for oss in oss_total_list:
189
- tmp_path_list = oss.source_name_or_path
190
- oss.source_name_or_path = ""
191
- oss.source_name_or_path = [os.path.join(root_dir, path) for path in tmp_path_list]
192
-
193
- write_scancodejson(os.path.dirname(ui_mode_report), os.path.basename(ui_mode_report),
194
- oss_total_list)
195
- except Exception as ex:
196
- err_msg = ex
197
- success = False
198
-
199
- return success, err_msg
200
-
201
-
202
- def correct_scanner_result(_output_dir, output_files, output_extension, exist_src, exist_bin):
203
- src_oss_list = []
204
- bin_oss_list = []
205
- duplicates = False
206
-
207
- if exist_src:
208
- src_oss_list = check_exclude_dir(get_osslist(_output_dir, output_files['SRC'], output_extension, SRC_SHEET))
209
- if exist_bin:
210
- bin_oss_list = check_exclude_dir(get_osslist(_output_dir, output_files['BIN'], output_extension, BIN_SHEET))
211
-
212
- if exist_src and exist_bin:
213
- try:
214
- remove_src_idx_list = []
215
- for idx_src, src_item in enumerate(src_oss_list):
216
- dup_flag = False
217
- for bin_item in bin_oss_list:
218
- if (not src_item.source_name_or_path):
219
- continue
220
- if src_item.source_name_or_path[0] == bin_item.source_name_or_path[0]:
221
- dup_flag = True
222
- if not bin_item.license and src_item.license:
223
- src_item.exclude = bin_item.exclude
224
- bin_item.set_sheet_item(src_item.get_print_array(constant.FL_BINARY)[0])
225
- if bin_item.comment:
226
- bin_item.comment += '/'
227
- bin_item.comment += 'Loaded from SRC OSS info'
228
- if dup_flag:
229
- remove_src_idx_list.append(idx_src)
230
- if remove_src_idx_list:
231
- duplicates = True
232
- for i in sorted(remove_src_idx_list, reverse=True):
233
- del src_oss_list[i]
234
- except Exception as ex:
235
- logger.warning(f"correct the scanner result:{ex}")
236
-
237
- try:
238
- if exist_src:
239
- success, err_msg = write_output_with_osslist(src_oss_list, _output_dir, output_files['SRC'],
240
- output_extension, SRC_SHEET)
241
- if not success:
242
- logger.warning(err_msg)
243
- if exist_bin:
244
- success, err_msg = write_output_with_osslist(bin_oss_list, _output_dir, output_files['BIN'],
245
- output_extension, BIN_SHEET, BIN_EXT_HEADER, BIN_HIDDEN_HEADER)
246
- if not success:
247
- logger.warning(err_msg)
248
- if duplicates:
249
- logger.info('Success to correct the src/bin scanner result')
250
- except Exception as ex:
251
- logger.warning(f"Corrected src/bin scanner result:{ex}")
252
- return
253
-
254
-
255
- def write_output_with_osslist(oss_list, output_dir, output_file, output_extension, sheetname, extended_hdr={}, hidden_hdr={}):
256
- new_oss_list = []
257
- sheet_list = {}
258
- sheet_list[sheetname] = []
259
-
260
- for src_item in oss_list:
261
- scanner_name = constant.supported_sheet_and_scanner[sheetname]
262
- new_oss_list.append(src_item.get_print_array(scanner_name)[0])
263
- sheet_list[sheetname].extend(new_oss_list)
264
- if os.path.exists(os.path.join(output_dir, output_file)):
265
- os.remove(os.path.join(output_dir, output_file))
266
- success, err_msg, _ = write_output_file(os.path.join(output_dir, output_file).rstrip(output_extension),
267
- output_extension, sheet_list, extended_hdr, hidden_hdr)
268
- return success, err_msg
269
-
270
-
271
- def get_osslist(_output_dir, output_file, output_extension, sheet_name=''):
272
- err_reason = ''
273
- oss_list = []
274
- oss_file_with_fullpath = os.path.join(_output_dir, output_file)
275
-
276
- if os.path.exists(oss_file_with_fullpath):
277
- if output_extension == '.xlsx':
278
- oss_list = read_oss_report(oss_file_with_fullpath, sheet_name)
279
- elif output_extension == '.yaml':
280
- oss_list, _, err_reason = parsing_yml(oss_file_with_fullpath, _output_dir)
281
- else:
282
- err_reason = f'Not supported extension: {output_extension}'
283
- if err_reason:
284
- logger.info(f'get_osslist: {err_reason}')
285
- return oss_list
286
-
287
-
288
- def check_exclude_dir(oss_list):
289
- _exclude_dirs = ["venv", "node_modules", "Pods", "Carthage"]
290
-
291
- for oss_item in oss_list:
292
- if not oss_item.source_name_or_path:
293
- continue
294
- for exclude_dir in _exclude_dirs:
295
- if exclude_dir in oss_item.source_name_or_path[0].split(os.path.sep):
296
- oss_item.exclude = True
297
- break
298
- return oss_list
@@ -1,11 +0,0 @@
1
- future
2
- pandas
3
- openpyxl
4
- progress
5
- pyyaml
6
- beautifulsoup4
7
- fosslight_util~=1.4.48
8
- fosslight_source~=1.7.8
9
- fosslight_dependency~=3.15.1
10
- fosslight_binary~=4.1.30
11
- fosslight_prechecker==3.0.27