setup_cpython.py

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import shutil
import subprocess
import sys
import sysconfig
from setuptools import setup, find_packages, Extension
from setuptools.command.install import install
from Cython.Build import cythonize

# Define macros for paths to simplify maintenance
SYSTEMD_DIR = '/lib/systemd/system/'
ETC_DIR = '/etc/vss-lib/'
SHARE_DIR = '/usr/share/vss-lib/'
USR_LIB_DIR = '/usr/lib/vss-lib/'
DBUS_DIR = '/usr/lib/vss-lib/dbus/'
JOYSTICKS_USR_SHARE = '/usr/share/vss-lib/joysticks/'
JOYSTICKS_USR_LIB = '/usr/lib/vss-lib/joysticks/'
LOG_DIR = '/var/log/vss-lib/'
DBUS_CONF_DIR = '/etc/dbus-1/system.d/'
VSS_DBUS_SERVICE = "vss-dbus"
ELECTRONICS_DIR = os.path.join(SHARE_DIR, 'electronics/')
LATEST_PYTHON_SITE_PACKAGES = sysconfig.get_paths()['purelib']

# Array of individual Python files to copy to LATEST_PYTHON_SITE_PACKAGES
python_files = [
    '__init__.py',
    'base_model.py',
    'config_loader.py',
    'vspec_parser.py',
    'vss_logging.py',
    'vendor_interface.py',
    'canbus.py'
]

# Directories to copy recursively to LATEST_PYTHON_SITE_PACKAGES
directories_to_copy = [
    'client',
    'dbus',
    'vendor',
    'vspec',
    'containers'
]


# Function to remove the existing file and create a new one with the correct content
def create_new_config_file(config_src, config_dst, vspec_path):
    if os.path.exists(config_dst):
        os.remove(config_dst)
        print(f"Removed existing file: {config_dst}")

    with open(config_src, 'r') as file:
        content = file.read()

    updated_content = content.replace('${vspec_path}', vspec_path)

    with open(config_dst, 'w') as file:
        file.write(updated_content)

    print(f"Created new config file: {config_dst} with vspec_path = {vspec_path}")


