PyFunceble-dev 4.2.9__tar.gz → 4.2.11__tar.gz

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyFunceble-dev
-Version: 4.2.9
+Version: 4.2.11
 Summary: The tool to check the availability or syntax of domain, IP or URL.
 Home-page: https://github.com/funilrys/PyFunceble
 Author: funilrys

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/checker/availability/base.py

@@ -1043,7 +1043,13 @@ class AvailabilityCheckerBase(CheckerBase):
                 self.collection_query_tool.preferred_status_origin == "latest"
                 and data["status"]["availability"]["latest"]
             ):
-                self.status.status = data["status"]["availability"]["latest"]["status"]
+                try:
+                    # legacy
+                    self.status.status = data["status"]["availability"]["latest"][
+                        "status"
+                    ]
+                except KeyError:
+                    self.status.status = data["status"]["availability"]["latest"]
                 self.status.status_source = "COLLECTION"
             elif (
                 self.collection_query_tool.preferred_status_origin == "recommended"

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/cli/entry_points/pyfunceble/cli.py

@@ -69,7 +69,9 @@ from PyFunceble.cli.system.launcher import SystemLauncher
 from PyFunceble.helpers.regex import RegexHelper
 
 
-def get_configured_value(entry: str, *, negate=False) -> Any:
+def get_configured_value(
+    entry: str, *, negate: bool = False, value_only: bool = False
+) -> Any:
     """
     Provides the currently configured value.
 
@@ -81,6 +83,9 @@ def get_configured_value(entry: str, *, negate=False) -> Any:
     :param negate:
         Allows us to negate the result from the configuration.
 
+    :param value_only:
+        Whether we should only return the value or the full message.
+
     :raise ValueError:
         When the given :code:`entry` is not found.
     """
@@ -102,10 +107,14 @@ def get_configured_value(entry: str, *, negate=False) -> Any:
         result = not result
 
     return (
-        f"\n{colorama.Fore.YELLOW}{colorama.Style.BRIGHT}"
-        f"Configured value: {colorama.Fore.BLUE}"
-        f"{result!r}"
-        f"{colorama.Style.RESET_ALL}"
+        (
+            f"\n{colorama.Fore.YELLOW}{colorama.Style.BRIGHT}"
+            f"Configured value: {colorama.Fore.BLUE}"
+            f"{result!r}"
+            f"{colorama.Style.RESET_ALL}"
+        )
+        if not value_only
+        else result
     )
 
 
@@ -122,6 +131,12 @@ def add_arguments_to_parser(
         if "dest" in opt_args:
             opt_args["dest"] = opt_args["dest"].replace(".", "__")
 
+        for index, value in enumerate(pos_args):
+            if value.startswith("-") and "." not in value:
+                continue
+
+            pos_args[index] = value.replace(".", "__")
+
         parser.add_argument(*pos_args, **opt_args)
 
 
@@ -1184,6 +1199,42 @@ def get_default_group_data() -> List[Tuple[List[str], dict]]:
     ]
 
 
+def platform_parser(
+    parser: Union[argparse.ArgumentParser, argparse._SubParsersAction]
+) -> None:
+    """
+    Adds the platform group to the given parser.
+    """
+
+    platform = parser.add_parser(
+        "platform",
+        add_help=False,
+        epilog=PyFunceble.cli.storage.STD_EPILOG,
+    )
+
+    args = [
+        (
+            ["cli_testing.testing_mode.platform_contribution"],
+            {
+                "default": get_configured_value(
+                    "cli_testing.testing_mode.platform_contribution", value_only=True
+                ),
+                "action": "store_%s"
+                % str(
+                    not get_configured_value(
+                        "cli_testing.testing_mode.platform_contribution",
+                        value_only=True,
+                    )
+                ).lower(),
+                "help": argparse.SUPPRESS,
+            },
+        )
+    ]
+
+    add_arguments_to_parser(platform, args)
+    add_arguments_to_parser(platform, get_default_group_data())
+
+
 def ask_authorization_to_merge_config(missing_key: Optional[str] = None) -> bool:
     """
     Asks the end-user for the authorization to merge the upstream
@@ -1292,6 +1343,8 @@ def tool() -> None:
 
     # pylint:  disable=possibly-unused-variable
 
+    command_sub = parser.add_subparsers(dest="command", help=argparse.SUPPRESS)
+
     shtab.add_argument_to(
         parser,
         option_string=["--show-completion"],
@@ -1321,6 +1374,8 @@ def tool() -> None:
         get_ci_group_data,
     ]
 
+    parse_funcs = [platform_parser]
+
     for func in funcs:
         parser_name = func.__name__.replace("get_", "").replace("_data", "")
 
@@ -1348,10 +1403,21 @@ def tool() -> None:
                 )
                 sys.exit(1)
 
+    for func in parse_funcs:
+        func(command_sub)
+
     add_arguments_to_parser(parser, get_default_group_data())
 
     args = parser.parse_args()
 
-    if any(getattr(args, x) for x in ["domains", "urls", "files", "url_files"]):
+    if any(
+        getattr(args, x)
+        for x in [
+            "domains",
+            "urls",
+            "files",
+            "url_files",
+        ]
+    ) or bool(args.command):
         SystemIntegrator(args).start()
         SystemLauncher(args).start()

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/cli/processes/workers/base.py

@@ -318,8 +318,10 @@ class WorkerBase(multiprocessing.Process):
 
                 try:
                     worker_name, destination_worker, consumed = self.input_queue.get()
-                except EOFError:
-                    PyFunceble.facility.Logger.info("Got EOFError. Stopping worker.")
+                except (EOFError, KeyboardInterrupt):
+                    PyFunceble.facility.Logger.info(
+                        "Got EOFError/KeyboardInterrupt. Stopping worker."
+                    )
                     self.global_exit_event.set()
                     break
 
@@ -370,7 +372,14 @@ class WorkerBase(multiprocessing.Process):
                     self.share_waiting_message(apply_breakoff=wait_for_stop)
                     continue
 
-                result = self.target(consumed)
+                try:
+                    result = self.target(consumed)
+                except (EOFError, KeyboardInterrupt):
+                    PyFunceble.facility.Logger.info(
+                        "Got EOFError/KeyboardInterrupt. Stopping worker."
+                    )
+                    self.global_exit_event.set()
+                    break
 
                 if result is not None:
                     self.add_to_output_queue(result)

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/cli/processes/workers/producer.py

@@ -399,6 +399,11 @@ class ProducerWorker(WorkerBase):
             )
             return None
 
+        if test_dataset["type"] == "platform-contribution":
+            self.collection_query_tool.deliver_contract(
+                test_dataset["contract"], test_result
+            )
+
         if (
             PyFunceble.storage.CONFIGURATION.collection.push
             and test_result.status_source != "COLLECTION"

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/cli/system/launcher.py

@@ -119,6 +119,7 @@ from PyFunceble.dataset.inactive.base import InactiveDatasetBase
 from PyFunceble.helpers.directory import DirectoryHelper
 from PyFunceble.helpers.download import DownloadHelper
 from PyFunceble.helpers.file import FileHelper
+from PyFunceble.query.collection import CollectionQueryTool
 
 
 class SystemLauncher(SystemBase):
@@ -222,7 +223,7 @@ class SystemLauncher(SystemBase):
             )
             self.producer_process_manager = ChancyProducerProcessesManager(
                 self.manager,
-                max_worker=1,
+                max_worker=PyFunceble.storage.CONFIGURATION.cli_testing.max_workers,
                 continuous_integration=self.continuous_integration,
                 input_queue=self.tester_process_manager.output_queue[0],
                 daemon=True,
@@ -406,6 +407,21 @@ class SystemLauncher(SystemBase):
                     "Added to the protocol:\n%r", to_append
                 )
 
+        # pylint: disable=line-too-long
+        if (
+            PyFunceble.storage.CONFIGURATION.cli_testing.testing_mode.platform_contribution
+        ):
+            self.testing_protocol.append(
+                {
+                    "type": "platform-contribution",
+                    "subject_type": "any",
+                    "destination": None,
+                    "checker_type": None,
+                    "output_dir": None,
+                    "session_id": None,
+                }
+            )
+
     def ci_stop_in_the_middle_if_time_exceeded(self) -> "SystemLauncher":
         """
         Stops our processes as soon as the time is exceeded.
@@ -648,7 +664,37 @@ class SystemLauncher(SystemBase):
                     )
             elif protocol["type"] == "file":
                 handle_file(protocol)
