crytic_compile.platform.abstract_platform

  1"""
  2Abstract Platform
  3
  4This gives the skeleton for any platform supported by crytic-compile
  5"""
  6import abc
  7from typing import TYPE_CHECKING, List, Dict, Optional
  8from dataclasses import dataclass, field
  9
 10from crytic_compile.platform import Type
 11from crytic_compile.utils.unit_tests import guess_tests
 12
 13if TYPE_CHECKING:
 14    from crytic_compile import CryticCompile
 15
 16
 17class IncorrectPlatformInitialization(Exception):
 18    """
 19    Exception raises if a platform was not properly defined
 20    """
 21
 22    # pylint: disable=unnecessary-pass
 23    pass
 24
 25
 26# pylint: disable=too-many-instance-attributes
 27@dataclass
 28class PlatformConfig:
 29    """
 30    This class represents a generic platform configuration
 31    """
 32
 33    offline: bool = False
 34    remappings: Optional[str] = None
 35    solc_version: Optional[str] = None
 36    optimizer: bool = False
 37    optimizer_runs: Optional[int] = None
 38    via_ir: bool = False
 39    allow_paths: Optional[str] = None
 40    evm_version: Optional[str] = None
 41    src_path: str = "src"
 42    tests_path: str = "test"
 43    libs_path: List[str] = field(default_factory=lambda: ["lib"])
 44    scripts_path: str = "script"
 45
 46
 47class AbstractPlatform(metaclass=abc.ABCMeta):
 48    """
 49    This is the abstract class for the platform
 50    """
 51
 52    NAME: str = ""
 53    PROJECT_URL: str = ""
 54    TYPE: Type = Type.NOT_IMPLEMENTED
 55
 56    HIDE = False  # True if the class is not meant for direct user manipulation
 57
 58    def __init__(self, target: str, **_kwargs: str):
 59        """Init the object
 60
 61        Args:
 62            target (str): path to the target
 63            **_kwargs: optional arguments.
 64
 65        Raises:
 66            IncorrectPlatformInitialization: If the Platform was not correctly designed
 67        """
 68        if not self.NAME:
 69            raise IncorrectPlatformInitialization(
 70                f"NAME is not initialized {self.__class__.__name__}"
 71            )
 72
 73        if not self.PROJECT_URL:
 74            raise IncorrectPlatformInitialization(
 75                f"PROJECT_URL is not initialized {self.__class__.__name__}"
 76            )
 77
 78        if self.TYPE == Type.NOT_IMPLEMENTED:
 79            raise IncorrectPlatformInitialization(
 80                f"TYPE is not initialized {self.__class__.__name__}"
 81            )
 82
 83        self._target: str = target
 84        self._cached_dependencies: Dict[str, bool] = {}
 85
 86    # region Properties.
 87    ###################################################################################
 88    ###################################################################################
 89    # The properties might be different from the class value
 90    # For example the archive will return the underlying platform values
 91    @property
 92    def target(self) -> str:
 93        """Return the target name
 94
 95        Returns:
 96            str: The target name
 97        """
 98        return self._target
 99
100    @property
101    def platform_name_used(self) -> str:
102        """Return the name of the underlying platform used
103
104        Returns:
105            str: The name of the underlying platform used
106        """
107        return self.NAME
108
109    @property
110    def platform_project_url_used(self) -> str:
111        """Return the underlying platform project 's url
112
113        Returns:
114            str: Underlying platform project 's url
115        """
116        return self.PROJECT_URL
117
118    @property
119    def platform_type_used(self) -> Type:
120        """Return the type of the underlying platform used
121
122        Returns:
123            Type: [description]
124        """
125        return self.TYPE
126
127    # endregion
128    ###################################################################################
129    ###################################################################################
130    # region Abstract methods
131    ###################################################################################
132    ###################################################################################
133
134    @abc.abstractmethod
135    def compile(self, crytic_compile: "CryticCompile", **kwargs: str) -> None:
136        """Run the compilation
137
138        Args:
139            crytic_compile (CryticCompile): CryticCompile object associated with the platform
140            **kwargs: optional arguments.
141        """
142        return
143
144    @abc.abstractmethod
145    def clean(self, **kwargs: str) -> None:
146        """Clean compilation artifacts
147
148        Args:
149            **kwargs: optional arguments.
150        """
151        return
152
153    @staticmethod
154    @abc.abstractmethod
155    def is_supported(target: str, **kwargs: str) -> bool:
156        """Check if the target is a project supported by this platform
157
158        Args:
159            target (str): path to the target
160            **kwargs: optional arguments. Used: "dapp_ignore"
161
162        Returns:
163            bool: True if the target is supported
164        """
165        return False
166
167    @abc.abstractmethod
168    def is_dependency(self, path: str) -> bool:
169        """Check if the target is a dependency
170
171        Args:
172            path (str): path to the target
173
174        Returns:
175            bool: True if the target is a dependency
176        """
177        return False
178
179    @staticmethod
180    def config(working_dir: str) -> Optional[PlatformConfig]:  # pylint: disable=unused-argument
181        """Return configuration data that should be passed to solc, such as version, remappings ecc.
182
183        Args:
184            working_dir (str): path to the target
185
186        Returns:
187            Optional[PlatformConfig]: Platform configuration data such as optimization, remappings...
188        """
189        return None
190
191    # Only _guessed_tests is an abstract method
192    # guessed_tests will call the generic guess_tests and appends to the list
193    # platforms-dependent tests
194    @abc.abstractmethod
195    def _guessed_tests(self) -> List[str]:
196        """Guess the potential unit tests commands
197
198        Returns:
199            List[str]: list of potential unit tests commands
200        """
201        return []
202
203    def guessed_tests(self) -> List[str]:
204        """Guess the potential unit tests commands
205
206        Returns:
207            List[str]: list of potential unit tests commands
208        """
209        return guess_tests(self._target) + self._guessed_tests()
210
211    # endregion
212    ###################################################################################
213    ###################################################################################