Release 3.2.0

Author: TheLocehiliosan

CHANGES

@@ -1,3 +1,10 @@
+3.2.0
+  * Support architecture for alternates/templates (#202, #203, #393)
+  * Support distro_family for alternates/templates (#213)
+  * Support setting multiple classes (#185, #304)
+  * Support environment variables in default template processor (#347)
+  * Update version command to include Bash & Git versions (#377)
+
 3.1.1
   * Fix clone support for older versions of Git (#348)
   * Fix support for multiple GPG recipients (#342)

CONTRIBUTORS

@@ -11,28 +11,35 @@ Tin Lai
 Espen Henriksen
 Cameron Eagans
 Klas Mellbourn
+James Clark
 Tomas Cernaj
 jonasc
 Chad Wade Day, Jr
 Sébastien Gross
 David Mandelberg
+Paulo Köch
+Oren Zipori
 Daniel Gray
 Paraplegic Racehorse
 japm48
 Siôn Le Roux
 Mateusz Piotrowski
 Uroš Golja
 Satoshi Ohki
+Nicolas stig124 FORMICHELLA
+Jonas
 Franciszek Madej
 Daniel Wagenknecht
 Stig Palmquist
 Patrick Hof
 con-f-use
+Samisafool
 Bram Ceulemans
 Travis A. Everett
 Sheng Yang
 Jared Smartt
 Adam Jimerson
+dessert1
 addshore
 Tim Condit
 Thomas Luzat

Makefile

@@ -1,5 +1,5 @@
 PYTESTS = $(wildcard test/test_*.py)
-IMAGE = yadm/testbed:2020-12-29
+IMAGE = yadm/testbed:2022-01-07
 
 .PHONY: all
 all:
@@ -192,9 +192,9 @@ install:
 	@[ -n "$(PREFIX)" ] || { echo "PREFIX is not set"; exit 1; }
 	@{\
 		set -e                                               ;\
-		bin="$(PREFIX)/bin"                                  ;\
-		doc="$(PREFIX)/share/doc/yadm"                       ;\
-		man="$(PREFIX)/share/man/man1"                       ;\
+		bin="$(DESTDIR)$(PREFIX)/bin"                        ;\
+		doc="$(DESTDIR)$(PREFIX)/share/doc/yadm"             ;\
+		man="$(DESTDIR)$(PREFIX)/share/man/man1"             ;\
 		install -d "$$bin" "$$doc" "$$man"                   ;\
 		install -m 0755 yadm "$$bin"                         ;\
 		install -m 0644 yadm.1 "$$man"                       ;\

README.md

@@ -3,7 +3,7 @@
 [![Latest Version][releases-badge]][releases-link]
 [![Homebrew Version][homebrew-badge]][homebrew-link]
 [![OBS Version][obs-badge]][obs-link]
-[![Arch Version][aur-badge]][aur-link]
+[![Arch Version][arch-badge]][arch-link]
 [![License][license-badge]][license-link]<br />
 [![Master Update][master-date]][master-commits]
 [![Develop Update][develop-date]][develop-commits]
@@ -56,8 +56,8 @@ The star count helps others discover yadm.
 [Git]: https://git-scm.com/
 [GnuPG]: https://gnupg.org/
 [OpenSSL]: https://www.openssl.org/
-[aur-badge]: https://img.shields.io/aur/version/yadm.svg
-[aur-link]: https://aur.archlinux.org/packages/yadm
+[arch-badge]: https://img.shields.io/archlinux/v/community/any/yadm
+[arch-link]: https://archlinux.org/packages/community/any/yadm/
 [dev-pages-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Test%20Site/dev-pages?label=dev-pages
 [develop-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/develop?label=develop
 [develop-commits]: https://github.com/TheLocehiliosan/yadm/commits/develop
@@ -72,7 +72,7 @@ The star count helps others discover yadm.
 [master-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/master?label=master
 [master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
 [master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
-[obs-badge]: https://img.shields.io/badge/OBS-v3.1.1-blue
+[obs-badge]: https://img.shields.io/badge/OBS-v3.2.0-blue
 [obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
 [releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
 [releases-link]: https://github.com/TheLocehiliosan/yadm/releases

pylintrc

@@ -8,7 +8,7 @@ max-attributes=8
 max-statements=65
 
 [SIMILARITIES]
-min-similarity-lines=6
+min-similarity-lines=8
 
 [MESSAGES CONTROL]
 disable=redefined-outer-name

test/Dockerfile

@@ -2,8 +2,8 @@ FROM ubuntu:18.04
 MAINTAINER Tim Byrne <[email protected]>
 
 # Shellcheck and esh versions
-ARG SC_VER=0.7.1
-ARG ESH_VER=0.3.0
+ARG SC_VER=0.8.0
+ARG ESH_VER=0.3.1
 
 # Install prerequisites and configure UTF-8 locale
 RUN \

test/conftest.py

@@ -25,7 +25,7 @@ def pytest_addoption(parser):
 @pytest.fixture(scope='session')
 def shellcheck_version():
     """Version of shellcheck supported"""
-    return '0.7.1'
+    return '0.8.0'
 
 
 @pytest.fixture(scope='session')
@@ -68,12 +68,29 @@ def tst_distro(runner):
     return distro
 
 
+@pytest.fixture(scope='session')
+def tst_distro_family(runner):
+    """Test session's distro_family"""
+    family = ''
+    with contextlib.suppress(Exception):
+        run = runner(command=[
+            'grep', '-oP', r'ID_LIKE=\K.+', '/etc/os-release'], report=False)
+        family = run.out.strip()
+    return family
+
+
 @pytest.fixture(scope='session')
 def tst_sys():
     """Test session's uname value"""
     return platform.system()
 
 
+@pytest.fixture(scope='session')
+def tst_arch():
+    """Test session's uname value"""
+    return platform.machine()
+
+
 @pytest.fixture(scope='session')
 def supported_commands():
     """List of supported commands
@@ -109,6 +126,7 @@ def supported_configs():
     This list should be updated every time yadm learns a new config.
     """
     return [
+        'local.arch',
         'local.class',
         'local.hostname',
         'local.os',

test/test_alt.py

@@ -82,25 +82,32 @@ def test_relative_link(runner, paths, yadm_alt):
 @pytest.mark.parametrize('suffix', [
     '##default',
     '##default,e.txt', '##default,extension.txt',
+    '##a.$tst_arch', '##arch.$tst_arch',
     '##o.$tst_sys', '##os.$tst_sys',
     '##d.$tst_distro', '##distro.$tst_distro',
+    '##f.$tst_distro_family', '##distro_family.$tst_distro_family',
     '##c.$tst_class', '##class.$tst_class',
     '##h.$tst_host', '##hostname.$tst_host',
     '##u.$tst_user', '##user.$tst_user',
     ])
 def test_alt_conditions(
         runner, paths,
-        tst_sys, tst_distro, tst_host, tst_user, suffix):
+        tst_arch, tst_sys, tst_distro, tst_distro_family, tst_host, tst_user,
+        suffix):
     """Test conditions supported by yadm alt"""
     yadm_dir, yadm_data = setup_standard_yadm_dir(paths)
 
     # set the class
     tst_class = 'testclass'
-    utils.set_local(paths, 'class', tst_class)
+    utils.set_local(paths, 'class', tst_class + ".before")
+    utils.set_local(paths, 'class', tst_class, add=True)
+    utils.set_local(paths, 'class', tst_class + ".after", add=True)
 
     suffix = string.Template(suffix).substitute(
+        tst_arch=tst_arch,
         tst_sys=tst_sys,
         tst_distro=tst_distro,
+        tst_distro_family=tst_distro_family,
         tst_class=tst_class,
         tst_host=tst_host,
         tst_user=tst_user,

test/test_unit_query_distro_family.py

@@ -0,0 +1,26 @@
+"""Unit tests: query_distro_family"""
+import pytest
+
+
+@pytest.mark.parametrize(
+    'condition', ['os-release', 'os-release-quotes', 'missing'])
+def test_query_distro_family(runner, yadm, tmp_path, condition):
+    """Match ID_LIKE when present"""
+    test_family = 'testfamily'
+    os_release = tmp_path.joinpath('os-release')
+    if 'os-release' in condition:
+        quotes = '"' if 'quotes' in condition else ''
+        os_release.write_text(
+            f"testing\nID_LIKE={quotes}{test_family}{quotes}\nfamily")
+    script = f"""
+        YADM_TEST=1 source {yadm}
+        OS_RELEASE="{os_release}"
+        query_distro_family
+    """
+    run = runner(command=['bash'], inp=script)
+    assert run.success
+    assert run.err == ''
+    if 'os-release' in condition:
+        assert run.out.rstrip() == test_family
+    else:
+        assert run.out.rstrip() == ''

test/test_unit_score_file.py

@@ -6,25 +6,33 @@
         'labels': ['default'],
         'modifier': 0,
         },
+    'arch': {
+        'labels': ['a', 'arch'],
+        'modifier': 1,
+        },
     'system': {
         'labels': ['o', 'os'],
-        'modifier': 1,
+        'modifier': 2,
         },
     'distro': {
         'labels': ['d', 'distro'],
-        'modifier': 2,
+        'modifier': 4,
+        },
+    'distro_family': {
+        'labels': ['f', 'distro_family'],
+        'modifier': 8,
         },
     'class': {
         'labels': ['c', 'class'],
-        'modifier': 4,
+        'modifier': 16,
         },
     'hostname': {
         'labels': ['h', 'hostname'],
-        'modifier': 8,
+        'modifier': 32,
         },
     'user': {
         'labels': ['u', 'user'],
-        'modifier': 16,
+        'modifier': 64,
         },
     }
 TEMPLATE_LABELS = ['t', 'template', 'yadm']
@@ -44,6 +52,12 @@ def calculate_score(filename):
             label, value = condition.split('.', 1)
         if label in CONDITION['default']['labels']:
             score += 1000
+        elif label in CONDITION['arch']['labels']:
+            if value == 'testarch':
+                score += 1000 + CONDITION['arch']['modifier']
+            else:
+                score = 0
+                break
         elif label in CONDITION['system']['labels']:
             if value == 'testsystem':
                 score += 1000 + CONDITION['system']['modifier']
@@ -82,6 +96,8 @@ def calculate_score(filename):
 
 @pytest.mark.parametrize(
     'default', ['default', None], ids=['default', 'no-default'])
+@pytest.mark.parametrize(
+    'arch', ['arch', None], ids=['arch', 'no-arch'])
 @pytest.mark.parametrize(
     'system', ['system', None], ids=['system', 'no-system'])
 @pytest.mark.parametrize(
@@ -93,10 +109,11 @@ def calculate_score(filename):
 @pytest.mark.parametrize(
     'user', ['user', None], ids=['user', 'no-user'])
 def test_score_values(
-        runner, yadm, default, system, distro, cla, host, user):
+        runner, yadm, default, arch, system, distro, cla, host, user):
     """Test score results"""
     # pylint: disable=too-many-branches
     local_class = 'testclass'
+    local_arch = 'testarch'
     local_system = 'testsystem'
     local_distro = 'testdistro'
     local_host = 'testhost'
@@ -111,6 +128,18 @@ def test_score_values(
                     newfile += ','
                 newfile += label
                 filenames[newfile] = calculate_score(newfile)
+    if arch:
+        for filename in list(filenames):
+            for match in [True, False]:
+                for label in CONDITION[arch]['labels']:
+                    newfile = filename
+                    if not newfile.endswith('##'):
+                        newfile += ','
+                    newfile += '.'.join([
+                        label,
+                        local_arch if match else 'badarch'
+                        ])
+                    filenames[newfile] = calculate_score(newfile)
     if system:
         for filename in list(filenames):
             for match in [True, False]:
@@ -176,6 +205,8 @@ def test_score_values(
         YADM_TEST=1 source {yadm}
         score=0
         local_class={local_class}
+        local_classes=({local_class})
+        local_arch={local_arch}
         local_system={local_system}
         local_distro={local_distro}
         local_host={local_host}
@@ -221,6 +252,7 @@ def test_extensions(runner, yadm, ext):
 def test_score_values_templates(runner, yadm):
     """Test score results"""
     local_class = 'testclass'
+    local_arch = 'arch'
     local_system = 'testsystem'
     local_distro = 'testdistro'
     local_host = 'testhost'
@@ -239,6 +271,7 @@ def test_score_values_templates(runner, yadm):
         YADM_TEST=1 source {yadm}
         score=0
         local_class={local_class}
+        local_arch={local_arch}
         local_system={local_system}
         local_distro={local_distro}
         local_host={local_host}