Merge pull request #116 from fosslight/develop

Add tox configuration for Windows

Author: bjk7119

.github/workflows/pull-request.yml

@@ -40,7 +40,7 @@ jobs:
           - os: ubuntu-latest
             TARGET: ubuntu
             CMD_BUILD: >
-                tox -e release
+                tox -e ubuntu
             OUT_FILE_NAME: fosslight_bin_ubuntu18
             ASSET_MIME: application/octet-stream
           - os: windows-latest
@@ -49,6 +49,7 @@ jobs:
                 pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks &&
                 move dist/cli.exe fosslight_prechecker_windows.exe &&
                 ./fosslight_prechecker_windows.exe
+                tox -e windows
             OUT_FILE_NAME: fosslight_prechecker_windows.exe
             ASSET_MIME: application/vnd.microsoft.portable-executable
     steps:

src/fosslight_oss_pkg/_parsing_excel.py

@@ -49,12 +49,12 @@ def convert_yml_to_excel(oss_yaml_files, output_file, file_option_on, base_path)
                 oss_items, _ = parsing_yml(yaml_file, base_path)
                 for item in oss_items:
                     items_to_print.extend(item.get_print_array())
-                if not base_path.endswith("/"):
-                    base_path += "/"
+                if not base_path.endswith(f"{os.sep}"):
+                    base_path += f"{os.sep}"
                 yaml_file = yaml_file.replace(base_path, '')
-                yaml_file = yaml_file.replace('/', '_')
-
+                yaml_file = yaml_file.replace(os.sep, '_')
                 yaml_file_sheet = get_sheet_name(yaml_file, sheet_list)
+
                 if yaml_file_sheet:
                     sheet_list[yaml_file_sheet] = items_to_print
                     header[yaml_file_sheet] = HEADER_CONTENT
@@ -69,6 +69,6 @@ def convert_yml_to_excel(oss_yaml_files, output_file, file_option_on, base_path)
             else:
                 logger.warning("Nothing is detected to convert so output file is not generated.")
         else:
-            logger.error(f"Error to write excel file : {msg}")
+            logger.error(f"Fail to write excel file : {msg}")
     except Exception as ex:
         logger.error(f"Error to write excel file : {ex}")

src/fosslight_prechecker/_precheck.py

@@ -40,18 +40,18 @@ def exclude_untracked_files(path):
         cmd_result = subprocess.check_output(['git', 'ls-files', '-o'], universal_newlines=True)
         cmd_result = cmd_result.split('\n')
         cmd_result.remove('')
-        if not path.endswith("/"):
-            path += "/"
+        if not path.endswith(f"{os.sep}"):
+            path += f"{os.sep}"
         cmd_result = [file.replace(path, '', 1) for file in cmd_result]
         DEFAULT_EXCLUDE_EXTENSION_FILES.extend(cmd_result)
     except Exception as ex:
         logger.error(f"Error to get git untracked files : {ex}")
 
 
-def exclude_gitignore_files(path):
+def exclude_gitignore_files(current_path, path):
     global DEFAULT_EXCLUDE_EXTENSION_FILES
     try:
