Add define jboss::cliexec that can execute any JBoss custom methods for any CLI path

[cardil]

This feature request describes new define: jboss::cliexec.

Description for Wiki (draft):

WIKI CUT HERE

The jboss::cliexec defined type

This define is very versatile. It can be used to execute any JBoss CLI method for any CLI path. This define also supports parameters onlyif and unless. One of them must be present to prevent idempotent issues, they should work similar to ones defined in Puppet build-in resource exec.

jboss::cliexec { '/subsystem=jgroups/stack=udp:add-protocol(type=PING)':
  unless => '/subsystem=jgroups/stack=udp/protocol=PING:read-resource',
}

Parameters of jboss::cliexec:

This type uses JBoss module standard metaparameters

unless parameter

The unless parameter can be used to check if resource should be executed. If passed command fails that means that it should be run. You must pass unless if not passing onlyif and only one of them can be set for given resource. Example:

jboss::cliexec { '/subsystem=jgroups/stack=udp:add-protocol(type=PING)':
  unless => '/subsystem=jgroups/stack=udp/protocol=PING:read-resource',
}

onlyif parameter

The onlyif parameter can be used to check if resource should be executed. If passed command succeds that means that it should be run. You must pass onlyif if not passing unless and only one of them can be set for given resource Example:

jboss::cliexec { '/subsystem=jgroups/stack=udp:remove-protocol(type=PING)':
  onlyif => '/subsystem=jgroups/stack=udp/protocol=PING:read-resource',
}

command parameter

This is the namevar. Command to be executed as full CLI entry and method. The command must be passed without /profile=<profile-name> in domain mode as well (for that profile parameter must be used).

basepath parameter

The base path can be used to shorten recurring paths in commands. Example:

jboss::cliexec { ':remove-protocol(type=PING)':
  onlyif   => '/protocol=PING:read-resource',
  basepath => '/subsystem=jgroups/stack=udp',
}

WIKI CUT HERE

Scope of change for this feature:

• Create appropriate define jboss::cliexec
• Puppet rspec tests for define jboss::cliexec
• Acceptance tests for define jboss::cliexec
• Smoke tests for define jboss::cliexec
• Create appropriate type jboss_cliexec and default provider jboss_cliexec/jbosscli for it
• Ruby rspec tests for type jboss_cliexec and provider jboss_cliexec/jbosscli
• Deprecate dorestart parameter in jboss::clientry, backing type and providers and change rspec tests
• Deprecate running and stopped options for ensure property in jboss::clientry, backing type and providers and change rspec tests
• Change the way that jboss::domain::server is implemented. Use jboss::cliexec instead of dorestart. Also running and stopped options for ensure should be implemented with jboss::cliexec.
• Documentation changes on README.md and Wiki pages

[cardil]

This feature will give users a way to run any JBoss commands, like in question #38

[Cosaquee]

First of all we need to merge #10 imho.

[cardil]

Yup @Cosaquee. This should be at least v1.1.0 or later