Merge branch 'main' into develop

Author: dd-jy

.bumpversion.cfg

@@ -2,7 +2,7 @@
 commit = True
 tag = False
 message = Bump version: {current_version} → {new_version}
-current_version = 1.6.12
+current_version = 1.7.1
 
 [bumpversion:file:setup.py]
 search = '{current_version}'

.github/workflows/pull-request.yml

@@ -4,9 +4,33 @@ name: Pull requests fosslight_scanner
 
 on:
   pull_request:
-    branches: [ main ]
+    branches:
+      - '*'
 
 jobs:
+  check-commit-message:
+    name: Check Commit Message
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get PR Commits
+        id: 'get-pr-commits'
+        uses: tim-actions/get-pr-commits@master
+        with:
+          token: ${{ secrets.TOKEN }}
+
+      - name: Check Subject Line Length
+        uses: tim-actions/[email protected]
+        with:
+          commits: ${{ steps.get-pr-commits.outputs.commits }}
+          pattern: '^.{0,50}(\n.*)*$'
+          error: 'Subject too long (max 50)'
+      - name: Check Body Line Length
+        if: ${{ success() || failure() }}
+        uses: tim-actions/[email protected]
+        with:
+          commits: ${{ steps.get-pr-commits.outputs.commits }}
+          pattern: '^.+(\n.{0,72})*$'
+          error: 'Body line too long (max 72)'
   build:
     runs-on: ubuntu-latest
     strategy:

CHANGELOG.md

@@ -1,5 +1,61 @@
 # Changelog
 
