SW-1014 added migration step (mrbeam#1576)

* changed logrotate files
* added migration 003
* add test for migration 003

Author: JFSolution

octoprint_mrbeam/files/migrate_logrotate/analytics

@@ -3,9 +3,11 @@
 
 /home/pi/.octoprint/analytics/analytics_log.json {
     size 100M
-    rotate 2
+    rotate 3
     compress
     delaycompress
     missingok
     notifempty
+    dateext
+    dateformat .%Y-%m-%d
 }

octoprint_mrbeam/files/migrate_logrotate/iobeam

@@ -1,9 +1,11 @@
 /var/log/iobeam.log {
     size 2M
-    rotate 4
+    rotate 3
     compress
     delaycompress
     missingok
     notifempty
     copytruncate
+    dateext
+    dateformat .%Y-%m-%d
 }

octoprint_mrbeam/files/migrate_logrotate/mount_manager

@@ -1,10 +1,12 @@
 /var/log/mount_manager.log {
     size 2M
-    rotate 2
+    rotate 3
     compress
     delaycompress
     missingok
     notifempty
     copytruncate
     create 644 root root
+    dateext
+    dateformat .%Y-%m-%d
 }

octoprint_mrbeam/files/migrate_logrotate/mrb_check

@@ -1,10 +1,12 @@
 /var/log/mrb_check.log {
     size 5M
-    rotate 4
+    rotate 3
     compress
     delaycompress
     missingok
     notifempty
     copytruncate
     create 644 root root
+    dateext
+    dateformat .%Y-%m-%d
 }

octoprint_mrbeam/files/migrate_logrotate/mrbeam_ledstrips

@@ -1,10 +1,12 @@
 /var/log/mrbeam_ledstrips.log {
     size 2M
-    rotate 2
+    rotate 3
     compress
     delaycompress
     missingok
     notifempty
     copytruncate
     create 644 root root
+    dateext
+    dateformat .%Y-%m-%d
 }

octoprint_mrbeam/files/migrate_logrotate/netconnectd

@@ -1,9 +1,11 @@
 /var/log/netconnectd.log {
     size 2M
-    rotate 2
+    rotate 3
     compress
     delaycompress
     missingok
     notifempty
     copytruncate
+    dateext
+    dateformat .%Y-%m-%d
 }

octoprint_mrbeam/migration/Mig003.py

@@ -0,0 +1,51 @@
+import os
+
+from octoprint_mrbeam.migration.migration_base import (
+    MigrationBaseClass,
+)
+
+
+class Mig003EnableLogrotateBuster(MigrationBaseClass):
+    """
+    This migration should add logrotate for the buster image and change the lorotate for the legacy image
+    """
+
+    MIGRATE_LOGROTATE_FOLDER = "files/migrate_logrotate/"
+    BEAMOS_VERSION_LOW = "0.14.0"
+    BEAMOS_VERSION_HIGH = "0.18.2"
+
+    def __init__(self, plugin):
+        super(Mig003EnableLogrotateBuster, self).__init__(plugin)
+
+    @property
+    def id(self):
+        return "003"
+
+    def _run(self):
+        self._logger.debug("delete wrong iobeam logrotate")
+        self.exec_cmd("sudo rm /etc/logrotate.d/iobeam.logrotate", optional=True)
+
+        logrotates = [
+            "analytics",
+            "iobeam",
+            "mount_manager",
+            "mrb_check",
+            "mrbeam_ledstrips",
+        ]
+        for logrotate in logrotates:
+            self._logger.debug("enable logrotate of " + logrotate)
+            src = os.path.join(
+                __package_path__, self.MIGRATE_LOGROTATE_FOLDER, logrotate
+            )
+            dst = os.path.join("/etc/logrotate.d/" + logrotate)
+            self.exec_cmd("sudo cp {src} {dst}".format(src=src, dst=dst))
+
+        self._logger.debug(
+            "restarting logrotate in order for the changed config to take effect"
+        )
+        self.exec_cmd("sudo logrotate /etc/logrotate.conf")
+        super(Mig003EnableLogrotateBuster, self)._run()
+
+    def _rollback(self):
+        # no rollback needed
+        super(Mig003EnableLogrotateBuster, self)._rollback()

octoprint_mrbeam/migration/__init__.py

@@ -23,9 +23,11 @@
 # this is for internal use
 from octoprint_mrbeam.migration.Mig001 import Mig001NetconnectdDisableLogDebugLevel
 from octoprint_mrbeam.migration.Mig002 import Mig002EnableOnlineCheck
+from octoprint_mrbeam.migration.Mig003 import Mig003EnableLogrotateBuster
 
 # To add migrations they have to be added to this list till we automate it
 list_of_migrations = [
     Mig001NetconnectdDisableLogDebugLevel,
     Mig002EnableOnlineCheck,
+    Mig003EnableLogrotateBuster,
 ]

octoprint_mrbeam/migration/migration_base.py

@@ -201,7 +201,7 @@ def state(self):
         """
         return self._state
 
-    def exec_cmd(self, command):
+    def exec_cmd(self, command, optional=False):
         """
         wrapper of exec_cmd to change to errorstate in case of a error
         Args:
@@ -210,9 +210,14 @@ def exec_cmd(self, command):
         Returns:
             None
         Raises:
-            MigrationException: if the execution of the command ended with a errorcode different to 0
+            MigrationException: if the execution of the command was not successful
         """
-        if not exec_cmd(command):
+        command_success = exec_cmd(command)
+        if command_success:
+            return
+        if optional and not command_success:
+            self._logger.warn("optional command failed - cmd: {}".format(command))
+        else:
             raise MigrationException("error during migration for cmd:", command)
 
     @staticmethod

tests/migrations/test-migration-Mig003.py

@@ -0,0 +1,29 @@
+from octoprint_mrbeam.migration import Mig003EnableLogrotateBuster
+import unittest
+
+
+class TestMigrationMig003(unittest.TestCase):
+    """
+    Testclass for the migration Mig001
+    """
+
+    def setUp(self):
+        self.m003 = Mig003EnableLogrotateBuster(None)
+
+    def test_beamos_versions(self):
+        # beamos versions where the migration should not run
+        self.assertFalse(self.m003.shouldrun(Mig003EnableLogrotateBuster, "0.19.0"))
+
+        # beamos versions where the migration should run
+        self.assertTrue(self.m003.shouldrun(Mig003EnableLogrotateBuster, "0.14.0"))
+        self.assertTrue(self.m003.shouldrun(Mig003EnableLogrotateBuster, "0.18.0"))
+        self.assertTrue(self.m003.shouldrun(Mig003EnableLogrotateBuster, "0.18.1"))
+        self.assertTrue(self.m003.shouldrun(Mig003EnableLogrotateBuster, "0.18.2"))
+
+        # not matching pattern strings
+        self.assertFalse(self.m003.shouldrun(Mig003EnableLogrotateBuster, None))
+        self.assertFalse(self.m003.shouldrun(Mig003EnableLogrotateBuster, "14.0"))
+        self.assertFalse(self.m003.shouldrun(Mig003EnableLogrotateBuster, "0"))
+
+    def test_migration_id(self):
+        self.assertEqual(self.m003.id, "003")