1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
|
# `platform`
PyFunceble alone is a great tool. What if we could just test the subject that
were not already tested by others ?
!!! danger "Beware!!!!"
The parameters listed below are not production ready. You should use or
activate them only if you have good reasons to.
## Overview
```yaml title=".PyFunceble.overwrite.yaml"
platform:
# Provides everything related to the platform.
# PyFunceble alone is a great tool. What if we could just test the subject that
# were not already tested by others ?
# Enable or disable the push of datasets (cf: test results) into the platform
# (API).
#
# NOTE:
# This parameter is useless, unless you have a valid API Token defined
# into the PYFUNCEBLE_PLATFORM_API_TOKEN environment variable.
#
# CLI Argument: --push-platform
push: no
# Set the preferred pull "method".
#
# The platform (API) does not only provides datasets but it also offer an
# aggregation endpoint that let PyFunceble pull datasets.
# When pulling information about a subject that is already known by the platform,
# it returns 3 group of results:
#
# - `frequent`, which provides the status that was mostly been pushed.
# - `latest`, which provides the status based on the latest submitted datasets.
# - `recommended`, which provides the recommended status.
#
# CLI Argument: --platform-preferred-origin
preferred_status_origin: recommended
# Defines the checker type to prioritize when trying to fullfil platform
# contracts.
#
# Notes:
# 1. This is a list. The order matters.
# 2. One can overwrite this value, by settings a comma separated list of
# checker type to prioritize through the PYFUNCEBLE_PLATFORM_CHECKER_PRIORITY
# environment variable.
# 3. When set to `none`, the platform will throw a random contract at us.
#
# Example:
# Prioritize availability checker until no contract is available, then
# prioritize syntax checker until no contract is available, then prioritize
# reputation checker until no contract is available.
#
# - availability
# - syntax
# - reputation
#
# Available Values: none | availability | reputation | syntax
#
# CLI Argument: none
checker_priority:
- none
# Defines the checker type to exclude when trying to fullfil platform
# contracts.
#
# Notes:
# 1. This is a list.
# 2. One can overwrite this value, by settings a comma separated list of
# checker type to exclude through the PYFUNCEBLE_PLATFORM_CHECKER_EXCLUDE
# environment variable.
# 3. When set to `none`, no checker type will be excluded.
#
# Example:
# Exclude the reputation checker from the list of checker to use to fullfil.
#
# - reputation
#
# Available Values: none | availability | reputation | syntax
#
# CLI Argument: none
checker_exclude:
- none
```
## `push`
Enable or disable the push of datasets (cf: test results) into the platform
(API).
!!! danger "Beware!!!!"
The parameters listed below are not production ready. You should use or
activate them only if you have good reasons to.
**Type:** boolean
**Default Value:** `no`
**Available Values:** `yes`, `no`
**CLI Argument:** `--push-platform`
## `preferred_status_origin`
Set the preferred pull "method".
The platform (API) does not only provides datasets but it also offer an
aggregation endpoint that let PyFunceble pull datasets.
When pulling information about a subject that is already known by the platform,
it returns 3 group of results:
- `frequent`, which provides the status that was mostly been pushed.
- `latest`, which provides the status based on the latest submitted datasets.
- `recommended`, which provides the recommended status.
!!! danger "Beware!!!!"
The parameters listed below are not production ready. You should use or
activate them only if you have good reasons to.
**Type:** string
**Default Value:** `recommended`
**Available Values:** `frequent`, `latest`, `recommended`
**CLI Argument:** `--platform-preferred-origin`
## `checker_priority`
Defines the checker type to prioritize when trying to fullfil platform contracts.
!!! note "Notes:"
1. This is a list. The order matters.
2. One can overwrite this value, by settings a comma separated list of
checker type to prioritize through the PYFUNCEBLE_PLATFORM_CHECKER_PRIORITY
environment variable.
3. When set to `none`, the platform will throw a random contract at us.
**Example:**
Prioritize availability checker until no contract is available, then
prioritize syntax checker until no contract is available, then prioritize
reputation checker until no contract is available.
```yaml
checker_priority:
- availability
- syntax
- reputation
```
!!! danger "Beware!!!!"
The parameters listed below are not production ready. You should use or
activate them only if you have good reasons to.
**Type:** list[string]
**Default Value:** `["none"]`
**Available Values:** `none`, `availability`, `reputation`, `syntax`
**CLI Argument:** none
## `checker_exclude`
Defines the checker type to exclude when trying to fullfil platform contracts.
!!! note "Notes:"
1. This is a list.
2. One can overwrite this value, by settings a comma separated list of
checker type to exclude through the PYFUNCEBLE_PLATFORM_CHECKER_EXCLUDE
environment variable.
3. When set to `none`, no checker type will be excluded.
**Example:**
Exclude the reputation checker from the list of checker to use to fullfil.
```yaml
checker_exclude:
- reputation
```
!!! danger "Beware!!!!"
The parameters listed below are not production ready. You should use or
activate them only if you have good reasons to.
**Type:** list[string]
**Default Value:** `["none"]`
**Available Values:** `none`, `availability`, `reputation`, `syntax`
**CLI Argument:** none
|
