Merge PR #1047

Fix context issue in bareos-dir python plugin
bareos · Feb 18, 2022 · a2cf56b · a2cf56b
2 parents 74b9bc4 + c3557d0
commit a2cf56b
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@ and since Bareos version 20 this project adheres to [Semantic Versioning](https:
 - sql_get.cc: fix error logging in GetJobRecord() for jobname #1042
 - webui: fix empty job timeline issue if date.timezone is not set in php.ini [PR #1051]
 - Fix for wrong update message when updating all volumes from all pools with no existing volumes [PR #1015]
+- Fix context confusion in Director's Python plugins [PR #1047]
 
 ### Added
 - Python plugins: add default module_path to search path [PR #1038]
@@ -58,6 +59,7 @@ and since Bareos version 20 this project adheres to [Semantic Versioning](https:
 [PR #1041]: https://github.com/bareos/bareos/pull/1041
 [PR #1043]: https://github.com/bareos/bareos/pull/1043
 [PR #1046]: https://github.com/bareos/bareos/pull/1046
+[PR #1047]: https://github.com/bareos/bareos/pull/1047
 [PR #1048]: https://github.com/bareos/bareos/pull/1048
 [PR #1050]: https://github.com/bareos/bareos/pull/1050
 [PR #1051]: https://github.com/bareos/bareos/pull/1051

diff --git a/core/src/plugins/dird/python/module/bareosdir.h b/core/src/plugins/dird/python/module/bareosdir.h
@@ -86,7 +86,7 @@ static bRC PyHandlePluginEvent(PluginContext* plugin_ctx,
 using namespace directordaemon;
 
 /* variables storing bareos pointers */
-PluginContext* plugin_context = NULL;
+thread_local PluginContext* plugin_context = NULL;
 
 MOD_INIT(bareosdir)
 {

diff --git a/core/src/plugins/dird/python/python-dir.cc b/core/src/plugins/dird/python/python-dir.cc
@@ -136,6 +136,7 @@ static bRC getPluginValue(PluginContext* bareos_plugin_ctx,
   bRC retval = bRC_Error;
 
   if (!plugin_priv_ctx) { goto bail_out; }
+  Bareosdir_set_plugin_context(bareos_plugin_ctx);
 
   PyEval_AcquireThread(plugin_priv_ctx->interpreter);
   retval = Bareosdir_PyGetPluginValue(bareos_plugin_ctx, var, value);
@@ -155,6 +156,7 @@ static bRC setPluginValue(PluginContext* bareos_plugin_ctx,
   bRC retval = bRC_Error;
 
   if (!plugin_priv_ctx) { return bRC_Error; }
+  Bareosdir_set_plugin_context(bareos_plugin_ctx);
 
   PyEval_AcquireThread(plugin_priv_ctx->interpreter);
   retval = Bareosdir_PySetPluginValue(bareos_plugin_ctx, var, value);
@@ -303,6 +305,8 @@ static bRC handlePluginEvent(PluginContext* plugin_ctx,
 
   if (!plugin_priv_ctx) { goto bail_out; }
 
+  Bareosdir_set_plugin_context(plugin_ctx);
+
   /*
    * First handle some events internally before calling python if it
    * want to do some special handling on the event triggered.

diff --git a/systemtests/tests/py2plug-dir/etc/bareos/bareos-dir.d/client/bareos-fd.conf.in b/systemtests/tests/py2plug-dir/etc/bareos/bareos-dir.d/client/bareos-fd.conf.in
@@ -4,4 +4,5 @@ Client {
   Address = @hostname@
   Password = "@fd_password@"          # password for FileDaemon
   FD PORT = @fd_port@
+  Maximum Concurrent Jobs = 10
 }
diff --git a/systemtests/tests/py2plug-dir/etc/bareos/bareos-dir.d/job/backup-bareos-fd.conf.in b/systemtests/tests/py2plug-dir/etc/bareos/bareos-dir.d/job/backup-bareos-fd.conf.in
@@ -1,6 +1,23 @@
 Job {
-  Name = "backup-bareos-fd"
-  DIR Plugin Options ="@python_module_name@:module_path=@python_plugin_module_src_test_dir@:module_name=bareos-dir-test:output=@tmp@/test-plugin.log"
+  Name = "backup-bareos-fd1"
+  DIR Plugin Options ="@python_module_name@:module_path=@python_plugin_module_src_test_dir@:module_name=bareos-dir-test:output=@tmp@/test-plugin1.log"
+  JobDefs = "DefaultJob"
+}
+
+Job {
+  Name = "backup-bareos-fd2"
+  DIR Plugin Options ="@python_module_name@:module_path=@python_plugin_module_src_test_dir@:module_name=bareos-dir-test:output=@tmp@/test-plugin2.log"
+  JobDefs = "DefaultJob"
+}
+
+Job {
+  Name = "backup-bareos-fd3"
+  DIR Plugin Options ="@python_module_name@:module_path=@python_plugin_module_src_test_dir@:module_name=bareos-dir-test:output=@tmp@/test-plugin3.log"
+  JobDefs = "DefaultJob"
+}
+
+Job {
+  Name = "backup-bareos-fd4"
+  DIR Plugin Options ="@python_module_name@:module_path=@python_plugin_module_src_test_dir@:module_name=bareos-dir-test:output=@tmp@/test-plugin4.log"
   JobDefs = "DefaultJob"
-  Client = "bareos-fd"
 }
diff --git a/systemtests/tests/py2plug-dir/etc/bareos/bareos-dir.d/storage/File.conf.in b/systemtests/tests/py2plug-dir/etc/bareos/bareos-dir.d/storage/File.conf.in
@@ -5,4 +5,5 @@ Storage {
   Device = FileStorage
   Media Type = File
   SD Port = @sd_port@
+  Maximum Concurrent Jobs = 10
 }
diff --git a/systemtests/tests/py2plug-dir/etc/bareos/bareos-sd.d/device/FileStorage.conf b/systemtests/tests/py2plug-dir/etc/bareos/bareos-sd.d/device/FileStorage.conf
@@ -1,5 +1,12 @@
-Device {
+Autochanger {
   Name = FileStorage
+  Device = FileStorageDev
+  Changer Command = ""
+  Changer Device = /dev/null
+}
+
+Device {
+  Name = FileStorageDev
   Media Type = File
   Archive Device = storage
   LabelMedia = yes;                   # lets Bareos label unlabeled media
@@ -8,4 +15,5 @@ Device {
   RemovableMedia = no;
   AlwaysOpen = no;
   Description = "File device. A connecting Director must have the same Name and MediaType."
+  Count = 10
 }
diff --git a/systemtests/tests/py2plug-dir/python-modules/BareosDirTest.py b/systemtests/tests/py2plug-dir/python-modules/BareosDirTest.py
@@ -22,6 +22,7 @@
 import bareosdir
 import BareosDirPluginBaseclass
 
+from time import time
 from sys import version_info
 
 
@@ -52,21 +53,31 @@ def parse_plugin_definition(self, plugindef):
 
     def handle_plugin_event(self, event):
         super(BareosDirTest, self).handle_plugin_event(event)
+        job_name = repr(bareosdir.GetValue(bareosdir.bDirVarJobName))
+        job_id = repr(bareosdir.GetValue(bareosdir.bDirVarJobId))
+        microtime = round(time() * 1000)
+        msg_f = "%s Job:" + job_name + " JobId: " + job_id + " Time: " + repr(microtime) + "\n"
+
         if event == bareosdir.bDirEventJobStart:
-            self.toFile("bDirEventJobStart\n")
+            self.toFile(msg_f % "bDirEventJobStart")
 
         elif event == bareosdir.bDirEventJobEnd:
-            self.toFile("bDirEventJobEnd\n")
+            self.toFile(msg_f % "bDirEventJobEnd")
 
         elif event == bareosdir.bDirEventJobInit:
-            self.toFile("bDirEventJobInit\n")
+            self.toFile(msg_f % "bDirEventJobInit")
 
         elif event == bareosdir.bDirEventJobRun:
-            self.toFile("bDirEventJobRun\n")
+            self.toFile(msg_f % "bDirEventJobRun")
 
         return bareosdir.bRC_OK
 
     def toFile(self, text):
+        bareosdir.DebugMessage(
+            100,
+            "Writing string '%s' to '%s'\n"
+            % (text, self.outputfile),
+        )
         doc = open(self.outputfile, "a")
         doc.write(text)
         doc.close()

diff --git a/systemtests/tests/py2plug-dir/testrunner b/systemtests/tests/py2plug-dir/testrunner
@@ -16,11 +16,9 @@ set -u
 TestName="$(basename "$(pwd)")"
 export TestName
 
-JobName=backup-bareos-fd
 #shellcheck source=../environment.in
 . ./environment
 
-JobName=backup-bareos-fd
 #shellcheck source=../scripts/functions
 . "${rscripts}"/functions
 "${rscripts}"/cleanup
@@ -39,9 +37,12 @@ cat <<END_OF_DATA >$tmp/bconcmds
 @$out /dev/null
 messages
 @$out $tmp/log1.out
-setdebug level=200 dir
+setdebug level=200 trace=1 dir
 label volume=TestVolume001 storage=File pool=Full
-run job=$JobName yes
+run job=backup-bareos-fd1 yes
+run job=backup-bareos-fd2 yes
+run job=backup-bareos-fd3 yes
+run job=backup-bareos-fd4 yes
 status director
 status client
 status storage=File
@@ -55,9 +56,16 @@ check_for_zombie_jobs storage=File
 stop_bareos
 
 for i in bDirEventJobStart bDirEventJobInit bDirEventJobRun bDirEventJobEnd; do
-  if ! grep -q "$i" ${tmp}/test-plugin.log; then
+  if ! grep -q "$i" ${tmp}/test-plugin1.log; then
     set_error "Failed to find logged event $i"
   fi
 done
 
+for i in 1 2 3 4; do
+  num="$(grep -c -F "Job:'backup-bareos-fd$i." "${tmp}/test-plugin$i.log")"
+  if [ $num -ne 4 ]; then
+    set_error "Mismatched job context on plugin event in backup-bareos-fd$i"
+  fi
+done
+
 end_test