Getting started ==================== .. objectives:: Objectives We will learn how to: - create a :term:`structure description file ` - add a :term:`structure file ` format version in the structure file - add a :term:`variable` in the structure file and set its default :term:`value` .. prerequisites:: Prerequisites - We assume that Rougail's library is :ref:`installed ` on your computer. - It is possible to retrieve the current state of the various rougail files manipulated in this tutorial step by checking out the corresponding tag of the Rougail-tutorials git repository. Each tag corresponds to a stage of progress in the tutorial. Of course, you can also decide to copy/paste or download the tutorial files contents while following the tutorial steps. If you want to follow this tutorial with the help of the corresponding :tutorial:`Rougail-tutorials git repository `, this workshop page corresponds to the tags :tutorial:`v1.1_000 ` to :tutorial:`v1.1_003 ` in the repository: :: git clone https://forge.cloud.silique.fr/stove/rougail-tutorials.git git checkout v1.1_000 Creating a structure file -------------------------- .. demo:: The folder structure Here is the tree structure we want to have:: rougail-tutorials └── firefox └── 00-proxy.yml - Let's make a :file:`rougail-tutorials` directory, with a :file:`firefox` subfolder. - First, we will create a :term:`structure file `, so let's create a :file:`00-proxy.yml` file located in the :file:`firefox` subfolder. This is an empty Rougail :term:`structure description file: ` .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_000/firefox/00-proxy.yml :language: yaml :caption: An empty rougail structure file with only the YAML header and the version number :name: RougailStructVersion .. --- version: 1.1 :tutorial:`Download this file from the rougail-tutorials git repository ` This `version` specification is just the rougail YAML's format version specification. By now, we have an empty structure file with the format specification in it. Let's add our first variable ------------------------------ .. type-along:: For those who follow the tutorial with the help of the git repository Now you need to checkout the `v1.1_001` version:: git checkout v1.1_001 - A variable is defined at a minimum by its name. - A :term:`variable` lives in the :term:`structure description file `. Here we define a variable named `proxy_mode`: .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_001/firefox/00-proxy.yml :language: yaml :caption: A Rougail structure file with only one variable in it :name: RougailDictionaryFirstVariableName .. --- proxy_mode: :tutorial:`Download this file from the rougail-tutorials git repository ` Let's run the Rougail CLI utility command in a terminal: .. code-block:: text :class: terminal rougail -m firefox/ Well, we notice that we have an error: .. raw:: html :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_001/config/01/output_ro.html :class: error-box .. 🛑 ERRORS ┣━━ The following variables are mandatory but have no value: ┗━━ - proxy_mode It's because this first defined variable is :term:`mandatory` and needs to have a value set **but** there's no value yet. We can therefore deduce the fact that: .. admonition:: Fact Once defined, an option configuration :term:`value` is :term:`mandatory`. That is to say, it is absolutely necessary to assign a value to this variable. Rougail expects the `proxy_mode` configuration option's value to be set. .. glossary:: mandatory A variable is mandatory when a value is required, that is, `None` **is not** a possible value. It **must** have a defined value. .. seealso:: To go further, have a look at the :tiramisu:`mandatory option ` according to the :xref:`Tiramisu ` underlyning consistency system. You will learn that it is actually possible to disable the mandatory property behavior, but you need to declare it explicitely. Describe the variable ------------------------- Let's add a variable's description, which is not mandatory but which is usually a good practice. .. type-along:: For those who follow the tutorial with the help of the git repository Now you need to checkout the `v1.1_002` version:: git checkout v1.1_002 .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_002/firefox/00-proxy.yml :language: yaml :caption: A Rougail structure file with a variable and a description :name: RougailStructFirstVariableDescription .. --- proxy_mode: # Configure Proxy Access to the Internet :tutorial:`Download this file from the rougail-tutorials git repository ` You have two way to define a variable's description: - the verbose way: .. code-block:: yaml proxy_mode: description: Configure Proxy Access to the Internet - or a short-hand way, setting the description using the "`#`" YAML comment notation: .. code-block:: yaml proxy_mode: # Configure Proxy Access to the Internet Set a default value --------------------- .. type-along:: For those who follow the tutorial with the help of the git repository Now you need to checkout the `v1.1_003` version:: git checkout v1.1_003 We will learn different ways to set a value, the first way is setting a *default* value. .. glossary:: default value A default value is a variable value that is predefined, that's why this value is placed right in the structure file. Let's add a default value to this `proxy_mode` variable. .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_003/firefox/00-proxy.yml :language: yaml :caption: A rougail structure file with a default value for the variable :name: RougailDictionaryVariableDefault .. --- proxy_mode: No proxy # Configure Proxy Access to the Internet :tutorial:`Download this file from the rougail-tutorials git repository ` The `proxy_mode` variable requires a value, that's why we have set a `No proxy` default value. .. raw:: html :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_003/config/01/output_ro.html :class: output .. 
╭─────── Caption ────────╮
    │ Variable Default value │
    ╰────────────────────────╯
    Variables:
    ┗━━ 📓 Configure Proxy Access to the Internet: No proxy