-        root_path = VCSStrategyGit.find_root(path)
+        root_path = VCSStrategyGit.find_root(current_path)
         if os.path.isfile(os.path.join(root_path, '.gitignore')):
             cmd_result = subprocess.check_output(['git',
                                                   'ls-files',
@@ -60,8 +60,8 @@ def exclude_gitignore_files(path):
                                                  universal_newlines=True)
             cmd_result = cmd_result.split('\n')
             cmd_result.remove('')
-            if not path.endswith("/"):
-                path += "/"
+            if not path.endswith(f"{os.sep}"):
+                path += f"{os.sep}"
             cmd_result = [file.replace(path, '', 1) for file in cmd_result]
             DEFAULT_EXCLUDE_EXTENSION_FILES.extend(cmd_result)
         else:
@@ -80,7 +80,7 @@ def exclude_git_related_files(path):
         # Exclude untracked files
         exclude_untracked_files(path)
         # Exclude ignore files
-        exclude_gitignore_files(path)
+        exclude_gitignore_files(current_path, path)
 
         # Restore path
         os.chdir(current_path)
@@ -244,14 +244,14 @@ def precheck_for_project(path_to_find, mode='lint'):
 
         # File list that missing license text
         missing_license = [str(sub) for sub in set(report.files_without_licenses)]
-        if not path_to_find.endswith("/"):
-            path_to_find += "/"
+        if not path_to_find.endswith(f"{os.sep}"):
+            path_to_find += f"{os.sep}"
         missing_license = [sub.replace(path_to_find, '') for sub in missing_license]
 
         # File list that missing copyright text
         missing_copyright = [str(sub) for sub in set(report.files_without_copyright)]
-        if not path_to_find.endswith("/"):
-            path_to_find += "/"
+        if not path_to_find.endswith(f"{os.sep}"):
+            path_to_find += f"{os.sep}"
         missing_copyright = [sub.replace(path_to_find, '') for sub in missing_copyright]
     except Exception as ex:
         dump_error_msg(f"Error prechecker lint: {ex}", True)

src/fosslight_prechecker/cli.py

@@ -40,7 +40,7 @@ def main():
     parser.add_argument('-o', '--output', help='Output file name', type=str, dest='output', default="")
     parser.add_argument('-l', '--license', help="License name to add(used in only 'add' mode)", type=str, dest='license', default="")
     parser.add_argument('-c', '--copyright', help="Copyright to add(used in only 'add' mode)", type=str, dest='copyright', default="")
-    parser.add_argument('--notice', action='store_true', required=False)
+    parser.add_argument('--notice', help="Show OSS notice", action='store_true', required=False)
     try:
         args = parser.parse_args()
     except SystemExit:

src/fosslight_prechecker/resources/convert_license.json

@@ -26,6 +26,12 @@
     "apgl3.0": "APGL-3.0",
     "agplv3": "AGPL-3.0",
     "mit": "MIT",
+    "epl-1.0": "EPL-1.0",
+    "epl 1.0": "EPL-1.0",
+    "epl1.0": "EPL-1.0",
+    "epl-2.0": "EPL-2.0",
+    "epl 2.0": "EPL-2.0",
+    "epl2.0": "EPL-2.0",
     "lge": "LicenseRef-LGE_Proprietary_License",
     "lge license": "LicenseRef-LGE_Proprietary_License",
     "lge proprietary": "LicenseRef-LGE_Proprietary_License",

tox.ini

@@ -1,14 +1,17 @@
 # Copyright (c) 2021 LG Electronics
 # SPDX-License-Identifier: GPL-3.0-only
 [tox]
-envlist = test_run
+envlist = {ubuntu, windows}
 skipdist = true
 
 [testenv]
 install_command = pip install {opts} {packages}
 whitelist_externals = cat
                       cp
                       rm
+                      cmd
+                      del
+                      copy
 setenv =
   PYTHONPATH=.
 
@@ -19,17 +22,30 @@ exclude = .tox/*
 [pytest]
 filterwarnings = ignore::DeprecationWarning
 
-[testenv:test_run]
+[testenv:windows]
+commands = 
+    fosslight_prechecker lint -p src -o "test_result\prechecker_result.yaml"
+    fosslight_prechecker lint -p src -f yaml -o "test_result2\prechecker_result.yaml"
+    fosslight_prechecker convert -p "tests\convert"
+    cmd /c del /s/q tests\add_result
+    cmd /c del /s/q tests\add\LICENSES
+    cmd /c del /s/q tests\add\LICENSE
+    cmd /c copy tests\add tests\add_result
+    fosslight_prechecker add -p "tests\add_result" -c "2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
+    fosslight_prechecker add -p "tests\add" -l "EPL-1.0"
+
+[testenv:ubuntu]
 commands =
     fosslight_prechecker lint -p src/ -o "test_result/prechecker_result.yaml"
     fosslight_prechecker lint -p src/ -f yaml -o "test_result2/prechecker_result.yaml"
-    fosslight_prechecker convert -p tests/convert
+    fosslight_prechecker convert -p "tests/convert"
     rm -rf tests/add_result
     rm -rf tests/add/LICENSES
     rm -rf tests/add/LICENSE
     cp -r tests/add tests/add_result
-    fosslight_prechecker add -p tests/add_result -c "2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
-    fosslight_prechecker add -p tests/add -l EPL-1.0
+    fosslight_prechecker add -p "tests/add_result" -c "2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
+    fosslight_prechecker add -p "tests/add" -l "EPL-1.0"
+
 [testenv:release]
 deps =
     -r{toxinidir}/requirements-dev.txt