Skip to content

[artifact-manager] (#898) Fix push of vROps policies #911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stanislav-skkolev-spec wants to merge 13 commits into
base: main
Choose a base branch
from
Open

[artifact-manager] (#898) Fix push of vROps policies #911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3286b72
initial preparations
Oct 10, 2025
24fca7a
added XmlUtilities
Oct 13, 2025
43035cc
prepared for testing on customer env
Oct 13, 2025
de6c36a
added check for missing policies dependencies
Oct 21, 2025
9000729
comparison improved
Oct 23, 2025
52e1cbe
Merge branch 'main' into fix/898-push-vrops-policies
Oct 23, 2025
ced0f15
fixed Linter suggestions
Oct 23, 2025
5007320
fixed Linter errors
Oct 23, 2025
16f05fa
added Readme.md
Oct 23, 2025
eac90fc
fixed linter errors
Oct 23, 2025
0fddd50
removed 4.15.0 folder
Oct 24, 2025
2310f21
added Javadocs + minor fixes
Oct 24, 2025
0b1a576
Merge branch 'main' into fix/898-push-vrops-policies
VenelinBakalov Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions ...ger/src/main/java/com/vmware/pscoe/iac/artifact/aria/operations/rest/RestClientVrops.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
import com.vmware.pscoe.iac.artifact.aria.operations.models.AlertDefinitionDTO;
import com.vmware.pscoe.iac.artifact.aria.operations.models.AlertDefinitionDTO.AlertDefinition.State;
import com.vmware.pscoe.iac.artifact.aria.operations.models.AlertDefinitionDTO.AlertDefinition.SymptomSet;
import com.vmware.pscoe.iac.artifact.aria.operations.models.SupermetricDTO.SuperMetric;
import com.vmware.pscoe.iac.artifact.aria.operations.models.AuthGroupDTO;
import com.vmware.pscoe.iac.artifact.aria.operations.models.AuthGroupsDTO;
import com.vmware.pscoe.iac.artifact.aria.operations.models.AuthUserDTO;
Expand Down Expand Up @@ -99,10 +100,18 @@ public class RestClientVrops extends RestClient {
* ALERT_DEFS_API.
*/
private static final String ALERT_DEFS_API = PUBLIC_API_PREFIX + "alertdefinitions/";
/**
* GET_ALL_ALERT_DEFS_API.
*/
private static final String GET_ALL_ALERT_DEFS_API = PUBLIC_API_PREFIX + "alertdefinitions";
/**
* SYMPTOM_DEFS_API.
*/
private static final String SYMPTOM_DEFS_API = PUBLIC_API_PREFIX + "symptomdefinitions/";
/**
* GET_ALL_SYMPTOM_DEFS_API.
*/
private static final String GET_ALL_SYMPTOM_DEFS_API = PUBLIC_API_PREFIX + "symptomdefinitions";
/**
* POLICIES_API.
*/
Expand Down Expand Up @@ -151,6 +160,10 @@ public class RestClientVrops extends RestClient {
* RECOMMENDATIONS_API.
*/
private static final String RECOMMENDATIONS_API = PUBLIC_API_PREFIX + "recommendations/";
/**
* GET_ALL_RECOMMENDATIONS_API.
*/
private static final String GET_ALL_RECOMMENDATIONS_API = PUBLIC_API_PREFIX + "recommendations";
/**
* RESOURCES_API.
*/
Expand Down Expand Up @@ -726,6 +739,74 @@ public void applyPolicyToCustomGroups(PolicyDTO.Policy policy, List<CustomGroupD
}
}

/**
* Reads all definition entities entities of sepcified type
* @param definitionType the type of definition about to be read from vROps
* @return list of the definitions
*/
public List<?> getAllDefinitionsOfType(VropsPackageMemberType definitionType) {

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

// older vROPs versions use internal API for policies, thus internal header
// needs to be set.
if (!this.isVersionAbove812()) {
headers.set(INTERNAL_API_HEADER_NAME, Boolean.TRUE.toString());
}
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response = new ResponseEntity<String>(HttpStatus.OK);

String url = "";
switch (definitionType) {
case ALERT_DEFINITION:
url = GET_ALL_ALERT_DEFS_API;
break;
case SYMPTOM_DEFINITION:
url = GET_ALL_SYMPTOM_DEFS_API;
break;
case RECOMMENDATION:
url = GET_ALL_RECOMMENDATIONS_API;
break;
default:
throw new RuntimeException("Unknown definition type used");
}

try {
UriComponentsBuilder uriBuilder;

uriBuilder = UriComponentsBuilder.fromUri(getURI(getURIBuilder().setPath(url)));
uriBuilder.queryParam("pageSize", DEFAULT_PAGE_SIZE);
URI restUri = uriBuilder.build().toUri();
response = restTemplate.exchange(restUri, HttpMethod.GET, entity, String.class);
} catch (HttpClientErrorException e) {
if (HttpStatus.NOT_FOUND.equals(e.getStatusCode())) {
return new ArrayList<>();
}
throw new RuntimeException(
String.format("HTTP error ocurred trying to fetching definitions of type %s. Message: %s, Server error: %s",
definitionType.toString(), e.getMessage(), e.getStatusText()));
} catch (Exception e) {
throw new RuntimeException(
String.format("General error while fetching definitions of type %s. Message: %s, Server error: %s",
definitionType.toString(), e.getMessage(), response.getBody()));
}

switch (definitionType) {
case ALERT_DEFINITION:
AlertDefinitionDTO alarmDefinitionDTO = (AlertDefinitionDTO) deserializeDefinitions(definitionType, response.getBody());
return alarmDefinitionDTO.getAlertDefinitions();
case SYMPTOM_DEFINITION:
SymptomDefinitionDTO symptomDefinitionDTO = (SymptomDefinitionDTO) deserializeDefinitions(definitionType, response.getBody());
return symptomDefinitionDTO.getSymptomDefinitions();
case RECOMMENDATION:
RecommendationDTO recommendationDTO = (RecommendationDTO) deserializeDefinitions(definitionType, response.getBody());
return recommendationDTO.getRecommendations();
default:
return new ArrayList<>();
}
}

/**
* Export custom groups filtered by list of custom group names.
*
Expand Down Expand Up @@ -1175,6 +1256,14 @@ public SupermetricDTO getAllSupermetrics() {
return retVal;
}

/**
* Imports all Supermetrics specified in the content.yaml
*/
public void importSupermetrics() {

List<SuperMetric> existingSupermetrics = getAllSupermetrics().getSuperMetrics();
}

/**
* Get all vROPs view definitions.
*
Expand Down
215 changes: 190 additions & 25 deletions .../src/main/java/com/vmware/pscoe/iac/artifact/aria/operations/store/VropsPackageStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.FileSystemUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
Expand All @@ -71,7 +72,11 @@
import com.vmware.pscoe.iac.artifact.aria.operations.models.ReportDefinitionDTO;
import com.vmware.pscoe.iac.artifact.aria.operations.models.SupermetricDTO;
import com.vmware.pscoe.iac.artifact.aria.operations.models.SymptomDefinitionDTO;
import com.vmware.pscoe.iac.artifact.aria.operations.models.SymptomDefinitionDTO.SymptomDefinition;
import com.vmware.pscoe.iac.artifact.aria.operations.models.ViewDefinitionDTO;
import com.vmware.pscoe.iac.artifact.aria.operations.models.AlertDefinitionDTO.AlertDefinition;
import com.vmware.pscoe.iac.artifact.aria.operations.models.PolicyDTO.Policy;
import com.vmware.pscoe.iac.artifact.aria.operations.models.RecommendationDTO.Recommendation;
import com.vmware.pscoe.iac.artifact.aria.operations.rest.RestClientVrops;
import com.vmware.pscoe.iac.artifact.aria.operations.store.models.VropsPackageDescriptor;
import com.vmware.pscoe.iac.artifact.aria.operations.store.models.VropsPackageMemberType;
Expand All @@ -83,6 +88,7 @@
import com.vmware.pscoe.iac.artifact.common.store.Version;
import com.vmware.pscoe.iac.artifact.common.store.models.PackageContent;
import com.vmware.pscoe.iac.artifact.common.store.models.PackageContent.Content;
import com.vmware.pscoe.iac.artifact.common.utils.XmlUtilities;
import com.vmware.pscoe.iac.artifact.common.utils.ZipUtilities;

/**
Expand Down Expand Up @@ -1139,6 +1145,148 @@ private String readCustomGroupFile(final File customGroupFile) throws IOExceptio
}
}


/**
* Sets the ids of the policy to be equal to the ids on the server to be pushed
* @param policy zip file with the policy
* @param allPolicies all policies read from the server
* @return new .zip file with adjusted ids
*/
private File setPolicyIds(final File policy, List<Policy> allPolicies) {
String path = policy.getParent().toString();
String fullPath = policy.getPath();
try {
logger.info("Unzipping file " + policy.getName());
File pathForUnzipping = new File(path);
ZipUtilities.unzip(policy, pathForUnzipping);
File exportedPoliciesXml = new File(path + "/exportedPolicies.xml");
String exportedPoliciesXmlContent = XmlUtilities.readXmlFileAsString(exportedPoliciesXml);
exportedPoliciesXmlContent = exportedPoliciesXmlContent.replace("><PolicyContent>", ">\n<PolicyContent>");
XmlUtilities.writeToXmlFile(exportedPoliciesXml, exportedPoliciesXmlContent);
Element document = XmlUtilities.initializeXmlFile(exportedPoliciesXml);
Node policyTag = XmlUtilities.findTagInXmlDocument(document, "Policies");
NodeList policies = policyTag.getChildNodes();

HashMap<String, HashMap<String, String>> values = new HashMap<>();
List<Element> policyElements = new ArrayList<>();

for (int i = 0; i < policies.getLength(); i++) {
Node node = policies.item(i);
if (node.getNodeType() == Node.ELEMENT_NODE) {
Element element = (Element) policies.item(i);
policyElements.add(element);
}
}

for (int i = 0; i < policyElements.size(); i++) {
Element policyElement = policyElements.get(i);
String policyName = policyElement.getAttribute("name");
HashMap<String, String> childMap = new HashMap<>();
Optional<Policy> currentPolicy = allPolicies.stream().filter(pol -> pol.getName().equals(policyElement.getAttribute("name"))).findAny();
Copy link
Collaborator

@VenelinBakalov VenelinBakalov Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What amount of policies do we expect here? I am wondering if it makes sense to convert this to a map and use the name or id for key so we can reduce the filtering operations in case we expect a big list.

Copy link
Author

@stanislav-skkolev-spec stanislav-skkolev-spec Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What amount of policies do we expect here? I am wondering if it makes sense to convert this to a map and use the name or id for key so we can reduce the filtering operations in case we expect a big list.

From what I have saw they are not that many.

Copy link
Contributor

@akantchev akantchev Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Map also would make sure no duplicate policy ids are present in the zip.

if (currentPolicy.isPresent()) {
childMap.put("key", currentPolicy.get().getId());
} else {
childMap.put("key", policyElement.getAttribute("key"));
}
if (policyElement.hasAttribute("parentPolicy")) {
String parentPolicyId = policyElement.getAttribute("parentPolicy");
Optional<Element> parentPolicyElement = policyElements.stream().filter(el -> el.getAttribute("key").equals(parentPolicyId)).findAny();
String parentPolicyName = parentPolicyElement.get().getAttribute("name");
Optional<Policy> parentPolicy = allPolicies.stream().filter(pol -> pol.getName().equals(parentPolicyName)).findAny();
if (parentPolicy.isPresent()) {
childMap.put("parentPolicy", parentPolicy.get().getId());
} else {
childMap.put("parentPolicy", parentPolicyId);
}
}
values.put(policyName, childMap);
}
XmlUtilities.setAttributesInXmlFile(exportedPoliciesXml, "Policies", values);
FileSystemUtils.deleteRecursively(policy);
ZipUtilities.zip(exportedPoliciesXml, fullPath);
FileSystemUtils.deleteRecursively(exportedPoliciesXml);
return new File(fullPath);
} catch (IOException e) {
throw new RuntimeException(String.format("An error occurred while setting the ids of policy %s : %s %n", policy.getName(),
e.getMessage()));
}
}

/**
* Checking the target system for missing alert definitions, symptom definitions and recommendations.
* It compares it with the alert definitions, symptom definitions and recommendations of the policy
* @param policy The policy .zip file
* @param alertIds The ids of all the alert definitions on the target system
* @param symptomIds The ids of all the symptom definitions on the target system
* @param recommendationsIds The ids of all the recommendations on the target system
*/
private void checkPolicyForMissingComponents(File policy, List<String> alertIds, List<String> symptomIds, List<String> recommendationsIds) {

String path = policy.getParent().toString();
try {
logger.info("Unzipping file " + policy.getName());
File pathForUnzipping = new File(path);
ZipUtilities.unzip(policy, pathForUnzipping);
File exportedPoliciesXml = new File(path + "/exportedPolicies.xml");
String exportedPoliciesXmlContent = XmlUtilities.readXmlFileAsString(exportedPoliciesXml);
exportedPoliciesXmlContent = exportedPoliciesXmlContent.replace("><PolicyContent>", ">\n<PolicyContent>");
Element document = XmlUtilities.initializeXmlFile(exportedPoliciesXml);

List<Element> alertDefinitions = XmlUtilities.getAllTagsWithAttributes(document, "AlertDefinition");
List<Element> missingAlerts = alertDefinitions.stream().filter(alert -> alertIds.indexOf(alert.getAttribute("id")) == -1).collect(Collectors.toList());

List<Element> symptomDefinitions = XmlUtilities.getAllTagsWithAttributes(document, "SymptomDefinition");
List<Element> missingSymptoms = symptomDefinitions.stream().filter(symp -> symptomIds.indexOf(symp.getAttribute("id")) == -1).collect(Collectors.toList());

List<Element> recommendations = XmlUtilities.getAllTagsWithAttribute(document, "Recommendation", "key");
List<Element> missingReccoms = recommendations.stream().filter(rec -> recommendationsIds.indexOf(rec.getAttribute("key")) == -1).collect(Collectors.toList());

FileSystemUtils.deleteRecursively(exportedPoliciesXml);

if (missingAlerts.size() > 0 || missingSymptoms.size() > 0 || missingReccoms.size() > 0) {

logger.info("Policy '" + policy.getName() + "' has missing dependencies");
logger.info("Total missing alert definitions: " + missingAlerts.size());
logger.info("Total missing symptom definitions: " + missingSymptoms.size());
logger.info("Total missing recommendations: " + missingReccoms.size());
String errorMessage = "";
String allMissingAlerts = missingAlerts.size() > 0 ? missingAlerts.stream()
.map(alert -> alert.getAttribute("name"))
.reduce((a, b) -> String.format("%s\n%s", a, b)).get() : "";
String allMissingSymptoms = missingSymptoms.size() > 0 ? missingSymptoms.stream()
.map(symp -> symp.getAttribute("name"))
.reduce((a, b) -> String.format("%s\n%s", a, b)).get() : "";
String allMissingReccoms = missingReccoms.size() > 0 ? missingReccoms.stream()
.map(recomm -> {
Node description = recomm.getFirstChild().getNextSibling();
if (description != null) {
return description.getTextContent();
} else {
return "";
}
})
.reduce((a, b) -> String.format("%s\n%s", a, b)).get() : "";

if (missingAlerts.size() > 0) {
errorMessage = String.format("\nthe following alert definitions:\n%s", allMissingAlerts);
}

if (missingSymptoms.size() > 0) {
errorMessage += String.format("\nthe following symptom definitions:\n%s", allMissingSymptoms);
}
if (missingReccoms.size() > 0) {
errorMessage += String.format("\nthe following recommendations:\n%s", allMissingReccoms);
}
throw new RuntimeException(String.format("Policy with name '%s' is missing the following entities on the target system:%s", policy.getName(), errorMessage));
}


} catch (IOException e) {
throw new RuntimeException(String.format("An error occurred while deleting the disabled items from policy '%s'. Reason: %n", policy.getName(),
e.getMessage()));
}
}

/**
* Import policies to vROPs.
*
Expand All @@ -1147,6 +1295,22 @@ private String readCustomGroupFile(final File customGroupFile) throws IOExceptio
* @throws RuntimeException if the polices cannot be imported.
*/
private void importPolicies(final Package vropsPackage, final File tmpDir) {

List<AlertDefinition> alertDefinitions = restClient.getAllDefinitionsOfType(VropsPackageMemberType.ALERT_DEFINITION)
.stream()
.map(AlertDefinitionDTO.AlertDefinition.class::cast)
.collect(Collectors.toList());
List<String> alertIds = alertDefinitions.stream().map(alert -> alert.getId()).toList();
List<SymptomDefinition> sympAlertDefinitions = restClient.getAllDefinitionsOfType(VropsPackageMemberType.SYMPTOM_DEFINITION)
.stream()
.map(SymptomDefinitionDTO.SymptomDefinition.class::cast)
.collect(Collectors.toList());
List<String> symptomIds = sympAlertDefinitions.stream().map(symp -> symp.getId()).toList();
List<Recommendation> recommendations = restClient.getAllDefinitionsOfType(VropsPackageMemberType.RECOMMENDATION)
.stream()
.map(RecommendationDTO.Recommendation.class::cast)
.collect(Collectors.toList());
List<String> recommIds = recommendations.stream().map(rec -> rec.getId()).toList();
File policiesDir = new File(tmpDir.getPath(), "policies");
if (!policiesDir.exists()) {
return;
Expand All @@ -1156,6 +1320,8 @@ private void importPolicies(final Package vropsPackage, final File tmpDir) {
for (File policy : FileUtils.listFiles(policiesDir, new String[] { "zip" }, Boolean.FALSE)) {
String policyName = FilenameUtils.removeExtension(policy.getName());
try {
logger.info("Checking for missing dependencies for policy: '{}'", policyName);
checkPolicyForMissingComponents(policy, alertIds, symptomIds, recommIds);
logger.info("Importing policy: '{}'", policyName);
restClient.importPolicyFromZip(policyName, policy, Boolean.TRUE);
logger.info("Imported policy: '{}'", policyName);
Expand Down Expand Up @@ -1607,31 +1773,30 @@ public Package importPackage(final Package pkg, final boolean dryrun, final bool

try {
new PackageManager(pkg).unpack(tmpDir);

addViewToImportList(pkg, tmpDir);
addDashboardToImportList(pkg, tmpDir);
addReportToImportList(pkg, tmpDir);
addSuperMetricToImportList(pkg, tmpDir);
addMetricConfigToImportList(pkg, tmpDir);

if (cliManager.hasAnyCommands()) {
cliManager.connect();
cliManager.importFilesToVrops();
}

importDefinitions(pkg, tmpDir);
importPolicies(pkg, tmpDir);
importCustomGroups(pkg, tmpDir);
// manage dashboard sharing per groups
manageDashboardSharing(tmpDir);
// manage dashboard activation per groups
manageDashboardActivation(tmpDir, true);
// manage dashboard activation per users
manageDashboardActivation(tmpDir, false);
// set default policy after importing policies
setDefaultPolicy(pkg, tmpDir);
// set policy priorities
setPolicyPriorities(pkg, tmpDir);
addViewToImportList(pkg, tmpDir);
addDashboardToImportList(pkg, tmpDir);
addReportToImportList(pkg, tmpDir);
addSuperMetricToImportList(pkg, tmpDir);
addMetricConfigToImportList(pkg, tmpDir);

if (cliManager.hasAnyCommands()) {
cliManager.connect();
cliManager.importFilesToVrops();
}

importDefinitions(pkg, tmpDir);
importPolicies(pkg, tmpDir);
importCustomGroups(pkg, tmpDir);
// manage dashboard sharing per groups
manageDashboardSharing(tmpDir);
// manage dashboard activation per groups
manageDashboardActivation(tmpDir, true);
// manage dashboard activation per users
manageDashboardActivation(tmpDir, false);
// set default policy after importing policies
setDefaultPolicy(pkg, tmpDir);
// set policy priorities
setPolicyPriorities(pkg, tmpDir);
} catch (IOException | JSchException | ConfigurationException e) {
String message = String.format("Unable to push package '%s' to vROps Server '%s' : %s : %s",
pkg.getFQName(), cliManager, e.getClass().getName(),
Expand Down
Loading
Loading