Skip to content

[artifact-manager] (#669) Fix failure during pull of vROPs Policies #678

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

Merged
VenelinBakalov merged 14 commits into from
Apr 24, 2025
Merged

[artifact-manager] (#669) Fix failure during pull of vROPs Policies #678

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
73d5ae8
[Task 669] fix: Fixed problem with exporting policies due to missing …
Mar 27, 2025
7650c0b
[Task 669] fix: Fixed linter issues.
Mar 27, 2025
b434a24
[Task 669] fix: Fixed formatting.
Mar 28, 2025
2371ef4
[Task 669] merge: Merged with main.
Apr 7, 2025
fbec6a8
[Task 669] fix: Fixed linter issues.
Apr 7, 2025
20636d3
[Task 669] merge: Merged with main.
Apr 7, 2025
53af19f
[Task 669] merge: merge with main.
Apr 10, 2025
ca408c5
[Task 669] merge: merge with main.
Apr 14, 2025
7f8769d
[Task 669] merge: merge with main.
Apr 15, 2025
5a5d885
[Task 669] merge: merge with main.
Apr 22, 2025
56f46ae
Merge branch 'main' into fix/669-vrops-pull-policy-failure
VenelinBakalov Apr 23, 2025
12389cf
Merge branch 'main' into fix/669-vrops-pull-policy-failure
VenelinBakalov Apr 24, 2025
2b9c43a
[Task 669] docs: Fixed release file.
Apr 24, 2025
365c1a1
[Task 669] merge: Merged from main.
Apr 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
57 changes: 45 additions & 12 deletions ...rc/main/java/com/vmware/pscoe/iac/artifact/aria/operations/models/CustomGroupTypeDTO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,55 @@
*/
package com.vmware.pscoe.iac.artifact.aria.operations.models;

import java.util.LinkedHashMap;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

@JsonPropertyOrder({ "name" })
public class CustomGroupTypeDTO {
@JsonPropertyOrder({"name", "key"})
@JsonInclude(JsonInclude.Include.NON_NULL)
public final class CustomGroupTypeDTO {

@JsonProperty("name")
private String name;
@JsonProperty("name")
private String name;

@JsonProperty("name")
public String getName() {
return name;
}
@JsonProperty("key")
private String key;

@JsonProperty("name")
public void setName(String name) {
this.name = name;
}
@JsonIgnore
private Map<String, Object> additionalProperties = new LinkedHashMap<String, Object>();

@JsonProperty("name")
public String getName() {
return name;
}

@JsonProperty("name")
public void setName(String name) {
this.name = name;
}

@JsonProperty("key")
public String getKey() {
return key;
}

@JsonProperty("key")
public void setKey(String key) {
this.key = key;
}

@JsonAnyGetter
public Map<String, Object> getAdditionalProperties() {
return this.additionalProperties;
}

@JsonAnySetter
public void setAdditionalProperty(String name, Object value) {
this.additionalProperties.put(name, value);
}
}
98 changes: 42 additions & 56 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 @@ -54,6 +54,7 @@
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.Strictness;
import com.jayway.jsonpath.JsonPath;
import com.vmware.pscoe.iac.artifact.configuration.Configuration;
import com.vmware.pscoe.iac.artifact.aria.operations.configuration.ConfigurationVrops;
Expand Down Expand Up @@ -505,13 +506,12 @@ public void setPolicyPriorities(final List<String> policies) throws Exception {
}

logger.info("Ordering policies by priority '{}'", this.concatenateList(policyNames, ", "));
Gson gson = new GsonBuilder().setLenient().create();
Gson gson = new GsonBuilder().setStrictness(Strictness.LENIENT).create();
try {
UriComponentsBuilder uriBuilder = UriComponentsBuilder
.fromUri(new URI(getURIBuilder().setPath(POLICY_PRIORITY_PUBLIC_API).toString()));
UriComponentsBuilder uriBuilder = UriComponentsBuilder.fromUri(new URI(getURIBuilder().setPath(POLICY_PRIORITY_PUBLIC_API).toString()));
URI restUri = uriBuilder.build().toUri();
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
Map<String, List<String>> parameters = new HashMap<String, List<String>>();
List<String> mergedPolicyIds = policyIds;
// in order priority list to work properly preserve the current ordering for the
Expand Down Expand Up @@ -579,7 +579,7 @@ public List<PolicyDTO.Policy> exportPoliciesFromVrops(List<String> policyEntries
*/
public List<PolicyDTO.Policy> getAllPolicies() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);

// older vROPs versions use internal API for policies, thus internal header
// needs to be set.
Expand Down Expand Up @@ -677,7 +677,7 @@ public PolicyDTO.Policy getPolicyContent(PolicyDTO.Policy policy) {
public void applyPolicyToCustomGroups(PolicyDTO.Policy policy, List<CustomGroupDTO.Group> groups) {
UriComponentsBuilder uriBuilder;
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);

// for newer vROPs versions the policies API is no longer internal.
if (this.isVersionAbove812()) {
Expand Down Expand Up @@ -763,7 +763,7 @@ public String exportDefinitionFromVrops(String definitionName, VropsPackageMembe
URI restUri = getDefinitionUri(definitionType, definitionId);

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response = new ResponseEntity<String>(HttpStatus.OK);
try {
Expand Down Expand Up @@ -795,7 +795,7 @@ public Object exportDefinitionsFromVrops(VropsPackageMemberType definitionType)
URI restUri = getDefinitionUri(definitionType);

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response = new ResponseEntity<String>(HttpStatus.OK);
try {
Expand Down Expand Up @@ -846,10 +846,8 @@ public void importDefinitionsInVrops(Map<String, Object> definitions, VropsPacka
*
* @param customGroupName - the custom group name.
* @param customGroupPayload - the payload of the custom group as json.
* @param policyIdMap - the policy mappings.
*/
public void importCustomGroupInVrops(String customGroupName, String customGroupPayload,
Map<String, String> policyIdMap) {
public void importCustomGroupInVrops(String customGroupName, String customGroupPayload) {
if (StringUtils.isEmpty(customGroupPayload)) {
return;
}
Expand All @@ -858,17 +856,22 @@ public void importCustomGroupInVrops(String customGroupName, String customGroupP
HttpMethod method = customGroupExists(customGroupPayload) ? HttpMethod.PUT : HttpMethod.POST;
CustomGroupDTO.Group customGroup = serializeCustomGroup(customGroupPayload);

// resolve the policy id from the name
PolicyDTO.Policy policy = this.findPolicyByName(customGroup.getPolicy());
customGroup.setPolicy(policy.getId());

// vROPs requires the group type to exists prior to creating
createMissingGroupTypes(customGroup);

customGroupPayload = deserializeCustomGroup(customGroup);
// vROPs requires the group id to be set to null prior creating it
if (HttpMethod.POST.equals(method)) {
customGroupPayload = setCustomGroupIdToNull(customGroupPayload);
} else {
customGroupPayload = updateCustomGroupId(serializeCustomGroup(customGroupPayload), customGroupPayload);
}

headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(customGroupPayload, headers);
ResponseEntity<String> response = new ResponseEntity<String>(HttpStatus.OK);
try {
Expand Down Expand Up @@ -910,7 +913,7 @@ public void importCustomGroupInVrops(String customGroupName, String customGroupP
// Update policy for the custom group (if any)
// Note: due to bug in the API of vROPs the updating for the policy of
// a custom group should be done via separate call to the vROPs public API
updateCustomGroupPolicy(customGroupPayload, policyIdMap);
updateCustomGroupPolicy(customGroupPayload, policy);
}

/**
Expand Down Expand Up @@ -943,7 +946,7 @@ public void createMissingGroupTypes(CustomGroupDTO.Group customGroup) {
public void createCustomGroupType(String customGroupType) {
logger.info(String.format("Custom group type doesn't exist. Creating custom group type '%s'", customGroupType));
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
CustomGroupTypeDTO customGroupTypeDto = new CustomGroupTypeDTO();
customGroupTypeDto.setName(customGroupType);
String customGroupTypePayload = deserializeCustomGroupType(customGroupTypeDto);
Expand Down Expand Up @@ -1013,7 +1016,7 @@ public ResourcesDTO getResourcesPerAdapterType(final String adapterType) {
*/
public ResourcesDTO getResourcesPerAdapterType(final String adapterType, final Long page) {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response = new ResponseEntity<String>(HttpStatus.OK);
String endpointName = String.format(RESOURCES_LIST_PER_ADAPTER_KIND, adapterType);
Expand Down Expand Up @@ -1090,7 +1093,7 @@ public ResourcesDTO getResources() {
*/
public ResourcesDTO getResources(final Long page) {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response = new ResponseEntity<String>(HttpStatus.OK);
try {
Expand Down Expand Up @@ -1131,7 +1134,7 @@ public ResourcesDTO getResources(final Long page) {
*/
public SupermetricDTO getAllSupermetrics() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response = new ResponseEntity<String>(HttpStatus.OK);
SupermetricDTO retVal = new SupermetricDTO();
Expand Down Expand Up @@ -1178,7 +1181,7 @@ public SupermetricDTO getAllSupermetrics() {
*/
public ViewDefinitionDTO getAllViewDefinitions() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
// Required header for internal API
headers.set(INTERNAL_API_HEADER_NAME, Boolean.TRUE.toString());
HttpEntity<String> entity = new HttpEntity<>(headers);
Expand Down Expand Up @@ -1223,7 +1226,7 @@ public ViewDefinitionDTO getAllViewDefinitions() {
*/
public ReportDefinitionDTO getAllReportDefinitions() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response;
ReportDefinitionDTO retVal = new ReportDefinitionDTO();
Expand Down Expand Up @@ -1271,7 +1274,7 @@ public ReportDefinitionDTO getAllReportDefinitions() {
*/
public List<AuthGroupDTO> findAllAuthGroups() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response;
List<AuthGroupDTO> retVal = new ArrayList<>();
Expand Down Expand Up @@ -1312,7 +1315,7 @@ public List<AuthGroupDTO> findAllAuthGroups() {
*/
public List<AuthUserDTO> findAllAuthUsers() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response;
List<AuthUserDTO> retVal = new ArrayList<>();
Expand Down Expand Up @@ -1444,10 +1447,10 @@ private List<PolicyDTO.Policy> filterPoliciesByName(List<String> policyEntries)
/**
* Update policy for custom group.
*
* @param customGroupPayload
* @param policyIdMap
* @param customGroupPayload - JSON string of the custom group payload.
* @param policy - policy that will be applied to the custom group.
*/
private void updateCustomGroupPolicy(String customGroupPayload, Map<String, String> policyIdMap) {
private void updateCustomGroupPolicy(String customGroupPayload, PolicyDTO.Policy policy) {
CustomGroupDTO.Group customGroup = serializeCustomGroup(customGroupPayload);
if (customGroup == null) {
return;
Expand All @@ -1459,44 +1462,28 @@ private void updateCustomGroupPolicy(String customGroupPayload, Map<String, Stri
}

String customGroupName = customGroup.getResourceKey().getName();
// throw an exception if the custom group has a policy but it cannot be found in
// the mapping data
if (!policyIdMap.containsKey(policyId)) {
throw new RuntimeException(
String.format("The policy for custom group '%s' could not be found in the policy metadata file",
customGroupName));
}

// find the custom group in the target system
customGroup = findCustomGroupByName(customGroupName);
if (customGroup == null) {
throw new RuntimeException(
String.format("Custom group '%s' cannot be found on the target system", customGroupName));
throw new RuntimeException(String.format("Custom group '%s' cannot be found on the target system", customGroupName));
}

// find policy in the target system
String policyName = policyIdMap.get(policyId);
PolicyDTO.Policy policy = findPolicyByName(policyName);
customGroup.setPolicy(policy.getId());

// prepare rest call payload
customGroupPayload = deserializeCustomGroup(customGroup);

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(customGroupPayload, headers);
ResponseEntity<String> responseEntity;
logger.info("Setting policy for custom group '{}' to '{}'", customGroupName, policyName);
logger.info("Setting policy for custom group '{}' to '{}'", customGroupName, policy.getName());
try {
URI restUri = new URI(getURIBuilder().setPath(CUSTOM_GROUPS_UPDATE_API).toString());
responseEntity = restTemplate.exchange(restUri, HttpMethod.PUT, entity, String.class);
} catch (RestClientException e) {
throw new RuntimeException(String.format("Unable to update policy for custom group '%s' : %s",
customGroupName, e.getMessage()), e);
throw new RuntimeException(String.format("Unable to update policy for custom group '%s' : %s", customGroupName, e.getMessage()), e);
} catch (URISyntaxException e) {
throw new RuntimeException(
String.format("Unable to determine REST endpoint for updating policy for custom group '%s' : %s",
customGroupName, e.getMessage()),
String.format("Unable to determine REST endpoint for updating policy for custom group '%s' : %s", customGroupName, e.getMessage()),
e);
}

Expand Down Expand Up @@ -1639,7 +1626,7 @@ private boolean customGroupExists(String customGroupPayload) {
private List<CustomGroupDTO.Group> findCustomGroupsByNames(List<String> customGroupNames) {
List<CustomGroupDTO.Group> retVal = new ArrayList<>();
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response = new ResponseEntity<>(HttpStatus.OK);
String groupInfo = customGroupNames != null && !customGroupNames.isEmpty()
Expand Down Expand Up @@ -1751,7 +1738,7 @@ private void importDefinitionToVrops(Object definition, VropsPackageMemberType d
}

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(definitionPayload, headers);
ResponseEntity<String> responseEntity = new ResponseEntity<>(HttpStatus.OK);
String definitionName = getDefinitionName(definition, definitionType);
Expand Down Expand Up @@ -2012,7 +1999,7 @@ private AdapterKindDTO getAllAdapterKindData() {
throw new RuntimeException(e);
}
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);

ResponseEntity<String> response;
Expand Down Expand Up @@ -2041,7 +2028,7 @@ private AdapterKindDTO getAllAdapterKindData() {

private ResourcesDTO.PageInfo getResourcePerAdapterKindPageInfo(String adapterKind) {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response;
String endpointName = String.format(RESOURCES_LIST_PER_ADAPTER_KIND, adapterKind);
Expand Down Expand Up @@ -2087,7 +2074,7 @@ private ResourcesDTO.PageInfo getResourcePerAdapterKindPageInfo(String adapterKi

private ResourcesDTO.PageInfo getResourcePageInfo() {
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<String> response;
try {
Expand Down Expand Up @@ -2136,16 +2123,15 @@ private boolean resourceKindExists(String resourceKindKey, String adapterKindKey
}

// get all resource kinds on the target system
ResourceKindDTO resourceKindObject = getAllResourceKinds(adapterKindKey);
ResourceKindDTO resourceKindObject = getResourceKindsPerAdapterKind(adapterKindKey);
if (resourceKindObject == null) {
return false;
}

return resourceKindObject.getResourceKind().stream()
.anyMatch(item -> resourceKindKey.equalsIgnoreCase(item.getKey()));
return resourceKindObject.getResourceKind().stream().anyMatch(item -> resourceKindKey.equalsIgnoreCase(item.getKey()));
}

private ResourceKindDTO getAllResourceKinds(String adapterKindKey) {
private ResourceKindDTO getResourceKindsPerAdapterKind(String adapterKindKey) {
if (StringUtils.isEmpty(adapterKindKey)) {
return new ResourceKindDTO();
}
Expand All @@ -2159,7 +2145,7 @@ private ResourceKindDTO getAllResourceKinds(String adapterKindKey) {
throw new RuntimeException(e);
}
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);

ResponseEntity<String> response;
Expand Down Expand Up @@ -2349,7 +2335,7 @@ private String getDefinitionIdByName(String definitionName, VropsPackageMemberTy
throw new RuntimeException(e);
}
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<String> entity = new HttpEntity<>(headers);

ResponseEntity<String> response;
Expand Down
Loading
Loading