Skip to content

Paramètres

Vous trouverez ci-dessous la structure arborescente des paramètres de configuration ainsi que leur description.

Structure arborescente des paramètres

AppConfig

Chemin des paramètres

Chemin
config.processor
config.variables
config.tags
config.execute
config.execute.pre_folder_delete
config.execute.pre_folder_creation
config.execute.command_suffix
config.execute.command_path
config.execute.executable_url
config.execute.command_guess_os_extension
config.execute.working_dir
config.execute_and_compare
config.execute_and_compare.test
config.execute_and_compare.test.pre_folder_delete
config.execute_and_compare.test.pre_folder_creation
config.execute_and_compare.test.command_suffix
config.execute_and_compare.test.command_path
config.execute_and_compare.test.executable_url
config.execute_and_compare.test.command_guess_os_extension
config.execute_and_compare.test.working_dir
config.execute_and_compare.test_only
config.execute_and_compare.reference
config.execute_and_compare.reference.pre_folder_delete
config.execute_and_compare.reference.pre_folder_creation
config.execute_and_compare.reference.command_suffix
config.execute_and_compare.reference.command_path
config.execute_and_compare.reference.executable_url
config.execute_and_compare.reference.command_guess_os_extension
config.execute_and_compare.reference.working_dir
config.file_reader
config.file_reader.extension_unknown_ignore
config.file_reader.extension_mapping
config.file_reader.extension_fallback
config.file_reader.encoding
config.file_reader.custom_curve_parser
config.readers
config.readers.txt
config.readers.txt.error_rule_patterns
config.readers.txt.ignore
config.readers.txt.report_lines
config.readers.csv
config.readers.csv.ignore_colunmns
config.readers.csv.curve_parser
config.readers.csv.curve_parser.name
config.readers.csv.curve_parser.parameters [1] [2]
parameters [1]
config.readers.csv.curve_parser.parameters.x
parameters [2]
config.readers.csv.curve_parser.parameters.x_index
config.readers.csv.curve_parser.parameters.y_index
config.compare
config.compare.float_thresholds
config.compare.float_thresholds.relative_vs_absolute_min
config.compare.float_thresholds.relative_error_min
config.compare.float_thresholds.relative_error_max
config.compare.float_thresholds.absolute_error_min
config.compare.float_thresholds.absolute_error_max
config.compare.sources
config.compare.sources.test_folder_relative_path
config.compare.sources.reference_folder_relative_path
config.compare.sources.additional_path_suffix
config.compare.sources.test_filename_match_ignore
config.compare.sources.reference_filename_match_ignore
config.compare.sources.recursive
config.report
config.report.debug
config.report.title
config.report.logo
config.report.logo_file
config.report.output
config.report.output.filename
config.report.output.export_html
config.report.output.export_txt
config.report.output.export_json
config.report.output.export_yaml
config.report.output.export_py
config.report.output.export_js
config.report.output.export_ts
config.report.output.export_php
config.report.html
config.report.html.compare_color_test
config.report.html.compare_color_reference
config.report.html.collapse_if_successful
config.report.html.parameter_page_mode
config.report.html.parameter_page_mode.is_user_preference
config.report.html.parameter_page_mode.default_value
config.report.html.parameter_open_file_in
config.report.html.parameter_open_file_in.is_user_preference
config.report.html.parameter_open_file_in.default_value
config.report.html.curves
config.report.html.curves.display_on_load
config.report.html.curves.init_width
config.report.html.curves.init_height

AppConfig

Nom Type Défault Description
processor string Nom du processeur à utiliser. Compare ou ExecuteAndCompare.
variables object Variables Utilisateur.
tags array[string] None Optionnel Utilisé dans un contexte ligne de commande, utilisé en conjonction avec l'option --discover pour filtrer les cas à éxécuter.
execute ExecuteConfig Configuration utile au processeur ExecuteAndCompare.
execute_and_compare ExecuteAndCompareConfig Configuration utile au processeur ExecuteAndCompare.
file_reader FileReaderConfig Configuration des readers fichiers.
readers ReadersConfig Configuration des readers.
compare CompareConfig Configuration utile aux processeurs Compare et ExecuteAndCompare
report ReportConfig Configuration des Reports.

