|
| 1 | +# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates. |
| 2 | +# SPDX-License-Identifier: MIT |
| 3 | +# |
| 4 | +# |
| 5 | +# Permission is hereby granted, free of charge, to any person obtaining a copy |
| 6 | +# of this software and associated documentation files (the "Software"), to deal |
| 7 | +# in the Software without restriction, including without limitation the rights |
| 8 | +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 9 | +# copies of the Software, and to permit persons to whom the Software is |
| 10 | +# furnished to do so, subject to the following conditions: |
| 11 | +# |
| 12 | +# The above copyright notice and this permission notice shall be included in all |
| 13 | +# copies or substantial portions of the Software. |
| 14 | +# |
| 15 | +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 16 | +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 17 | +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 18 | +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 19 | +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 20 | +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 21 | +# SOFTWARE. |
| 22 | + |
| 23 | +"""Defines options for connecting to a gRPC server.""" |
| 24 | + |
| 25 | +from abc import ABC, abstractmethod |
| 26 | +from dataclasses import asdict, dataclass |
| 27 | +import enum |
| 28 | +from pathlib import Path |
| 29 | +from typing import TYPE_CHECKING, Any, ClassVar |
| 30 | + |
| 31 | +import grpc |
| 32 | + |
| 33 | +from .. import cyberchannel |
| 34 | + |
| 35 | +__all__ = [ |
| 36 | + "TransportMode", |
| 37 | + "UDSOptions", |
| 38 | + "WNUAOptions", |
| 39 | + "MTLSOptions", |
| 40 | + "InsecureOptions", |
| 41 | + "TransportOptionsType", |
| 42 | +] |
| 43 | + |
| 44 | +# For Python 3.10 and below, emulate the behavior of StrEnum by |
| 45 | +# inheriting from str and enum.Enum. |
| 46 | +# Note that this does *not* work on Python 3.11+, since the default |
| 47 | +# Enum format method has changed and will not return the value of |
| 48 | +# the enum member. |
| 49 | +# When type checking, always use the Python 3.10 workaround, otherwise |
| 50 | +# the StrEnum resolves as 'Any'. |
| 51 | +if TYPE_CHECKING: # pragma: no cover |
| 52 | + |
| 53 | + class StrEnum(str, enum.Enum): |
| 54 | + """String enum.""" |
| 55 | + |
| 56 | +else: |
| 57 | + try: |
| 58 | + from enum import StrEnum |
| 59 | + except ImportError: |
| 60 | + |
| 61 | + import enum |
| 62 | + |
| 63 | + class StrEnum(str, enum.Enum): |
| 64 | + """String enum.""" |
| 65 | + |
| 66 | + pass |
| 67 | + |
| 68 | + |
| 69 | +class TransportMode(StrEnum): |
| 70 | + """Enumeration of transport modes supported by the FileTransfer Tool.""" |
| 71 | + |
| 72 | + UDS = "uds" |
| 73 | + WNUA = "wnua" |
| 74 | + MTLS = "mtls" |
| 75 | + INSECURE = "insecure" |
| 76 | + |
| 77 | + |
| 78 | +class TransportOptionsBase(ABC): |
| 79 | + """Base class for transport options.""" |
| 80 | + |
| 81 | + _MODE: ClassVar[TransportMode] |
| 82 | + |
| 83 | + @property |
| 84 | + def mode(self) -> TransportMode: |
| 85 | + """Transport mode.""" |
| 86 | + return self._MODE |
| 87 | + |
| 88 | + def create_channel(self, **extra_kwargs: Any) -> grpc.Channel: |
| 89 | + """Create a gRPC channel using the transport options. |
| 90 | +
|
| 91 | + Parameters |
| 92 | + ---------- |
| 93 | + extra_kwargs : |
| 94 | + Extra keyword arguments to pass to the channel creation function. |
| 95 | +
|
| 96 | + Returns |
| 97 | + ------- |
| 98 | + : |
| 99 | + gRPC channel created using the transport options. |
| 100 | + """ |
| 101 | + return cyberchannel.create_channel(**self._to_cyberchannel_kwargs(), **extra_kwargs) |
| 102 | + |
| 103 | + @abstractmethod |
| 104 | + def _to_cyberchannel_kwargs(self) -> dict[str, Any]: |
| 105 | + """Convert transport options to cyberchannel keyword arguments. |
| 106 | +
|
| 107 | + Returns |
| 108 | + ------- |
| 109 | + : |
| 110 | + Dictionary of keyword arguments for cyberchannel. |
| 111 | + """ |
| 112 | + pass |
| 113 | + |
| 114 | + |
| 115 | +@dataclass(kw_only=True) |
| 116 | +class UDSOptions(TransportOptionsBase): |
| 117 | + """Options for UDS transport mode.""" |
| 118 | + |
| 119 | + _MODE = TransportMode.UDS |
| 120 | + |
| 121 | + uds_service: str |
| 122 | + uds_dir: str | Path | None = None |
| 123 | + uds_id: str | None = None |
| 124 | + |
| 125 | + def _to_cyberchannel_kwargs(self) -> dict[str, Any]: |
| 126 | + return asdict(self) | {"transport_mode": self.mode.value} |
| 127 | + |
| 128 | + |
| 129 | +@dataclass(kw_only=True) |
| 130 | +class WNUAOptions(TransportOptionsBase): |
| 131 | + """Options for WNUA transport mode.""" |
| 132 | + |
| 133 | + _MODE = TransportMode.WNUA |
| 134 | + |
| 135 | + port: int |
| 136 | + |
| 137 | + def _to_cyberchannel_kwargs(self) -> dict[str, Any]: |
| 138 | + return asdict(self) | {"transport_mode": self.mode.value, "host": "localhost"} |
| 139 | + |
| 140 | + |
| 141 | +@dataclass(kw_only=True) |
| 142 | +class MTLSOptions(TransportOptionsBase): |
| 143 | + """Options for mTLS transport mode.""" |
| 144 | + |
| 145 | + _MODE = TransportMode.MTLS |
| 146 | + |
| 147 | + certs_dir: str | Path | None = None |
| 148 | + host: str = "localhost" |
| 149 | + port: int |
| 150 | + allow_remote_host: bool = False |
| 151 | + |
| 152 | + def _to_cyberchannel_kwargs(self) -> dict[str, Any]: |
| 153 | + if not self.allow_remote_host: |
| 154 | + if self.host not in ("localhost", "127.0.0.1"): |
| 155 | + raise ValueError( |
| 156 | + f"Remote host '{self.host}' specified without setting 'allow_remote_host=True'." |
| 157 | + ) |
| 158 | + res = asdict(self) |
| 159 | + res.pop("allow_remote_host", None) |
| 160 | + return res | {"transport_mode": self.mode.value} |
| 161 | + |
| 162 | + |
| 163 | +@dataclass(kw_only=True) |
| 164 | +class InsecureOptions(TransportOptionsBase): |
| 165 | + """Options for insecure transport mode.""" |
| 166 | + |
| 167 | + _MODE = TransportMode.INSECURE |
| 168 | + |
| 169 | + host: str = "localhost" |
| 170 | + port: int |
| 171 | + allow_remote_host: bool = False |
| 172 | + |
| 173 | + def _to_cyberchannel_kwargs(self) -> dict[str, Any]: |
| 174 | + if not self.allow_remote_host: |
| 175 | + if self.host not in ("localhost", "127.0.0.1"): |
| 176 | + raise ValueError( |
| 177 | + f"Remote host '{self.host}' specified without setting 'allow_remote_host=True'." |
| 178 | + ) |
| 179 | + res = asdict(self) |
| 180 | + res.pop("allow_remote_host", None) |
| 181 | + return res | {"transport_mode": self.mode.value} |
| 182 | + |
| 183 | + |
| 184 | +TransportOptionsType = UDSOptions | WNUAOptions | MTLSOptions | InsecureOptions |
0 commit comments