Changeset fb7e36a in nscp

Timestamp:

09/03/11 21:17:11 (21 months ago)

Author:

Michael Medin <michael@…>

Branches:

master, 0.4.0, 0.4.1, 0.4.2

Children:

a78a985

Parents:

4cac39f

Message:

• Added installer for unittests to test.py run like so: nscp --client --module PythonScript --command execute-and-load-python --script test.py
• Fixed so settings are created if not existing
• Fixed so plugins are not loaded in client mode
• Fixed so core is booting correctly in client mode
• Added new option --settings --switch <context> to allow switching context without migrating data
• Fixed unicode error on linux (settings file)

Files:

• changelog (modified) (1 diff)
• files/old-settings.map (modified) (1 diff)
• helpers/installers/installer/Product.wxs (modified) (3 diffs)
• helpers/settings_manager/settings_manager_impl.cpp (modified) (2 diffs)
• include/settings/settings_core.hpp (modified) (1 diff)
• include/settings/settings_handler_impl.hpp (modified) (1 diff)
• include/settings/settings_ini.hpp (modified) (2 diffs)
• include/simpleini/simpleini.h (modified) (2 diffs)
• modules/PythonScript/PythonScript.cpp (modified) (5 diffs)
• modules/PythonScript/PythonScript.h (modified) (1 diff)
• scripts/python/test.py (modified) (3 diffs)
• service/NSClient++.cpp (modified) (6 diffs)
• service/NSClient++.h (modified) (1 diff)
• service/cli_parser.hpp (modified) (3 diffs)
• service/settings_client.hpp (modified) (2 diffs)
• service/simple_client.hpp (modified) (1 diff)

changelog

@@ -10 +10 @@
  * Upgraded to new version of simpleinin class
  * Added new component for python protocol buffer library to installer
+ * Added installer for unittests to test.py run like so:
+   nscp --client --module PythonScript --command execute-and-load-python --script test.py
+ * Fixed so settings are created if not existing
+ * Fixed so plugins are not loaded in client mode
+ * Fixed so core is booting correctly in client mode
+ * Added new option --settings --switch <context> to allow switching context without migrating data
+ * Fixed unicode error on linux (settings file)
 
 2011-09-02 MickeM

files/old-settings.map

@@ -18 +18 @@
 modules/CheckTaskSched.dll=/modules/CheckTaskSched
 modules/Scheduler.dll=/modules/Scheduler
+
+modules=/modules
 
 # Crash section

helpers/installers/installer/Product.wxs

@@ -174 +174 @@
 
             <Directory Id="INSTALLLOCATION_SCRIPTS_PYTHON_LIB1" Name="lib">
-              <Component Id="PythonScriptsPBLib1" Guid="8820A304-C697-4393-B72F-$(var.Postfix.GUID)" Win64="$(var.Win64)">
+              <Component Id="PythonScriptsPBLib1" Guid="555165B3-5CBF-4204-A349-6AD7CCEF14EB" Win64="$(var.Win64)">
                 <File Id="p_script_lib_001" Name="__init__.py" DiskId="1" Source="$(var.Source)/scripts/python/lib/__init__.py" Vital="no" />
               </Component>
               <Directory Id="INSTALLLOCATION_SCRIPTS_PYTHON_LIB2" Name="google">
-                <Component Id="PythonScriptsPBLib2" Guid="8820A304-C697-4393-B72F-$(var.Postfix.GUID)" Win64="$(var.Win64)">
+                <Component Id="PythonScriptsPBLib2" Guid="555165B3-5CBF-4204-A349-6AD7CCEF14E1" Win64="$(var.Win64)">
                   <File Id="p_script_lib_002" Name="__init__.py" DiskId="1" Source="$(var.Source)/scripts/python/lib/google/__init__.py" Vital="no" />
                 </Component>
                 <Directory Id="INSTALLLOCATION_SCRIPTS_PYTHON_LIB3" Name="protobuf">