+## v1.7.1 (22/07/2022)
+## Changes
+## 🐛 Hotfixes
+
+- Change FL Reuse to FL Prechecker @bjk7119 (#43)
+
+---
+
+## v1.7.0 (22/07/2022)
+## Changes
+## 🚀 Features
+
+- Add compare mode @dd-jy (#38)
+
+## 🔧 Maintenance
+
+- Replace 'y' option to 'p' option. @dd-jy (#41)
+- Fix scanner support format and not to create csv. @dd-jy (#40)
+- Print message when comparison rows are over 100. @dd-jy (#39)
+
+---
+
+## v1.6.15 (06/07/2022)
+## Changes
+## 🐛 Hotfixes
+
+- Modify reuse input parameter @bjk7119 (#37)
+
+---
+
+## v1.6.14 (19/05/2022)
+## Changes
+## 🚀 Features
+
+- Run fosslight_source without installing it @soimkim (#34)
+- Add a Dockerfile @soimkim (#35)
+
+## 🐛 Hotfixes
+
+- Fix a bug where part of the output file is not created without the -o option @soimkim (#36)
+
+---
+
+## v1.6.13 (11/04/2022)
+## Changes
+## 🐛 Hotfixes
+
+- Fix an errors when parsing with path @soimkim (#33)
+- Fix an error that occur when downloading link @soimkim (#30)
+
+## 🔧 Maintenance
+
+- Add a commit message checker @soimkim (#31)
+
+---
+
 ## v1.6.12 (28/03/2022)
 ## 🐛 Hotfixes
 

Dockerfile

@@ -0,0 +1,25 @@
+# Copyright (c) 2022 LG Electronics Inc.
+# SPDX-License-Identifier: Apache-2.0
+FROM	ubuntu:20.04
+
+RUN 	apt-get update && apt-get install sudo -y
+RUN	ln -sf /bin/bash /bin/sh
+
+COPY	. /app
+WORKDIR	/app
+
+ENV 	DEBIAN_FRONTEND=noninteractive
+
+RUN	apt-get -y install build-essential
+RUN     apt-get -y install python3 python3-distutils python3-pip python3-dev
+RUN	apt-get -y install python3-intbitset python3-magic
+RUN	apt-get -y install libxml2-dev
+RUN	apt-get -y install libxslt1-dev
+RUN 	apt-get -y install libhdf5-dev
+RUN 	apt-get -y install bzip2 xz-utils zlib1g libpopt0 
+RUN	apt-get -y install gcc-10 g++-10
+RUN	pip3 install --upgrade pip
+RUN	pip3 install .
+RUN	pip3 install dparse
+
+ENTRYPOINT ["/usr/local/bin/fosslight"] 

README.md

@@ -11,7 +11,7 @@ SPDX-License-Identifier: Apache-2.0
 
 **FOSSLight Scanner** performs open source analysis after downloading the source by passing a link that can be cloned by wget or git. Instead, open source analysis can be performed for the local source path. The output result is generated in [FOSSLight Report][or] format.
 
-- **[FOSSLight Reuse][re]** Check whether the [source code's copyright and license writing rules][rule] are complied with.
+- **[FOSSLight Prechecker][re]** Check whether the [source code's copyright and license writing rules][rule] are complied with.
 - **[FOSSLight Source Scanner][s]** Extract license and copyright in the source code using [ScanCode][sc].
 - **[FOSSLight Dependency Scanner][d]** Extract dependency and OSS information from the package manager's manifest file.
 - **[FOSSLight Binary Scanner][flbin]** Find binary and print OSS information.
@@ -21,7 +21,7 @@ SPDX-License-Identifier: Apache-2.0
 [sc]: https://github.com/nexB/scancode-toolkit
 [or]: https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html
 [flbin]: https://github.com/fosslight/fosslight_binary_scanner
-[re]: https://github.com/fosslight/fosslight_reuse
+[re]: https://github.com/fosslight/fosslight_prechecker
 [rule]: https://oss.lge.com/guide/process/osc_process/1-identification/copyright_license_rule.html
 
 ## Contents
@@ -35,6 +35,7 @@ SPDX-License-Identifier: Apache-2.0
     - [Ex 1. Local Source Analysis](#ex-1-local-source-analysis)
     - [Ex 2. Download Link and analyze](#ex-2-download-link-and-analyze)
   - [📁 Result](#-result)
+  - [🐳 How to run using Docker](#-how-to-run-using-docker)
   - [👏 How to report issue](#-how-to-report-issue)
   - [📄 License](#-license)
 
@@ -64,7 +65,7 @@ Mode
             source            Run FOSSLight Source
             dependency        Run FOSSLight Dependency
             binary            Run FOSSLight Binary
-            reuse             Run FOSSLight Reuse
+            prechecker        Run FOSSLight Prechecker
             all               Run all scanners
 ``` 
 Options:
@@ -111,6 +112,17 @@ $ tree
 - FOSSLight_Report-[datetime].xlsx : OSS Report format file that outputs source code analysis, binary analysis, and dependency analysis results.
 - fosslight_raw_data_[datetime] directory: Directory in which raw data files are created as a result of analysis
 
+## 🐳 How to run using Docker
+1. Build image using Dockerfile.
+```
+$docker build -t fosslight .
+```
+2. Run with the image you built.      
+ex. Output: /Users/fosslight_source_scanner/test_output, Path to be analyzed: tests/test_files
+```
+$docker run -it -v /Users/fosslight_source_scanner/test_output:/app/output fosslight -p tests/test_files -o output
+```
+
 ## 👏 How to report issue
 
 Please report any ideas or bugs to improve by creating an issue in [fosslight_scanner repository][cl].    

requirements.txt

@@ -9,4 +9,4 @@ beautifulsoup4
 fosslight_util>=1.4.1
 fosslight_dependency>=3.7.4
 fosslight_binary>=4.0.7
-fosslight_reuse>=2.2.1
+fosslight_prechecker>=3.0.1

setup.py

@@ -15,7 +15,7 @@
 if __name__ == "__main__":
     setup(
         name='fosslight_scanner',
-        version='1.6.12',
+        version='1.7.1',
         package_dir={"": "src"},
         packages=find_packages(where='src'),
         description='FOSSLight Scanner',

src/fosslight_scanner/_help.py

@@ -16,7 +16,7 @@
             source\t\t    Run FOSSLight Source
             dependency\t\t    Run FOSSLight Dependency
             binary\t\t    Run FOSSLight Binary
-            reuse\t\t    Run FOSSLight Reuse
+            prechecker\t\t    Run FOSSLight Prechecker
             all\t\t\t    Run all scanners
             compare\t\t    Compare two FOSSLight reports in yaml format
 

src/fosslight_scanner/cli.py

@@ -10,7 +10,7 @@
 
 def main():
     parser = ArgumentParser(description='FOSSLight Scanner', prog='fosslight_scanner', add_help=False)
-    parser.add_argument('mode', nargs='?', help='source| dependency| binary| reuse| all| compare', default="all")
+    parser.add_argument('mode', nargs='?', help='source| dependency| binary| prechecker| all| compare', default="all")
     parser.add_argument('--path', '-p', help='Path to analyze (In compare mode, two FOSSLight reports',
                         dest='path', nargs='+', default="")
     parser.add_argument('--wget', '-w', help='Link to be analyzed', type=str, dest='link', default="")

src/fosslight_scanner/fosslight_scanner.py

@@ -20,7 +20,7 @@
 from fosslight_util.timer_thread import TimerThread
 import fosslight_util.constant as constant
 from fosslight_util.output_format import check_output_format
-from fosslight_reuse._fosslight_reuse import run_lint as reuse_lint
+from fosslight_prechecker._precheck import run_lint as prechecker_lint
 from .common import (copy_file, call_analysis_api,
                      overwrite_excel, extract_name_from_link,
                      merge_yamls)
@@ -100,7 +100,7 @@ def run_dependency(path_to_analyze, output_file_with_path, params=""):
 
 
 def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
-                run_src=True, run_bin=True, run_dep=True, run_reuse=True,
+                run_src=True, run_bin=True, run_dep=True, run_prechecker=True,
                 remove_src_data=True, result_log={}, output_file="",
                 output_extension="", num_cores=-1, db_url="",
                 default_oss_name="", url=""):
@@ -130,14 +130,15 @@ def run_scanner(src_path, dep_arguments, output_path, keep_raw_data=False,
                             "BIN": f"FL_Binary{output_extension}",
                             "BIN_TXT": "FL_Binary.txt",
                             "DEP": f"FL_Dependency{output_extension}",
-                            "REUSE": "FL_Reuse.yaml"}
-            if run_reuse:
-                output_reuse = os.path.join(_output_dir, output_files["REUSE"])
-                success, result = call_analysis_api(src_path, "Reuse Lint",
-                                                    -1, reuse_lint,
+
+                            "PRECHECKER": "FL_Prechecker.yaml"}
+            if run_prechecker:
+                output_prechecker = os.path.join(_output_dir, output_files["PRECHECKER"])
+                success, result = call_analysis_api(src_path, "Prechecker Lint",
+                                                    -1, prechecker_lint,
                                                     abs_path, False,
-                                                    output_reuse)
-                success_file, copied_file = copy_file(output_reuse, output_path)
+                                                    output_prechecker)
+                success_file, copied_file = copy_file(output_prechecker, output_path)
                 if success_file:
                     temp_output_fiiles.append(copied_file)
 
@@ -323,13 +324,13 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
             run_src = False
             run_bin = False
             run_dep = False
-            run_reuse = False
+            run_prechecker = False
             remove_downloaded_source = False
             if output_path == "":
                 output_path = _executed_path
 
-            if mode == "reuse":
-                run_reuse = True
+            if mode == "prechecker" or mode == "reuse":
+                run_prechecker = True
             elif mode == "binary" or mode == "bin":
                 run_bin = True
             elif mode == "source" or mode == "src":
@@ -340,7 +341,7 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
                 run_src = True
                 run_bin = True
                 run_dep = True
-                run_reuse = True
+                run_prechecker = True
 
             if src_path == "" and url_to_analyze == "":
                 src_path, dep_arguments, url_to_analyze = get_input_mode()
@@ -357,7 +358,7 @@ def run_main(mode, path_arg, dep_arguments, output_file_or_dir, file_format, url
 
             if src_path != "":
                 run_scanner(src_path, dep_arguments, output_path, keep_raw_data,
-                            run_src, run_bin, run_dep, run_reuse,
+                            run_src, run_bin, run_dep, run_prechecker,
                             remove_downloaded_source, {}, output_file,
                             output_extension, num_cores, db_url,
                             default_oss_name, url_to_analyze)