As we have set the `proxy_mode`'s value as `No proxy` by default, The chosen value is indicated in the rougail's CLI output as the default choice. .. glossary:: short-hand notation A short-hand notation in rougail is the ability to define a variable in a short-hand way, there are several example: - a default value: .. code-block:: yaml my_var: true instead of: .. code-block:: yaml my_var: default: true - a quick description: .. code-block:: yaml proxy_mode: # Configure Proxy Access to the Internet instead of: .. code-block:: yaml proxy_mode: description: Configure Proxy Access to the Internet There are some other short-hand ways with rougail that you may encounter as you read the rougail's documentation and tutorial. .. admonition:: how to set a value -- the assignment A default value has been set, great. This raises a question about what a normal value is. Now then how can I assign a normal value to a variable? .. type-along:: The different rougail roles and setting a variable's value So far we have only talked about the guy that writes the :term:`structure files `\ . The one who writes the structure file plays the *role* of the *integrator*. .. glossary:: integrator An integrator in the Rougail field is the person who writes the :term:`structure files `\ . He has the responsibility of the integration process, that is, he defines the variables and the relationship between them, the variables that are allowed (or not) to be set, and so on. His responsabilites are the **structuration** and the **consistency** of the organisation of the variables between them. Now we will talk about the one that defines the values. His role is called the operator role. .. glossary:: operator An operator in the Rougail field is the person who assigns :term:`value`\ s to the pre-defined variables, his responsabilities are to set variable values correctly. The user :term:`value`\ s, that is the values that have been set by the operator, are of course type validated. The type validation is driven by the definitions in the :term:`structure file `. It is the operator's responsibility to set the user datas variables values. The operator does not handle the structure files, he is responsible of other files called the :term:`user data files `. .. glossary:: user datas User datas, as opposed to structured datas, are datas that only concern the assignment of values and not the consistency of the variables between them. The variable's values are also called **user values**. The consistency field is outside of the user datas scope. The consistency is handled in the :term:`structured datas `\ 's scope. .. important:: If user datas are not set, default values are mandatory, otherwise Rougail will raise an error. .. exercise:: Folder structure update Now we add a user data file named :file:`config/config.yml` in our project:: rougail-tutorials ├── firefox │ ├── 00-proxy.yml └── config └── config.yml .. type-along:: how to set a user data value If the integrator has not set any default value in his structure file, it's up to the operator to do the job in the `config.yml` file: .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_003/config/02/config.yml :language: yaml :caption: A Rougail user datas file :file:`config/config.yml`, with a value set. :name: RougailConfigDefaultValue .. --- proxy_mode: No proxy :tutorial:`Download this file from the rougail-tutorials git repository ` The operator needs to add the `-u yaml -yf config/config.yml` options to the rougail CLI: .. raw:: html :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_003/config/02/cmd_ro.txt :class: terminal .. rougail -m firefox/ -u yaml -yf config/02/config.yml which gives us this output: .. raw:: html :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_003/config/02/output_ro.html :class: output .. 
╭──────── Caption ────────╮
    │ Variable Modified value │
    ╰─────────────────────────╯
    Variables:
    ┗━━ 📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yml"
Now the `proxy_mode`'s new `No proxy` value is the same as the default value but we see in the rougail CLI output that the value comes from the :file:`config/02/config.yml` user data file. From now on this `proxy_mode` variable's value is a user data value and not a default value (even if it's actually the same value). .. type-along:: structure values and user data values We can see with the rougail CLI utility where the values come from. It can come from an integrator's setting or from an operator's setting. .. admonition:: Reminder - the integrator works on structure files, he can define default value for variables - the operator works on user data files, he only can set user data values for variables Most of the time, the integrator and the operator are one and the same person, here we are talking about roles and not necessarily about people. .. keypoints:: Key points progress **Keywords** - :term:`structure file `: structure description file - :term:`variable`: an option's name which has a value - a variable's description - a variable's mandatory value - a variable's default value - a variable's user value - the :term:`integrator` and :term:`operator` roles