feat: Allow to exclude dotfiles on pillar data

README.md

@@ -2,6 +2,7 @@
 
 <!--
 SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->
@@ -13,6 +14,7 @@ Dotfiles.
 *   [Description](#description)
 *   [Installation](#installation)
     *   [Salt](#salt)
+        *   [Pillar](#pillar)
     *   [Script](#script)
 *   [Usage](#usage)
 *   [License](#license)
@@ -59,6 +61,47 @@ Install specific files in Dom0:
 sudo qubesctl state.apply dotfiles.copy-dom0,dotfiles.copy-sh,dotfiles.copy-vim,dotfiles.copy-x11
 ```
 
+#### Pillar
+
+By default, all states are executed when applied.  This can be deactivated in
+full or in part by configuring the corresponding pillar data to a non true
+value.
+
+You will need a top file and a sls file in your pillar_roots, when following
+[the Qusal's installation instructions](https://github.com/ben-grande/qusal/blob/main/docs/INSTALL.md),
+`/srv/pillar/qusal` will be added to you pillar_roots.
+
+Example: `/srv/pillar/qusal/dotfiles.top`
+
+```yaml
+base:
+  '*':
+    - qusal.dotfiles
+```
+
+It will apply the `qusal/dotfiles.sls` on all targets.
+
+Example: `/srv/pillar/qusal/dotfiles.sls`:
+
+```yaml
+qusal:
+  dotfiles:
+    dom0: false
+```
+
+This will disable the dom0 dotfiles configuration.
+
+For a complete example of a pillar state and a listing of their corresponding
+formulas states, please refer to `pillar.sls.example`.
+
+Enable the pillar top above:
+
+```sh
+sudo qubesctl top.enable qusal.dotfiles pillar=true
+```
+
+Now subsequent calls to the states of this repository will skip `copy-dom0.sls`.
+
 ### Script
 
 You can simply deploy all configurations with:

copy-all.sls

@@ -1,9 +1,25 @@
 {#
 SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:dom0') == true
+         or salt['pillar.get']('qusal:dotfiles:git')  == true
+         or salt['pillar.get']('qusal:dotfiles:gtk')  == true
+         or salt['pillar.get']('qusal:dotfiles:net')  == true
+         or salt['pillar.get']('qusal:dotfiles:pgp')  == true
+         or salt['pillar.get']('qusal:dotfiles:sh')   == true
+         or salt['pillar.get']('qusal:dotfiles:ssh')  == true
+         or salt['pillar.get']('qusal:dotfiles:vim')  == true
+         or salt['pillar.get']('qusal:dotfiles:x11')  == true
+         or salt['pillar.get']('qusal:dotfiles:xfce') == true
+       )
+-%}
+
 include:
   - .copy-dom0
   - .copy-git
@@ -17,6 +33,13 @@ include:
   - .copy-x11
   - .copy-xfce
 
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif -%}
+
 {#
 Unfortunately salt.states.file does not keep permissions when using salt-ssh.
 Best option is 'file.managed mode: keep' or 'file.recurse file_mode: keep'.

copy-dom0.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:dom0') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-dom0-home":
@@ -25,3 +32,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - user: root
     - group: root
     - makedirs: True
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-git.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:git') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-git-home":
@@ -65,3 +72,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - mode: '0755'
     - recurse:
       - mode
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-gtk.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:gtk') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-gtk-home":
@@ -23,3 +30,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - dir_mode: '0700'
     - user: root
     - group: root
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-mutt.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:mutt') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-mutt-home":
@@ -25,3 +32,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - user: root
     - group: root
     - makedirs: True
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-net.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:net') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-net-home":
@@ -27,3 +34,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - group: root
     - keep_symlinks: True
     - force_symlinks: True
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-pgp.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:pgp') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-pgp-home":
@@ -23,3 +30,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - dir_mode: '0700'
     - user: root
     - group: root
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-sh.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:sh') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-sh-home":
@@ -43,3 +50,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - dir_mode: '0755'
     - recurse:
       - mode
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-ssh.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:ssh') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-ssh-home":
@@ -24,3 +31,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - dir_mode: '0700'
     - user: root
     - group: root
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-tmux.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:tmux') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-tmux-home":
@@ -37,3 +44,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - mode: '0755'
     - recurse:
       - mode
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}

copy-vim.sls

@@ -1,9 +1,16 @@
 {#
 SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <[email protected]>
+SPDX-FileCopyrightText: 2024 seven-beep <[email protected]>
 
 SPDX-License-Identifier: AGPL-3.0-or-later
 #}
 
+{%- if (
+         salt['pillar.get']('qusal:dotfiles:all', default=true) == true
+         or salt['pillar.get']('qusal:dotfiles:vim') == true
+       )
+-%}
+
 {%- import "dom0/gui-user.jinja" as gui_user -%}
 
 "{{ slsdotpath }}-copy-vim-home":
@@ -23,3 +30,10 @@ SPDX-License-Identifier: AGPL-3.0-or-later
     - dir_mode: '0700'
     - user: root
     - group: root
+
+{%- else -%}
+
+"{{ sls }}-is-deactivated":
+  test.nop
+
+{%- endif %}