Merge pull request #73 from fosslight/develop

soimkim · web-flow · commit 0c4f4aac2469 · 2022-06-27T15:25:05.000+09:00
Add generating html format file
diff --git a/src/fosslight_reuse/_constant.py b/src/fosslight_reuse/_constant.py
@@ -8,3 +8,67 @@
 OSS_PKG_INFO_FILES = ["oss-pkg-info.yaml", "oss-pkg-info.yml", r"oss-package*.info", "requirement.txt",
                       "requirements.txt", "package.json", "pom.xml", "build.gradle", "podfile.lock", "cartfile.resolved",
                       "pubspec.yaml", "package.resolved", "go.mod", r"fosslight-sbom-info*.yaml"]
+
+HTML_FORMAT_PREFIX = """
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/strict.dtd">
+<html lang="ko">
+    <head>
+        <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+        <style>
+            .marker{background-color: Yellow;}
+        </style>
+        <title>FOSSLight Reuse</title>
+    </head>
+    <body>
+        <table cellspacing="0" cellpadding="0" border="0" style="font-family:'arial,sans-serif'">
+            <tr>
+                <td colspan="3" height="28" style="background:#f9f9f9"></td>
+            </tr>
+            <tr>
+                <td width="60" style="background:#f9f9f9"></td>
+                <td>
+                    <table cellspacing="0" cellpadding="0" border="0">
+                        <tr>
+                            <td colspan="3" height="25" style="background:#c00c3f">
+                                <h1 style="margin:0;padding-left:5px;font-size:14px;color:white">FOSSLight Reuse Lint</h1>
+                            </td>
+                        </tr>
+                        <tr>
+                            <td width="1" style="background:#ddd"></td>
+                            <td style="padding:40px;">
+                                <div style="padding-bottom:10px;font-size:16px;font-weight:bold;">"""
+
+HTML_COMPLIANCE_SUFFIX = """
+                            </div>
+                            <p style="font-size:12px;">
+                            """
+
+HTML_CELL_PREFIX = """
+                                <h2 style="margin:20px 0 0;padding:10px;font-size:16px;">« Files without License or Copyright »</h2>
+                                <table cellspacing="0" cellpadding="0" width="100%" border="1" style="font-size:12px;border-color:#ddd;">
+                                    <tr>
+                                        <th style="padding:5px;background:#f0f0f0;">File</th>
+                                        <th style="padding:5px;background:#f0f0f0;">License</th>
+                                        <th style="padding:5px;background:#f0f0f0;">Copyright</th>
+                                    </tr>"""
+
+HTML_FORMAT_SUFFIX = """
+                                </table>
+                                <br/>
+                             </td>
+                            <td width="1" style="background:#ddd"></td>
+                        </tr>
+                        <tr>
+                            <td colspan="3" height="1" style="background:#ddd"></td>
+                        </tr>
+                    </table>
+                </td>
+                <td width="60" style="background:#f9f9f9"></td>
+            </tr>
+            <tr>
+                <td colspan="3" height="28" style="background:#f9f9f9"></td>
+            </tr>
+        </table>
+    </body>
+</html>
+"""
diff --git a/src/fosslight_reuse/_fosslight_reuse.py b/src/fosslight_reuse/_fosslight_reuse.py
@@ -342,7 +342,8 @@ def run_lint(target_path, disable, output_file_name, format='', need_log_file=Tr
                                          lic_present_files_in_yaml,
                                          cop_present_files_in_yaml)
 
-        success, exit_code = write_result_file(result_file, output_extension, _exit_code, result_item, _result_log)
+        success, exit_code = write_result_file(result_file, output_extension, _exit_code,
+                                               result_item, _result_log, project, path_to_find)
         if success:
             logger.warning(f"Created file name: {result_file}\n")
         else:
diff --git a/src/fosslight_reuse/_result.py b/src/fosslight_reuse/_result.py
@@ -9,8 +9,11 @@
 import xml.etree.ElementTree as ET
 import logging
 import fosslight_util.constant as constant
-from fosslight_util.output_format import check_output_format
 from pathlib import Path
+from reuse.project import Project
+from fosslight_reuse._result_html import result_for_html
+from fosslight_util.output_format import check_output_format
+
 
 CUSTOMIZED_FORMAT_FOR_REUSE = {'html': '.html', 'xml': '.xml', 'yaml': '.yaml'}
 RULE_LINK = "https://oss.lge.com/guide/process/osc_process/1-identification/copyright_license_rule.html"
@@ -27,6 +30,7 @@ def __init__(self):
         self._oss_pkg_files = []
         self._detected_licenses = []
         self._count_total_files = ""
+        self._count_without_both = ""
         self._count_without_lic = ""
         self._count_without_cop = ""
         self._files_without_both = []
