Merge pull request #1521 from sever-sever/T3476

update-check: T3476: Allow update-check for VyOS images

4 files changed, 266 insertions, 0 deletions

diff --git a/src/conf_mode/system_update_check.py b/src/conf_mode/system_update_check.py
new file mode 100755
index 000000000..08ecfcb81
--- /dev/null
+++ b/src/conf_mode/system_update_check.py
@@ -0,0 +1,93 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2022 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import json
+import jmespath
+
+from pathlib import Path
+from sys import exit
+
+from vyos.config import Config
+from vyos.util import call
+from vyos import ConfigError
+from vyos import airbag
+airbag.enable()
+
+
+base = ['system', 'update-check']
+service_name = 'vyos-system-update'
+service_conf = Path(f'/run/{service_name}.conf')
+motd_file = Path('/run/motd.d/10-vyos-update')
+
+
+def get_config(config=None):
+    if config:
+        conf = config
+    else:
+        conf = Config()
+
+    if not conf.exists(base):
+        return None
+
+    config = conf.get_config_dict(base, key_mangling=('-', '_'),
+                                  get_first_key=True, no_tag_node_value_mangle=True)
+
+    return config
+
+
+def verify(config):
+    # bail out early - looks like removal from running config
+    if config is None:
+        return
+
+    if 'url' not in config:
+        raise ConfigError('URL is required!')
+
+
+def generate(config):
+    # bail out early - looks like removal from running config
+    if config is None:
+        # Remove old config and return
+        service_conf.unlink(missing_ok=True)
+        # MOTD used in /run/motd.d/10-update
+        motd_file.unlink(missing_ok=True)
+        return None
+
+    # Write configuration file
+    conf_json = json.dumps(config, indent=4)
+    service_conf.write_text(conf_json)
+
+    return None
+
+
+def apply(config):
+    if config:
+        if 'auto_check' in config:
+            call(f'systemctl restart {service_name}.service')
+    else:
+        call(f'systemctl stop {service_name}.service')
+
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)
diff --git a/src/op_mode/system.py b/src/op_mode/system.py
new file mode 100755
index 000000000..11a3a8730
--- /dev/null
+++ b/src/op_mode/system.py
@@ -0,0 +1,92 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2022 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import jmespath
+import json
+import sys
+import requests
+import typing
+
+from sys import exit
+
+from vyos.configquery import ConfigTreeQuery
+
+import vyos.opmode
+import vyos.version
+
+config = ConfigTreeQuery()
+base = ['system', 'update-check']
+
+
+def _compare_version_raw():
+    url = config.value(base + ['url'])
+    local_data = vyos.version.get_full_version_data()
+    remote_data = vyos.version.get_remote_version(url)
+    if not remote_data:
+        return {"error": True,
+                "reason": "Unable to get remote version"}
+    if local_data.get('version') and remote_data:
+        local_version = local_data.get('version')
+        remote_version = jmespath.search('[0].version', remote_data)
+        image_url = jmespath.search('[0].url', remote_data)
+        if local_data.get('version') != remote_version:
+            return {"error": False,
+                    "update_available": True,
+                    "local_version": local_version,
+                    "remote_version": remote_version,
+                    "url": image_url}
+        return {"update_available": False,
+                "local_version": local_version,
+                "remote_version": remote_version}
+
+
+def _formatted_compare_version(data):
+    local_version = data.get('local_version')
+    remote_version = data.get('remote_version')
+    url = data.get('url')
+    if {'update_available','local_version', 'remote_version', 'url'} <= set(data):
+        return f'Current version: {local_version}\n\nUpdate available: {remote_version}\nUpdate URL: {url}'
+    elif local_version == remote_version and remote_version is not None:
+        return f'No available updates for your system \n' \
+               f'current version: {local_version}\nremote version: {remote_version}'
+    else:
+        return 'Update not found'
+
+
+def _verify():
+    if not config.exists(base):
+        return False
+    return True
+
+
+def show_update(raw: bool):
+    if not _verify():
+        raise vyos.opmode.UnconfiguredSubsystem("system update-check not configured")
+    data = _compare_version_raw()
+    if raw:
+        return data
+    else:
+        return _formatted_compare_version(data)
+
+
+if __name__ == '__main__':
+    try:
+        res = vyos.opmode.run(sys.modules[__name__])
+        if res:
+            print(res)
+    except (ValueError, vyos.opmode.Error) as e:
+        print(e)
+        sys.exit(1)
diff --git a/src/system/vyos-system-update-check.py b/src/system/vyos-system-update-check.py
new file mode 100755
index 000000000..c9597721b
--- /dev/null
+++ b/src/system/vyos-system-update-check.py
@@ -0,0 +1,70 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2022 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import argparse
+import json
+import jmespath
+
+from pathlib import Path
+from sys import exit
+from time import sleep
+
+from vyos.util import call
+
+import vyos.version
+
+motd_file = Path('/run/motd.d/10-vyos-update')
+
+
+if __name__ == '__main__':
+    # Parse command arguments and get config
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-c',
+                        '--config',
+                        action='store',
+                        help='Path to system-update-check configuration',
+                        required=True,
+                        type=Path)
+
+    args = parser.parse_args()
+    try:
+        config_path = Path(args.config)
+        config = json.loads(config_path.read_text())
+    except Exception as err:
+        print(
+            f'Configuration file "{config_path}" does not exist or malformed: {err}'
+        )
+        exit(1)
+
+    url_json = config.get('url')
+    local_data = vyos.version.get_full_version_data()
+    local_version = local_data.get('version')
+
+    while True:
+        remote_data = vyos.version.get_remote_version(url_json)
+        if remote_data:
+            url = jmespath.search('[0].url', remote_data)
+            remote_version = jmespath.search('[0].version', remote_data)
+            if local_version != remote_version and remote_version:
+                call(f'wall -n "Update available: {remote_version} \nUpdate URL: {url}"')
+                # MOTD used in /run/motd.d/10-update
+                motd_file.parent.mkdir(exist_ok=True)
+                motd_file.write_text(f'---\n'
+                                     f'Current version: {local_version}\n'
+                                     f'Update available: \033[1;34m{remote_version}\033[0m\n'
+                                     f'---\n')
+        # Check every 12 hours
+        sleep(43200)
diff --git a/src/systemd/vyos-system-update.service b/src/systemd/vyos-system-update.service
new file mode 100644
index 000000000..032e5a14c
--- /dev/null
+++ b/src/systemd/vyos-system-update.service
@@ -0,0 +1,11 @@
+[Unit]
+Description=VyOS system udpate-check service
+After=network.target vyos-router.service
+
+[Service]
+Type=simple
+Restart=always
+ExecStart=/usr/bin/python3 /usr/libexec/vyos/system/vyos-system-update-check.py --config /run/vyos-system-update.conf
+
+[Install]
+WantedBy=multi-user.target