Skip to content

# Launcher

The tool to check the availability or syntax of domain, IP or URL.

::

    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides the system launcher. From here, it's all about real testing.

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks: https://pyfunceble.github.io/#/special-thanks

Contributors: https://pyfunceble.github.io/#/contributors

Project link: https://github.com/funilrys/PyFunceble

Project documentation: https://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 Nissar Chababy

    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

        https://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.

## `SystemLauncher`

Bases: `SystemBase`

Provides the system tests launcher.

Source code in `PyFunceble/cli/system/launcher.py`

     129
     130
     131
     132
     133
     134
     135
     136
     137
     138
     139
     140
     141
     142
     143
     144
     145
     146
     147
     148
     149
     150
     151
     152
     153
     154
     155
     156
     157
     158
     159
     160
     161
     162
     163
     164
     165
     166
     167
     168
     169
     170
     171
     172
     173
     174
     175
     176
     177
     178
     179
     180
     181
     182
     183
     184
     185
     186
     187
     188
     189
     190
     191
     192
     193
     194
     195
     196
     197
     198
     199
     200
     201
     202
     203
     204
     205
     206
     207
     208
     209
     210
     211
     212
     213
     214
     215
     216
     217
     218
     219
     220
     221
     222
     223
     224
     225
     226
     227
     228
     229
     230
     231
     232
     233
     234
     235
     236
     237
     238
     239
     240
     241
     242
     243
     244
     245
     246
     247
     248
     249
     250
     251
     252
     253
     254
     255
     256
     257
     258
     259
     260
     261
     262
     263
     264
     265
     266
     267
     268
     269
     270
     271
     272
     273
     274
     275
     276
     277
     278
     279
     280
     281
     282
     283
     284
     285
     286
     287
     288
     289
     290
     291
     292
     293
     294
     295
     296
     297
     298
     299
     300
     301
     302
     303
     304
     305
     306
     307
     308
     309
     310
     311
     312
     313
     314
     315
     316
     317
     318
     319
     320
     321
     322
     323
     324
     325
     326
     327
     328
     329
     330
     331
     332
     333
     334
     335
     336
     337
     338
     339
     340
     341
     342
     343
     344
     345
     346
     347
     348
     349
     350
     351
     352
     353
     354
     355
     356
     357
     358
     359
     360
     361
     362
     363
     364
     365
     366
     367
     368
     369
     370
     371
     372
     373
     374
     375
     376
     377
     378
     379
     380
     381
     382
     383
     384
     385
     386
     387
     388
     389
     390
     391
     392
     393
     394
     395
     396
     397
     398
     399
     400
     401
     402
     403
     404
     405
     406
     407
     408
     409
     410
     411
     412
     413
     414
     415
     416
     417
     418
     419
     420
     421
     422
     423
     424
     425
     426
     427
     428
     429
     430
     431
     432
     433
     434
     435
     436
     437
     438
     439
     440
     441
     442
     443
     444
     445
     446
     447
     448
     449
     450
     451
     452
     453
     454
     455
     456
     457
     458
     459
     460
     461
     462
     463
     464
     465
     466
     467
     468
     469
     470
     471
     472
     473
     474
     475
     476
     477
     478
     479
     480
     481
     482
     483
     484
     485
     486
     487
     488
     489
     490
     491
     492
     493
     494
     495
     496
     497
     498
     499
     500
     501
     502
     503
     504
     505
     506
     507
     508
     509
     510
     511
     512
     513
     514
     515
     516
     517
     518
     519
     520
     521
     522
     523
     524
     525
     526
     527
     528
     529
     530
     531
     532
     533
     534
     535
     536
     537
     538
     539
     540
     541
     542
     543
     544
     545
     546
     547
     548
     549
     550
     551
     552
     553
     554
     555
     556
     557
     558
     559
     560
     561
     562
     563
     564
     565
     566
     567
     568
     569
     570
     571
     572
     573
     574
     575
     576
     577
     578
     579
     580
     581
     582
     583
     584
     585
     586
     587
     588
     589
     590
     591
     592
     593
     594
     595
     596
     597
     598
     599
     600
     601
     602
     603
     604
     605
     606
     607
     608
     609
     610
     611
     612
     613
     614
     615
     616
     617
     618
     619
     620
     621
     622
     623
     624
     625
     626
     627
     628
     629
     630
     631
     632
     633
     634
     635
     636
     637
     638
     639
     640
     641
     642
     643
     644
     645
     646
     647
     648
     649
     650
     651
     652
     653
     654
     655
     656
     657
     658
     659
     660
     661
     662
     663
     664
     665
     666
     667
     668
     669
     670
     671
     672
     673
     674
     675
     676
     677
     678
     679
     680
     681
     682
     683
     684
     685
     686
     687
     688
     689
     690
     691
     692
     693
     694
     695
     696
     697
     698
     699
     700
     701
     702
     703
     704
     705
     706
     707
     708
     709
     710
     711
     712
     713
     714
     715
     716
     717
     718
     719
     720
     721
     722
     723
     724
     725
     726
     727
     728
     729
     730
     731
     732
     733
     734
     735
     736
     737
     738
     739
     740
     741
     742
     743
     744
     745
     746
     747
     748
     749
     750
     751
     752
     753
     754
     755
     756
     757
     758
     759
     760
     761
     762
     763
     764
     765
     766
     767
     768
     769
     770
     771
     772
     773
     774
     775
     776
     777
     778
     779
     780
     781
     782
     783
     784
     785
     786
     787
     788
     789
     790
     791
     792
     793
     794
     795
     796
     797
     798
     799
     800
     801
     802
     803
     804
     805
     806
     807
     808
     809
     810
     811
     812
     813
     814
     815
     816
     817
     818
     819
     820
     821
     822
     823
     824
     825
     826
     827
     828
     829
     830
     831
     832
     833
     834
     835
     836
     837
     838
     839
     840
     841
     842
     843
     844
     845
     846
     847
     848
     849
     850
     851
     852
     853
     854
     855
     856
     857
     858
     859
     860
     861
     862
     863
     864
     865
     866
     867
     868
     869
     870
     871
     872
     873
     874
     875
     876
     877
     878
     879
     880
     881
     882
     883
     884
     885
     886
     887
     888
     889
     890
     891
     892
     893
     894
     895
     896
     897
     898
     899
     900
     901
     902
     903
     904
     905
     906
     907
     908
     909
     910
     911
     912
     913
     914
     915
     916
     917
     918
     919
     920
     921
     922
     923
     924
     925
     926
     927
     928
     929
     930
     931
     932
     933
     934
     935
     936
     937
     938
     939
     940
     941
     942
     943
     944
     945
     946
     947
     948
     949
     950
     951
     952
     953
     954
     955
     956
     957
     958
     959
     960
     961
     962
     963
     964
     965
     966
     967
     968
     969
     970
     971
     972
     973
     974
     975
     976
     977
     978
     979
     980
     981
     982
     983
     984
     985
     986
     987
     988
     989
     990
     991
     992
     993
     994
     995
     996
     997
     998
     999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    1076
    1077
    1078
    1079
    1080
    1081
    1082
    1083
    1084
    1085
    1086
    1087
    1088
    1089
    1090
    1091
    1092
    1093
    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    1129
    1130
    1131
    1132
    1133
    1134
    1135
    1136
    1137
    1138
    1139
    1140
    1141
    1142
    1143
    1144
    1145
    1146
    1147
    1148
    1149
    1150
    1151
    1152
    1153
    1154
    1155
    1156
    1157
    1158
    1159
    1160
    1161
    1162
    1163
    1164
    1165
    1166
    1167
    1168
    1169
    1170
    1171
    1172
    1173
    1174
    1175
    1176
    1177
    1178
    1179
    1180
    1181
    1182
    1183
    1184
    1185
    1186
    1187
    1188
    1189
    1190
    1191
    1192
    1193
    1194
    1195
    1196
    1197
    1198
    1199
    1200
    1201
    1202
    1203
    1204
    1205
    1206
    1207
    1208
    1209
    1210
    1211
    1212
    1213

    class SystemLauncher(SystemBase):
        """
        Provides the system tests launcher.
        """

        testing_protocol: List[dict] = []
        """
        Saves the protocol which we are going to generate.
        The protocol will saves a set of information about what to test,
        what kind of output to produce and most importantly where.
        """

        subject2complements: Subject2Complements = Subject2Complements()
        inputline2subject: InputLine2Subject = InputLine2Subject()
        adblock_inputline2subject: AdblockInputLine2Subject = AdblockInputLine2Subject()
        wildcard2subject: Wildcard2Subject = Wildcard2Subject()
        rpz_policy2subject: RPZPolicy2Subject = RPZPolicy2Subject()
        rpz_inputline2subject: RPZInputLine2Subject = RPZInputLine2Subject()
        url2netloc: Url2Netloc = Url2Netloc()
        cidr2subject: CIDR2Subject = CIDR2Subject()

        stdout_printer: StdoutPrinter = StdoutPrinter()
        file_printer: FilePrinter = FilePrinter()
        counter: FilesystemCounter = FilesystemCounter()
        registrar_counter: RegistrarCounter = RegistrarCounter()

        execution_time_holder: Optional[ExecutionTime] = None
        file_preloader: Optional[FilePreloader] = None

        manager: Optional[multiprocessing.Manager]
        tester_process_manager: Optional[
            Union[TesterProcessesManager, ChancyTesterProcessesManager]
        ] = None
        producer_process_manager: Optional[
            Union[ProducerProcessesManager, ChancyProducerProcessesManager]
        ] = None
        miner_process_manager: Optional[MinerProcessesManager] = None
        dir_files_sorter_process_manager: Optional[DirFileSorterProcessesManager] = None
        migrator_process_manager: Optional[MigratorProcessesManager] = None

        continue_dataset: Optional[ContinueDatasetBase] = None
        inactive_dataset: Optional[InactiveDatasetBase] = None
        whois_dataset: Optional[WhoisDatasetBase] = None
        continuous_integration: Optional[ContinuousIntegrationBase] = None

        db_session: Optional[Session] = None

        checker_type: Optional[str] = None

        sessions_id: dict = {}

        def __init__(self, args: Optional[argparse.Namespace] = None) -> None:
            try:
                self.db_session = (
                    PyFunceble.cli.factory.DBSession.get_db_session().get_new_session()()
                )
            except TypeError:
                self.db_session = None

            self.execution_time_holder = ExecutionTime().set_start_time()
            self.checker_type = get_testing_mode()
            self.continue_dataset = get_continue_dataset_object(db_session=self.db_session)
            self.inactive_dataset = get_inactive_dataset_object(db_session=self.db_session)
            self.whois_dataset = get_whois_dataset_object(db_session=self.db_session)
            self.continuous_integration = ci_object()

            if self.continuous_integration.authorized:
                self.continuous_integration.init()

            self.stdout_printer.guess_allow_coloration().guess_allow_background_coloration()

            self.manager = multiprocessing.Manager()

            if not PyFunceble.storage.CONFIGURATION.cli_testing.chancy_tester:
                self.tester_process_manager = TesterProcessesManager(
                    max_workers=PyFunceble.storage.CONFIGURATION.cli_testing.max_workers,
                    manager=self.manager,
                    daemon=True,
                    generate_output_queue=True,
                    output_queue_count=(
                        1 if not PyFunceble.storage.CONFIGURATION.cli_testing.mining else 2
                    ),
                    spread_stop_signal=True,
                    spread_wait_signal=True,
                    dynamic_up_scaling=True,
                    dynamic_down_scaling=True,
                    delay_shutdown=PyFunceble.storage.CONFIGURATION.cli_testing.mining,
                    generate_configuration_queue=False,
                    continuous_integration=self.continuous_integration,
                )

                self.producer_process_manager = ProducerProcessesManager(
                    max_workers=1,
                    manager=self.manager,
                    daemon=True,
                    generate_output_queue=False,
                    spread_stop_signal=True,
                    spread_wait_signal=True,
                    delay_shutdown=PyFunceble.storage.CONFIGURATION.cli_testing.mining,
                    generate_configuration_queue=False,
                    continuous_integration=self.continuous_integration,
                )
            else:
                self.tester_process_manager = ChancyTesterProcessesManager(
                    max_workers=PyFunceble.storage.CONFIGURATION.cli_testing.max_workers,
                    manager=self.manager,
                    daemon=True,
                    generate_output_queue=True,
                    output_queue_count=(
                        1 if not PyFunceble.storage.CONFIGURATION.cli_testing.mining else 2
                    ),
                    spread_stop_signal=True,
                    spread_wait_signal=True,
                    dynamic_up_scaling=True,
                    dynamic_down_scaling=True,
                    delay_shutdown=PyFunceble.storage.CONFIGURATION.cli_testing.mining,
                    generate_configuration_queue=False,
                    continuous_integration=self.continuous_integration,
                )
                self.producer_process_manager = ChancyProducerProcessesManager(
                    max_workers=1,
                    manager=self.manager,
                    daemon=True,
                    generate_output_queue=False,
                    spread_stop_signal=True,
                    spread_wait_signal=True,
                    delay_shutdown=PyFunceble.storage.CONFIGURATION.cli_testing.mining,
                    generate_configuration_queue=False,
                    continuous_integration=self.continuous_integration,
                )

            self.tester_process_manager.add_dependent_manager(self.producer_process_manager)

            self.dir_files_sorter_process_manager = DirFileSorterProcessesManager(
                manager=self.manager,
                max_workers=PyFunceble.storage.CONFIGURATION.cli_testing.max_workers,
                continuous_integration=self.continuous_integration,
                daemon=True,
                generate_output_queue=False,
                generate_configuration_queue=False,
            )
            self.migrator_process_manager = MigratorProcessesManager(
                manager=self.manager,
                continuous_integration=self.continuous_integration,
                daemon=True,
                generate_input_queue=False,
                generate_output_queue=False,
            )

            if PyFunceble.storage.CONFIGURATION.cli_testing.mining:
                self.miner_process_manager = MinerProcessesManager(
                    manager=self.manager,
                    max_workers=1,
                    continuous_integration=self.continuous_integration,
                    output_queues=[self.tester_process_manager.input_queue],
                    generate_input_queue=False,
                    generate_output_queue=False,
                    daemon=True,
                    spread_stop_signal=False,
                    spread_wait_signal=True,
                    delay_shutdown=PyFunceble.storage.CONFIGURATION.cli_testing.mining,
                )

                self.tester_process_manager.add_dependent_manager(
                    self.miner_process_manager
                )

            if self.continuous_integration.authorized:
                self.continuous_integration.set_start_time()

            self.file_preloader = FilePreloader(
                continuous_integration=self.continuous_integration,
                checker_type=self.checker_type,
                adblock_inputline2subject=self.adblock_inputline2subject,
                wildcard2subject=self.wildcard2subject,
                rpz_policy2subject=self.rpz_policy2subject,
                rpz_inputline2subject=self.rpz_inputline2subject,
                inputline2subject=self.inputline2subject,
                subject2complements=self.subject2complements,
                url2netloc=self.url2netloc,
                continue_dataset=self.continue_dataset,
                inactive_dataset=self.inactive_dataset,
            )

            super().__init__(args)

        def __del__(self) -> None:
            if self.db_session is not None:
                try:
                    self.db_session.close()
                except sqlalchemy.exc.OperationalError:
                    pass

        @staticmethod
        def print_home_ascii() -> None:
            """
            Prints our ASCII home logo.
            """

            if not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet:
                if PyFunceble.cli.utils.stdout.get_template_to_use() != "simple":
                    print(PyFunceble.cli.utils.ascii_logo.get_home_representation())

        @SystemBase.ensure_args_is_given
        def fill_protocol(self) -> "SystemLauncher":
            """
            Fills the protocol with the information about what we are supposed to test.
            """

            filesytem_dirbase = FilesystemDirBase()

            if self.args.domains:
                for domain in self.args.domains:
                    to_append = {
                        "type": "single",
                        "subject_type": "domain",
                        "destination": None,
                        "subject": domain,
                        "idna_subject": domain2idna.domain2idna(domain),
                        "source": None,
                        "output_dir": None,
                        "checker_type": self.checker_type,
                        "session_id": None,
                    }

                    self.testing_protocol.append(to_append)

                    PyFunceble.facility.Logger.debug(
                        "Added to the protocol:\n%r", to_append
                    )

            if self.args.urls:
                for url in self.args.urls:
                    to_append = {
                        "type": "single",
                        "subject_type": "url",
                        "destination": None,
                        "subject": url,
                        "idna_subject": domain2idna.domain2idna(url),
                        "source": None,
                        "output_dir": None,
                        "checker_type": self.checker_type,
                        "session_id": None,
                    }

                    self.testing_protocol.append(to_append)

                    PyFunceble.facility.Logger.debug(
                        "Added to the protocol:\n%r", to_append
                    )

            if self.args.files:
                for file in self.args.files:
                    # pylint: disable=line-too-long
                    if (
                        not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.merge_output_dirs
                    ):
                        destination = get_destination_from_origin(file)
                    else:
                        destination = get_destination_from_origin(
                            PyFunceble.cli.storage.OUTPUTS.merged_directory
                        )

                    to_append = {
                        "type": "file",
                        "subject_type": "domain",
                        # pylint: disable=line-too-long
                        "destination": destination,
                        "source": file,
                        "subject": file,
                        "checker_type": self.checker_type,
                        "session_id": None,
                    }

                    to_append["output_dir"] = filesytem_dirbase.set_parent_dirname(
                        to_append["destination"]
                    ).get_output_basedir()

                    self.testing_protocol.append(to_append)

                    PyFunceble.facility.Logger.debug(
                        "Added to the protocol:\n%r", to_append
                    )

            if self.args.url_files:
                for file in self.args.url_files:
                    # pylint: disable=line-too-long
                    if (
                        not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.merge_output_dirs
                    ):
                        destination = get_destination_from_origin(file)
                    else:
                        destination = get_destination_from_origin(
                            PyFunceble.cli.storage.OUTPUTS.merged_directory
                        )

                    to_append = {
                        "type": "file",
                        "subject_type": "url",
                        # pylint: disable=line-too-long
                        "destination": destination,
                        "source": file,
                        "subject": file,
                        "checker_type": self.checker_type,
                        "session_id": None,
                    }

                    to_append["output_dir"] = filesytem_dirbase.set_parent_dirname(
                        to_append["destination"]
                    ).get_output_basedir()

                    self.testing_protocol.append(to_append)

                    PyFunceble.facility.Logger.debug(
                        "Added to the protocol:\n%r", to_append
                    )

            # pylint: disable=line-too-long
            if (
                not self.testing_protocol
                and 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.
            """

            if self.continuous_integration.is_time_exceeded():
                self.run_ci_saving_instructions()

            return self

        # pylint: disable=too-many-statements
        def fill_to_test_queue_from_protocol(self) -> "SystemLauncher":
            """
            Read the protocol and fill the testing queue.
            """

            def download_file(file: str, destination: str) -> bool:
                """
                Downloads the given file (if it's an URL).

                :param file:
                    The file to download.
                :param destination.
                    The file to write.

                :return:
                    A boolean which represent the action state.
                """

                if URLSyntaxChecker(file).is_valid():
                    DownloadHelper(
                        file,
                        certificate_validation=(
                            PyFunceble.storage.CONFIGURATION.verify_ssl_certificate
                            if PyFunceble.storage.CONFIGURATION
                            else True
                        ),
                        own_proxy_handler=True,
                        proxies=PyFunceble.storage.PROXY,
                    ).download_text(destination=destination)
                    return True
                return False

            def create_trigger_file_if_necessary(parent_dirname: str) -> None:
                """
                Create the trigger file if necessary. The purpose of the trigger
                file is to have a file that is always updated until a test is
                completed done.
                """

                if self.continuous_integration.authorized:
                    cleanup_tool = FilesystemCleanup(parent_dirname)

                    trigger_file_helper = FileHelper(
                        os.path.join(
                            cleanup_tool.get_output_basedir(),
                            PyFunceble.cli.storage.CI_TRIGGER_FILE,
                        )
                    )

                    # Ensures that we always have something to commit.
                    trigger_file_helper.write(
                        f"{self.sessions_id[parent_dirname]} " f"{secrets.token_hex(8)}",
                        overwrite=True,
                    )

            def cleanup_if_necessary(parent_dirname: str) -> None:
                """
                Process the cleanup if it's necessary.
                """

                cleanup_tool = FilesystemCleanup(parent_dirname)
                running_file_helper = FileHelper(
                    os.path.join(
                        cleanup_tool.get_output_basedir(),
                        PyFunceble.cli.storage.TEST_RUNNING_FILE,
                    )
                )

                if not running_file_helper.exists():
                    self.sessions_id[parent_dirname] = secrets.token_hex(12)

                    cleanup_tool.clean_output_files()
                    running_file_helper.write(
                        f"{self.sessions_id[parent_dirname]} "
                        f"{datetime.datetime.now(datetime.timezone.utc).isoformat()}",
                        overwrite=True,
                    )
                else:
                    possible_session_id = running_file_helper.read().split()[0]

                    try:
                        _ = datetime.datetime.fromisoformat(possible_session_id).astimezone(
                            datetime.timezone.utc
                        )
                        self.sessions_id[parent_dirname] = None
                    except (ValueError, TypeError):
                        self.sessions_id[parent_dirname] = possible_session_id

            def match_output_directory_if_necessary(parent_dirname: str) -> None:
                """
                Restore missing directories from the current directory.
                """

                if not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.no_file:
                    DirectoryStructureRestoration(parent_dirname).restore_from_backup()

            def handle_file(protocol: dict) -> None:
                """
                Given a protocol related to a given file, we handle every
                possible decoding case before submitting a new subject to the queue.
                """

                cleanup_if_necessary(protocol["destination"])
                create_trigger_file_if_necessary(protocol["destination"])
                match_output_directory_if_necessary(protocol["destination"])

                if download_file(protocol["subject"], protocol["destination"]):
                    protocol["subject"] = os.path.relpath(protocol["destination"])
                else:
                    protocol["subject"] = os.path.relpath(protocol["subject"])

                protocol["source"] = os.path.relpath(protocol["source"])
                protocol["session_id"] = self.sessions_id[protocol["destination"]]

                if isinstance(self.continue_dataset, CSVContinueDataset):
                    self.continue_dataset.set_base_directory(protocol["output_dir"])

                if self.file_preloader.authorized:
                    if not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet:
                        print(
                            f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
                            f"Started preloading of {protocol['source']}..."
                        )

                    self.file_preloader.set_protocol(protocol).start(
                        # pylint: disable=line-too-long
                        print_dots=(
                            PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet
                            or bool(
                                PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.dots
                            )
                        )
                    )

                    if not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet:
                        print(
                            f"\n{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
                            f"Finished preloading of {protocol['source']}."
                        )

                    self.__start_core_processes()

                    for subject in self.continue_dataset.get_to_test(
                        protocol["session_id"]
                    ):
                        self.ci_stop_in_the_middle_if_time_exceeded()

                        to_send = copy.deepcopy(protocol)
                        to_send["subject"], to_send["idna_subject"] = subject, subject
                        to_send["from_preload"] = True

                        self.tester_process_manager.push_to_input_queue(
                            to_send, source_worker="main"
                        )

                else:
                    with FileHelper(protocol["subject"]).open(
                        "r", encoding="utf-8"
                    ) as file_stream:
                        for line in file_stream:
                            self.ci_stop_in_the_middle_if_time_exceeded()

                            line = line.strip()

                            if "SOA" in line:
                                self.rpz_policy2subject.set_soa(line.split()[0])

                            for subject in get_subjects_from_line(
                                line,
                                self.checker_type,
                                subject_type=protocol["subject_type"],
                                adblock_inputline2subject=self.adblock_inputline2subject,
                                wildcard2subject=self.wildcard2subject,
                                rpz_policy2subject=self.rpz_policy2subject,
                                rpz_inputline2subject=self.rpz_inputline2subject,
                                inputline2subject=self.inputline2subject,
                                subject2complements=self.subject2complements,
                                url2netloc=self.url2netloc,
                                cidr2subject=self.cidr2subject,
                            ):
                                to_send = copy.deepcopy(protocol)
                                to_send["subject"] = subject
                                to_send["idna_subject"] = domain2idna.domain2idna(subject)

                                self.tester_process_manager.push_to_input_queue(
                                    to_send, source_worker="main"
                                )

                # Now, let's handle the inactive one :-)
                if bool(PyFunceble.storage.CONFIGURATION.cli_testing.inactive_db):
                    for dataset in self.inactive_dataset.get_to_retest(
                        protocol["destination"],
                        protocol["checker_type"],
                        # pylint: disable=line-too-long
                        min_days=PyFunceble.storage.CONFIGURATION.cli_testing.days_between.db_retest,
                    ):
                        self.ci_stop_in_the_middle_if_time_exceeded()

                        to_send = copy.deepcopy(protocol)
                        to_send["from_inactive"] = True

                        # Note: Our test infrastructure need a subject
                        # but there is no subject in the table.
                        to_send["subject"] = dataset["idna_subject"]
                        to_send["idna_subject"] = dataset["idna_subject"]

                        self.tester_process_manager.push_to_input_queue(
                            to_send, source_worker="main"
                        )

                self.dir_files_sorter_process_manager.input_datasets.append(
                    {"directory": protocol["output_dir"]}
                )

            def handle_platform_contribution() -> None:
                """
                Assuming that we are testing a platform contribution, proceed with the
                testing.
                """

                query_tool = PlatformQueryTool()

                max_breakoff = 120.0

                initial_breakoff = 0.1 * self.tester_process_manager.max_workers
                breakoff = initial_breakoff

                while True:
                    protocol_data = {}

                    for next_contract in next(
                        query_tool.pull_contract(self.tester_process_manager.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.push_to_input_queue(
                            protocol_data, source_worker="main"
                        )

                    self.ci_stop_in_the_middle_if_time_exceeded()

                    if self.tester_process_manager.queue_full:
                        breakoff_multiplier = self.tester_process_manager.queue_size * 2

                        if breakoff < max_breakoff:
                            breakoff += 0.1 * breakoff_multiplier
                        else:
                            breakoff = initial_breakoff
                    elif breakoff >= max_breakoff:
                        breakoff = initial_breakoff

                    if PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.dots:
                        PyFunceble.cli.utils.stdout.print_single_line("S")

                    time.sleep(breakoff)

            for protocol in self.testing_protocol:
                self.ci_stop_in_the_middle_if_time_exceeded()

                if protocol["type"] == "single":
                    for subject in get_subjects_from_line(
                        protocol["idna_subject"],
                        self.checker_type,
                        subject_type=protocol["subject_type"],
                        adblock_inputline2subject=self.adblock_inputline2subject,
                        wildcard2subject=self.wildcard2subject,
                        rpz_policy2subject=self.rpz_policy2subject,
                        rpz_inputline2subject=self.rpz_inputline2subject,
                        inputline2subject=self.inputline2subject,
                        subject2complements=self.subject2complements,
                        url2netloc=self.url2netloc,
                        cidr2subject=self.cidr2subject,
                    ):
                        to_send = copy.deepcopy(protocol)
                        to_send["subject"], to_send["idna_subject"] = (
                            subject,
                            domain2idna.domain2idna(subject),
                        )

                        self.tester_process_manager.push_to_input_queue(
                            to_send, source_worker="main"
                        )
                elif protocol["type"] == "file":
                    handle_file(protocol)
                elif protocol["type"] == "platform-contribution":
                    handle_platform_contribution()
            return self

        def generate_waiting_files(self) -> "SystemLauncher":
            """
            Generates all the files that needs to be generated when all status
            are processes.
            """

            def generate_percentage_file(parent_dirname: Union[str, None]) -> None:
                """
                Generates the percentage file.
                """

                if not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.no_file:
                    self.counter.set_differ_to_inline(True).set_parent_dirname(
                        parent_dirname
                    )

                    destination = os.path.join(
                        self.counter.get_output_basedir(),
                        PyFunceble.cli.storage.OUTPUTS.logs.directories.parent,
                        PyFunceble.cli.storage.OUTPUTS.logs.directories.percentage,
                        PyFunceble.cli.storage.OUTPUTS.logs.filenames.percentage,
                    )

                    stdout_header_printed = False

                    self.stdout_printer.template_to_use = "percentage"
                    self.file_printer.template_to_use = "percentage"
                    self.file_printer.destination = destination

                    for data in self.counter.get_dataset_for_printer():
                        self.file_printer.set_dataset(data).print_interpolated_line()

                        # pylint: disable=line-too-long
                        if (
                            PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.percentage
                            and not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet
                        ):
                            self.stdout_printer.dataset = data

                            if not stdout_header_printed:
                                self.stdout_printer.print_header()
                                stdout_header_printed = True

                            self.stdout_printer.print_interpolated_line()

            def generate_registrar_file(parent_dirname: Union[str, None]) -> None:
                """
                Generates the registrar file.
                """

                if not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.no_file:
                    self.registrar_counter.set_differ_to_inline(True).set_parent_dirname(
                        parent_dirname
                    )

                    destination = os.path.join(
                        self.counter.get_output_basedir(),
                        PyFunceble.cli.storage.OUTPUTS.logs.directories.parent,
                        PyFunceble.cli.storage.OUTPUTS.logs.directories.percentage,
                        PyFunceble.cli.storage.OUTPUTS.logs.filenames.registrar,
                    )

                    stdout_header_printed = False

                    self.stdout_printer.template_to_use = "registrar"
                    self.file_printer.template_to_use = "registrar"
                    self.file_printer.destination = destination

                    registrar_limit = 0
                    for data in self.registrar_counter.get_dataset_for_printer():
                        self.file_printer.set_dataset(data).print_interpolated_line()

                        # pylint: disable=line-too-long
                        if (
                            PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.registrar
                            and not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet
                            and registrar_limit
                            < PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.max_registrar
                        ):
                            self.stdout_printer.dataset = data

                            if not stdout_header_printed:
                                self.stdout_printer.print_header()
                                stdout_header_printed = True

                            self.stdout_printer.print_interpolated_line()
                            registrar_limit += 1

            def print_result_ascii(parent_dirname: Union[str, None]) -> None:
                """
                Generates the result repr.
                """

                # pylint: disable=line-too-long
                if (
                    not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.no_file
                    and not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet
                    and PyFunceble.cli.utils.stdout.get_template_to_use() != "simple"
                ):
                    self.counter.set_differ_to_inline(True).set_parent_dirname(
                        parent_dirname
                    )

                    print(
                        PyFunceble.cli.utils.ascii_logo.get_result_representation(
                            self.counter.get_sorted_dataset()[0][0]
                        )
                    )

            no_destination_found = []
            amount_protocol_without_dest = len(
                [x["destination"] for x in self.testing_protocol if not x["destination"]]
            )

            for protocol in self.testing_protocol:
                if not protocol["destination"]:
                    if any(no_destination_found):
                        continue

                    if amount_protocol_without_dest >= 2:
                        # Show percentage, only if the amount of subjects is > 2.
                        generate_percentage_file(protocol["destination"])
                else:
                    generate_percentage_file(protocol["destination"])

                if protocol["checker_type"] in self.registrar_counter.SUPPORTED_TEST_MODES:
                    generate_registrar_file(protocol["destination"])

                print_result_ascii(protocol["destination"])

                no_destination_found.append(not protocol["destination"])

                if protocol["checker_type"] in self.registrar_counter.SUPPORTED_TEST_MODES:
                    generate_registrar_file(protocol["destination"])

                # pylint: disable=line-too-long
                if (
                    PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.merge_output_dirs
                ):
                    break

            return self

        def remove_unwanted_files(self) -> "SystemLauncher":
            """
            Deletes some unwanted files that needs to be deleted when all status
            are processed.
            """

            def remove_running_file(protocol: str) -> None:
                """
                Removes the running file.
                :param parent_dirname:
                    The name of the directory to work from (under the output
                    directory).
                """

                if protocol["output_dir"]:
                    file_helper.set_path(
                        os.path.join(
                            protocol["output_dir"],
                            PyFunceble.cli.storage.TEST_RUNNING_FILE,
                        )
                    ).delete()
                    PyFunceble.facility.Logger.debug("Deleted: %r.", file_helper.path)

            def remove_trigger_file(protocol: str) -> None:
                """
                Removes the trigger file.

                :param protocol:
                    The protocol to work with.
                """

                if protocol["output_dir"]:
                    file_helper.set_path(
                        os.path.join(
                            protocol["output_dir"],
                            PyFunceble.cli.storage.CI_TRIGGER_FILE,
                        )
                    ).delete()
                    PyFunceble.facility.Logger.debug("Deleted: %r.", file_helper.path)

            def remove_continue_dataset(protocol: dict) -> None:
                """
                Removes the continue file.

                :param protocol:
                    The protocol to work with.
                """

                if (
                    isinstance(self.continue_dataset, CSVContinueDataset)
                    and protocol["output_dir"]
                ):
                    # CSV file :-)
                    self.continue_dataset.set_base_directory(protocol["output_dir"])
                    file_helper.set_path(self.continue_dataset.source_file).delete()

                    PyFunceble.facility.Logger.debug("Deleted: %r.", file_helper.path)
                elif protocol["destination"]:
                    # MariaDB / MySQL

                    #   ## We specially have different signature.
                    self.continue_dataset.cleanup(  # pylint: disable=unexpected-keyword-arg
                        session_id=self.sessions_id[protocol["destination"]]
                    )

            def remove_preload_dataset(protocol: dict) -> None:
                """
                Removes the preloader dataset file.

                :param protocol:
                    The protocol to work with.
                """

                if self.file_preloader.authorized and protocol["output_dir"]:
                    file_helper.set_path(
                        os.path.join(
                            protocol["output_dir"],
                            PyFunceble.cli.storage.PRE_LOADER_FILE,
                        )
                    ).delete()
                    PyFunceble.facility.Logger.debug("Deleted: %r.", file_helper.path)

            def remove_inline_dest(protocol: dict) -> None:
                """
                Remove the inline destination - when necessary.

                :param protocol:
                    The protocol to work with.
                """

                if not protocol["destination"]:
                    directory_helper.set_path(
                        self.counter.set_differ_to_inline(True)
                        .set_parent_dirname(protocol["destination"])
                        .get_output_basedir()
                    ).delete()

            file_helper = FileHelper()
            directory_helper = DirectoryHelper()

            for protocol in self.testing_protocol:
                if "destination" in protocol or "output_dir" in protocol:
                    remove_running_file(protocol)
                    remove_trigger_file(protocol)

                    remove_continue_dataset(protocol)
                    remove_preload_dataset(protocol)
                    remove_inline_dest(protocol)
                    self.whois_dataset.cleanup()

            return self

        def run_standard_end_instructions(self) -> "SystemLauncher":
            """
            Runs our standard "end" instructions.

            The instructions executed by this method are the one we execute normally.

            The purpose of this method is to make our standard end instructions
            available to everybody instead of hiding them into the :code:`start`
            method. :-)

            .. warning::
                This is the standard "end" instructions. Do not call this method
                if you are trying to run an action after the CI execution time
                exceeded.
            """

            self.generate_waiting_files()
            self.remove_unwanted_files()

            return self

        def run_ci_saving_instructions(self) -> "SystemLauncher":
            """
            Runs our CI "saving" instructions.

            The instructions executed by this method are the one we execute
            before ending a testing session under one of the supported CI engines.

            The purpose of this method is to make our instructions
            available to everybody instead of hiding them into the :code:`start`
            method. :-)

            .. warning::
                This is the standard "end" instructions. Do not call this method
                if you are trying to run an action after the CI execution time
                exceeded.
            """

            if self.continuous_integration.authorized:
                self.continuous_integration.apply_commit()

            return self

        def run_ci_end_saving_instructions(self) -> "SystemLauncher":
            """
            Runs our CI END "saving" instructions.

            The instructions executed by this method are the one we execute
            before ending a testing session under one of the supported CI engines.

            The purpose of this method is to make our instructions
            available to everybody instead of hiding them into the :code:`start`
            method. :-)

            .. warning::
                This is the standard "end" instructions. Do not call this method
                if you are trying to run an action after the CI execution time
                exceeded.
            """

            self.run_standard_end_instructions()

            if self.continuous_integration.authorized:
                self.continuous_integration.apply_end_commit()

            return self

        def stop_and_wait_for_all_manager(self) -> "SystemLauncher":
            """
            Sends our stop signal and wait until all managers are finished.
            """

            # We start the termination process of the tester.
            #
            # Please note that we do not explicitly wait for the tester to terminate
            # through the `wait` method. The reason is that the `terminate` method
            # will wait for the tester to finish before terminating itself.
            #
            # Please also note that any process depending on the tester will be
            # terminated after the tester is done because we are setting the
            # `spread_stop_signal` # attribute to `True` (cf: see __init__ method).
            self.tester_process_manager.terminate()

            if self.miner_process_manager:
                self.miner_process_manager.wait()

            self.tester_process_manager.wait()
            self.producer_process_manager.wait()

            try:
                # From here, we are sure that every test and files are produced.
                # We now format the generated file(s).
                self.dir_files_sorter_process_manager.start()
                self.dir_files_sorter_process_manager.terminate()
            except AssertionError:
                # Example: Already started previously.
                pass

            if self.execution_time_holder.authorized:
                self.execution_time_holder.set_end_time()

                self.stdout_printer.set_template_to_use("execution_time").set_dataset(
                    self.execution_time_holder.get_info()
                ).print_interpolated_line()

            return self

        def __start_core_processes(self):
            """
            Starts our core processes.
            """

            if not self.producer_process_manager.running:
                self.producer_process_manager.start()

            if not self.tester_process_manager.running:
                self.tester_process_manager.start()

            if self.miner_process_manager and not self.miner_process_manager.running:
                self.miner_process_manager.start()

        @SystemBase.ensure_args_is_given
        def start(self) -> "SystemLauncher":
            try:
                self.print_home_ascii()

                print_central_messages(check_force_update=True)

                # This tries to bypass the execution when the continuous integration
                # is given and the last commit message (the one we are testing for)
                # match any of our known marker. Please report to the method itself
                # for more information about the markers.
                self.continuous_integration.bypass()

                self.migrator_process_manager.start()
                self.migrator_process_manager.wait()

                del self.migrator_process_manager

                if not self.file_preloader.authorized or (
                    not self.args.files and not self.args.url_files
                ):
                    self.__start_core_processes()

                self.fill_protocol()
                self.fill_to_test_queue_from_protocol()

                self.stop_and_wait_for_all_manager()

                if self.continuous_integration.is_time_exceeded():
                    # Does not includes the run_standard_end_instructions call.
                    # Reason: We have to continue.
                    self.run_ci_saving_instructions()
                elif self.continuous_integration.authorized:
                    # Includes the run_standard_end_instructions call.
                    self.run_ci_end_saving_instructions()
                else:
                    self.run_standard_end_instructions()

            except (KeyboardInterrupt, StopExecution):
                pass
            except Exception as exception:  # pylint: disable=broad-except
                PyFunceble.facility.Logger.critical(
                    "Fatal error.",
                    exc_info=True,
                )
                if isinstance(exception, PyFunceble.helpers.exceptions.UnableToDownload):
                    message = (
                        f"{colorama.Fore.RED}{colorama.Style.BRIGHT}Unable to download "
                        f"{exception}"
                    )
                else:
                    message = (
                        f"{colorama.Fore.RED}{colorama.Style.BRIGHT}Fatal Error: "
                        f"{exception}"
                    )

                print(message)

                if PyFunceble.facility.Logger.authorized:
                    print(traceback.format_exc())
                sys.exit(1)

            PyFunceble.cli.utils.stdout.print_thanks()

            return self

### `testing_protocol = []` `class-attribute` `instance-attribute`

Saves the protocol which we are going to generate. The protocol will saves a set of information about what to test, what kind of output to produce and most importantly where.

### `__start_core_processes()`

Starts our core processes.

Source code in `PyFunceble/cli/system/launcher.py`

    1135
    1136
    1137
    1138
    1139
    1140
    1141
    1142
    1143
    1144
    1145
    1146
    1147

    def __start_core_processes(self):
        """
        Starts our core processes.
        """

        if not self.producer_process_manager.running:
            self.producer_process_manager.start()

        if not self.tester_process_manager.running:
            self.tester_process_manager.start()

        if self.miner_process_manager and not self.miner_process_manager.running:
            self.miner_process_manager.start()

### `ci_stop_in_the_middle_if_time_exceeded()`

Stops our processes as soon as the time is exceeded.

Source code in `PyFunceble/cli/system/launcher.py`

    462
    463
    464
    465
    466
    467
    468
    469
    470

    def ci_stop_in_the_middle_if_time_exceeded(self) -> "SystemLauncher":
        """
        Stops our processes as soon as the time is exceeded.
        """

        if self.continuous_integration.is_time_exceeded():
            self.run_ci_saving_instructions()

        return self

### `fill_protocol()`

Fills the protocol with the information about what we are supposed to test.

Source code in `PyFunceble/cli/system/launcher.py`

    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460

    @SystemBase.ensure_args_is_given
    def fill_protocol(self) -> "SystemLauncher":
        """
        Fills the protocol with the information about what we are supposed to test.
        """

        filesytem_dirbase = FilesystemDirBase()

        if self.args.domains:
            for domain in self.args.domains:
                to_append = {
                    "type": "single",
                    "subject_type": "domain",
                    "destination": None,
                    "subject": domain,
                    "idna_subject": domain2idna.domain2idna(domain),
                    "source": None,
                    "output_dir": None,
                    "checker_type": self.checker_type,
                    "session_id": None,
                }

                self.testing_protocol.append(to_append)

                PyFunceble.facility.Logger.debug(
                    "Added to the protocol:\n%r", to_append
                )

        if self.args.urls:
            for url in self.args.urls:
                to_append = {
                    "type": "single",
                    "subject_type": "url",
                    "destination": None,
                    "subject": url,
                    "idna_subject": domain2idna.domain2idna(url),
                    "source": None,
                    "output_dir": None,
                    "checker_type": self.checker_type,
                    "session_id": None,
                }

                self.testing_protocol.append(to_append)

                PyFunceble.facility.Logger.debug(
                    "Added to the protocol:\n%r", to_append
                )

        if self.args.files:
            for file in self.args.files:
                # pylint: disable=line-too-long
                if (
                    not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.merge_output_dirs
                ):
                    destination = get_destination_from_origin(file)
                else:
                    destination = get_destination_from_origin(
                        PyFunceble.cli.storage.OUTPUTS.merged_directory
                    )

                to_append = {
                    "type": "file",
                    "subject_type": "domain",
                    # pylint: disable=line-too-long
                    "destination": destination,
                    "source": file,
                    "subject": file,
                    "checker_type": self.checker_type,
                    "session_id": None,
                }

                to_append["output_dir"] = filesytem_dirbase.set_parent_dirname(
                    to_append["destination"]
                ).get_output_basedir()

                self.testing_protocol.append(to_append)

                PyFunceble.facility.Logger.debug(
                    "Added to the protocol:\n%r", to_append
                )

        if self.args.url_files:
            for file in self.args.url_files:
                # pylint: disable=line-too-long
                if (
                    not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.merge_output_dirs
                ):
                    destination = get_destination_from_origin(file)
                else:
                    destination = get_destination_from_origin(
                        PyFunceble.cli.storage.OUTPUTS.merged_directory
                    )

                to_append = {
                    "type": "file",
                    "subject_type": "url",
                    # pylint: disable=line-too-long
                    "destination": destination,
                    "source": file,
                    "subject": file,
                    "checker_type": self.checker_type,
                    "session_id": None,
                }

                to_append["output_dir"] = filesytem_dirbase.set_parent_dirname(
                    to_append["destination"]
                ).get_output_basedir()

                self.testing_protocol.append(to_append)

                PyFunceble.facility.Logger.debug(
                    "Added to the protocol:\n%r", to_append
                )

        # pylint: disable=line-too-long
        if (
            not self.testing_protocol
            and 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,
                }
            )

### `fill_to_test_queue_from_protocol()`

Read the protocol and fill the testing queue.

Source code in `PyFunceble/cli/system/launcher.py`

    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735
    736
    737
    738
    739
    740
    741
    742
    743
    744
    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771

    def fill_to_test_queue_from_protocol(self) -> "SystemLauncher":
        """
        Read the protocol and fill the testing queue.
        """

        def download_file(file: str, destination: str) -> bool:
            """
            Downloads the given file (if it's an URL).

            :param file:
                The file to download.
            :param destination.
                The file to write.

            :return:
                A boolean which represent the action state.
            """

            if URLSyntaxChecker(file).is_valid():
                DownloadHelper(
                    file,
                    certificate_validation=(
                        PyFunceble.storage.CONFIGURATION.verify_ssl_certificate
                        if PyFunceble.storage.CONFIGURATION
                        else True
                    ),
                    own_proxy_handler=True,
                    proxies=PyFunceble.storage.PROXY,
                ).download_text(destination=destination)
                return True
            return False

        def create_trigger_file_if_necessary(parent_dirname: str) -> None:
            """
            Create the trigger file if necessary. The purpose of the trigger
            file is to have a file that is always updated until a test is
            completed done.
            """

            if self.continuous_integration.authorized:
                cleanup_tool = FilesystemCleanup(parent_dirname)

                trigger_file_helper = FileHelper(
                    os.path.join(
                        cleanup_tool.get_output_basedir(),
                        PyFunceble.cli.storage.CI_TRIGGER_FILE,
                    )
                )

                # Ensures that we always have something to commit.
                trigger_file_helper.write(
                    f"{self.sessions_id[parent_dirname]} " f"{secrets.token_hex(8)}",
                    overwrite=True,
                )

        def cleanup_if_necessary(parent_dirname: str) -> None:
            """
            Process the cleanup if it's necessary.
            """

            cleanup_tool = FilesystemCleanup(parent_dirname)
            running_file_helper = FileHelper(
                os.path.join(
                    cleanup_tool.get_output_basedir(),
                    PyFunceble.cli.storage.TEST_RUNNING_FILE,
                )
            )

            if not running_file_helper.exists():
                self.sessions_id[parent_dirname] = secrets.token_hex(12)

                cleanup_tool.clean_output_files()
                running_file_helper.write(
                    f"{self.sessions_id[parent_dirname]} "
                    f"{datetime.datetime.now(datetime.timezone.utc).isoformat()}",
                    overwrite=True,
                )
            else:
                possible_session_id = running_file_helper.read().split()[0]

                try:
                    _ = datetime.datetime.fromisoformat(possible_session_id).astimezone(
                        datetime.timezone.utc
                    )
                    self.sessions_id[parent_dirname] = None
                except (ValueError, TypeError):
                    self.sessions_id[parent_dirname] = possible_session_id

        def match_output_directory_if_necessary(parent_dirname: str) -> None:
            """
            Restore missing directories from the current directory.
            """

            if not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.no_file:
                DirectoryStructureRestoration(parent_dirname).restore_from_backup()

        def handle_file(protocol: dict) -> None:
            """
            Given a protocol related to a given file, we handle every
            possible decoding case before submitting a new subject to the queue.
            """

            cleanup_if_necessary(protocol["destination"])
            create_trigger_file_if_necessary(protocol["destination"])
            match_output_directory_if_necessary(protocol["destination"])

            if download_file(protocol["subject"], protocol["destination"]):
                protocol["subject"] = os.path.relpath(protocol["destination"])
            else:
                protocol["subject"] = os.path.relpath(protocol["subject"])

            protocol["source"] = os.path.relpath(protocol["source"])
            protocol["session_id"] = self.sessions_id[protocol["destination"]]

            if isinstance(self.continue_dataset, CSVContinueDataset):
                self.continue_dataset.set_base_directory(protocol["output_dir"])

            if self.file_preloader.authorized:
                if not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet:
                    print(
                        f"{colorama.Fore.MAGENTA}{colorama.Style.BRIGHT}"
                        f"Started preloading of {protocol['source']}..."
                    )

                self.file_preloader.set_protocol(protocol).start(
                    # pylint: disable=line-too-long
                    print_dots=(
                        PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet
                        or bool(
                            PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.dots
                        )
                    )
                )

                if not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet:
                    print(
                        f"\n{colorama.Fore.GREEN}{colorama.Style.BRIGHT}"
                        f"Finished preloading of {protocol['source']}."
                    )

                self.__start_core_processes()

                for subject in self.continue_dataset.get_to_test(
                    protocol["session_id"]
                ):
                    self.ci_stop_in_the_middle_if_time_exceeded()

                    to_send = copy.deepcopy(protocol)
                    to_send["subject"], to_send["idna_subject"] = subject, subject
                    to_send["from_preload"] = True

                    self.tester_process_manager.push_to_input_queue(
                        to_send, source_worker="main"
                    )

            else:
                with FileHelper(protocol["subject"]).open(
                    "r", encoding="utf-8"
                ) as file_stream:
                    for line in file_stream:
                        self.ci_stop_in_the_middle_if_time_exceeded()

                        line = line.strip()

                        if "SOA" in line:
                            self.rpz_policy2subject.set_soa(line.split()[0])

                        for subject in get_subjects_from_line(
                            line,
                            self.checker_type,
                            subject_type=protocol["subject_type"],
                            adblock_inputline2subject=self.adblock_inputline2subject,
                            wildcard2subject=self.wildcard2subject,
                            rpz_policy2subject=self.rpz_policy2subject,
                            rpz_inputline2subject=self.rpz_inputline2subject,
                            inputline2subject=self.inputline2subject,
                            subject2complements=self.subject2complements,
                            url2netloc=self.url2netloc,
                            cidr2subject=self.cidr2subject,
                        ):
                            to_send = copy.deepcopy(protocol)
                            to_send["subject"] = subject
                            to_send["idna_subject"] = domain2idna.domain2idna(subject)

                            self.tester_process_manager.push_to_input_queue(
                                to_send, source_worker="main"
                            )

            # Now, let's handle the inactive one :-)
            if bool(PyFunceble.storage.CONFIGURATION.cli_testing.inactive_db):
                for dataset in self.inactive_dataset.get_to_retest(
                    protocol["destination"],
                    protocol["checker_type"],
                    # pylint: disable=line-too-long
                    min_days=PyFunceble.storage.CONFIGURATION.cli_testing.days_between.db_retest,
                ):
                    self.ci_stop_in_the_middle_if_time_exceeded()

                    to_send = copy.deepcopy(protocol)
                    to_send["from_inactive"] = True

                    # Note: Our test infrastructure need a subject
                    # but there is no subject in the table.
                    to_send["subject"] = dataset["idna_subject"]
                    to_send["idna_subject"] = dataset["idna_subject"]

                    self.tester_process_manager.push_to_input_queue(
                        to_send, source_worker="main"
                    )

            self.dir_files_sorter_process_manager.input_datasets.append(
                {"directory": protocol["output_dir"]}
            )

        def handle_platform_contribution() -> None:
            """
            Assuming that we are testing a platform contribution, proceed with the
            testing.
            """

            query_tool = PlatformQueryTool()

            max_breakoff = 120.0

            initial_breakoff = 0.1 * self.tester_process_manager.max_workers
            breakoff = initial_breakoff

            while True:
                protocol_data = {}

                for next_contract in next(
                    query_tool.pull_contract(self.tester_process_manager.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.push_to_input_queue(
                        protocol_data, source_worker="main"
                    )

                self.ci_stop_in_the_middle_if_time_exceeded()

                if self.tester_process_manager.queue_full:
                    breakoff_multiplier = self.tester_process_manager.queue_size * 2

                    if breakoff < max_breakoff:
                        breakoff += 0.1 * breakoff_multiplier
                    else:
                        breakoff = initial_breakoff
                elif breakoff >= max_breakoff:
                    breakoff = initial_breakoff

                if PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.dots:
                    PyFunceble.cli.utils.stdout.print_single_line("S")

                time.sleep(breakoff)

        for protocol in self.testing_protocol:
            self.ci_stop_in_the_middle_if_time_exceeded()

            if protocol["type"] == "single":
                for subject in get_subjects_from_line(
                    protocol["idna_subject"],
                    self.checker_type,
                    subject_type=protocol["subject_type"],
                    adblock_inputline2subject=self.adblock_inputline2subject,
                    wildcard2subject=self.wildcard2subject,
                    rpz_policy2subject=self.rpz_policy2subject,
                    rpz_inputline2subject=self.rpz_inputline2subject,
                    inputline2subject=self.inputline2subject,
                    subject2complements=self.subject2complements,
                    url2netloc=self.url2netloc,
                    cidr2subject=self.cidr2subject,
                ):
                    to_send = copy.deepcopy(protocol)
                    to_send["subject"], to_send["idna_subject"] = (
                        subject,
                        domain2idna.domain2idna(subject),
                    )

                    self.tester_process_manager.push_to_input_queue(
                        to_send, source_worker="main"
                    )
            elif protocol["type"] == "file":
                handle_file(protocol)
            elif protocol["type"] == "platform-contribution":
                handle_platform_contribution()
        return self

### `generate_waiting_files()`

Generates all the files that needs to be generated when all status are processes.

Source code in `PyFunceble/cli/system/launcher.py`

    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    809
    810
    811
    812
    813
    814
    815
    816
    817
    818
    819
    820
    821
    822
    823
    824
    825
    826
    827
    828
    829
    830
    831
    832
    833
    834
    835
    836
    837
    838
    839
    840
    841
    842
    843
    844
    845
    846
    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    884
    885
    886
    887
    888
    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914

    def generate_waiting_files(self) -> "SystemLauncher":
        """
        Generates all the files that needs to be generated when all status
        are processes.
        """

        def generate_percentage_file(parent_dirname: Union[str, None]) -> None:
            """
            Generates the percentage file.
            """

            if not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.no_file:
                self.counter.set_differ_to_inline(True).set_parent_dirname(
                    parent_dirname
                )

                destination = os.path.join(
                    self.counter.get_output_basedir(),
                    PyFunceble.cli.storage.OUTPUTS.logs.directories.parent,
                    PyFunceble.cli.storage.OUTPUTS.logs.directories.percentage,
                    PyFunceble.cli.storage.OUTPUTS.logs.filenames.percentage,
                )

                stdout_header_printed = False

                self.stdout_printer.template_to_use = "percentage"
                self.file_printer.template_to_use = "percentage"
                self.file_printer.destination = destination

                for data in self.counter.get_dataset_for_printer():
                    self.file_printer.set_dataset(data).print_interpolated_line()

                    # pylint: disable=line-too-long
                    if (
                        PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.percentage
                        and not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet
                    ):
                        self.stdout_printer.dataset = data

                        if not stdout_header_printed:
                            self.stdout_printer.print_header()
                            stdout_header_printed = True

                        self.stdout_printer.print_interpolated_line()

        def generate_registrar_file(parent_dirname: Union[str, None]) -> None:
            """
            Generates the registrar file.
            """

            if not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.no_file:
                self.registrar_counter.set_differ_to_inline(True).set_parent_dirname(
                    parent_dirname
                )

                destination = os.path.join(
                    self.counter.get_output_basedir(),
                    PyFunceble.cli.storage.OUTPUTS.logs.directories.parent,
                    PyFunceble.cli.storage.OUTPUTS.logs.directories.percentage,
                    PyFunceble.cli.storage.OUTPUTS.logs.filenames.registrar,
                )

                stdout_header_printed = False

                self.stdout_printer.template_to_use = "registrar"
                self.file_printer.template_to_use = "registrar"
                self.file_printer.destination = destination

                registrar_limit = 0
                for data in self.registrar_counter.get_dataset_for_printer():
                    self.file_printer.set_dataset(data).print_interpolated_line()

                    # pylint: disable=line-too-long
                    if (
                        PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.registrar
                        and not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet
                        and registrar_limit
                        < PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.max_registrar
                    ):
                        self.stdout_printer.dataset = data

                        if not stdout_header_printed:
                            self.stdout_printer.print_header()
                            stdout_header_printed = True

                        self.stdout_printer.print_interpolated_line()
                        registrar_limit += 1

        def print_result_ascii(parent_dirname: Union[str, None]) -> None:
            """
            Generates the result repr.
            """

            # pylint: disable=line-too-long
            if (
                not PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.no_file
                and not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet
                and PyFunceble.cli.utils.stdout.get_template_to_use() != "simple"
            ):
                self.counter.set_differ_to_inline(True).set_parent_dirname(
                    parent_dirname
                )

                print(
                    PyFunceble.cli.utils.ascii_logo.get_result_representation(
                        self.counter.get_sorted_dataset()[0][0]
                    )
                )

        no_destination_found = []
        amount_protocol_without_dest = len(
            [x["destination"] for x in self.testing_protocol if not x["destination"]]
        )

        for protocol in self.testing_protocol:
            if not protocol["destination"]:
                if any(no_destination_found):
                    continue

                if amount_protocol_without_dest >= 2:
                    # Show percentage, only if the amount of subjects is > 2.
                    generate_percentage_file(protocol["destination"])
            else:
                generate_percentage_file(protocol["destination"])

            if protocol["checker_type"] in self.registrar_counter.SUPPORTED_TEST_MODES:
                generate_registrar_file(protocol["destination"])

            print_result_ascii(protocol["destination"])

            no_destination_found.append(not protocol["destination"])

            if protocol["checker_type"] in self.registrar_counter.SUPPORTED_TEST_MODES:
                generate_registrar_file(protocol["destination"])

            # pylint: disable=line-too-long
            if (
                PyFunceble.storage.CONFIGURATION.cli_testing.file_generation.merge_output_dirs
            ):
                break

        return self

### `print_home_ascii()` `staticmethod`

Prints our ASCII home logo.

Source code in `PyFunceble/cli/system/launcher.py`

    322
    323
    324
    325
    326
    327
    328
    329
    330

    @staticmethod
    def print_home_ascii() -> None:
        """
        Prints our ASCII home logo.
        """

        if not PyFunceble.storage.CONFIGURATION.cli_testing.display_mode.quiet:
            if PyFunceble.cli.utils.stdout.get_template_to_use() != "simple":
                print(PyFunceble.cli.utils.ascii_logo.get_home_representation())

### `remove_unwanted_files()`

Deletes some unwanted files that needs to be deleted when all status are processed.

Source code in `PyFunceble/cli/system/launcher.py`

     916
     917
     918
     919
     920
     921
     922
     923
     924
     925
     926
     927
     928
     929
     930
     931
     932
     933
     934
     935
     936
     937
     938
     939
     940
     941
     942
     943
     944
     945
     946
     947
     948
     949
     950
     951
     952
     953
     954
     955
     956
     957
     958
     959
     960
     961
     962
     963
     964
     965
     966
     967
     968
     969
     970
     971
     972
     973
     974
     975
     976
     977
     978
     979
     980
     981
     982
     983
     984
     985
     986
     987
     988
     989
     990
     991
     992
     993
     994
     995
     996
     997
     998
     999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026

    def remove_unwanted_files(self) -> "SystemLauncher":
        """
        Deletes some unwanted files that needs to be deleted when all status
        are processed.
        """

        def remove_running_file(protocol: str) -> None:
            """
            Removes the running file.
            :param parent_dirname:
                The name of the directory to work from (under the output
                directory).
            """

            if protocol["output_dir"]:
                file_helper.set_path(
                    os.path.join(
                        protocol["output_dir"],
                        PyFunceble.cli.storage.TEST_RUNNING_FILE,
                    )
                ).delete()
                PyFunceble.facility.Logger.debug("Deleted: %r.", file_helper.path)

        def remove_trigger_file(protocol: str) -> None:
            """
            Removes the trigger file.

            :param protocol:
                The protocol to work with.
            """

            if protocol["output_dir"]:
                file_helper.set_path(
                    os.path.join(
                        protocol["output_dir"],
                        PyFunceble.cli.storage.CI_TRIGGER_FILE,
                    )
                ).delete()
                PyFunceble.facility.Logger.debug("Deleted: %r.", file_helper.path)

        def remove_continue_dataset(protocol: dict) -> None:
            """
            Removes the continue file.

            :param protocol:
                The protocol to work with.
            """

            if (
                isinstance(self.continue_dataset, CSVContinueDataset)
                and protocol["output_dir"]
            ):
                # CSV file :-)
                self.continue_dataset.set_base_directory(protocol["output_dir"])
                file_helper.set_path(self.continue_dataset.source_file).delete()

                PyFunceble.facility.Logger.debug("Deleted: %r.", file_helper.path)
            elif protocol["destination"]:
                # MariaDB / MySQL

                #   ## We specially have different signature.
                self.continue_dataset.cleanup(  # pylint: disable=unexpected-keyword-arg
                    session_id=self.sessions_id[protocol["destination"]]
                )

        def remove_preload_dataset(protocol: dict) -> None:
            """
            Removes the preloader dataset file.

            :param protocol:
                The protocol to work with.
            """

            if self.file_preloader.authorized and protocol["output_dir"]:
                file_helper.set_path(
                    os.path.join(
                        protocol["output_dir"],
                        PyFunceble.cli.storage.PRE_LOADER_FILE,
                    )
                ).delete()
                PyFunceble.facility.Logger.debug("Deleted: %r.", file_helper.path)

        def remove_inline_dest(protocol: dict) -> None:
            """
            Remove the inline destination - when necessary.

            :param protocol:
                The protocol to work with.
            """

            if not protocol["destination"]:
                directory_helper.set_path(
                    self.counter.set_differ_to_inline(True)
                    .set_parent_dirname(protocol["destination"])
                    .get_output_basedir()
                ).delete()

        file_helper = FileHelper()
        directory_helper = DirectoryHelper()

        for protocol in self.testing_protocol:
            if "destination" in protocol or "output_dir" in protocol:
                remove_running_file(protocol)
                remove_trigger_file(protocol)

                remove_continue_dataset(protocol)
                remove_preload_dataset(protocol)
                remove_inline_dest(protocol)
                self.whois_dataset.cleanup()

        return self

### `run_ci_end_saving_instructions()`

Runs our CI END "saving" instructions.

The instructions executed by this method are the one we execute before ending a testing session under one of the supported CI engines.

The purpose of this method is to make our instructions available to everybody instead of hiding them into the :code:`start` method. :-)

.. warning:: This is the standard "end" instructions. Do not call this method if you are trying to run an action after the CI execution time exceeded.

Source code in `PyFunceble/cli/system/launcher.py`

    1071
    1072
    1073
    1074
    1075
    1076
    1077
    1078
    1079
    1080
    1081
    1082
    1083
    1084
    1085
    1086
    1087
    1088
    1089
    1090
    1091
    1092
    1093

    def run_ci_end_saving_instructions(self) -> "SystemLauncher":
        """
        Runs our CI END "saving" instructions.

        The instructions executed by this method are the one we execute
        before ending a testing session under one of the supported CI engines.

        The purpose of this method is to make our instructions
        available to everybody instead of hiding them into the :code:`start`
        method. :-)

        .. warning::
            This is the standard "end" instructions. Do not call this method
            if you are trying to run an action after the CI execution time
            exceeded.
        """

        self.run_standard_end_instructions()

        if self.continuous_integration.authorized:
            self.continuous_integration.apply_end_commit()

        return self

### `run_ci_saving_instructions()`

Runs our CI "saving" instructions.

The instructions executed by this method are the one we execute before ending a testing session under one of the supported CI engines.

The purpose of this method is to make our instructions available to everybody instead of hiding them into the :code:`start` method. :-)

.. warning:: This is the standard "end" instructions. Do not call this method if you are trying to run an action after the CI execution time exceeded.

Source code in `PyFunceble/cli/system/launcher.py`

    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069

    def run_ci_saving_instructions(self) -> "SystemLauncher":
        """
        Runs our CI "saving" instructions.

        The instructions executed by this method are the one we execute
        before ending a testing session under one of the supported CI engines.

        The purpose of this method is to make our instructions
        available to everybody instead of hiding them into the :code:`start`
        method. :-)

        .. warning::
            This is the standard "end" instructions. Do not call this method
            if you are trying to run an action after the CI execution time
            exceeded.
        """

        if self.continuous_integration.authorized:
            self.continuous_integration.apply_commit()

        return self

### `run_standard_end_instructions()`

Runs our standard "end" instructions.

The instructions executed by this method are the one we execute normally.

The purpose of this method is to make our standard end instructions available to everybody instead of hiding them into the :code:`start` method. :-)

.. warning:: This is the standard "end" instructions. Do not call this method if you are trying to run an action after the CI execution time exceeded.

Source code in `PyFunceble/cli/system/launcher.py`

    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047

    def run_standard_end_instructions(self) -> "SystemLauncher":
        """
        Runs our standard "end" instructions.

        The instructions executed by this method are the one we execute normally.

        The purpose of this method is to make our standard end instructions
        available to everybody instead of hiding them into the :code:`start`
        method. :-)

        .. warning::
            This is the standard "end" instructions. Do not call this method
            if you are trying to run an action after the CI execution time
            exceeded.
        """

        self.generate_waiting_files()
        self.remove_unwanted_files()

        return self

### `stop_and_wait_for_all_manager()`

Sends our stop signal and wait until all managers are finished.

Source code in `PyFunceble/cli/system/launcher.py`

    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    1129
    1130
    1131
    1132
    1133

    def stop_and_wait_for_all_manager(self) -> "SystemLauncher":
        """
        Sends our stop signal and wait until all managers are finished.
        """

        # We start the termination process of the tester.
        #
        # Please note that we do not explicitly wait for the tester to terminate
        # through the `wait` method. The reason is that the `terminate` method
        # will wait for the tester to finish before terminating itself.
        #
        # Please also note that any process depending on the tester will be
        # terminated after the tester is done because we are setting the
        # `spread_stop_signal` # attribute to `True` (cf: see __init__ method).
        self.tester_process_manager.terminate()

        if self.miner_process_manager:
            self.miner_process_manager.wait()

        self.tester_process_manager.wait()
        self.producer_process_manager.wait()

        try:
            # From here, we are sure that every test and files are produced.
            # We now format the generated file(s).
            self.dir_files_sorter_process_manager.start()
            self.dir_files_sorter_process_manager.terminate()
        except AssertionError:
            # Example: Already started previously.
            pass

        if self.execution_time_holder.authorized:
            self.execution_time_holder.set_end_time()

            self.stdout_printer.set_template_to_use("execution_time").set_dataset(
                self.execution_time_holder.get_info()
            ).print_interpolated_line()

        return self