@@ -49,7 +53,7 @@ def compliant_result(self, value):
         if value:
             self._compliant_result = "OK"
         else:
-            self._compliant_result = "Not OK"
+            self._compliant_result = "Not-OK"
 
     @property
     def oss_pkg_files(self):
@@ -59,7 +63,7 @@ def get_print_yaml(self):
         result_item = {}
         result_item["Compliant"] = self._compliant_result
         result_summary_item = {}
-        result_summary_item["Open Source Package File"] = self._oss_pkg_files
+        result_summary_item["Open Source Package File"] = is_list_empty(self._oss_pkg_files)
         result_summary_item["Detected Licenses"] = is_list_empty(self._detected_licenses)
         result_summary_item["Files without license / total"] = f"{self._count_without_lic} / {self._count_total_files}"
         result_summary_item["Files without copyright / total"] = f"{self._count_without_cop} / {self._count_total_files}"
@@ -133,7 +137,7 @@ def result_for_xml(result_item: ResultItem):
     return _root_xml_item
 
 
-def write_result_xml(result_file: str, exit_code: int, result_item: ResultItem, _result_log: str) -> None:
+def write_result_xml(result_file: str, exit_code: int, result_item: ResultItem, _result_log: str):
     success = False
     # Create a new XML file with the results
     try:
@@ -148,19 +152,22 @@ def write_result_xml(result_file: str, exit_code: int, result_item: ResultItem,
     return success, exit_code
 
 
-def write_result_html(result_file: str, exit_code: int, _result_log: str) -> None:
+def write_result_html(result_file: str, exit_code: int, result_item: ResultItem, project: Project, path_to_find):
     success = False
     try:
         output_dir = os.path.dirname(result_file)
         Path(output_dir).mkdir(parents=True, exist_ok=True)
+        html_result = result_for_html(result_item, project, path_to_find)
+        with open(result_file, 'w') as f:
+            f.write(html_result)
         success = True
     except Exception as ex:
         logger.error(f"Error_to_write_html: {ex}")
         exit_code = os.EX_IOERR
     return success, exit_code
 
 
-def write_result_yaml(result_file: str, exit_code: int, result_item: ResultItem) -> None:
+def write_result_yaml(result_file: str, exit_code: int, result_item: ResultItem):
     success = False
     try:
         output_dir = os.path.dirname(result_file)
@@ -206,7 +213,7 @@ def create_result_file(output_file_name, format='', _start_time=""):
 
 
 def result_for_summary(oss_pkg_info_files, license_missing_files, copyright_missing_files,
-                       report, _result_log, _check_only_file_mode, file_to_check_list, error_items,
+                       prj_report, _result_log, _check_only_file_mode, file_to_check_list, error_items,
                        excluded_files, lic_present_files_in_yaml, cop_present_files_in_yaml):
     reuse_compliant = False
     detected_lic = []
@@ -216,9 +223,9 @@ def result_for_summary(oss_pkg_info_files, license_missing_files, copyright_miss
     if _check_only_file_mode:
         file_total = len(file_to_check_list)
     else:
-        file_total = len(report.file_reports)
+        file_total = len(prj_report.file_reports)
         # Get detected License
-        for i, lic in enumerate(sorted(report.used_licenses)):
+        for i, lic in enumerate(sorted(prj_report.used_licenses)):
             detected_lic.append(lic)
 
     # Subtract license or copyright presenting file and excluded file
@@ -245,6 +252,7 @@ def result_for_summary(oss_pkg_info_files, license_missing_files, copyright_miss
     result_item._oss_pkg_files = oss_pkg_info_files
     result_item._detected_licenses = detected_lic
     result_item._count_total_files = file_total
+    result_item._count_without_both = str(len(missing_both_files))
     result_item._count_without_lic = str(len(license_missing_files) + len(missing_both_files))
     result_item._count_without_cop = str(len(copyright_missing_files) + len(missing_both_files))
     result_item._files_without_both = sorted(missing_both_files)
@@ -259,12 +267,12 @@ def result_for_summary(oss_pkg_info_files, license_missing_files, copyright_miss
     return result_item
 
 
-def write_result_file(result_file, output_extension, exit_code, result_item, _result_log):
+def write_result_file(result_file, output_extension, exit_code, result_item, _result_log, project, path_to_find):
     success = False
     if output_extension == ".yaml" or output_extension == "":
         success, exit_code = write_result_yaml(result_file, exit_code, result_item)
     elif output_extension == ".html":
-        success, exit_code = write_result_html(result_file, exit_code, _result_log)
+        success, exit_code = write_result_html(result_file, exit_code, result_item, project, path_to_find)
     elif output_extension == ".xml":
         success, exit_code = write_result_xml(result_file, exit_code, result_item, _result_log)
     else:
@@ -273,6 +281,6 @@ def write_result_file(result_file, output_extension, exit_code, result_item, _re
     if success:
         # Print yaml result
         yaml_result = result_item.get_print_yaml()
-        str_yaml_result = yaml.safe_dump(yaml_result, allow_unicode=True, sort_keys=True)
+        str_yaml_result = yaml.safe_dump(yaml_result, allow_unicode=True, sort_keys=False)
         logger.info(str_yaml_result)
     return success, exit_code
diff --git a/src/fosslight_reuse/_result_html.py b/src/fosslight_reuse/_result_html.py
@@ -0,0 +1,92 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2022 LG Electronics Inc.
+# SPDX-License-Identifier: GPL-3.0-only
+import os
+from reuse import report
+from reuse.project import Project
+from fosslight_reuse._constant import HTML_FORMAT_PREFIX, HTML_CELL_PREFIX, HTML_FORMAT_SUFFIX, HTML_COMPLIANCE_SUFFIX
+
+
+def get_html_summary(result_item):
+    pkg_file_str = ""
+    detected_lic_str = ""
+    if result_item._oss_pkg_files:
+        for pkg_file in result_item._oss_pkg_files:
+            pkg_file_str += f"<br>&nbsp;&nbsp;&nbsp; - {pkg_file}"
+    else:
+        pkg_file_str = 'N/A'
+
+    if result_item._detected_licenses:
+        for detected_lic in result_item._detected_licenses:
+            detected_lic_str += f"<br>&nbsp;&nbsp;&nbsp; - {detected_lic}"
+    else:
+        detected_lic_str = 'N/A'
+
+    html_lint_str = f"""
+    - Open Source Package file: {pkg_file_str}</br>
+    - Detected licenses: {detected_lic_str}</br>
+    - Files without copyright / total: {result_item._count_without_cop} / {result_item._count_total_files}</br>
+    - Files without license / total: {result_item._count_without_lic} / {result_item._count_total_files}</br></p>
+    """
+    return html_lint_str
+
+
+def get_html_compliance(result_item):
+    return f"Compliant: {result_item.compliant_result}{HTML_COMPLIANCE_SUFFIX}"
+
+
+def get_num_of_not_compliant(result_item):
+    return int(result_item._count_without_lic) + int(result_item._count_without_cop)
+
+
+def get_file_report(project, path_to_find, file):
+    file_abs_path = os.path.abspath(os.path.join(path_to_find, file))
+    file_rep = report.FileReport.generate(project, file_abs_path)
+    return file_rep
+
+
+def get_html_cell(result_item, project: Project, path_to_find):
+    cell_str = ""
+    for both_file in result_item._files_without_both:
+        cell_str += f"""<tr>
+                        <td style="padding:5px;">{both_file}</td>
+                        <td style="padding:5px;"></td>
+                        <td style="padding:5px;"></td>
+                    </tr>"""
+
+    for file in result_item._files_without_lic:
+        file_rep = get_file_report(project, path_to_find, file)
+        cop_text = file_rep.spdxfile.copyright.replace("SPDX-FileCopyrightText: ", "")
+        cell_str += f"""<tr>
+                        <td style="padding:5px;">{file}</td>
+                        <td style="padding:5px;"></td>
+                        <td style="padding:5px;">{cop_text}</td>
+                    </tr>"""
+
+    for file in result_item._files_without_cop:
+        file_rep = get_file_report(project, path_to_find, file)
+        lic_in_file = ', '.join(file_rep.spdxfile.licenses_in_file)
+        cell_str += f"""<tr>
+                        <td style="padding:5px;">{file}</td>
+                        <td style="padding:5px;">{lic_in_file}</td>
+                        <td style="padding:5px;"></td>
+                    </tr>"""
+    return cell_str
+
+
+def result_for_html(result_item, project: Project, path_to_find):
+    compliance_str = get_html_compliance(result_item)
+    summary_str = get_html_summary(result_item)
+    cell_contents_str = ""
+
+    if get_num_of_not_compliant(result_item) <= 100:
+        cell_contents_str = get_html_cell(result_item, project, path_to_find)
+        html_in_str = f"{HTML_FORMAT_PREFIX}{compliance_str}{summary_str}{HTML_CELL_PREFIX}{cell_contents_str}{HTML_FORMAT_SUFFIX}"
+    else:
+        cell_contents_str = "<b> &#9888; There are so many incompliant files, so result can't be printed in html. </b>"
+        html_in_str = f"{HTML_FORMAT_PREFIX}{compliance_str}{summary_str}{cell_contents_str}{HTML_FORMAT_SUFFIX}"
+
+    # if result_item.execution_error:
+    # TODO: How do handle for execution_error in html format?
+    return html_in_str
