third-party-generator.py

#!/usr/bin/python3
# Software Name: floss-toolbox
# SPDX-FileCopyrightText: Copyright (c) Orange SA
# SPDX-License-Identifier: Apache-2.0
#
# This software is distributed under the Apache 2.0 license,
# the text of which is available at https://opensource.org/license/apache-2-0
# or see the "LICENSE.txt" file for more details.
#
# Authors: See CONTRIBUTORS.txt
# Software description: A toolbox of scripts to help work of forges admins and open source referents

# Version.............: 3.1.0
# Since...............: 12/03/2024
# Description.........: Builds a third-party Markdown file based on a CSV file and a delimiter

import argparse
import csv
import os
import sys

from configuration import *

# Configuration
# -------------

# Error codes
EXIT_OK = 0
ERROR_BAD_ARGUMENTS = 1

# Other config
RESULT_FILE_NAME = "THIRD-PARTY.md.result"

# Check arguments
# ---------------

parser = argparse.ArgumentParser(description='This script will build a third-party file listing components based on a CSV file and a delimiter')
required_args = parser.add_argument_group('Required arguments')
required_args.add_argument('-f', '--file', help='The CSV file file to process', default=DEFAULT_PROMPT_RESULT_FILE)
required_args.add_argument('-d', '--delimiter', help='The delimter symbol (e.g. ";" to split fields for each line of the CSV file', default=DEFAULT_PROMPT_RESULT_FILE_DELIMITER)
required_args.add_argument('-a', '--avoid', help='The sequence to use to define wether or not a specific field (version or copyright) must be ignored (e.g. "?" in the CSV raw field', default=DEFAULT_AVOID_FIELD_SYMBOL)
args = parser.parse_args()

content_file_name = args.file
content_file_delimiter = args.delimiter
content_file_avoid_field_symbol = args.avoid

if not os.path.isfile(content_file_name):
    print("❌ Error: the file parameter is not a file.")
    sys.exit(ERROR_BAD_ARGUMENTS)
else:
    print(f'🆗 File to process is "{content_file_name}" with delimiter "{content_file_delimiter}"')

# Service
# -------

# Process file to build the results
print(f'🆗 Let\'s now build the {RESULT_FILE_NAME} file!')
computed_components = 0
unique_computed_components = set()
components_with_missing_licences = 0
with open(content_file_name, 'r') as content_file:
    with open(RESULT_FILE_NAME, 'w') as result_file:
        result_file.write("""
# Third Party Softwares

This document contains the list of Third Party Softwares along with the license information.

Third Party Software may impose additional restrictions and it is the user's responsibility to ensure that they have met the licensing
requirements of the relevant license of the Third Party Software they are using.

""")
        csv_reader = csv.reader(content_file, delimiter=content_file_delimiter)
        csv_reader = sorted(csv_reader, key=lambda x: x[0]) # Sort entries by component name, i.e. first column of CSV
        for component_fields in csv_reader: # Iterator on each component returning one row (i.e. component) as array of fieds
            name = component_fields[0]
            
            # Do not add component already added
            if name in unique_computed_components:
                print(f"- The component '{name}' has several occurences in the content file, won't process it anymore")
                computed_components += 1
                continue
            
            unique_computed_components.add(name) 
            repository = component_fields[1]
            license_identifier = component_fields[2]
            copyright = component_fields[3]
            version = component_fields[4]
            license_name = LICENSES[license_identifier][0]
            license_url = LICENSES[license_identifier][1]
            component_entry = """## {name}
""".format(name=name)
            
            # Add version only if defined
            if version != content_file_avoid_field_symbol:
                component_entry += """
Version {version}
""".format(version=version)
            else:
                print(f"- No version defined for component '{name}'")

            # Add copyright only if defined
            if copyright != content_file_avoid_field_symbol:
                component_entry += """
Copyright {copyright}
""".format(copyright=copyright)
            else:
                print(f"- No copyright defined for component '{name}'")

            component_entry += """
**{name}** is distributed under the terms and conditions of the [{license}]({url}).
You may download the source code on the [following website]({repository}).""".format(name=name, license=license_name, url=license_url, repository=repository)
            result_file.write(component_entry)
            result_file.write("\n\n")
            computed_components += 1
            if license_name == "Other":
                components_with_missing_licences += 1

# Clean up
content_file.close()
result_file.close()
print("\n")
print(f'🎉 Operation completed! Find your result file at "{RESULT_FILE_NAME}" with {computed_components} components (and {len(unique_computed_components)} unique)!')
if components_with_missing_licences > 0:
    print("\n")
    print(f'❗ But beware you have {components_with_missing_licences} components without managed licenses, you shall fix the result file with suitable names and URL ❗')
    print("👉 Please refer to either https://opensource.org/licenses or https://spdx.org/licenses/ 👈")
    print("🧡 You can also submit an issue or a pull request to manage new licences: https://github.com/Orange-OpenSource/floss-toolbox/issues/new 🧡")

sys.exit(EXIT_OK)