ExecuteConfig

Nom Type Défault Description
pre_folder_delete array[string] None Optionnel Liste de répertoire à supprimer avant l'éxecution. Ex: ["DEBUG", "LOG", "OUT"]
pre_folder_creation array[string] None Optionnel Liste de répertoire à créeravant l'éxecution. Ex : ["INI", "DAT"]
command_suffix string None Optionnel Suffixe à ajouter à la commande. Typiquemnt des secrets. Ex : --token DGDFGDFGDH
command_path string None Optionnel Commande à exécuter. Ex : /absolute/path/executable or relative/path/executable. Dans le cas, d'un chemin relatif, il testera le working directory et le origin working directory.
executable_url string None Optionnel Url de l'exécutable à télécharger avant de l'exécuter. Ex : https://github.com/org/app/releases/download/v3.31.5/app-2.12.2-linux-x86-64.
command_guess_os_extension boolean False Si la commande à exécuter n'est pas trouvée, cherche avec des extensions en fonction de l'OS. Ex : .exe, .bat pour windows
working_dir string None Optionnel Chemin relatif du répertoire de travail pour l'éxecution de la commande. Dans le contexte processeur ExecuteAndCompare si non défini, récupère respectivement la valeur de compare.sources.test_folder_relative_path ou compare.sources.reference_folder_relative_path

ExecuteAndCompareConfig

Nom Type Défault Description
test ExecuteConfig None Optionnel Surcharge les paramètres de la section execute pour le contexte de test.
test_only boolean False Si true, aucune éxécution faite pour la référence (les sorties de réferences pour comparaison existent déjà).
reference ExecuteConfig None Optionnel Surcharge les paramètres de la section execute pour le contexte de référence.

FileReaderConfig

Nom Type Défault Description
extension_unknown_ignore boolean False Si aucun reader n'est trouvé pour une extension, passe au suivant sans générer d'erreur.
extension_mapping object None Optionnel Mapping d'extensions source - cible. Ex {"txt": "csv"}.
extension_fallback string None Optionnel Si aucun reader n'est trouvé pour une extension, utilise cette extension pour déterminer le reader.
encoding string utf-8 Encodage utilisé pour lire les fichiers.
custom_curve_parser string ou object None Optionnel Représente le chemin d'un fichier/module python suivi par :: suivi par le nom d'une fonction à appeller pour parser les courbes d'un fichier. Le chemin peut être absolu ou relatif. Dans le cas, d'un chemin relatif, il testera le working directory et le origin working directory. Ex: custom_parser.py::parse_curves

ReadersConfig

Nom Type Défault Description
txt ReaderTxtConfig Configuration des readers txt.
csv ReaderCsvConfig Configuration des readers csv.

ReaderTxtConfig