+            elif protocol["type"] == "platform-contribution":
+                query_tool = CollectionQueryTool()
+
+                while True:
+                    for next_contract in next(
+                        query_tool.pull_contract(
+                            PyFunceble.storage.CONFIGURATION.cli_testing.max_workers
+                        )
+                    ):
+                        if (
+                            "subject" not in next_contract
+                            or not next_contract["subject"]
+                        ):
+                            continue
 
+                        protocol_data = copy.deepcopy(protocol)
+
+                        protocol_data["checker_type"] = next_contract[
+                            "checker_type"
+                        ].upper()
+                        protocol_data["subject_type"] = next_contract["subject_type"]
+                        protocol_data["subject"] = protocol_data["idna_subject"] = (
+                            next_contract["subject"]["subject"]
+                        )
+                        protocol_data["contract"] = copy.deepcopy(next_contract)
+
+                        self.tester_process_manager.add_to_input_queue(
+                            protocol_data, worker_name="main"
+                        )
+
+                    self.ci_stop_in_the_middle_if_time_exceeded()
         return self
 
     def generate_waiting_files(self) -> "SystemLauncher":

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/config/loader.py

@@ -172,6 +172,16 @@ class ConfigLoader:
             # If timeout is set to a negative digit, switch to the default one.
             config["lookup"]["timeout"] = 5
 
