From f18dd5bed3639882ded33bf22c3346993905c67d Mon Sep 17 00:00:00 2001
From: John Mazzitelli <mazz@redhat.com>
Date: Sat, 3 Oct 2009 10:51:58 -0400
Subject: extend the script plugin so I can pick up its capabilities to get
 avail, discovery, version checking

---
 .../org/rhq/plugins/puppet/PuppetComponent.java    |  95 +++-----------
 .../org/rhq/plugins/puppet/PuppetDiscovery.java    | 139 ++++++++++++++-------
 src/main/resources/META-INF/rhq-plugin.xml         |  30 ++++-
 3 files changed, 134 insertions(+), 130 deletions(-)

(limited to 'src')

diff --git a/src/main/java/org/rhq/plugins/puppet/PuppetComponent.java b/src/main/java/org/rhq/plugins/puppet/PuppetComponent.java
index 5dcd657..b311f98 100644
--- a/src/main/java/org/rhq/plugins/puppet/PuppetComponent.java
+++ b/src/main/java/org/rhq/plugins/puppet/PuppetComponent.java
@@ -1,112 +1,47 @@
-
 package org.rhq.plugins.puppet;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 import org.rhq.core.domain.configuration.Configuration;
-import org.rhq.core.domain.measurement.AvailabilityType;
 import org.rhq.core.pluginapi.inventory.CreateChildResourceFacet;
 import org.rhq.core.pluginapi.inventory.CreateResourceReport;
 import org.rhq.core.pluginapi.inventory.DeleteResourceFacet;
 import org.rhq.core.pluginapi.inventory.InvalidPluginConfigurationException;
 import org.rhq.core.pluginapi.inventory.ResourceComponent;
-import org.rhq.core.pluginapi.inventory.ResourceContext;
-import org.rhq.core.pluginapi.operation.OperationContext;
 import org.rhq.core.pluginapi.operation.OperationFacet;
 import org.rhq.core.pluginapi.operation.OperationResult;
+import org.rhq.core.system.ProcessExecutionResults;
+import org.rhq.core.system.SystemInfo;
+import org.rhq.plugins.script.ScriptServerComponent;
 
