Skip to content
This repository has been archived by the owner on Jul 11, 2022. It is now read-only.

Commit

Permalink
[BZ 1069547] Removing support for patches from the content subsystem
Browse files Browse the repository at this point in the history 
This is to not overload the user with overlapping yet incompatible
choices for doing the same thing.

After discussion, we decided to keep the support for patching in the
bundle subsystem and drop it from the content subsystem.

This also means we need to drop the specialized rollback operation
because using that we could bring RHQ bundles into an inconsistent
state.
  • Loading branch information
@metlos
metlos committed Jul 22, 2014
1 parent 6a61088 commit abe38c4
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 256 deletions.
193 changes: 1 addition & 192 deletions ...gins/jboss-as-7/src/main/java/org/rhq/modules/plugins/jbossas7/StandaloneASComponent.java
View file
Expand Up @@ -23,15 +23,12 @@
import static org.rhq.core.pluginapi.bundle.BundleHandoverResponse.FailureType.EXECUTION;
import static org.rhq.core.pluginapi.bundle.BundleHandoverResponse.FailureType.INVALID_ACTION;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
Expand All @@ -47,24 +44,13 @@
import org.rhq.core.domain.configuration.PropertyList;
import org.rhq.core.domain.configuration.PropertyMap;
import org.rhq.core.domain.configuration.PropertySimple;
import org.rhq.core.domain.content.PackageDetailsKey;
import org.rhq.core.domain.content.PackageType;
import org.rhq.core.domain.content.transfer.ContentResponseResult;
import org.rhq.core.domain.content.transfer.DeployIndividualPackageResponse;
import org.rhq.core.domain.content.transfer.DeployPackageStep;
import org.rhq.core.domain.content.transfer.DeployPackagesResponse;
import org.rhq.core.domain.content.transfer.RemoveIndividualPackageResponse;
import org.rhq.core.domain.content.transfer.RemovePackagesResponse;
import org.rhq.core.domain.content.transfer.ResourcePackageDetails;
import org.rhq.core.domain.measurement.AvailabilityType;
import org.rhq.core.domain.measurement.MeasurementDataTrait;
import org.rhq.core.domain.measurement.MeasurementReport;
import org.rhq.core.domain.measurement.MeasurementScheduleRequest;
import org.rhq.core.pluginapi.bundle.BundleHandoverRequest;
import org.rhq.core.pluginapi.bundle.BundleHandoverResponse;
import org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport;
import org.rhq.core.pluginapi.content.ContentFacet;
import org.rhq.core.pluginapi.content.ContentServices;
import org.rhq.core.pluginapi.inventory.ResourceComponent;
import org.rhq.core.pluginapi.inventory.ResourceContext;
import org.rhq.core.pluginapi.measurement.MeasurementFacet;
Expand All @@ -86,15 +72,14 @@
import org.rhq.modules.plugins.jbossas7.json.ReadAttribute;
import org.rhq.modules.plugins.jbossas7.json.ReadResource;
import org.rhq.modules.plugins.jbossas7.json.Result;
import org.rhq.modules.plugins.jbossas7.util.PatchDetails;

