JITL Jobs, JobScheduler Plugins and JOC Cockpit should support use of a Credential Store

Current Situation

• The following hibernate configuration files are available with JobScheduler Master and JOC Cockpit:
  • JobScheduler run-time database: hibernate.cfg.xml
  • Reporting database: reporting.hibernate.cfg.xml
• Database accounts, passwords and URLs are specified as plain text with the above hibernate configuration files.

Desired Behavior

• The above hibernate configuration files should support credential store syntax:
  • Full syntax:
    • <property name="hibernate.connection.username">cs://some/path/entry@user?file=some/path/database.kdbx</property>
    • <property name="hibernate.connection.password">cs://some/path/entry@password?file=some/path/database.kdbx</property>
    • <property name="hibernate.connection.url">cs://some/path/entry@url?file=some/path/database.kdbx</property>
  • Short syntax:
    • <property name="hibernate.connection.username">cs://@user</property>
    • <property name="hibernate.connection.password">cs://@password</property>
    • <property name="hibernate.connection.url">cs://@url</property>
    • Inroducing new hibernate configuration credential store items for the Short syntax:
      • <property name="hibernate.sos.credential_store_file">some/path/database.kdbx</property>
      • <property name="hibernate.sos.credential_store_key_file">some/path/database.key</property>
      • <property name="hibernate.sos.credential_store_password">some password</property>
      • <property name="hibernate.sos.credential_store_entry_path">/some/entry/path</property>
• The following components and plugins make use of the above hibernate configuration files:
  • Fact-Plugin in JobScheduler Master
  • Inventory-Plugin in JobScheduler Master
  • Job Streams-Plugin in JobScheduler Master
  • YADE Job in JobScheduler Master
  • Notification Jobs in JobScheduler Master
  • JOC Cockpit
  • JobScheduler Master scripts
    • scheduler_install/install
      • scheduler_install_tables.cmd|sh
      • import_jitl_jobs_docu.cmd|sh
    • scheduler_install/bin
      • scheduler_install_tables.cmd|sh
      • cleanup_***.cmd|sh

Test Instructions

• JobScheduler
  • Test configuration:
    • unzip TEST-JITIL-589-jobscheduler.zip to any location
      • copy config/cs folder with the credential store files to the $scheduler_data/config directory
      • adjust database credentials for the JobScheduler and Reporting databases in the config/cs/kdbx-p-f.kdbx file:
        • credential store password: test
        • credential store key file: kdbx-p-f.key
      • Stop JobScheduler
      • replace existing $scheduler_data/config/hibernate.cfg.xml and $scheduler_data/config/reporting.hibernate.cfg.xml files
      • Start JobScheduler
  • Test execution:
    • Check Fact-Plugin, Inventory-Plugin, Job Streams-Plugin functionallity
    • Check jobs
      • Run a YADE job
      • Run a Notification order (e.g. sos/notification/CleanupNotifications->Cleanup)
    • Check the JobScheduler Master scripts (see explanation above)
      • call the $scheduler_install/install/scheduler_install_tables.cmd|sh etc scripts (Windows, Unix)
    • Check JobScheduler Setup
      • Update JobScheduler with the JobScheduler installer
    • Check the credentialstore syntax:
      • use the Full Syntax in the hibernate.cfg.xml and reporting.hibernate.cfg.xml files und rerun the tests
• JOC Cockpit
  • Test configuration:
    • unzip TEST-JITIL-589-joc.zip to any location
      • copy resources/joc/cs folder with the credential store files to the $joc_data/resources/joc directory
      • adjust database credentials for the JobScheduler and Reporting databases in the resources/cs/kdbx-p-f.kdbx file:
        • credential store password: test
        • credential store key file: kdbx-p-f.key
      • Stop JOC Cockpit
      • replace existing $joc_data/resources/joc/jobscheduler.hibernate.cfg.xml and $joc_data/resources/joc/hibernate.cfg.xml files
      • Start JOC Cockpit
  • Test execution:
    • Check JOC Cockpit functionality (history etc)
    • Check JOC Cockpit Setup
      • Update JOC with the JOC Cockpit installer
    • Check the credentialstore syntax:
      • use the Full Syntax in the jobscheduler.hibernate.cfg.xml and reporting.hibernate.cfg.xml files und rerun the tests