From 0bf261f16d77e811e5cbb789ba399bec422b691d Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 2 Dec 2025 16:18:32 +0100 Subject: [PATCH] [tutorial v1.1_032] A variable with type "port" (config and doc) --- README.md | 129 ++++++++++++++++++---------------- config/01/config.yml | 1 + config/01/output_ro.html | 17 +++-- config/02/cmd_invalid.txt | 1 - config/02/config.yml | 4 +- config/02/output_invalid.html | 11 --- config/02/output_ro.html | 17 +++-- config/03/config.yml | 4 +- config/03/output_invalid.html | 6 +- config/03/output_ro.html | 24 ++++--- tree.html | 8 +-- 11 files changed, 119 insertions(+), 103 deletions(-) delete mode 100644 config/02/cmd_invalid.txt delete mode 100644 config/02/output_invalid.html diff --git a/README.md b/README.md index 3b9040b7..5af5cd14 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_030] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)) +- [[tutorial v1.1_031] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031)) -# [tutorial v1.1_031] A variable with type's parameters +# [tutorial v1.1_032] A variable with type "port" -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type's-parameters) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"port") ## Screenshot @@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_031 +git switch --detach v1.1_032 ``` ## Structure @@ -39,10 +39,10 @@ git switch --detach v1.1_031

-.
- └── firefox
-     ├── 00-proxy.yml
-     └── 10-manual.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     └── 10-manual.yml


Contents of the firefox/10-manual.yml file @@ -61,6 +61,11 @@ manual: # Manual proxy configuration type: domainname params: allow_ip: true + + port: + description: HTTP Port + type: port + default: 8080 ... ``` @@ -85,20 +90,21 @@ rougail -m firefox/ -o doc > > **Path**: manual.http_proxy -| Variable | Description | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validators**:
• type domainname
• the domain name can be an IP | +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validators**:
• type domainname
• the domain name can be an IP | +| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP Port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: 8080 | ### Let's generate the changelog ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### Modified variable +#### New variable -| Variable | Description | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validators**:
• type domainname
• the domain name can be an IP | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP Port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: 8080 | ## User datas @@ -110,6 +116,7 @@ rougail -m firefox/ -o doc --doc.contents changelog ```yml --- +proxy_mode: Manual proxy configuration manual: http_proxy: address: example.net @@ -119,16 +126,19 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -
╭───────────────────── Caption ─────────────────────╮
-│ Variable                           Default value  │
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
 ┗━━ 📂 Manual proxy configuration
     ┗━━ 📂 HTTP Proxy
-        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
-            "config/01/config.yml"
+        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+        ┃   "config/01/config.yml"
+        ┗━━ 📓 HTTP Port: 8080
 

 ### Example 2
 
@@ -137,41 +147,30 @@ Variables:
 
 ```yml
 ---
+proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
-    address: 192.168.0.1
+    address: example.net
+    port: 3128
 ```
 #### Output
 
 ```shell
 rougail -m firefox/ -u yaml -yf config/02/config.yml
 ```
-
╭───────────────────── Caption ─────────────────────╮
-│ Variable                           Default value  │
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Modified value              │
+│ Undocumented but modified variable (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
 ┗━━ 📂 Manual proxy configuration
     ┗━━ 📂 HTTP Proxy
-        ┗━━ 📓 HTTP address: 192.168.0.1 ◀ loaded from the YAML file 
-            "config/02/config.yml"
-

-#### Output when invalid user datas is an error
-
-```shell
-rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.invalid_user_datas_error
-```
-
╭───────────────────── Caption ─────────────────────╮
-│ Variable                           Default value  │
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📂 Manual proxy configuration
-    ┗━━ 📂 HTTP Proxy
-        ┗━━ 📓 HTTP address: 192.168.0.1 ◀ loaded from the YAML file 
-            "config/02/config.yml"
+        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+        ┃   "config/02/config.yml"
+        ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
+            "config/02/config.yml" (⏳ 8080)
 

 ### Example 3
 
@@ -180,9 +179,11 @@ Variables:
 
 ```yml
 ---
+proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
-    address: not a valid domain name
+    address: example.net
+    port: 100000
 ```
 #### Output
 
@@ -190,14 +191,22 @@ manual:
 rougail -m firefox/ -u yaml -yf config/03/config.yml
 ```
 
🔔 WARNINGS
-┗━━ the value "not a valid domain name" is an invalid domain name for 
-    "manual.http_proxy.address" (HTTP address), must have dot, it will be 
-    ignored when loading from the YAML file "config/03/config.yml"
-🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTP Proxy
-            ┗━━ HTTP address
+┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
+    Port), must be between 1 and 65535, it will be ignored when loading from the
+    YAML file "config/03/config.yml"
+╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+        ┃   "config/03/config.yml"
+        ┗━━ 📓 HTTP Port: 8080
 

 #### Output when invalid user datas is an error
 
@@ -205,10 +214,10 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml
 rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error
 ```
 
🛑 ERRORS
-┗━━ the value "not a valid domain name" is an invalid domain name for 
-    "manual.http_proxy.address" (HTTP address), must have dot, it will be 
-    ignored when loading from the YAML file "config/03/config.yml"
+┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
+    Port), must be between 1 and 65535, it will be ignored when loading from the
+    YAML file "config/03/config.yml"
 

 
 
