From 7216a8fc8f6acbc6608844c194c7c962663b6226 Mon Sep 17 00:00:00 2001
From: John Estabrook <jestabro@vyos.io>
Date: Thu, 10 Nov 2022 12:00:45 -0600
Subject: migration: T4808: print configtree operations during migration

Print configtree operations to stdout during migration; the migrator
will log the output.
---
 python/vyos/configtree.py | 20 +++++++++++++++++++-
 python/vyos/migrator.py   |  1 +
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/python/vyos/configtree.py b/python/vyos/configtree.py
index e9cdb69e4..b88615513 100644
--- a/python/vyos/configtree.py
+++ b/python/vyos/configtree.py
@@ -1,5 +1,5 @@
 # configtree -- a standalone VyOS config file manipulation library (Python bindings)
-# Copyright (C) 2018 VyOS maintainers and contributors
+# Copyright (C) 2018-2022 VyOS maintainers and contributors
 #
 # This library is free software; you can redistribute it and/or modify it under the terms of
 # the GNU Lesser General Public License as published by the Free Software Foundation;
@@ -12,6 +12,7 @@
 # You should have received a copy of the GNU Lesser General Public License along with this library;
 # if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
+import os
 import re
 import json
 
@@ -147,6 +148,8 @@ class ConfigTree(object):
             self.__config = address
             self.__version = ''
 
+        self.__migration = os.environ.get('VYOS_MIGRATION')
+
     def __del__(self):
         if self.__config is not None:
             self.__destroy(self.__config)
@@ -191,18 +194,27 @@ class ConfigTree(object):
             else:
                 self.__set_add_value(self.__config, path_str, str(value).encode())
 
+        if self.__migration:
+            print(f"- op: set path: {path} value: {value} replace: {replace}")
+
     def delete(self, path):
         check_path(path)
         path_str = " ".join(map(str, path)).encode()
 
         self.__delete(self.__config, path_str)
 
+        if self.__migration:
+            print(f"- op: delete path: {path}")
+
     def delete_value(self, path, value):
         check_path(path)
         path_str = " ".join(map(str, path)).encode()
 
         self.__delete_value(self.__config, path_str, value.encode())
 
+        if self.__migration:
+            print(f"- op: delete_value path: {path} value: {value}")
+
     def rename(self, path, new_name):
         check_path(path)
         path_str = " ".join(map(str, path)).encode()
@@ -216,6 +228,9 @@ class ConfigTree(object):
         if (res != 0):
             raise ConfigTreeError("Path [{}] doesn't exist".format(path))
 
+        if self.__migration:
+            print(f"- op: rename old_path: {path} new_path: {new_path}")
+
     def copy(self, old_path, new_path):
         check_path(old_path)
         check_path(new_path)
@@ -229,6 +244,9 @@ class ConfigTree(object):
         if (res != 0):
             raise ConfigTreeError("Path [{}] doesn't exist".format(old_path))
 
+        if self.__migration:
+            print(f"- op: copy old_path: {old_path} new_path: {new_path}")
+
     def exists(self, path):
         check_path(path)
         path_str = " ".join(map(str, path)).encode()
diff --git a/python/vyos/migrator.py b/python/vyos/migrator.py
index 1e1172778..87c74e1ea 100644
--- a/python/vyos/migrator.py
+++ b/python/vyos/migrator.py
@@ -137,6 +137,7 @@ class Migrator(object):
                 cfg_ver = next_ver
             rev_versions[key] = cfg_ver
 
+        del os.environ['VYOS_MIGRATION']
         return rev_versions
 
     def write_config_file_versions(self, cfg_versions):
-- 
cgit v1.2.3