-
-public class PuppetComponent implements ResourceComponent
-, OperationFacet
-, CreateChildResourceFacet
-, DeleteResourceFacet
-{
+public class PuppetComponent extends ScriptServerComponent implements ResourceComponent, OperationFacet, CreateChildResourceFacet,
+    DeleteResourceFacet {
+    
     private final Log log = LogFactory.getLog(this.getClass());
 
-    private static final int CHANGEME = 1; // TODO remove or change this
-
-
-
-
-    /**
-     * Return availability of this resource
-     *  @see ResourceComponent#getAvailability()
-     */
-    public AvailabilityType getAvailability() {
-        // TODO supply real implementation
-        return AvailabilityType.UP;
-    }
-
-
-    /**
-     * Start the resource connection
-     * @see org.rhq.core.pluginapi.inventory.ResourceComponent#start(org.rhq.core.pluginapi.inventory.ResourceContext)
-     */
-    public void start(ResourceContext context) throws InvalidPluginConfigurationException, Exception {
-
-        Configuration conf = context.getPluginConfiguration();
-        // TODO add code to start the resource / connection to it
-
-
-    }
-
-
-    /**
-     * Tear down the rescource connection
-     * @see org.rhq.core.pluginapi.inventory.ResourceComponent#stop()
-     */
-    public void stop() {
-
+    // these are reused from our generic script plugin
+    protected static final String PLUGINCONFIG_EXECUTABLE = ScriptServerComponent.PLUGINCONFIG_EXECUTABLE;
 
-    }
-
-
-
-
-
-    public void startOperationFacet(OperationContext context) {
-
-    }
-
-
-    /**
-     * Invokes the passed operation on the managed resource
-     * @param name Name of the operation
-     * @param params The method parameters
-     * @return An operation result
-     * @see org.rhq.core.pluginapi.operation.OperationFacet
-     */
     public OperationResult invokeOperation(String name, Configuration params) throws Exception {
 
+        // TODO
         OperationResult res = new OperationResult();
         if ("dummyOperation".equals(name)) {
-            // TODO implement me
-
         }
         return res;
     }
 
-
-
-    /**
-     * Create a child resource
-     * @see org.rhq.core.pluginapi.inventory.CreateChildResourceFacet
-     */
-    public CreateResourceReport createResource(CreateResourceReport report)
-    {
-        // TODO supply code to create a child resource
-
+    public CreateResourceReport createResource(CreateResourceReport report) {
         return null; // TODO change this
     }
 
-    /**
-     * Delete a child resource
-     * @see org.rhq.core.pluginapi.inventory.DeleteResourceFacet
-     */
-    public void deleteResource() throws Exception
-    {
+    public void deleteResource() throws Exception {
         // TODO supply code to delete a child resource
     }
 
+    protected static ProcessExecutionResults executeExecutable(SystemInfo sysInfo, Configuration pluginConfig,
+        String args, long wait, boolean captureOutput) throws InvalidPluginConfigurationException {
+        return ScriptServerComponent.executeExecutable(sysInfo, pluginConfig, args, wait, captureOutput);
+    }
 }
diff --git a/src/main/java/org/rhq/plugins/puppet/PuppetDiscovery.java b/src/main/java/org/rhq/plugins/puppet/PuppetDiscovery.java
index 4a10f66..fb0133c 100644
--- a/src/main/java/org/rhq/plugins/puppet/PuppetDiscovery.java
+++ b/src/main/java/org/rhq/plugins/puppet/PuppetDiscovery.java
@@ -1,46 +1,95 @@
-package org.rhq.plugins.puppet;
-
-import java.util.HashSet;
-import java.util.Set;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails;
-import org.rhq.core.pluginapi.inventory.ResourceDiscoveryComponent;
-import org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext;
-
-
-/**
- * Discovery class
- */
-public class PuppetDiscovery implements ResourceDiscoveryComponent {
-
-
-    private final Log log = LogFactory.getLog(this.getClass());
-
-
-    /**
-     * Run the discovery
-     */
-    public Set<DiscoveredResourceDetails> discoverResources(ResourceDiscoveryContext discoveryContext) throws Exception {
-
-        Set<DiscoveredResourceDetails> discoveredResources = new HashSet<DiscoveredResourceDetails>();
-
-        /**
-         * TODO: do your discovery here
-         * A discovered resource must have a unique key, that must
-         * stay the same when the resource is discovered the next
-         * time
-         */
-        DiscoveredResourceDetails detail = null; // new DiscoveredResourceDetails(  );
-
-
-        // Add to return values
-        discoveredResources.add(detail);
-        log.info("Discovered new ... TODO "); // TODO change
-
-        return discoveredResources;
-
-    }
+package org.rhq.plugins.puppet;
+
+import java.io.File;
+import java.util.HashSet;
+import java.util.Set;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+import org.rhq.core.domain.configuration.Configuration;
+import org.rhq.core.domain.configuration.PropertySimple;
+import org.rhq.core.domain.resource.ResourceType;
+import org.rhq.core.pluginapi.inventory.DiscoveredResourceDetails;
+import org.rhq.core.pluginapi.inventory.ResourceDiscoveryComponent;
+import org.rhq.core.pluginapi.inventory.ResourceDiscoveryContext;
+import org.rhq.core.system.ProcessExecution;
+import org.rhq.core.system.ProcessExecutionResults;
+import org.rhq.core.system.SystemInfo;
+import org.rhq.plugins.script.ScriptDiscoveryComponent;
+
+/**
+ * Puppet client discovery class.
+ */
+public class PuppetDiscovery extends ScriptDiscoveryComponent implements ResourceDiscoveryComponent {
+
+    private final Log log = LogFactory.getLog(this.getClass());
+
+    @Override
+    public Set<DiscoveredResourceDetails> discoverResources(ResourceDiscoveryContext discoveryContext) {
+
+        String executable = checkExecutables(discoveryContext.getSystemInformation());
+
+        // if null, it means puppet is not installed or we could not auto-detect its location
+        if (executable == null) {
+            return new HashSet<DiscoveredResourceDetails>();
+        }
+
+        // create our plugin config with the executable path, and use the manual-add facet to create our details
+        Configuration pluginConfig = discoveryContext.getDefaultPluginConfiguration();
+        pluginConfig.put(new PropertySimple(PuppetComponent.PLUGINCONFIG_EXECUTABLE, executable));
+
+        Set<DiscoveredResourceDetails> discoveredResources = new HashSet<DiscoveredResourceDetails>();
+        DiscoveredResourceDetails details = discoverResource(pluginConfig, discoveryContext);
+        if (details != null) {
+            discoveredResources.add(details);
+        }
+
+        return discoveredResources;
+    }
+
+    @Override
+    public DiscoveredResourceDetails discoverResource(Configuration config, ResourceDiscoveryContext context) {
+        DiscoveredResourceDetails details = super.discoverResource(config, context);
+        if (details != null) {
+            details.setResourceName("Puppet Client");
+            log.info("Discovered new puppet client at ["
+                + config.getSimpleValue(PuppetComponent.PLUGINCONFIG_EXECUTABLE, "?") + "]");
+        }
+        return details;
+    }
+
+    @Override
+    protected String determineDescription(ResourceDiscoveryContext context, Configuration pluginConfig) {
+        return "Puppet client that applies recipes to the system";
+    }
+
+    private String checkExecutables(SystemInfo systemInfo) {
+        // Make sure puppet is actually on the system
+        // First we see if its in a typical place.
+        String[] executables = new String[] { "/usr/bin/puppet", "/bin/puppet" };
+        for (String executable : executables) {
+            File file = new File(executable);
+            if (file.canRead()) {
+                return executable;
+            }
+        }
+
+        // We can't find it, use 'which' to see if it knows
+        String executable = null;
+
+        try {
+            ProcessExecution processExecution = new ProcessExecution("which");
+            processExecution.setArguments(new String[] { "puppet" });
+            processExecution.setCaptureOutput(true);
+
+            ProcessExecutionResults executionResults = systemInfo.executeProcess(processExecution);
+            String capturedOutput = executionResults.getCapturedOutput();
+            executable = (((capturedOutput == null) || "".equals(capturedOutput)) ? null : capturedOutput.trim());
+        } catch (Exception e) {
+            log.debug("'which' failed to determine where the puppet executable is. Cause: " + e);
+        }
+
+        return executable;
+    }
 }
\ No newline at end of file
diff --git a/src/main/resources/META-INF/rhq-plugin.xml b/src/main/resources/META-INF/rhq-plugin.xml
index a1124d7..955a09d 100644
--- a/src/main/resources/META-INF/rhq-plugin.xml
+++ b/src/main/resources/META-INF/rhq-plugin.xml
@@ -6,18 +6,38 @@
         xmlns="urn:xmlns:rhq-plugin"
         xmlns:c="urn:xmlns:rhq-configuration">
 
+   <depends plugin="Script"/>
+
    <server name="Puppet Client"
            discovery="PuppetDiscovery"
            class="PuppetComponent"
-           createDeletePolicy="both">
+           supportsManualAdd="true"
+           description="The puppet client that will be invoked to process puppet recipes">
 
       <plugin-configuration>
-         <!-- TODO add your own here -->
-         <c:simple-property name="dummy" />
+         <c:group name="executableEnvironment" displayName="Executable Runtime Environment">
+            <c:simple-property name="executable" required="true" description="The full path to the puppet client" />
+            <c:simple-property name="workingDirectory" required="false" description="When the executable is invoked, this will be its working directory." />
+            <c:list-property name="environmentVariables" required="false" description="Environment variables that are set when executing the executable">
+               <c:map-property name="environmentVariable">
+                  <c:simple-property name="name" type="string" required="true" summary="true" description="Name of the environment variable"/>
+                  <c:simple-property name="value" type="string" required="true" summary="true" description="Value of the environment variable" />
+               </c:map-property>
+            </c:list-property>
+         </c:group>
+         <c:group name="avail" displayName="Availability Definition">
+            <c:simple-property name="availabilityExecuteCheck" default="false" required="false" type="boolean" description="If specified and true, the ability to successfully execute the puppet client can determine whether or not it is considered up and available. If you set this to true, you normally do not set the availability regex settings in order to allow availability to be determined based solely on the successful execution, regardless of the exit code or output. If this is false, setting one of the avail regex settings will override it as if it were true."/>
+            <c:simple-property name="availabilityExitCodeRegex" required="false" description="If specified, the executable must return an exit code that matches this regular expression if the managed resource is to be considered up and available"/>
+            <c:simple-property name="availabilityOutputRegex" required="false" description="If specified, the executable must output text that matches this regular expression if the managed resource is to be considered up and available"/>
+            <c:simple-property name="availabilityArguments" required="false" description="If the executable needs to be executed in order to determine availability, these are the arguments that will be passed to the executable. If you do not specify the regex settings and you set the execute check setting to false, the executable will not be executed and these arguments will not be used - in this case, availability will be determined by the mere existence of the executable file."/>
+         </c:group>
+         <c:group name="version" displayName="Version Definition">
+            <c:simple-property name="versionArguments" default="--version" required="false" description="The arguments to pass to the executable that will help determine the version of the managed resource"/>
+            <c:simple-property name="versionRegex" default=".*" required="false" description="The regex that can pick out the version from the executable output. If the regex has a captured group, its matched content will be used as the version. If there is no captured group, the entire output will be used as the version."/>
+            <c:simple-property name="fixedVersion" required="false" description="If specified, this will be the version of the managed resource - the executable will not be invoked to determine it." />
+         </c:group>
       </plugin-configuration>
 
-      <!-- TODO process scans -->
-
       <operation name="dummyOperation">
          <!-- TODO supply parameters and return values -->
       </operation>
-- 
cgit