Develop OS Command Extension

[NassimBtk]

Description

Check List

Agent

• Remove the OsCommandProtocolConfig class.
• In ConfigHelper move the validateOsCommandInfo() and validateSshInfo() methods content to the OsCommandConfiguration and SshConfiguration class which is located in the metricshub-oscommand-extension. And adapt the ConfigHelper code so that we call IConfiguration#validateConfiguration (OsCommandConfiguration and SshConfiguration) to validate the content of the OsCommand and SSH configuration.
• Add the IConfiguration instance for oscommand and ssh to the final Map<Class<? extends IConfiguration>, IConfiguration> protocolConfigurations map which is built in ConfigHelper#buildHostConfiguration.
• In the MetricsHub CLI, adapt the OsCommandConfigCli class.
• Re-write sshConfigCli.toProtocol to call the extensionManager instance responsible of building the right IConfiguration for OsCommand protocol.
• If it is required to build a new configuration for OS Command in the unit tests then create a OsCommandTestConfiguration class and create its extension OsCommandTestExtension.
• Remove ConfigHelperTest#testValidateOsCommandInfo() and ConfigHelperTest#testValidateSshInfo() because the validation will be moved to the OsCommandConfiguration class in the metricshub-oscommand-extension.
• Adapt the TaskSchedulingServiceTest to replace the removed classes by the extension classes E.g. OsCommandTestConfiguration.
• Adapt the SshConfigCliTest tests. Probably Static Mocks will be involved.

Engine

• Remove the org.sentrysoftware:ssh dependency from metricshub-engine POM.
• Move OsCommandHelper code to the metricshub-oscommand-extension. Make sure to remove the call from the OsCommandHelper.run* method and adapt the caller (SourceProcessor CriterionProcessor) to invoke the extensionManager correctly.
• Remove OsCommandConfiguration.class and SshConfiguration.class mapping from the HostConfiguration#CONFIGURATION_TO_SOURCES_MAP map.
• Move OsCommandConfiguration.java to metricshub-oscommand-extension module.
• Move ProtocolHealthCheckStrategy#checkSshHealth to OsCommandExtension located at the metricshub-oscommand-extension module. Make sure to remove the unused constants and methods.
• Move the code of the method: CriterionProcessor#CriterionTestResult process(@SpanAttribute("criterion.definition") OsCommandCriterion OsCommandCriterion) to the appropriate class in the metricshub-oscommand-extension module and call the extensionManager in this process method to execute criterion.
• Move the code of the method: SourceProcessor#process(@SpanAttribute("source.definition") final OsCommandSource oscommandSource) to the appropriate class in the metricshub-oscommand-extension module and call the extensionManager in this process method to execute the source.
• Move the OsCommandConfigurationTest class to the extension unit tests.
• Move the SshConfigurationTest class to the extension unit tests.
• Adapt correct engine unit tests because the code is moved to another module.

Extension

• Implement the IProtocolExtension class.
• Make sure to accept both OsCommandConfiguration and SshConfiguration, this means that metricshub-oscommand-extension depends on the metricshub-oscommand-extension
• Make sure to implement native OS Command executions and Ssh commands through OS Command Helper.
• Make sure to define the /metricshub-oscommand-extension/src/main/resources/META-INF/services/org.sentrysoftware.metricshub.engine.extension.IProtocolExtension file so that the ServiceLoader loads the extension implementation correctly at runtime.
• Add the metricshub-engine,lombok, jupiter,jackson (all the necessary dependencies) in the extension project's POM.
• Make sure to create a jar using the maven-shade-plugin (POM)
• Make sure to include the required dependencies (org.sentrysoftware:ssh and org.sentrysoftware:metricshub-oscommand-extension)
• Develop unit tests.

Packaging Windows and Linux

• Add the metricshub-oscommand-extension as dependency.
• Update the maven-dependency-plugin, execution-id: unpack-extensions and add the artifactItem defining the metricshub-oscommand-extension.