From 4af36f34a2785bef716ffd1935c4875bdd74a4c0 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sun, 9 Nov 2025 19:31:13 +0100 Subject: [PATCH] [tutorial v1.1_022)] A variable with type "port" (config and doc) --- README.md | 103 ++++++++++++++++++---------------- config/01/config.yml | 1 + config/01/output_ro.html | 14 +++-- config/02/cmd_invalid.txt | 1 - config/02/config.yml | 4 +- config/02/output_invalid.html | 10 ---- config/02/output_ro.html | 13 +++-- config/03/config.yml | 4 +- config/03/output_invalid.html | 2 +- config/03/output_ro.html | 18 ++++-- tree.html | 8 +-- 11 files changed, 93 insertions(+), 85 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 7ae22db6..71d5af8c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_020] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020)) +- [[tutorial v1.1_021] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021)) -# [tutorial v1.1_021)] A variable with type's parameters +# [tutorial v1.1_022)] A variable with type "port" -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022) ## Screenshot @@ -29,7 +29,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_021 +git switch --detach v1.1_022 ``` ## Structure @@ -37,10 +37,10 @@ git switch --detach v1.1_021

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


Contents of the firefox/10-manual.yml file @@ -59,6 +59,11 @@ manual: # Manual proxy configuration type: domainname params: allow_ip: true + + port: + description: HTTP Port + type: port + default: 8080 ... ``` @@ -86,17 +91,18 @@ rougail -m firefox/ -o doc | Variable                                                                                            | Description                                                                                         | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validator**: 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.
**Validator**: 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 @@ -108,6 +114,7 @@ rougail -m firefox/ -o doc --doc.contents changelog ```yml --- +proxy_mode: Manual proxy configuration manual: http_proxy: address: example.net @@ -117,15 +124,17 @@ manual: ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          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
 
@@ -134,39 +143,27 @@ 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  │
-│          Modified value │
-╰─────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ 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/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  │
-│          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
 
@@ -175,9 +172,11 @@ Variables:
 
 ```yml
 ---
+proxy_mode: Manual proxy configuration
 manual:
   http_proxy:
-    address: not a valid domain name
+    address: example.net
+    port: 100000
 ```
 #### Output
 
@@ -185,12 +184,18 @@ 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               │
+│          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
 
@@ -198,8 +203,8 @@ 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_022] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
+- [[tutorial v1.1_023] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_023/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023))
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 d298e7b1..dcc2f500 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -1,10 +1,12 @@
-
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          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 2f748124..00000000
--- a/config/02/output_invalid.html
+++ /dev/null
@@ -1,10 +0,0 @@
-
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          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 2f748124..31b5ed09 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,10 +1,11 @@
-
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ 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/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 f04dbb17..9a0085e0 100644
--- a/config/03/output_invalid.html
+++ b/config/03/output_invalid.html
@@ -1,3 +1,3 @@
 
🛑 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 00845602..6088afd2 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,8 +1,14 @@
 
🔔 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               │
+│          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 ecb6b46e..a040cdf7 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