-                  <Component Id="PythonScriptsPBLib3" Guid="8820A304-C697-4393-B72F-$(var.Postfix.GUID)" Win64="$(var.Win64)">
+                  <Component Id="PythonScriptsPBLib3" Guid="555165B3-5CBF-4204-A349-6AD7CCEF14E2" Win64="$(var.Win64)">
                     <File Id="p_script_lib_003" Name="descriptor.py" DiskId="1" Source="$(var.Source)/scripts/python/lib/google/protobuf/descriptor.py" Vital="no" />
                     <File Id="p_script_lib_004" Name="descriptor_pb2.py" DiskId="1" Source="$(var.Source)/scripts/python/lib/google/protobuf/descriptor_pb2.py" Vital="no" />
@@ -193 +193 @@
                   </Component>
                   <Directory Id="INSTALLLOCATION_SCRIPTS_PYTHON_LIB4" Name="compiler">
-                    <Component Id="PythonScriptsPBLib4" Guid="8820A304-C697-4393-B72F-$(var.Postfix.GUID)" Win64="$(var.Win64)">
+                    <Component Id="PythonScriptsPBLib4" Guid="555165B3-5CBF-4204-A349-6AD7CCEF14E3" Win64="$(var.Win64)">
                       <File Id="p_script_lib_011" Name="plugin_pb2.py" DiskId="1" Source="$(var.Source)/scripts/python/lib/google/protobuf/compiler/plugin_pb2.py" Vital="no" />
                     </Component>
                   </Directory>
                   <Directory Id="INSTALLLOCATION_SCRIPTS_PYTHON_LIB5" Name="internal">
-                    <Component Id="PythonScriptsPBLib5" Guid="8820A304-C697-4393-B72F-$(var.Postfix.GUID)" Win64="$(var.Win64)">
+                    <Component Id="PythonScriptsPBLib5" Guid="555165B3-5CBF-4204-A349-6AD7CCEF14E4" Win64="$(var.Win64)">
                       <File Id="p_script_lib_012" Name="api_implementation.py" DiskId="1" Source="$(var.Source)/scripts/python/lib/google/protobuf/internal/api_implementation.py" Vital="no" />
                       <File Id="p_script_lib_013" Name="containers.py" DiskId="1" Source="$(var.Source)/scripts/python/lib/google/protobuf/internal/containers.py" Vital="no" />
@@ -214 +214 @@
               </Directory>
             </Directory>
-
-
           </Directory>
         </Directory>

helpers/settings_manager/settings_manager_impl.cpp

@@ -175 +175 @@
       set_instance(key);
       return;
-    } 
-
+    }
+
+    get_logger()->debug(__FILE__, __LINE__, _T("No valid settings found (tried): ") + boot_order);
+
+    std::wstring tgt = get_boot_string(_T("main"), _T("write"), _T(""));
+    if (!tgt.empty()) {
+      get_logger()->debug(__FILE__, __LINE__, _T("Creating new settings file: ") + tgt);
+      set_instance(tgt);
+      return;
+    }
     get_logger()->err(__FILE__, __LINE__, _T("No valid settings found (tried): ") + boot_order);
   }
@@ -195 +203 @@
       set_boot_string(_T("settings"), strEx::itos(i++), k);
     }
+    set_boot_string(_T("main"), _T("write"), key);
   }
 

include/settings/settings_core.hpp

@@ -230 +230 @@
     virtual void migrate_from(std::wstring from) = 0;
 
+    virtual void set_primary(std::wstring context) = 0;
+
     //////////////////////////////////////////////////////////////////////////
     /// Overwrite the (current) settings store with default values.

include/settings/settings_handler_impl.hpp

@@ -195 +195 @@
       migrate(ifrom, ito);
     }
-    virtual void set_primary(std::wstring key) = 0;
 
     //////////////////////////////////////////////////////////////////////////

include/settings/settings_ini.hpp

@@ -9 +9 @@
 #include <settings/settings_core.hpp>
 #include <settings/settings_core_impl.hpp>
+//#define SI_CONVERT_ICU
 #include <simpleini/simpleini.h>
 #include <error.hpp>
@@ -226 +227 @@
       }
       std::wstring f = get_file_name();
+      ini.SetUnicode();
       get_core()->get_logger()->debug(__FILE__, __LINE__, _T("Loading: ") + f + _T(" from ") + get_context());
       SI_Error rc = ini.LoadFile(f.c_str());

