@regulaforensics/face-sdk 6.3.3-beta → 6.3.4-beta

package/ios-ci/ios_ci/common/dependency.py

@@ -1,466 +0,0 @@
-import os
-import subprocess
-from enum import Enum, auto
-from pathlib import Path
-from typing import Optional, Tuple
-
-from ios_ci import __script_call_location__
-
-
-class DependencyBuildType(Enum):
-    TEMP = "Temp"
-    BETA = "Beta"
-    NIGHTLY = "Nightly"
-    STAGE = "Stage"
-    RELEASE = "Release"
-
-
-class DependencySourceType(Enum):
-    COCOAPODS = auto()
-    FTP_PRIVATE = auto()
-    FTP_PUBLIC = auto()
-
-
-class Dependency:
-    name: str
-    """ Plain dependency name without `Beta` prefix. Example: `FaceSDK`, `FullRFID`, `DocumentReader` """
-
-    build_type: DependencyBuildType
-
-    def __init__(self, name: str, build_type: DependencyBuildType):
-        self.name = name
-        self.build_type = build_type
-
-    @property
-    def framework_name(self) -> str:
-        return f"{self.name}.xcframework"
-
-    @property
-    def pod_name(self) -> str:
-        """The name of the dependency as if it is a pod name in Podfile. Has `Beta` prefix if needed"""
-        pod_name = self.name
-        if self.build_type == DependencyBuildType.BETA:
-            pod_name = f"{pod_name}Beta"
-        elif self.build_type == DependencyBuildType.NIGHTLY:
-            pod_name = f"{pod_name}Nightly"
-        elif self.build_type == DependencyBuildType.STAGE:
-            pod_name = f"{pod_name}Stage"
-        return pod_name
-
-    @property
-    def pod_name_temp(self) -> str:
-        """The name of the dependency as if it is a pod name in Podfile. Has `Beta` or `Temp` prefix if needed"""
-        pod_name = self.name
-        if self.build_type == DependencyBuildType.BETA:
-            pod_name = f"{pod_name}Beta"
-        elif self.build_type == DependencyBuildType.NIGHTLY:
-            pod_name = f"{pod_name}Nightly"
-        elif self.build_type == DependencyBuildType.STAGE:
-            pod_name = f"{pod_name}Stage"
-        elif self.build_type == DependencyBuildType.TEMP:
-            pod_name = f"{pod_name}Temp"
-        return pod_name
-
-    def ftp_archive_name(self, version: str) -> str:
-        archive_name = f"{self.pod_name}-{version}"
-        return archive_name
-
-    @property
-    def ftp_project_path(self) -> str:
-        if self.build_type == DependencyBuildType.TEMP:
-            resource_path = f"iOS/{self.pod_name}"
-        else:
-            resource_path = f"{self.pod_name}"
-        return resource_path
-
-
-def _core_full_name_from_short_name(short_name: str) -> str:
-    map = {
-        "barcode": "Barcode",
-        "barcodemrz": "MRZBarcode",
-        "barcodemrzrfid": "BarcodeMRZRFID",
-        "bounds": "Bounds",
-        "creditcard": "BankCard",
-        "doctype": "DocType",
-        "full": "Full",
-        "fullauth": "FullAuth",
-        "fullauthrfid": "FullAuthRFID",
-        "fullcc": "FullBankCard",
-        "fullrfid": "FullRFID",
-        "mrz": "MRZ",
-        "mrzcreditcard": "MRZBankCard",
-        "mrzrfid": "MRZRFID",
-        "ocrandmrz": "OCR",
-        "ocrandmrzcc": "OCRBankCard",
-        "ocrandmrzrfid": "OCRRFID",
-        "ocrmrzccrfid": "OCRBankCardRFID",
-    }
-    full_name = map.get(short_name)
-    return full_name
-
-def _other_full_name_from_short_name(lower_case: str) -> str:
-    map = {
-        "faceSDK": "FaceSDK",
-        "basic": "FaceCoreBasic",
-        "match": "FaceCoreMatch",
-        "common": "RegulaCommon",
-        "documentReader": "DocumentReader",
-        "btDevice": "BTDevice",
-    }
-    upper_case = map.get(lower_case)
-    return  upper_case
-
-def _spm_git_url(short_name: str) -> str:
-    map = {
-        "barcode": "https://github.com/regulaforensics/DocumentReaderBarcode-Swift-Package.git",
-        "barcodemrz": "https://github.com/regulaforensics/DocumentReaderMRZBarcode-Swift-Package.git",
-        "barcodemrzrfid": "https://github.com/regulaforensics/DocumentReaderBarcodeMRZRFID-Swift-Package.git",
-        "bounds": "https://github.com/regulaforensics/DocumentReaderBounds-Swift-Package.git",
-        "doctype": "https://github.com/regulaforensics/DocumentReaderDocType-Swift-Package.git",
-        "full": "https://github.com/regulaforensics/DocumentReaderFull-Swift-Package.git",
-        "fullauth": "https://github.com/regulaforensics/DocumentReaderFullAuth-Swift-Package.git",
-        "fullauthrfid": "https://github.com/regulaforensics/DocumentReaderFullAuthRFID-Swift-Package.git",
-        "fullrfid": "https://github.com/regulaforensics/DocumentReaderFullRFID-Swift-Package.git",
-        "mrz": "https://github.com/regulaforensics/DocumentReaderMRZ-Swift-Package.git",
-        "mrzrfid": "https://github.com/regulaforensics/DocumentReaderMRZRFID-Swift-Package.git",
-        "ocrandmrz": "https://github.com/regulaforensics/DocumentReaderOCR-Swift-Package.git",
-        "ocrandmrzrfid": "https://github.com/regulaforensics/DocumentReaderOCRRFID-Swift-Package.git",
-        "basic": "https://github.com/regulaforensics/FaceCoreBasic-Swift-Package.git",
-        "match": "https://github.com/regulaforensics/FaceCoreMatch-Swift-Package.git",
-        "common": "https://github.com/regulaforensics/RegulaCommon-Swift-Package.git",
-        "documentReader": "https://github.com/regulaforensics/DocumentReader-Swift-Package.git",
-        "faceSDK": "https://github.com/regulaforensics/FaceSDK-Swift-Package.git",
-        "btDevice": "https://github.com/regulaforensics/BTDevice-Swift-Package.git",
-
-    }
-    git_url = map.get(short_name)
-    return git_url
-
-def _is_core_by_short_name(short_name: str) -> bool:
-    return _core_full_name_from_short_name(short_name) is not None
-
-
-class CoreDependency(Dependency):
-    core_short_name: str
-    """ Short name for Core dependency. Example: `fullrfid`, `mrz`. For decoded name see `name` field. """
-
-    def __init__(self, core_short_name: str, build_type: DependencyBuildType):
-        name = _core_full_name_from_short_name(core_short_name)
-        super().__init__(name, build_type)
-        self.core_short_name = core_short_name
-
-    @property
-    def framework_name(self) -> str:
-        return "DocumentReaderCore.xcframework"
-
-    @property
-    def pod_name(self) -> str:
-        pod_name = f"DocumentReader{self.name}"
-        if self.build_type == DependencyBuildType.BETA:
-            pod_name = f"{pod_name}Beta"
-        elif self.build_type == DependencyBuildType.NIGHTLY:
-            pod_name = f"{pod_name}Nightly"
-        elif self.build_type == DependencyBuildType.STAGE:
-            pod_name = f"{pod_name}Stage"
-        return pod_name
-
-    @property
-    def pod_name_temp(self) -> str:
-        pod_name = f"DocumentReader{self.name}"
-        if self.build_type == DependencyBuildType.BETA:
-            pod_name = f"{pod_name}Beta"
-        elif self.build_type == DependencyBuildType.NIGHTLY:
-            pod_name = f"{pod_name}Nightly"
-        elif self.build_type == DependencyBuildType.STAGE:
-            pod_name = f"{pod_name}Stage"
-        elif self.build_type == DependencyBuildType.TEMP:
-            pod_name = f"{pod_name}Temp"
-        return pod_name
-
-    @property
-    def pod_short_name(self) -> str:
-        """Core pod name without `DocumentReader` prefix. Example: `FullRFID`"""
-        pod_name = self.name
-        if self.build_type == DependencyBuildType.BETA:
-            pod_name = f"{pod_name}Beta"
-        elif self.build_type == DependencyBuildType.NIGHTLY:
-            pod_name = f"{pod_name}Nightly"
-        elif self.build_type == DependencyBuildType.STAGE:
-            pod_name = f"{pod_name}Stage"
-        return pod_name
-
-    def ftp_archive_name(self, version: str) -> str:
-        archive_name = "DocumentReaderCore"
-        if self.build_type == DependencyBuildType.BETA:
-            archive_name = f"{archive_name}Beta"
-        elif self.build_type == DependencyBuildType.NIGHTLY:
-            archive_name = f"{archive_name}Nightly"
-        elif self.build_type == DependencyBuildType.STAGE:
-            archive_name = f"{archive_name}Stage"
-        archive_name = f"{archive_name}_{self.core_short_name}_{version}"
-        return archive_name
-
-    @property
-    def ftp_project_path(self) -> str:
-        if self.build_type == DependencyBuildType.TEMP:
-            resource_path = f"iOS/{self.core_short_name}"
-        else:
-            resource_path = f"{self.pod_short_name}"
-        return resource_path
-
-
-def make_dependency(name: str, build_type: DependencyBuildType) -> Dependency:
-    if _is_core_by_short_name(name):
-        return CoreDependency(name, build_type)
-    else:
-        return Dependency(name, build_type)
-
-
-class DependencyVersion:
-    version: str
-    version_selector: str
-    build_type: DependencyBuildType
-    source: DependencySourceType
-
-    def __init__(
-        self,
-        version: str,
-        version_selector: str,
-        build_type: DependencyBuildType,
-        source: DependencySourceType,
-    ):
-        self.version = version
-        self.version_selector = version_selector
-        self.build_type = build_type
-        self.source = source
-
-
-def inject_destination_path(dependency: Dependency) -> str:
-    pods_directory = _find_pods_folder()
-    if pods_directory is not None:
-        existing_filepath, _ = _find_existing_pod_location(
-            root_pods_directory=pods_directory, dependency=dependency
-        )
-        if existing_filepath is not None:
-            return existing_filepath
-        else:
-            print(
-                f"[warning] host project contains Pods folder and the dependency may be resolved as Cocoapods, but there is no folder for the dependency: {dependency.name}. Please make sure the project's frameworks are linked correctly or run pod install prior this script."
-            )
-
-        filepath = f"{pods_directory}/{dependency.pod_name}"
-        return filepath
-
-    filepath = __script_call_location__
-    return filepath
-
-
-def _find_pods_folder() -> str:
-    script_call_path = Path(__script_call_location__)
-    possible_project_locations = [
-        script_call_path,
-        script_call_path.parent,
-        script_call_path.parent.parent,
-    ]
-
-    pods_marks = ["Pods", "Podfile", "Podfile.lock"]
-    for location in possible_project_locations:
-        print(f"[log] looking for pods in {location}")
-        host_project_files = os.listdir(location)
-
-        for mark in pods_marks:
-            for filename in host_project_files:
-                if filename == mark:
-                    pods = location / "Pods"
-                    print(f"[log] found pods at {pods}")
-                    return pods
-
-    return None
-
-
-def _find_existing_pod_location(
-    root_pods_directory: str, dependency: Dependency
-) -> Tuple[str, DependencyBuildType]:
-    pod_name = dependency.pod_name
-    possible_names = [pod_name, pod_name.replace("Beta", ""), pod_name.replace("Nightly", ""),
-                      pod_name.replace("Stage", ""), f"{pod_name}Beta", f"{pod_name}Nightly", f"{pod_name}Stage"]
-
-    is_core = isinstance(dependency, CoreDependency)
-    if is_core:
-        possible_names.append("DocumentReaderFull")
-        possible_names.append("DocumentReaderFullBeta")
-        possible_names.append("DocumentReaderFullNightly")
-        possible_names.append("DocumentReaderFullStage")
-
-    for name in possible_names:
-        path = f"{root_pods_directory}/{name}"
-
-        build_type = DependencyBuildType.RELEASE
-        if name.find("Beta") != -1:
-            build_type = DependencyBuildType.BETA
-        elif name.find("Nightly") != -1:
-            build_type = DependencyBuildType.NIGHTLY
-        elif name.find("Stage") != -1:
-            build_type = DependencyBuildType.STAGE
-
-        if os.path.exists(path):
-            return [path, build_type]
-
-    return [None, None]
-
-
-def clean_coaopod(pod_name: str):
-    this_script_path = os.path.dirname(os.path.realpath(__file__))
-    subprocess.run(
-        ["bash", "clean_cocoapod.sh", pod_name],
-        cwd=this_script_path,
-        check=True,
-        text=True,
-        stdout=subprocess.PIPE,
-    ).stdout
-
-
-class VersionResolver:
-    def resolve_dependency_version(
-        self, dependency: Dependency, version_selector: str, branch: str
-    ) -> DependencyVersion:
-        version = self.fetch_version(version_selector, branch, dependency)
-        pods_directory = _find_pods_folder()
-        path, type = _find_existing_pod_location(
-            root_pods_directory=pods_directory, dependency=dependency
-        )
-
-        if type is not None:
-            # Note: check only for Beta dependency. Temp and Release types are kind of the same.
-            if (
-                dependency.build_type is DependencyBuildType.BETA
-                and type is not DependencyBuildType.BETA
-            ):
-                print(
-                    f"[warning] given dependency and resolved path do not math: dependency.type: {dependency.build_type} and path: {path}. Make sure the paths and the dependency name are correct."
-                )
-                print(
-                    f"[warning] resolving dependency.type by Pods folder: {dependency.build_type}"
-                )
-
-        source: DependencySourceType
-        if path is not None:
-            source = DependencySourceType.COCOAPODS
-        elif dependency.build_type is DependencyBuildType.TEMP:
-            source = DependencySourceType.FTP_PRIVATE
-        else:
-            source = DependencySourceType.FTP_PUBLIC
-
-        return DependencyVersion(
-            version=version,
-            version_selector=version_selector,
-            build_type=type,
-            source=source,
-        )
-
-    def fetch_version(
-        self, version_selector: str, branch: str, dependency: Dependency
-    ) -> Optional[str]:
-        version = version_selector
-        if (
-            version_selector == "+"
-            and dependency.build_type != DependencyBuildType.TEMP
-        ):
-            full_pod_name = dependency.pod_name
-            print(f"[log] searching for pod version for: {full_pod_name}")
-            version = self._search_pod_version(full_pod_name)
-            if version == "":
-                print(
-                    f"[warning] search pod version returned empty for dependency: {dependency.name}"
-                )
-                return None
-        elif dependency.build_type == DependencyBuildType.TEMP:
-            version = self._search_temp_version(branch, dependency)
-
-        if version == "+":
-            print(
-                f"[warning] unable to fetch version for dependency: {dependency.name} – version: {version}"
-            )
-            return None
-
-        return version
-
-    def _search_temp_version(
-        self, branch: str, dependency: Dependency
-    ) -> Optional[str]:
-        from ios_ci.common import ftp
-
-        last_version: Optional[str] = None
-
-        url = ftp.make_ftp_project_url(dependency=dependency)
-        index = ftp.fetch_build_index(project_url=url)
-        if index:
-            last_version = index.version(branch=branch)
-
-        if last_version is None:
-            # Search the filesystem on shared volume for file with version.
-            # This method is usually not appropriate for anything other than Core builds
-            # because we have already migrated all the iOS SDK products to use BuildIndex.
-            #
-            # The only thing is left to use legacy version indexing via shared volumes is Core builds.
-            # Maybe we should migrate them at one point too, but it was decided to keep it as it is for now.
-            version_filepath = self._make_temp_version_filepath(branch, dependency)
-            last_version = self._read_version_from_file(version_filepath)
-
-        return last_version
-
-    def _search_pod_version(self, pod_name):
-        """
-        Searches pod version in the repository
-        Returns a string in a format of `x.x.x` e.g. `5.7.487`
-        """
-        this_script_path = os.path.dirname(os.path.realpath(__file__))
-        result = subprocess.run(
-            ["bash", "searchpod.sh", pod_name],
-            cwd=this_script_path,
-            check=True,
-            text=True,
-            stdout=subprocess.PIPE,
-        ).stdout
-        if result == "unknown":
-            return None
-        return result.replace("\n", "")
-
-    def _read_version_from_file(self, filepath):
-        if filepath is None:
-            print(f"[warning] [_read_version_from_file]. Filepath is None.")
-            return None
-        if not os.path.exists(filepath):
-            print(
-                f"[warning] [_read_version_from_file]. There is no file at path:{filepath}"
-            )
-            return None
-
-        content = None
-        with open(filepath, "r") as content_file:
-            content = content_file.read().replace("\n", "")
-        return content
-
-    def _make_temp_version_filepath(self, branch: str, dependency: Dependency) -> str:
-        prefix = "/Volumes/work/software/AutoBuild/MobileApp"
-        type = dependency.build_type.value
-        paths = {
-            "DocumentReader": f"/iOSApi/api_{branch}_{type}.txt",
-            "BTDevice": f"/iOSBTDevice/BTDevice_{branch}_{type}.txt",
-            "FaceSDK": f"/iOSFaceSDK/facesdk_{branch}_{type}.txt",
-            "RegulaCommon": f"/iOSCommon/common_api_{branch}_{type}.txt",
-        }
-        is_core = isinstance(dependency, CoreDependency)
-        if is_core:
-            dependency.__class__ = CoreDependency
-            path = f"/iOSCore/core_{dependency.core_short_name}_{branch}_{type}.txt"
-        else:
-            path = paths.get(dependency.name)
-
-        if path:
-            return prefix + path
-        else:
-            print(
-                f"[error] the dependency: {dependency.name} is unknown. There is no .txt version file on local disk."
-            )
-            return None