# Custom install command to handle file installation and ensure directories exist
class CustomInstallCommand(install):
    def run(self):
        # Stop the service before proceeding with the installation
        stop_vss_dbus_service()

        # Run the standard installation process
        install.run(self)

        # Ensure systemd, etc, share, dbus, log, and dbus-manager directories exist
        os.makedirs(SYSTEMD_DIR, exist_ok=True)
        os.makedirs(ETC_DIR, exist_ok=True)
        os.makedirs(SHARE_DIR, exist_ok=True)
        os.makedirs(USR_LIB_DIR, exist_ok=True)
        os.makedirs(DBUS_DIR, exist_ok=True)
        os.makedirs(JOYSTICKS_USR_SHARE, exist_ok=True)
        os.makedirs(JOYSTICKS_USR_LIB, exist_ok=True)
        os.makedirs(LOG_DIR, exist_ok=True)
        os.makedirs(ELECTRONICS_DIR, exist_ok=True)
        dbus_manager_dir = os.path.join(SHARE_DIR, 'dbus-manager/')
        os.makedirs(dbus_manager_dir, exist_ok=True)

        print(f"Ensured necessary directories exist, including {dbus_manager_dir}")

        # Define the VSS path
        vspec_path = '/usr/share/vss-lib/'

        # Remove and create a new config file
        config_file_src = 'etc/vss-lib/vss.config'
        config_file_dst = os.path.join(ETC_DIR, 'vss.config')
        create_new_config_file(config_file_src, config_file_dst, vspec_path)

        # Copy the logging configuration file to /etc/vss-lib
        shutil.copy('etc/vss-lib/logging.conf', os.path.join(ETC_DIR, 'logging.conf'))
        print(f"Copied logging configuration to {ETC_DIR}")

        # Define the source and destination directories
        SRC_DIR = './usr/share/vss-lib/'
        SHR_DIR = f'{vspec_path}'

        # Ensure the destination directory exists
        os.makedirs(SHR_DIR, exist_ok=True)

        # Install the get_python_version.sh script to /usr/lib/vss-lib
        shutil.copy('./usr/lib/vss-lib/get_python_version', os.path.join(USR_LIB_DIR, 'get_python_version'))
        print(f"Copied get_python_version.sh to {SHARE_DIR}")

        # Copy the systemd service file to /lib/systemd/system/
        shutil.copy('systemd/vss-dbus.service', os.path.join(SYSTEMD_DIR, 'vss-dbus.service'))
        print(f"Copied vss-dbus.service to {SYSTEMD_DIR}")

        # Get all .vspec files from the source directory
        vspec_files = [f for f in os.listdir(SRC_DIR) if f.endswith('.vspec')]

        # Copy each .vspec file to the destination directory
        for vspec in vspec_files:
            src_path = os.path.join(SRC_DIR, vspec)
            dest_path = os.path.join(SHR_DIR, vspec)
            shutil.copy(src_path, dest_path)
            print(f"Copied {vspec} to {SHR_DIR}")

        # Copy the dbus service file to /usr/lib/vss-lib/dbus
        shutil.copy('src/dbus/container_dbus_service', os.path.join(DBUS_DIR, 'container_dbus_service'))
        print(f"Copied dbus service file to {DBUS_DIR}")

        # Copy files to /usr/lib/vss-lib/joysticks
        shutil.copy('src/joysticks/container_joysticks_service', os.path.join(JOYSTICKS_USR_LIB, 'container_joysticks_service'))
        print(f"Copied joysticks service file to {JOYSTICKS_USR_LIB}")

        # Copy files to /usr/share/vss-lib/joysticks
        shutil.copy('usr/share/vss-lib/joysticks/ContainerFile', os.path.join(JOYSTICKS_USR_SHARE, 'ContainerFile'))
        print(f"Copied joysticks service file to {JOYSTICKS_USR_SHARE}")

        # Copy the D-Bus configuration file to /etc/dbus-1/system.d
        shutil.copy('etc/dbus-1/system.d/vss-dbus.conf', os.path.join(DBUS_CONF_DIR, 'vss-dbus.conf'))
        print(f"Copied D-Bus configuration to {DBUS_CONF_DIR}")

        # Copy electronics .vspec files from usr/share/vss-lib/electronics/ to /usr/share/vss-lib/electronics/
        electronics_source_dir = 'usr/share/vss-lib/electronics/'
        if os.path.exists(electronics_source_dir):
            for file_name in os.listdir(electronics_source_dir):
                if file_name.endswith('.vspec'):
                    src_file = os.path.join(electronics_source_dir, file_name)
                    dst_file = os.path.join(ELECTRONICS_DIR, file_name)
                    shutil.copy(src_file, dst_file)
                    print(f"Copied {file_name} to {dst_file}")
                else:
                    print(f"{file_name} is not a .vspec file, skipping...")
        else:
            print(f"Directory {electronics_source_dir} does not exist, skipping electronics files...")

        # Copy files from dbus-manager into /usr/share/vss-lib/joyticks
        joystick_source_dir = './usr/share/vss-lib/joysticks/'
        if os.path.exists(joystick_source_dir):
            for file_name in os.listdir(joystick_source_dir):
                src_file = os.path.join(joystick_source_dir, file_name)
                dst_file = os.path.join(dbus_manager_dir, file_name)
                shutil.copy(src_file, dst_file)
                print(f"Copied {file_name} to {dbus_manager_dir}")
        else:
            print(f"Directory {joystick_source_dir} does not exist, skipping dbus-manager files...")

        # Copy files from dbus-manager into /usr/share/vss-lib/dbus-manager
        dbus_manager_source_dir = './usr/share/vss-lib/dbus-manager/'
        if os.path.exists(dbus_manager_source_dir):
            for file_name in os.listdir(dbus_manager_source_dir):
                src_file = os.path.join(dbus_manager_source_dir, file_name)
                dst_file = os.path.join(dbus_manager_dir, file_name)
                shutil.copy(src_file, dst_file)
                print(f"Copied {file_name} to {dbus_manager_dir}")
        else:
            print(f"Directory {dbus_manager_source_dir} does not exist, skipping dbus-manager files...")

        # Define the target directory for Python files using sysconfig's purelib path
        target_dir = os.path.join(LATEST_PYTHON_SITE_PACKAGES, "vss_lib")

        # Ensure target directory exists for Python files
        os.makedirs(target_dir, exist_ok=True)
        print(f"Created {target_dir}")

        # Copy individual Python files to LATEST_PYTHON_SITE_PACKAGES
        for py_file in python_files:
            shutil.copy(f'src/{py_file}', target_dir)
            print(f"Copied {py_file} to {target_dir}")

        # Recursively copy directories and their subdirectories to LATEST_PYTHON_SITE_PACKAGES
        for directory in directories_to_copy:
            src_dir = f'src/{directory}'
            dst_dir = os.path.join(target_dir, directory)
            if os.path.exists(src_dir):
                shutil.copytree(src_dir, dst_dir, dirs_exist_ok=True)
                print(f"Copied {src_dir} to {dst_dir}")
            else:
                print(f"Directory {src_dir} does not exist, skipping...")

        # Reload D-Bus service and enable/start vss-dbus.service
        try:
            subprocess.check_call(['sudo', 'systemctl', 'reload', 'dbus'])
            print("Reloaded D-Bus configuration.")

            subprocess.check_call(['sudo', 'systemctl', 'enable', '--now', 'vss-dbus.service'])
            print("Enabled and started vss-dbus.service.")

        except subprocess.CalledProcessError as e:
            print(f"Failed to reload D-Bus or start service: {e}")
            raise