Nom Type Défault Description
error_rule_patterns array[string] None Optionnel Liste de motifs de chaîne à vérifier. Si un motif est trouvé, génère une erreur. Ex: ["NaN", "infinity"]
ignore object None Optionnel Ignore les lignes d'un fichier selon un motif. Ex: {"path": [{"pattern": "NaN", "pre": 0, "post": 0}]}
report_lines object None Optionnel Nombre de lignes à reporter avant et après une erreur. Ex: {"path": {"pre": 0, "post": 0}

ReaderCsvConfig

Nom Type Défault Description
ignore_colunmns array[string] None Optionnel Liste des noms des colonnes à ignorer. (Valide seulement si la première ligne est les en-têtes)
curve_parser ReaderCsvCurveParserConfig None Optionnel Parseur de courbe à utiliser.

ReaderCsvCurveParserConfig

Nom Type Défault Description
name enum Valeurs possibles: col_x, cols_couple. Le type de paramètres dépend de cette valeur
parameters ReaderCsvCurveParserColXConfig ou ReaderCsvCurveParserColsCoupleConfig Paramètres du parser de courbes

ReaderCsvCurveParserColXConfig

Nom Type Défault Description
x integer ou string ou array[string] 1 Si integer, index de la colonne pour l'axe x (index 1 pour la première colonne).Si String, nom de la colonne pour l'axe x. Si la colonne n'existe pas, il n'y aura pas de parsing.(Valide seulement si la première ligne est les en-têtes)Si `List[String] (utiles dans un contexte multi dataset), noms de la colonne pour l'axe x, noms des colonnes pour l'axe x , si plusieurs colonnes correspondent, la première trouvée sera utilisée. Si aucune colonne ne correspond, il n'y aura pas de parsing.(Valide seulement si la première ligne est les en-têtes)

ReaderCsvCurveParserColsCoupleConfig

Nom Type Défault Description
x_index integer NOT IMPLEMENTED - Index Col x
y_index integer NOT IMPLEMENTED - Index Col y

CompareConfig

Nom Type Défault Description
float_thresholds CompareFloatThresholdsConfig Seuil de comparaison pour les valeurs flottantes.
sources CompareSourceFoldersConfig Configuration pour les sources des données de test et de référence.

CompareFloatThresholdsConfig

Nom Type Défault Description
relative_vs_absolute_min number 1e-12 Si la valeur de test est inférieure à ce seuil, calcul de l'erreur absolue.
relative_error_min number 0.001 Si l'erreur relative est supérieure à ce seuil, génére un warning.
relative_error_max number 0.01 Si l'erreur relative est supérieure à ce seuil, génére une erreur.
absolute_error_min number 1e-07 Si l'erreur absolue est supérieure à ce seuil, génére un warning.
absolute_error_max number 1e-06 Si l'erreur absolue est supérieure à ce seuil, génére une erreur.

CompareSourceFoldersConfig

Nom Type Défault Description
test_folder_relative_path string test Relative path to the working directory for the test folder.
reference_folder_relative_path string reference Relative path to the working directory for the reference folder.
additional_path_suffix string Additional path to add after test and reference folders.
test_filename_match_ignore string None Optionnel Chaîne spécifique dans le nom de fichier test à ignorer pour matcher les noms. Ex : .test or test_
reference_filename_match_ignore string None Optionnel Chaîne spécifique dans le nom de fichier référence à ignorer pour matcher les noms. Ex : .ref or ref_
recursive boolean False Recherche récursive dans les répertoires de test et de référence.

ReportConfig

Nom Type Défault Description
debug boolean False If true the report will be more verbose and displays template input data.
title string cglblens Report Titre du rapport
logo string None Optionnel Source d'une image logo. Peut être une url ou une url data image encodée base64 (exclusif avec logo_file).
logo_file string None Optionnel Source fichier d'une image logo (exclusif avec logo).
output ReportOutputConfig
html ReportHtmlConfig

ReportOutputConfig

Nom Type Défault Description
filename string cglblens_report Nom de fichier (sans l'extension) des rapports générés.
export_html boolean False Génère un rapport HTML
export_txt boolean False Génère un rapport TXT
export_json boolean False Génère un rapport JSON
export_yaml boolean False Génère un rapport YAML
export_py boolean False Génère un rapport Python (Variable)
export_js boolean False Génère un rapport Javascript (Variable)
export_ts boolean False Génère un rapport Typecript (Variable)
export_php boolean False Génère un rapport Php (Variable)

ReportHtmlConfig

Nom Type Défault Description
compare_color_test string 1982c4 Couleur pour les données de test.
compare_color_reference string 6a4c93 Couleur pour les données de référence.
collapse_if_successful boolean True N'affiche par défaut les sections de comparaison sans erreur.
parameter_page_mode ReportParameterPageModeConfig
parameter_open_file_in ReportParameterOpenFileInConfig
curves ReportHtmlCurvesConfig

ReportParameterPageModeConfig

Nom Type Défault Description
is_user_preference boolean True Paramètre modifiable par l'utilisateur
default_value string onepage tabs ou onepage

ReportParameterOpenFileInConfig

Nom Type Défault Description
is_user_preference boolean True Paramètre modifiable par l'utilisateur
default_value string browser browser ou vscode

ReportHtmlCurvesConfig

Nom Type Défault Description
display_on_load boolean False Si true, affiche tous les graphiques courbes à l'ouverture du rapport.
init_width integer 600 Largeur initiale des graphiques courbes.
init_height integer 400 Hauteur initiale des graphiques courbes.
CesGensLaB