-- [[tutorial v1.1_032] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032))
+- [[tutorial v1.1_033] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))
diff --git a/config/01/config.yml b/config/01/config.yml
index 22422a2f..e3db924b 100644
--- a/config/01/config.yml
+++ b/config/01/config.yml
@@ -1,4 +1,5 @@
 ---
+proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
     address: example.net
diff --git a/config/01/output_ro.html b/config/01/output_ro.html
index c2e650fc..c0fff144 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -1,11 +1,14 @@
-
╭───────────────────── Caption ─────────────────────╮
-│ Variable                           Default value  │
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
 ┗━━ 📂 Manual proxy configuration
     ┗━━ 📂 HTTP Proxy
-        ┗━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
-            "config/01/config.yml"
+        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+        ┃   "config/01/config.yml"
+        ┗━━ 📓 HTTP Port: 8080
 

diff --git a/config/02/cmd_invalid.txt b/config/02/cmd_invalid.txt
deleted file mode 100644
index 0bbf6053..00000000
--- a/config/02/cmd_invalid.txt
+++ /dev/null
@@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.invalid_user_datas_error
\ No newline at end of file
diff --git a/config/02/config.yml b/config/02/config.yml
index cbc99036..6e7c9dc6 100644
--- a/config/02/config.yml
+++ b/config/02/config.yml
@@ -1,4 +1,6 @@
 ---
+proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
-    address: 192.168.0.1
+    address: example.net
+    port: 3128
diff --git a/config/02/output_invalid.html b/config/02/output_invalid.html
deleted file mode 100644
index 8723e89e..00000000
--- a/config/02/output_invalid.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
╭───────────────────── Caption ─────────────────────╮
-│ Variable                           Default value  │
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📂 Manual proxy configuration
-    ┗━━ 📂 HTTP Proxy
-        ┗━━ 📓 HTTP address: 192.168.0.1 ◀ loaded from the YAML file 
-            "config/02/config.yml"
-

diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index 8723e89e..4a8ef0ff 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,11 +1,14 @@
-
╭───────────────────── Caption ─────────────────────╮
-│ Variable                           Default value  │
-│ Undocumented but modified variable Modified value │
-╰───────────────────────────────────────────────────╯
+
╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Modified value              │
+│ Undocumented but modified variable (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
 ┗━━ 📂 Manual proxy configuration
     ┗━━ 📂 HTTP Proxy
-        ┗━━ 📓 HTTP address: 192.168.0.1 ◀ loaded from the YAML file 
-            "config/02/config.yml"
+        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+        ┃   "config/02/config.yml"
+        ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
+            "config/02/config.yml" (⏳ 8080)
 

diff --git a/config/03/config.yml b/config/03/config.yml
index bdc052ca..d05944fe 100644
--- a/config/03/config.yml
+++ b/config/03/config.yml
@@ -1,4 +1,6 @@
 ---
+proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
-    address: not a valid domain name
+    address: example.net
+    port: 100000
diff --git a/config/03/output_invalid.html b/config/03/output_invalid.html
index 4c6a9ad2..3bc8ae7e 100644
--- a/config/03/output_invalid.html
+++ b/config/03/output_invalid.html
@@ -1,5 +1,5 @@
 
🛑 ERRORS
-┗━━ the value "not a valid domain name" is an invalid domain name for 
-    "manual.http_proxy.address" (HTTP address), must have dot, it will be 
-    ignored when loading from the YAML file "config/03/config.yml"
+┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
+    Port), must be between 1 and 65535, it will be ignored when loading from the
+    YAML file "config/03/config.yml"
 

diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 7ae93065..af7a3f9b 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,10 +1,18 @@
 
🔔 WARNINGS
-┗━━ the value "not a valid domain name" is an invalid domain name for 
-    "manual.http_proxy.address" (HTTP address), must have dot, it will be 
-    ignored when loading from the YAML file "config/03/config.yml"
-🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┗━━ HTTP Proxy
-            ┗━━ HTTP address
+┗━━ the value "100000" is an invalid port for "manual.http_proxy.port" (HTTP 
+    Port), must be between 1 and 65535, it will be ignored when loading from the
+    YAML file "config/03/config.yml"
+╭─────────────────────────── Caption ────────────────────────────╮
+│ Variable                           Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
+┃   loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
+┗━━ 📂 Manual proxy configuration
+    ┗━━ 📂 HTTP Proxy
+        ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file 
+        ┃   "config/03/config.yml"
+        ┗━━ 📓 HTTP Port: 8080
 

diff --git a/tree.html b/tree.html
index f3ac9c54..b6437367 100644
--- a/tree.html
+++ b/tree.html
@@ -25,10 +25,10 @@
 
 
 	
Directory Tree

-	.

-	└── firefox

-	    ├── 00-proxy.yml

-	    └── 10-manual.yml

+	.

+	└── firefox

+	    ├── 00-proxy.yml

+	    └── 10-manual.yml

 


 
 2 directories, 2 files