def check_if_fedora():
    """
    Check if the system is running Fedora by inspecting /etc/os-release or using the rpm command.
    """
    try:
        # Check the operating system by reading /etc/os-release
        result = subprocess.run(['grep', '-i', 'fedora', '/etc/os-release'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
        if result.returncode == 0:
            return True
        return False
    except subprocess.CalledProcessError as e:
        print(f"An error occurred while checking the operating system: {e}")
        return False


def stop_vss_dbus_service():
    try:
        # Check if the service is active (running)
        result = subprocess.run(['systemctl', 'is-active', VSS_DBUS_SERVICE], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)

        if result.stdout.strip() == 'active':
            print(f"Stopping {VSS_DBUS_SERVICE} service...")
            subprocess.run(['sudo', 'systemctl', 'stop', VSS_DBUS_SERVICE], check=True)
            print(f"{VSS_DBUS_SERVICE} service stopped successfully.")
        else:
            print(f"{VSS_DBUS_SERVICE} service is not running.")

        # Check if the service is enabled
        result = subprocess.run(['systemctl', 'is-enabled', 'VSS_DBUS_SERVICE'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)

        if result.stdout.strip() == 'enabled':
            print(f"Disabling {VSS_DBUS_SERVICE} service...")
            subprocess.run(['sudo', 'systemctl', 'disable', VSS_DBUS_SERVICE], check=True)
            print(f"{VSS_DBUS_SERVICE} service disabled successfully.")
        else:
            print(f"{VSS_DBUS_SERVICE} service is not enabled.")

    except subprocess.CalledProcessError as e:
        print(f"Error while managing {VSS_DBUS_SERVICE} service: {e}")
        sys.exit(1)


# vss-lib was developed under Fedora, this checks for Fedora environment
def check_fuse_overlayfs():
    """
    Check if fuse-overlayfs is installed and recommend installation if it's missing, but only if the system is Fedora.
    """
    if not check_if_fedora():
        print("System is not running Fedora. Skipping fuse-overlayfs check.")
        return

    try:
        # Try to find the fuse-overlayfs package using the rpm command
        result = subprocess.run(['rpm', '-q', 'fuse-overlayfs'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)

        if result.returncode == 0:
            print("fuse-overlayfs is installed.")
        else:
            print("fuse-overlayfs is not installed. Please install it using:")
            print("sudo dnf install fuse-overlayfs")
    except subprocess.CalledProcessError as e:
        print(f"An error occurred while checking fuse-overlayfs installation: {e}")


# Check if fuse-overlayfs is installed
check_fuse_overlayfs()

# Define Cython extensions to compile Python to C
extensions = [
    Extension("vss_lib.base_model", ["src/base_model.pyx"]),
    Extension("vss_lib.config_loader", ["src/config_loader.pyx"]),
    Extension("vss_lib.vspec_parser", ["src/vspec_parser.pyx"]),
    Extension("vss_lib.vss_logging", ["src/vss_logging.pyx"]),
    Extension("vss_lib.vendor_interface", ["src/vendor_interface.pyx"]),
    Extension("vss_lib.canbus", ["src/canbus.pyx"])
]

# Define the setup for the package
setup(
    name="vss-lib",
    version="0.1.0",
    description="A library for interacting with vehicle signals",
    author="Douglas Schilling Landgraf, Leonardo Rosetti, Yariv Rachmani",
    author_email="dougsland@redhat.com,lrossett@redhat.com,yrachman@redhat.com",
    packages=find_packages(where='src'),  # Find Python packages in src/
    package_dir={'': 'src'},  # Define the package directory for Python files
    python_requires='>=3.10',
    install_requires=[
        "pydbus",
        "toml",
        "pyyaml",
        "invoke",
        "pygame",
        "pydualsense",
        "python-can",
        "vss-tools",
        "cython"  # Added Cython for compiling Python to C
    ],
    ext_modules=cythonize(extensions),  # Cython extensions for CPython
    cmdclass={
        'install': CustomInstallCommand,  # Custom install command for Python files and system-wide files
    },
)