include/simpleini/simpleini.h

@@ -1333 +1333 @@
     return rc;
 #else // !_WIN32 (therefore SI_CONVERT_ICU)
-#if SI_CONVERT_ICU
+#ifdef SI_CONVERT_ICU
     char szFile[256];
     u_austrncpy(szFile, a_pwszFile, sizeof(szFile));
@@ -1689 +1689 @@
     ) const
 {
-    return (a_c == '\n' || a_c == '\r');
+    return (a_c == '\n' || a_c == '\r' || a_c == 0);
 }
 

modules/PythonScript/PythonScript.cpp

@@ -21 +21 @@
 #include "stdafx.h"
 #include "PythonScript.h"
-#include <strEx.h>
 #include <time.h>
 #include <error.hpp>
+
+#include <boost/python.hpp>
+#include <boost/program_options.hpp>
+
+#include <strEx.h>
 #include <file_helpers.hpp>
-
-#include <boost/python.hpp>
-
 #include <settings/client/settings_client.hpp>
 #include <nscapi/functions.hpp>
@@ -39 +40 @@
 
 namespace sh = nscapi::settings_helper;
+namespace po = boost::program_options;
 
 bool PythonScript::loadModule() {
@@ -102 +104 @@
 
 python_script::python_script(unsigned int plugin_id, const std::string alias, const script_container& script) : alias(alias), plugin_id(plugin_id) {
+  NSC_DEBUG_MSG_STD(_T("Loading python script: ") + script.script.string());
+  std::wcout << script.script.string() << std::endl;;
   _exec(utf8::cvt<std::string>(script.script.string()));
   callFunction("init", plugin_id, alias, utf8::cvt<std::string>(script.alias));
@@ -213 +217 @@
   NSC_LOG_ERROR(_T("Script not found: ") + file);
   return boost::optional<boost::filesystem::wpath>();
+}
+
+NSCAPI::nagiosReturn PythonScript::execute_and_load_python(std::list<std::wstring> args) {
+  try {
+    po::options_description desc;
+    boost::program_options::variables_map vm;
+    std::wstring file;
+    desc.add_options()
+      ("script", po::wvalue<std::wstring>(&file), "The script to run")
+      ("file", po::wvalue<std::wstring>(&file), "The script to run")
+      ;
+
+    std::vector<std::wstring> vargs(args.begin(), args.end());
+    po::wparsed_options parsed = po::basic_command_line_parser<wchar_t>(vargs).options(desc).run();
+    po::store(parsed, vm);
+    po::notify(vm);
+
+    boost::optional<boost::filesystem::wpath> ofile = find_file(file);
+    if (!ofile)
+      return false;
+    script_container sc(*ofile);
+    python_script script(get_id(), "", sc);
+    script.callFunction("__main__");
+  } catch (const std::exception &e) {
+    NSC_LOG_ERROR_STD(_T("Failed to execute script ") + utf8::cvt<std::wstring>(e.what()));
+  } catch (...) {
+    NSC_LOG_ERROR_STD(_T("Failed to execute script..."));
+  }
 }
 
@@ -275 +307 @@
 
 NSCAPI::nagiosReturn PythonScript::commandRAWLineExec(const wchar_t* char_command, const std::string &request, std::string &response) {
+  std::wstring command = char_command;
+  if (command == _T("execute-and-load-python")) {
+    nscapi::functions::decoded_simple_command_data data = nscapi::functions::parse_simple_exec_request(char_command, request);
+    return execute_and_load_python(data.args);
+  }
   boost::shared_ptr<script_wrapper::function_wrapper> inst = script_wrapper::function_wrapper::create(get_id());
   std::string cmd = utf8::cvt<std::string>(char_command);

modules/PythonScript/PythonScript.h

@@ -88 +88 @@
   NSCAPI::nagiosReturn handleRAWNotification(const std::wstring &channel, const std::wstring &command, std::string &request);
 
+  NSCAPI::nagiosReturn execute_and_load_python(std::list<std::wstring> args);
   //NSCAPI::nagiosReturn RunLUA(const unsigned int argLen, wchar_t **char_args, std::wstring &message, std::wstring &perf);
   //NSCAPI::nagiosReturn extract_return(Lua_State &L, int arg_count,  std::wstring &message, std::wstring &perf);

scripts/python/test.py

@@ -202 +202 @@
     return (status.CRITICAL, 'Tests failed %d of %d'%(all_failed, all_count))
 
-
+def install_test(arguments):
+  log('-+---==(TEST INSTALLER)==---------------------------------------------------+-')
+  log(' | Setup nessecary configuration for running test                           |')
+  log(' | This includes: Loading the PythonScript module at startup                |')
+  log(' | To use this please run nsclient++ in "test mode" like so:                |')
+  log(' | nscp --test                                                              |')
+  log(' | Then start the pytest_test command by typing it and press enter like so: |')
+  log(' | pytest_test                                                              |')
+  log(' | Lastly exit by typing exit like so:                                      |')
+  log(' | exit                                                                     |')
+  log('-+--------------------------------------------------------==(DAS ENDE!)==---+-')
+  conf = Settings.get()
+  conf.set_string('/modules', 'pytest', 'PythonScript')
+  conf.set_string('/settings/pytest/scripts', 'pytest', 'test.py')
+  conf.save()
+
+def __main__():
+  install_test([])
+  
 def init(pid, plugin_alias, script_alias):
   global prefix
@@ -210 +228 @@
     prefix = '%s_'%script_alias
 
-  log('Script: test.py with alias: %s (%s:%d)'%(script_alias, plugin_alias, plugin_id))
-
   conf = Settings.get()
-  val = conf.get_string('/modules', 'PythonScript', 'foo')
-
-  log('Got it: %s'%val)
+  #val = conf.get_string('/modules', 'PythonScript', 'foo')
+
+  #log('Got it: %s'%val)
   
   log('Testing to register a function')
   reg = Registry.get(plugin_id)
   
-  #reg.simple_cmdline('help', get_help)
-  #reg.simple_cmdline('%stest'%prefix, test_cmd)
+  reg.simple_cmdline('help', get_help)
+  reg.simple_cmdline('install_python_test', install_test)
 
   reg.simple_function('%stest'%prefix, test, 'Run python unittest')
@@ -228 +244 @@
   #core.simple_submit('test', 'test.py', status.WARNING, 'hello', '')
   
-  (ret, list) = core.simple_exec('%stest'%prefix, ['a', 'b', 'c'])
-  for l in list:
-    log('-- %s --'%l)
-
-  log('Testing to register settings keys')
-  conf.register_path('hello', 'PYTHON SETTINGS', 'This is stuff for python')
-  conf.register_key('hello', 'python', 'int', 'KEY', 'This is a key', '42')
-
-  log('Testing to get key (nonexistant): %d' % conf.get_int('hello', 'python', -1))
-  conf.set_int('hello', 'python', 4)
-  log('Testing to get it (after setting it): %d' % conf.get_int('hello', 'python', -1))
-
-  log('Saving configuration...')
+  #(ret, list) = core.simple_exec('%stest'%prefix, ['a', 'b', 'c'])
+  #for l in list:
+  # log('-- %s --'%l)
+
+  #log('Testing to register settings keys')
+  #conf.register_path('hello', 'PYTHON SETTINGS', 'This is stuff for python')
+  #conf.register_key('hello', 'python', 'int', 'KEY', 'This is a key', '42')
+
+  #log('Testing to get key (nonexistant): %d' % conf.get_int('hello', 'python', -1))
+  #conf.set_int('hello', 'python', 4)
+  #log('Testing to get it (after setting it): %d' % conf.get_int('hello', 'python', -1))
+
+  #log('Saving configuration...')
   #conf.save()
 

service/NSClient++.cpp

@@ -533 +533 @@
  * @author mickem
  */
-bool NSClientT::initCore(bool boot) {
-  LOG_INFO_CORE(_T("Attempting to start"));
+bool NSClientT::boot_init() {
+  LOG_INFO_CORE(SERVICE_NAME _T(" booting..."));
 
   if (!settings_manager::init_settings(&provider, context_)) {
@@ -627 +627 @@
 
   if (enable_shared_session_) {
-    LOG_DEBUG_CORE(_T("Enabling shared session..."));
-    if (boot) {
-      LOG_INFO_CORE(_T("shared session not ported yet!..."));
+    LOG_INFO_CORE(_T("shared session not ported yet!..."));
+//    if (boot) {
+//      LOG_INFO_CORE(_T("shared session not ported yet!..."));
 //      try {
 //        shared_server_.reset(new nsclient_session::shared_server_session(this));
@@ -645 +645 @@
 //        shared_server_.reset(NULL);
 //      }
-    } else {
-      LOG_INFO_CORE(_T("shared session not ported yet!..."));
+//    } else {
+//      LOG_INFO_CORE(_T("shared session not ported yet!..."));
 //      try {
 //        std::wstring id = _T("_attached_") + strEx::itos(GetCurrentProcessId()) + _T("_");
@@ -663 +663 @@
 //        shared_client_.reset(NULL);
 //      }
-    }
+//    }
   }
 #ifdef WIN32
@@ -676 +676 @@
   }
 #endif
+  return true;
+}
+bool NSClientT::boot_load_plugins(bool boot) {
+  LOG_DEBUG_CORE(_T("booting::loading plugins"));
   try {
     boost::filesystem::wpath pluginPath = expand_path(_T("${module-path}"));
@@ -1379 +1383 @@
 void NSClientT::handle_startup(std::wstring service_name) {
   service_name_ = service_name;
-  initCore(true);
+  boot_init();
+  boot_load_plugins(true);
 /*
   DWORD dwSessionId = remote_processes::getActiveSessionId();

service/NSClient++.h

@@ -131 +131 @@
 
   // Service helper functions
-  bool initCore(bool boot);
+  bool boot_init();
+  bool boot_load_plugins(bool boot);
   bool exitCore(bool boot);
   void set_settings_context(std::wstring context) { context_ = context; }

service/cli_parser.hpp

@@ -58 +58 @@
       ("key", po::value<std::wstring>()->default_value(_T("")), "Key to work with.")
       ("set", po::value<std::wstring>(), "Set a key and path to a given value.")
+      ("switch", po::value<std::wstring>(), "Set default context to use (similar to migrate but does NOT copy values)")
       ("show", "Set a value given a key and path.")
       ("list", "Set all keys below the path (or root).")
@@ -210 +211 @@
       if (vm.count("show")) {
         ret = client.show(vm["path"].as<std::wstring>(), vm["key"].as<std::wstring>());
+      }
+      if (vm.count("switch")) {
+        client.switch_context(vm["switch"].as<std::wstring>());
+        ret = 0;
       }
       client.exit();
@@ -335 +340 @@
         mainClient.log_info(__FILE__, __LINE__, _T("Arguments: ") + args);
       }
+      core_->boot_init();
       if (module.empty()) {
-        core_->initCore(false);
+        core_->boot_load_plugins(false);
       }
       int ret = 0;

service/settings_client.hpp

@@ -21 +21 @@
       if (!current_.empty())
         core_->set_settings_context(current_);
-      if (!core_->initCore(false)) {
-        std::wcout << _T("Service *NOT* started!") << std::endl;
+      if (!core_->boot_init()) {
+        std::wcout << _T("boot::init failed") << std::endl;
+        return;
+      }
+      if (!core_->boot_load_plugins(false)) {
+        std::wcout << _T("boot::load_plugins failed!") << std::endl;
         return;
       }
@@ -126 +130 @@
 
 
+    void switch_context(std::wstring contect) {
+      settings_manager::get_core()->set_primary(contect);
+    }
+
     int set(std::wstring path, std::wstring key, std::wstring val) {
       core_->load_all_plugins(NSCAPI::dontStart);

service/simple_client.hpp

@@ -15 +15 @@
     void start() {
       core_->enableDebug(true);
-      if (!core_->initCore(true)) {
-        core_->log_error(__FILE__, __LINE__, _T("Service failed to start"));
+      if (!core_->boot_init()) {
+        core_->log_error(__FILE__, __LINE__, _T("Service failed to init"));
+        return;
+      }
+      if (!core_->boot_load_plugins(true)) {
+        core_->log_error(__FILE__, __LINE__, _T("Service failed to load plugin"));
         return;
       }