+        if (
+            "cli_testing" in config
+            and "testing_mode" in config["cli_testing"]
+            and "platform_contribution" in config["cli_testing"]["testing_mode"]
+            and config["cli_testing"]["testing_mode"]["platform_contribution"]
+        ):
+            # If we are under a special testing mode. We shouldn't generate
+            # any files
+            config["cli_testing"]["file_generation"]["no_file"] = True
+
         return config
 
     @staticmethod

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/data/infrastructure/.PyFunceble_production.yaml

@@ -173,6 +173,9 @@ cli_testing:
     # Activates the reputation test.
     reputation: no
 
+    # BETA: Activates the platform contribution test.
+    platform_contribution: no
+
   days_between:
     # Provides everything which is x days periodic.
 

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/query/collection.py

@@ -51,7 +51,7 @@ License:
 """
 
 import json
-from typing import List, Optional, Union
+from typing import Generator, List, Optional, Union
 
 import requests
 import requests.exceptions
@@ -447,7 +447,7 @@ class CollectionQueryTool:
 
         return self
 
-    def ensure_is_modern_api_is_set(func):  # pylint: disable=no-self-argument
+    def ensure_modern_api(func):  # pylint: disable=no-self-argument
         """
         Ensures that the :code:`is_modern_api` attribute is set before running
         the decorated method.
@@ -461,7 +461,7 @@ class CollectionQueryTool:
 
         return wrapper
 