/**
* Component class for standalone AS7 servers.
*
* @author Heiko W. Rupp
*/
public class StandaloneASComponent<T extends ResourceComponent<?>> extends BaseServerComponent<T> implements
MeasurementFacet, OperationFacet, SupportFacet, ContentFacet {
MeasurementFacet, OperationFacet, SupportFacet {

private static final Log LOG = LogFactory.getLog(StandaloneASComponent.class);

Expand Down Expand Up @@ -463,168 +448,6 @@ public SnapshotReportResults getSnapshotReport(SnapshotReportRequest request) th
throw new Exception("Cannot obtain report, resource is not UP");
}

public List<DeployPackageStep> generateInstallationSteps(ResourcePackageDetails packageDetails) {
return null;
}

@Override
public DeployPackagesResponse deployPackages(Set<ResourcePackageDetails> packages,
ContentServices contentServices) {

DeployPackagesResponse response = new DeployPackagesResponse();
boolean someFailed = false;

for (ResourcePackageDetails pkg : packages) {
if (PATCH_PACKAGE_TYPE_NAME.equals(pkg.getKey().getPackageTypeName())) {
DeployIndividualPackageResponse resp = deployPatch(pkg, contentServices);
response.addPackageResponse(resp);
someFailed = someFailed || resp.getResult() != ContentResponseResult.SUCCESS;
}
}

response.setOverallRequestResult(someFailed ? ContentResponseResult.FAILURE : ContentResponseResult.SUCCESS);

return response;
}

@Override
public RemovePackagesResponse removePackages(Set<ResourcePackageDetails> packages) {
RemovePackagesResponse response = new RemovePackagesResponse();
boolean someFailed = false;
for(ResourcePackageDetails pkg : packages) {
RemoveIndividualPackageResponse r = rollbackPatch(pkg);
response.addPackageResponse(r);
someFailed = someFailed || r.getResult() != ContentResponseResult.SUCCESS;
}

response
.setOverallRequestResult(someFailed ? ContentResponseResult.FAILURE : ContentResponseResult.SUCCESS);

return response;
}

@Override
public Set<ResourcePackageDetails> discoverDeployedPackages(PackageType type) {
if (!PATCH_PACKAGE_TYPE_NAME.equals(type.getName())) {
return Collections.emptySet();
}

CliExecutor runner = CliExecutor
.onServer(pluginConfiguration, getMode(), context.getSystemInformation()).disconnected(true);

ProcessExecutionResults infoResults = runner.executeCliCommand("patch info");
if (infoResults.getError() != null || infoResults.getExitCode() == null || infoResults.getExitCode() != 0) {
if (getLog().isDebugEnabled()) {
if (infoResults.getError() == null) {
getLog().debug(
"Failed to obtain the patch info while discovering patches on " +
context.getResourceDetails() + ". Exit code: " + infoResults.getExitCode() + ", output:\n" +
infoResults.getCapturedOutput()
);
} else {
getLog().debug("Failed to obtain the patch info while discovering patches on " +
context.getResourceDetails(), infoResults.getError());
}
} else if (infoResults.getError() != null) {
getLog().info("Failed to obtain the patch info while discovering patches on " +
context.getResourceDetails() + ": " + infoResults.getError().getMessage());
}
return Collections.emptySet();
}

ProcessExecutionResults historyResults = runner.executeCliCommand("patch history");
if (historyResults.getError() != null || historyResults.getExitCode() == null || historyResults.getExitCode() != 0) {
if (getLog().isDebugEnabled()) {
if (historyResults.getError() == null) {
getLog().debug(
"Failed to obtain the patch history while discovering patches on " +
context.getResourceDetails() + ". Exit code: " + historyResults.getExitCode() + ", output:\n" +
historyResults.getCapturedOutput()
);
} else {
getLog().debug("Failed to obtain the patch history while discovering patches on " +
context.getResourceDetails(), historyResults.getError());
}
} else if (historyResults.getError() != null) {
getLog().info("Failed to obtain the patch history while discovering patches on " +
context.getResourceDetails() + ": " + historyResults.getError().getMessage());
}
return Collections.emptySet();
}

return getInstalledPatches(infoResults.getCapturedOutput(), historyResults.getCapturedOutput());
}

private Set<ResourcePackageDetails> getInstalledPatches(String patchInfoResults, String patchHistoryResults) {
List<PatchDetails> patchDetails = PatchDetails.fromInfo(patchInfoResults, patchHistoryResults);

HashSet<ResourcePackageDetails> ret = new HashSet<ResourcePackageDetails>();

for (PatchDetails p : patchDetails) {
ResourcePackageDetails details = new ResourcePackageDetails(
new PackageDetailsKey(p.getId(), "NA", PATCH_PACKAGE_TYPE_NAME, "noarch"));

details.setInstallationTimestamp(p.getAppliedAt().getTime());
details.setShortDescription("Type: " + p.getType().toString());
details.setFileName(p.getId());

ret.add(details);
}

return ret;
}

@Override
public InputStream retrievePackageBits(ResourcePackageDetails packageDetails) {
//we cannot retrieve the bits really, so just return a dummy empty input stream
return new InputStream() {
@Override
public int read() throws IOException {
return -1;
}
};
}

private DeployIndividualPackageResponse deployPatch(ResourcePackageDetails pkg, ContentServices contentServices) {
DeployIndividualPackageResponse response = new DeployIndividualPackageResponse(pkg.getKey());

File patchFile;
try {
patchFile = File.createTempFile("rhq-jbossas-7-", ".patch");
} catch (IOException e) {
response.setErrorMessage("Could not create a temporary file to download the patch to. " + e.getMessage());
response.setResult(ContentResponseResult.FAILURE);
return response;
}

OutputStream out;
try {
out = new BufferedOutputStream(new FileOutputStream(patchFile));
} catch (FileNotFoundException e) {
response.setErrorMessage("Could not open the temporary file to download the patch to. " + e.getMessage());
response.setResult(ContentResponseResult.FAILURE);
return response;
}

try {
contentServices.downloadPackageBits(context.getContentContext(), pkg.getKey(), out, true);
} finally {
StreamUtil.safeClose(out);
}

String errorMessage = deployPatch(patchFile, Collections.<String, String>emptyMap());

if (errorMessage != null) {
response.setErrorMessage(errorMessage);
response.setResult(ContentResponseResult.FAILURE);
return response;
}

response.setResult(ContentResponseResult.SUCCESS);

return response;
}

private BundleHandoverResponse deployPatch(BundleHandoverRequest request) {
//download the file to a temp location
File patchFile;
Expand Down Expand Up @@ -706,20 +529,6 @@ private String deployPatch(File patchFile, Map<String, String> additionalParams)
return null;
}

private RemoveIndividualPackageResponse rollbackPatch(ResourcePackageDetails pkg) {
String errorMessage = rollbackPatch(pkg.getName(), null);

RemoveIndividualPackageResponse response = new RemoveIndividualPackageResponse(pkg.getKey());
if (errorMessage != null) {
response.setErrorMessage(errorMessage);
response.setResult(ContentResponseResult.FAILURE);
} else {
response.setResult(ContentResponseResult.SUCCESS);
}

return response;
}

private String rollbackPatch(String patchId, Configuration params) {
StringBuilder command = new StringBuilder("patch rollback --patch-id=");
command.append(patchId);
Expand Down
64 changes: 0 additions & 64 deletions modules/plugins/jboss-as-7/src/main/resources/META-INF/rhq-plugin.xml
View file
Expand Up @@ -1511,58 +1511,6 @@
<c:simple-property name="operationResult"/>
</results>
</operation>
<operation name="rollbackPatch" description="Rolls back the specified patch.">
<parameters>
<c:simple-property name="patch-id" displayName="Patch Id" required="true" type="string">
<c:description>
The ID of the patch to roll back.
</c:description>
</c:simple-property>
<c:simple-property name="restartImmediately" required="true" type="boolean" default="true">
<c:description>
For the rollback to take effect, the server must be restarted. Set this to true if you want to do
that immediately, false if you want to do it manually at some later point in time.
</c:description>
</c:simple-property>
<c:simple-property name="reset-configuration" displayName="Reset Configuration" required="true"
default="false" type="boolean">
<c:description>
Signifies whether the rollback operation should
reset the installation configurations to their state
before the patch was applied.
</c:description>
</c:simple-property>
<c:simple-property name="override-all" displayName="Override All" required="false" type="boolean">
<c:description>
Signifies to bypass any content verification on the
miscellaneous items changed by the patch. Default is "false".
</c:description>
</c:simple-property>
<c:simple-property name="override-modules" displayName="Override Modules" required="false" type="boolean">
<c:description>
Signifies to bypass any content verification on the
modules and OSGi bundles affected by the patch. Default is "false".
</c:description>
</c:simple-property>
<c:simple-property name="override" displayName="Override" required="false" type="longString">
<c:description>
The value is a comma-separated list of the miscellaneous
items in the patch that can be overridden on the server
whether the item reports a conflict or not.
</c:description>
</c:simple-property>
<c:simple-property name="preserve" displayName="Preserve" required="false" type="longString">
<c:description>
The value is a comma-separated list of the miscellaneous
items that must be preserved and not modified by
applying or rolling back a patch.
</c:description>
</c:simple-property>
</parameters>
<results>
<c:simple-property name="operationResult"/>
</results>
</operation>
&executeCliOperations;

<metric property="_internal:mgmtRequests" category="performance" dataType="measurement" defaultInterval="120000"
Expand Down Expand Up @@ -1592,18 +1540,6 @@

<event name="logEntry" description="an entry in a log file"/>

<content name="wflyPatch" displayName="Wildfly/JBoss EAP Patch" category="deployable" supportsArchitecture="false"
description="Wildfly/JBoss EAP Patch">
<configuration>
<c:simple-property name="restartImmediately" type="boolean" required="true" default="true">
<c:description>
For the rollback to take effect, the server must be restarted. Set this to true if you want to do
that immediately, false if you want to do it manually at some later point in time.
</c:description>
</c:simple-property>
</configuration>
</content>

<resource-configuration>

<c:group name="children:system-property:name+" displayName="System-properties">
Expand Down

0 comments on commit abe38c4

Please sign in to comment.