scripts/spec_xml/paths.py

#!/usr/bin/env python3

# Copyright (c) 2024 Project CHIP Authors
#
# 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
from enum import Enum

# Define a branch enum for different versions or branches


class Branch(Enum):
    MASTER = "master"
    V1_3 = "v1_3"
    V1_4 = "v1_4"
    IN_PROGRESS = "in_progress"


def get_chip_root():
    """
    Returns the CHIP root directory, trying the environment variable first 
    and falling back if necessary.
    """
    chip_root = os.getenv('PW_PROJECT_ROOT')
    if chip_root:
        return chip_root
    else:
        try:
            return os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
        except Exception as e:
            raise EnvironmentError(
                "Unable to determine CHIP root directory. Please ensure the environment is activated."
            ) from e


def get_data_model_path(branch: Branch):
    """
    Returns the path to the data model directory for a given branch.
    """
    chip_root = get_chip_root()
    data_model_path = os.path.join(chip_root, 'data_model', branch.value)
    if not os.path.exists(data_model_path):
        raise FileNotFoundError(f"Data model path for branch {branch} does not exist: {data_model_path}")
    return data_model_path


def get_spec_xml_output_path():
    """
    Returns the path to the output directory for generated XML files.
    """
    chip_root = get_chip_root()
    output_dir = os.path.join(chip_root, 'out', 'spec_xml')
    if not os.path.exists(output_dir):
        os.makedirs(output_dir)  # Automatically create the directory if it doesn't exist
    return output_dir


def get_documentation_file_path():
    """
    Returns the path to the documentation file.
    """
    chip_root = get_chip_root()
    documentation_file = os.path.join(chip_root, 'docs', 'spec_clusters.md')
    if not os.path.exists(documentation_file):
        raise FileNotFoundError(f"Documentation file does not exist: {documentation_file}")
    return documentation_file


def get_python_testing_path():
    """
    Returns the path to the python_testing directory.
    """
    chip_root = get_chip_root()
    python_testing_path = os.path.join(chip_root, 'src', 'python_testing')
    if not os.path.exists(python_testing_path):
        raise FileNotFoundError(f"Python testing directory does not exist: {python_testing_path}")
    return python_testing_path


def get_in_progress_defines():
    """
    Returns a list of defines that are currently in progress.
    This can be updated dynamically as needed.
    """
    return [
        'aliro', 'atomicwrites', 'battery-storage', 'device-location', 'e2e-jf',
        'energy-calendar', 'energy-drlc', 'energy-management', 'heat-pump', 'hrap-1',
        'hvac', 'matter-fabric-synchronization', 'metering', 'secondary-net',
        'service-area-cluster', 'solar-power', 'tcp', 'water-heater', 'wifiSetup'
    ]


def get_available_branches():
    """
    Return a list of available branches for the data model.
    This can be expanded or dynamically fetched if necessary.
    """
    return [Branch.MASTER, Branch.V1_3, Branch.V1_4]