-    @ensure_is_modern_api_is_set
+    @ensure_modern_api
     def pull(self, subject: str) -> Optional[dict]:
         """
         Pulls all data related to the subject or :py:class:`None`
@@ -520,7 +520,113 @@ class CollectionQueryTool:
 
         return None
 
-    @ensure_is_modern_api_is_set
+    @ensure_modern_api
+    def pull_contract(self, amount: int = 1) -> Generator[dict, None, None]:
+        """
+        Pulls the next amount of contracts.
+
+        :param int amount:
+            The amount of data to pull.
+
+        :return:
+            The response of the query.
+        """
+
+        PyFunceble.facility.Logger.info("Starting to pull next contract")
+
+        url = f"{self.url_base}/v1/contracts/next"
+        params = {
+            "limit": amount,
+            "shuffle": True,
+        }
+
+        try:
+            response = self.session.get(
+                url,
+                params=params,
+                timeout=self.timeout,
+            )
+
+            response_json = response.json()
+
+            if response.status_code == 200:
+                PyFunceble.facility.Logger.debug(
+                    "Successfully pulled next %r contracts. Response: %r", response_json
+                )
+
+                PyFunceble.facility.Logger.info("Finished to pull next contract")
+
+                yield response_json
+        except (requests.RequestException, json.decoder.JSONDecodeError):
+            response_json = [{"subject": {}}]
+
+        PyFunceble.facility.Logger.debug(
+            "Failed to pull next contract. Response: %r", response_json
+        )
+        PyFunceble.facility.Logger.info("Finished to pull next contracts")
+
+        yield response_json
+
+    @ensure_modern_api
+    def deliver_contract(self, contract: dict, contract_data: dict) -> Optional[dict]:
+        """
+        Delivers the given contract data.
+
+        :param contract:
+            The contract to deliver.
+        :param contract_data:
+            The data to deliver.
+
+        :return:
+            The response of the query.
+        """
+
+        PyFunceble.facility.Logger.info(
+            "Starting to deliver contract data: %r", contract
+        )
+
+        contract_id = contract["id"]
+        contract_data = (
+            contract_data.to_json()
+            if not isinstance(contract_data, dict)
+            else contract_data
+        )
+        url = f"{self.url_base}/v1/contracts/{contract_id}/delivery"
+
+        try:
+            response = self.session.post(
+                url,
+                data=contract_data.encode("utf-8"),
+                timeout=self.timeout,
+            )
+
+            response_json = response.json()
+
+            if response.status_code == 200:
+                PyFunceble.facility.Logger.debug(
+                    "Successfully delivered contract: %r. Response: %r",
+                    contract_data,
+                    response_json,
+                )
+
+                PyFunceble.facility.Logger.info(
+                    "Finished to deliver contract: %r", contract_data
+                )
+
+                return response_json
+        except (requests.RequestException, json.decoder.JSONDecodeError):
+            response_json = {}
+
+        PyFunceble.facility.Logger.debug(
+            "Failed to deliver contract: %r. Response: %r", contract_data, response_json
+        )
+        PyFunceble.facility.Logger.info(
+            "Finished to deliver contract: %r", contract_data
+        )
+
+        return None
+
+    @ensure_modern_api
     def push(
         self,
         checker_status: Union[
@@ -705,25 +811,36 @@ class CollectionQueryTool:
         if not self.token:
             return None
 
-        if isinstance(
-            data,
-            (AvailabilityCheckerStatus, SyntaxCheckerStatus, ReputationCheckerStatus),
-        ):
-            data = data.to_dict()
-
-        if not isinstance(data, dict):  # pragma: no cover ## Should never happen
-            raise TypeError(f"<data> should be {dict}, {type(data)} given.")
-
         PyFunceble.facility.Logger.info("Starting to submit WHOIS: %r", data)
 
         url = f"{self.url_base}/v1/status/whois"
 
         try:
-            response = self.session.post(
-                url,
-                json=data,
-                timeout=self.timeout,
-            )
+            if isinstance(data, dict):
+                response = self.session.post(
+                    url,
+                    json=data,
+                    timeout=self.timeout,
+                )
+            elif isinstance(
+                data,
+                (
+                    AvailabilityCheckerStatus,
+                    SyntaxCheckerStatus,
+                    ReputationCheckerStatus,
+                ),
+            ):
+                response = self.session.post(
+                    url,
+                    data=data.to_json(),
+                    timeout=self.timeout,
+                )
+            else:
+                response = self.session.post(
+                    url,
+                    data=data,
+                    timeout=self.timeout,
+                )
 
             response_json = response.json()
 

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble/storage.py

@@ -61,7 +61,7 @@ from dotenv import load_dotenv
 from PyFunceble.storage_facility import get_config_directory
 
 PROJECT_NAME: str = "PyFunceble"
-PROJECT_VERSION: str = "4.2.9.dev (Blue Duckling: Ixora)"
+PROJECT_VERSION: str = "4.2.11.dev (Blue Duckling: Ixora)"
 
 DISTRIBUTED_CONFIGURATION_FILENAME: str = ".PyFunceble_production.yaml"
 DISTRIBUTED_DIR_STRUCTURE_FILENAME: str = "dir_structure_production.json"

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/PyFunceble_dev.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyFunceble-dev
-Version: 4.2.9
+Version: 4.2.11
 Summary: The tool to check the availability or syntax of domain, IP or URL.
 Home-page: https://github.com/funilrys/PyFunceble
 Author: funilrys

{PyFunceble-dev-4.2.9 → PyFunceble-dev-4.2.11}/version.yaml

@@ -1,4 +1,4 @@
-current_version: '4.2.9.dev (Blue Duckling: Ixora)'
+current_version: '4.2.11.dev (Blue Duckling: Ixora)'
 deprecated:
 - 3.0.21
 - 3.1.20