SLING-7569 by default emit a healtcheck critical state for each artifact
not installed below the checked URL prefix
Also added configuration options to not emit warnings in that case to go
back to the previous more lenient behaviour
Move back to parent version 29 as this is the last version supporting
SCR annotations (SLING-6746)
diff --git a/pom.xml b/pom.xml
index b4210a9..3bd5e8d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -15,7 +15,7 @@
<parent>
<groupId>org.apache.sling</groupId>
<artifactId>sling</artifactId>
- <version>30</version>
+ <version>29</version>
<relativePath />
</parent>
diff --git a/src/main/java/org/apache/sling/installer/hc/OsgiInstallerHealthCheck.java b/src/main/java/org/apache/sling/installer/hc/OsgiInstallerHealthCheck.java
index ab7abb4..52a7d8b 100644
--- a/src/main/java/org/apache/sling/installer/hc/OsgiInstallerHealthCheck.java
+++ b/src/main/java/org/apache/sling/installer/hc/OsgiInstallerHealthCheck.java
@@ -17,8 +17,10 @@
*/
package org.apache.sling.installer.hc;
+import java.util.HashMap;
import java.util.Map;
+import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Property;
@@ -33,6 +35,7 @@
import org.apache.sling.installer.api.info.InstallationState;
import org.apache.sling.installer.api.info.Resource;
import org.apache.sling.installer.api.info.ResourceGroup;
+import org.osgi.framework.Version;
import org.osgi.service.cm.ConfigurationAdmin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -64,9 +67,17 @@
@Property(label = "Check Configurations", description = "If enabled configurations are checked (restricted to the ones matching one of the prefixes)", boolValue = true)
static final String PROP_CHECK_CONFIGURATIONS = "checkConfigurations";
+ @Property(label = "Allow not installed artifacts in a group", description="If true there is no warning reported if at least one artifact in the same group (i.e. with the same entity id) is installed matching one of the configured URL prefixes. Otherwise there is a warning for every not installed artifact", boolValue=false)
+ static final String PROP_CHECK_ALLOW_NOT_INSTALLED_ARTIFACTS_IN_GROUP = "allowNotInstalledArtifactsInAGroup";
+
+ @Property(label = "Skip entity ids", description="The given entity ids should be skipped for the health check. Each entry has the format '<entity id> [<version>]", cardinality = 1)
+ static final String PROP_SKIP_ENTITY_IDS = "skipEntityIds";
+
private String[] urlPrefixes;
+ private Map<String, Version> skipEntityIdsWithVersions;
private boolean checkBundles;
private boolean checkConfigurations;
+ private boolean allowNotInstalledArtifactsInAGroup;
private final static String DOCUMENTATION_URL = "https://sling.apache.org/documentation/bundles/osgi-installer.html#health-check";
@@ -79,6 +90,26 @@
new String[] { DEFAULT_URL_PREFIX });
checkBundles = PropertiesUtil.toBoolean(properties.get(PROP_CHECK_BUNDLES), true);
checkConfigurations = PropertiesUtil.toBoolean(properties.get(PROP_CHECK_CONFIGURATIONS), true);
+ allowNotInstalledArtifactsInAGroup = PropertiesUtil.toBoolean(properties.get(PROP_CHECK_ALLOW_NOT_INSTALLED_ARTIFACTS_IN_GROUP), false);
+ skipEntityIdsWithVersions = parseEntityIdsWithVersions(PropertiesUtil.toStringArray(properties.get(PROP_SKIP_ENTITY_IDS), null));
+ }
+
+ private Map<String, Version> parseEntityIdsWithVersions(String[] entityIdsAndVersions) throws IllegalArgumentException {
+ Map<String, Version> entityIdsWithVersions = new HashMap<>();
+ if (entityIdsAndVersions != null) {
+ for (String entityIdAndVersion : entityIdsAndVersions) {
+ String[] parts = entityIdAndVersion.split(" ", 2);
+ final String entityId = parts[0];
+ final Version version;
+ if (parts.length > 1) {
+ version = Version.parseVersion(parts[1]);
+ } else {
+ version = null;
+ }
+ entityIdsWithVersions.put(entityId, version);
+ }
+ }
+ return entityIdsWithVersions;
}
@Override
@@ -86,21 +117,21 @@
InstallationState installationState = infoProvider.getInstallationState();
FormattingResultLog hcLog = new FormattingResultLog();
- int numCheckedConfigurations = 0;
- int numCheckedBundles = 0;
+ int numCheckedConfigurationGroups = 0;
+ int numCheckedBundleGroups = 0;
// go through all resource groups of the OSGi Installer
for (final ResourceGroup group : installationState.getInstalledResources()) {
String type = evaluateGroup(group, hcLog);
switch (type) {
case InstallableResource.TYPE_CONFIG:
- numCheckedConfigurations++;
+ numCheckedConfigurationGroups++;
break;
case InstallableResource.TYPE_BUNDLE:
- numCheckedBundles++;
+ numCheckedBundleGroups++;
break;
}
}
- hcLog.info("Checked {} OSGi bundles and {} configurations.", numCheckedBundles, numCheckedConfigurations);
+ hcLog.info("Checked {} OSGi bundle and {} configuration groups.", numCheckedBundleGroups, numCheckedConfigurationGroups);
if (hcLog.getAggregateStatus().ordinal() >= Result.Status.WARN.ordinal()) {
hcLog.info("Refer to the OSGi installer's documentation page at {} for further details on how to fix those issues.", DOCUMENTATION_URL);
}
@@ -118,6 +149,7 @@
private String evaluateGroup(ResourceGroup group, FormattingResultLog hcLog) {
Resource invalidResource = null;
String resourceType = "";
+ boolean isGroupRelevant = false;
// go through all resources within the given group
for (Resource resource : group.getResources()) {
// check for the correct type
@@ -141,39 +173,60 @@
return "";
}
if (StringUtils.startsWithAny(resource.getURL(), urlPrefixes)) {
+ isGroupRelevant = true;
switch (resource.getState()) {
case IGNORED: // means a considered resource was found and it is invalid
// still the other resources need to be evaluated
case INSTALL:
- if (invalidResource == null) {
- invalidResource = resource;
+ if (!allowNotInstalledArtifactsInAGroup) {
+ reportInvalidResource(resource, resourceType, hcLog);
+ } else {
+ if (invalidResource == null) {
+ invalidResource = resource;
+ }
}
break;
default:
- // means a considered resource was found and it is valid
- // no need to evaluate other resources from this group
- return resourceType;
+ if (allowNotInstalledArtifactsInAGroup) {
+ // means a considered resource was found and it is valid
+ // no need to evaluate other resources from this group
+ return resourceType;
+ }
}
} else {
LOG.debug("Skipping resource '{}' as its URL is not starting with any of these prefixes'{}'", resource,
StringUtils.join(urlPrefixes, ","));
}
}
- if (invalidResource != null) {
- if (resourceType.equals(InstallableResource.TYPE_CONFIG)) {
- hcLog.critical(
- "The installer state of the OSGi configuration resource '{}' is {}, config might have been manually overwritten!",
- invalidResource, invalidResource.getState());
- } else {
- hcLog.critical(
- "The installer state of the OSGi bundle resource '{}' is {}, probably because a later or the same version of that bundle is already installed!",
- invalidResource, invalidResource.getState());
- }
- return resourceType;
- } else {
- return ""; // do not count this group, as only non-considered resources have been in there
+ if (invalidResource != null && allowNotInstalledArtifactsInAGroup) {
+ reportInvalidResource(invalidResource, resourceType, hcLog);
}
+ // only return resource type if at least one resource in it belonged to a covered url prefix
+ return isGroupRelevant ? resourceType : "";
}
+ private void reportInvalidResource(Resource invalidResource, String resourceType, FormattingResultLog hcLog) {
+ if (skipEntityIdsWithVersions.containsKey(invalidResource.getEntityId())) {
+ Version version = skipEntityIdsWithVersions.get(invalidResource.getEntityId());
+ if (version != null) {
+ if (version.equals(invalidResource.getVersion())) {
+ LOG.debug("Skipping not installed resource '{}' as its entity id and version is in the skip list", invalidResource);
+ return;
+ }
+ } else {
+ LOG.debug("Skipping not installed resource '{}' as its entity id is in the skip list", invalidResource);
+ return;
+ }
+ }
+ if (resourceType.equals(InstallableResource.TYPE_CONFIG)) {
+ hcLog.critical(
+ "The installer state of the OSGi configuration resource '{}' is {}, config might have been manually overwritten!",
+ invalidResource, invalidResource.getState());
+ } else {
+ hcLog.critical(
+ "The installer state of the OSGi bundle resource '{}' is {}, probably because a later or the same version of that bundle is already installed!",
+ invalidResource, invalidResource.getState());
+ }
+ }
}
