rougail-tutorials/README.md

• Summary
• [tutorial v1.1_022] Putting a variable inside of a family or a sub family (diff)

[tutorial v1.1_030] A variable with type "domainname"

View the diff

Read the documentation

Screenshot

Clone and install

To test this tutorial, you need to download this repository and install Rougail:

git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml

Then switch to the tutorial page:

git switch --detach v1.1_030

Structure

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

Contents of the firefox/10-manual.yml file

%YAML 1.2
---
version: 1.1

manual:  # Manual proxy configuration

  http_proxy:  # HTTP Proxy

    address:
      description: HTTP address
      type: domainname
...

Let's generate the documentation

rougail -m firefox/ -o doc

Variable	Description
proxy_mode choice mandatory	Configure Proxy Access to the Internet. Choices: • No proxy ← (default) • Auto-detect proxy settings for this network • Use system proxy settings • Manual proxy configuration • Automatic proxy configuration URL

Manual proxy configuration

🛈 Informations

Path: manual

HTTP Proxy

🛈 Informations

Path: manual.http_proxy

Variable	Description
manual.http_proxy.address domainname mandatory	HTTP address. Validator: type domainname

Let's generate the changelog

rougail -m firefox/ -o doc --doc.contents changelog

Modified variable

Variable	Description
manual.http_proxy.address domainname mandatory	HTTP address. Validator: type domainname

User datas

Example 1

config/01/config.yml

---
manual:
  http_proxy:
    address: example.net

Output

rougail -m firefox/ -u yaml -yf config/01/config.yml

╭───────────────────── 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: example.net ◀ loaded from the YAML file 
            "config/01/config.yml"

Example 2

config/02/config.yml

---
manual:
  http_proxy:
    address: 192.168.0.1

Output

rougail -m firefox/ -u yaml -yf config/02/config.yml

🔔 WARNINGS
┗━━ the value "192.168.0.1" is an invalid domain name for 
    "manual.http_proxy.address" (HTTP address), must not be an IP, it will be 
    ignored when loading from the YAML file "config/02/config.yml"
🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Manual proxy configuration
        ┗━━ HTTP Proxy
            ┗━━ HTTP address

Output when invalid user datas is an error

rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.invalid_user_datas_error

🛑 ERRORS
┗━━ the value "192.168.0.1" is an invalid domain name for 
    "manual.http_proxy.address" (HTTP address), must not be an IP, it will be 
    ignored when loading from the YAML file "config/02/config.yml"

Example 3

config/03/config.yml

---
manual:
  http_proxy:
    address: not a valid domain name

Output

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

Output when invalid user datas is an error

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"

• [tutorial v1.1_031] A variable with type's parameters (diff)