api,server,ui: allow updating computeoffering external details

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Author: shwstppr

api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java

@@ -267,7 +267,7 @@ public class CreateServiceOfferingCmd extends BaseCmd {
             type = CommandType.MAP,
             description = "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue",
             since = "4.21.0")
-    protected Map externalDetails;
+    private Map externalDetails;
 
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////

api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateServiceOfferingCmd.java

@@ -18,6 +18,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 import com.cloud.offering.ServiceOffering.State;
 import org.apache.cloudstack.api.APICommand;
@@ -94,6 +95,12 @@ public class UpdateServiceOfferingCmd extends BaseCmd {
             since="4.20")
     private Boolean purgeResources;
 
+    @Parameter(name = ApiConstants.EXTERNAL_DETAILS,
+            type = CommandType.MAP,
+            description = "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue",
+            since = "4.21.0")
+    private Map externalDetails;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -194,6 +201,10 @@ public boolean isPurgeResources() {
         return Boolean.TRUE.equals(purgeResources);
     }
 
+    public Map<String, String> getExternalDetails() {
+        return convertExternalDetailsToMap(externalDetails);
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java

@@ -304,6 +304,7 @@
 import com.cloud.utils.net.NetUtils;
 import com.cloud.vm.NicIpAlias;
 import com.cloud.vm.VirtualMachine;
+import com.cloud.vm.VmDetailConstants;
 import com.cloud.vm.dao.NicIpAliasDao;
 import com.cloud.vm.dao.NicIpAliasVO;
 import com.cloud.vm.dao.VMInstanceDao;
@@ -3752,6 +3753,30 @@ private void setBytesRate(DiskOffering offering, Long bytesReadRate, Long bytesR
         }
     }
 
+    protected boolean serviceOfferingExternalDetailsNeedUpdate(final Map<String, String> offeringDetails,
+               final Map<String, String> externalDetails) {
+        if (MapUtils.isEmpty(externalDetails)) {
+            return false;
+        }
+
+        Map<String, String> existingExternalDetails = offeringDetails.entrySet().stream()
+                .filter(detail -> detail.getKey().startsWith(VmDetailConstants.EXTERNAL_DETAIL_PREFIX))
+                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+
+        if (MapUtils.isEmpty(existingExternalDetails) || existingExternalDetails.size() != externalDetails.size()) {
+            return true;
+        }
+
+        for (Map.Entry<String, String> entry : externalDetails.entrySet()) {
+            String key = entry.getKey();
+            String value = entry.getValue();
+            if (!value.equals(existingExternalDetails.get(key))) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     @Override
     @ActionEvent(eventType = EventTypes.EVENT_SERVICE_OFFERING_EDIT, eventDescription = "updating service offering")
     public ServiceOffering updateServiceOffering(final UpdateServiceOfferingCmd cmd) {
@@ -3766,6 +3791,7 @@ public ServiceOffering updateServiceOffering(final UpdateServiceOfferingCmd cmd)
         String hostTags = cmd.getHostTags();
         ServiceOffering.State state = cmd.getState();
         boolean purgeResources = cmd.isPurgeResources();
+        final Map<String, String> externalDetails = cmd.getExternalDetails();
 
         if (userId == null) {
             userId = Long.valueOf(User.UID_SYSTEM);
@@ -3783,7 +3809,8 @@ public ServiceOffering updateServiceOffering(final UpdateServiceOfferingCmd cmd)
         List<Long> existingZoneIds = _serviceOfferingDetailsDao.findZoneIds(id);
         Collections.sort(existingZoneIds);
 
-        String purgeResourceStr = _serviceOfferingDetailsDao.getDetail(id, ServiceOffering.PURGE_DB_ENTITIES_KEY);
+        Map<String, String> offeringDetails = _serviceOfferingDetailsDao.listDetailsKeyPairs(id);
+        String purgeResourceStr = offeringDetails.get(ServiceOffering.PURGE_DB_ENTITIES_KEY);
         boolean existingPurgeResources = false;
         if (StringUtils.isNotBlank(purgeResourceStr)) {
             existingPurgeResources = Boolean.parseBoolean(purgeResourceStr);
@@ -3857,8 +3884,11 @@ public ServiceOffering updateServiceOffering(final UpdateServiceOfferingCmd cmd)
         }
 
         final boolean updateNeeded = name != null || displayText != null || sortKey != null || storageTags != null || hostTags != null || state != null;
+        final boolean serviceOfferingExternalDetailsNeedUpdate =
+                serviceOfferingExternalDetailsNeedUpdate(offeringDetails, externalDetails);
         final boolean detailsUpdateNeeded = !filteredDomainIds.equals(existingDomainIds) ||
-                !filteredZoneIds.equals(existingZoneIds) || purgeResources != existingPurgeResources;
+                !filteredZoneIds.equals(existingZoneIds) || purgeResources != existingPurgeResources ||
+                serviceOfferingExternalDetailsNeedUpdate;
         if (!updateNeeded && !detailsUpdateNeeded) {
             return _serviceOfferingDao.findById(id);
         }
@@ -3900,6 +3930,7 @@ public ServiceOffering updateServiceOffering(final UpdateServiceOfferingCmd cmd)
             SearchBuilder<ServiceOfferingDetailsVO> sb = _serviceOfferingDetailsDao.createSearchBuilder();
             sb.and("offeringId", sb.entity().getResourceId(), SearchCriteria.Op.EQ);
             sb.and("detailName", sb.entity().getName(), SearchCriteria.Op.EQ);
+            sb.and("detailNameLike", sb.entity().getName(), SearchCriteria.Op.LIKE);
             sb.done();
             SearchCriteria<ServiceOfferingDetailsVO> sc = sb.create();
             sc.setParameters("offeringId", String.valueOf(id));
@@ -3925,6 +3956,14 @@ public ServiceOffering updateServiceOffering(final UpdateServiceOfferingCmd cmd)
                             "true", false));
                 }
             }
+            if (serviceOfferingExternalDetailsNeedUpdate) {
+                SearchCriteria<ServiceOfferingDetailsVO> externalDetailsRemoveSC = sb.create();
+                externalDetailsRemoveSC.setParameters("detailNameLike", VmDetailConstants.EXTERNAL_DETAIL_PREFIX + "%");
+                _serviceOfferingDetailsDao.remove(externalDetailsRemoveSC);
+                for (Map.Entry<String, String> entry : externalDetails.entrySet()) {
+                    detailsVO.add(new ServiceOfferingDetailsVO(id, entry.getKey(), entry.getValue(), true));
+                }
+            }
         }
         if (!detailsVO.isEmpty()) {
             for (ServiceOfferingDetailsVO detailVO : detailsVO) {

server/src/test/java/com/cloud/configuration/ConfigurationManagerImplTest.java

@@ -88,6 +88,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyLong;
@@ -1041,4 +1042,54 @@ public void getConfigurationTypeTestReturnsStringRepresentingConfigurationType()
         configurationManagerImplSpy.getConfigurationType(configuration.key());
         Mockito.verify(configurationManagerImplSpy).parseConfigurationTypeIntoString(configuration.type(), configurationVOMock);
     }
+
+    @Test
+    public void serviceOfferingExternalDetailsNeedUpdateReturnsFalseWhenExternalDetailsIsEmpty() {
+        Map<String, String> offeringDetails = Map.of("key1", "value1");
+        Map<String, String> externalDetails = Collections.emptyMap();
+
+        boolean result = configurationManagerImplSpy.serviceOfferingExternalDetailsNeedUpdate(offeringDetails, externalDetails);
+
+        Assert.assertFalse(result);
+    }
+
+    @Test
+    public void serviceOfferingExternalDetailsNeedUpdateReturnsTrueWhenExistingExternalDetailsIsEmpty() {
+        Map<String, String> offeringDetails = Map.of("key1", "value1");
+        Map<String, String> externalDetails = Map.of("External:key1", "value1");
+
+        boolean result = configurationManagerImplSpy.serviceOfferingExternalDetailsNeedUpdate(offeringDetails, externalDetails);
+
+        Assert.assertTrue(result);
+    }
+
+    @Test
+    public void serviceOfferingExternalDetailsNeedUpdateReturnsTrueWhenSizesDiffer() {
+        Map<String, String> offeringDetails = Map.of("External:key1", "value1");
+        Map<String, String> externalDetails = Map.of("External:key1", "value1", "External:key2", "value2");
+
+        boolean result = configurationManagerImplSpy.serviceOfferingExternalDetailsNeedUpdate(offeringDetails, externalDetails);
+
+        Assert.assertTrue(result);
+    }
+
+    @Test
+    public void serviceOfferingExternalDetailsNeedUpdateReturnsTrueWhenValuesDiffer() {
+        Map<String, String> offeringDetails = Map.of("External:key1", "value1");
+        Map<String, String> externalDetails = Map.of("External:key1", "differentValue");
+
+        boolean result = configurationManagerImplSpy.serviceOfferingExternalDetailsNeedUpdate(offeringDetails, externalDetails);
+
+        Assert.assertTrue(result);
+    }
+
+    @Test
+    public void serviceOfferingExternalDetailsNeedUpdateReturnsFalseWhenDetailsMatch() {
+        Map<String, String> offeringDetails = Map.of("External:key1", "value1", "External:key2", "value2");
+        Map<String, String> externalDetails = Map.of("External:key1", "value1", "External:key2", "value2");
+
+        boolean result = configurationManagerImplSpy.serviceOfferingExternalDetailsNeedUpdate(offeringDetails, externalDetails);
+
+        Assert.assertFalse(result);
+    }
 }

ui/src/config/section/offering.js

@@ -16,6 +16,7 @@
 // under the License.
 import { shallowRef, defineAsyncComponent } from 'vue'
 import store from '@/store'
+import { getFilteredExternalDetails } from '@/utils/extension'
 
 export default {
   name: 'offering',
@@ -95,7 +96,12 @@ export default {
         label: 'label.edit',
         docHelp: 'adminguide/service_offerings.html#modifying-or-deleting-a-service-offering',
         dataView: true,
-        args: ['name', 'displaytext', 'storageaccessgroups', 'hosttags']
+        args: ['name', 'displaytext', 'storageaccessgroups', 'hosttags', 'externaldetails'],
+        mapping: {
+          externaldetails: {
+            transformedvalue: (record) => { return getFilteredExternalDetails(record.serviceofferingdetails) }
+          }
+        }
       }, {
         api: 'updateServiceOffering',
         icon: 'lock-outlined',

ui/src/utils/extension.js

@@ -0,0 +1,30 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+export function getFilteredExternalDetails (details) {
+  if (!details || typeof details !== 'object') {
+    return null
+  }
+  const prefix = 'External:'
+  const result = {}
+  for (const key in details) {
+    if (key.startsWith(prefix)) {
+      result[key.substring(prefix.length)] = details[key]
+    }
+  }
+  return Object.keys(result).length > 0 ? result : null
+}

ui/src/views/AutogenView.vue

@@ -363,6 +363,9 @@
                     {{ opt.name && opt.type ? opt.name + ' (' + opt.type + ')' : opt.name || opt.description }}
                   </a-select-option>
                 </a-select>
+                <details-input
+                  v-else-if="field.type==='map'"
+                  v-model:value="form[field.name]" />
                 <a-input-number
                   v-else-if="field.type==='long'"
                   v-focus="fieldIndex === firstIndex"
@@ -473,6 +476,7 @@ import OsLogo from '@/components/widgets/OsLogo'
 import ResourceIcon from '@/components/view/ResourceIcon'
 import BulkActionProgress from '@/components/view/BulkActionProgress'
 import TooltipLabel from '@/components/widgets/TooltipLabel'
+import DetailsInput from '@/components/widgets/DetailsInput'
 
 export default {
   name: 'Resource',
@@ -485,7 +489,8 @@ export default {
     BulkActionProgress,
     TooltipLabel,
     OsLogo,
-    ResourceIcon
+    ResourceIcon,
+    DetailsInput
   },
   mixins: [mixinDevice],
   provide: function () {
@@ -1423,6 +1428,15 @@ export default {
           this.form[field.name] = fieldValue
         } else if (field.type === 'boolean' && field.name === 'rebalance' && this.currentAction.api === 'cancelMaintenance') {
           this.form[field.name] = true
+        } else if (field.type === 'map') {
+          const transformedValue = this.currentAction.mapping?.[field.name]?.transformedvalue
+          if (typeof transformedValue === 'function') {
+            this.form[field.name] = transformedValue(this.resource)
+          } else if (typeof transformedValue === 'object' && transformedValue !== null) {
+            this.form[field.name] = { ...transformedValue }
+          } else {
+            this.form[field.name] = {}
+          }
         }
       })
     },
@@ -1623,6 +1637,10 @@ export default {
               } else {
                 params[key] = param.opts[input].name
               }
+            } else if (param.type === 'map' && typeof input === 'object') {
+              Object.entries(values.externaldetails).forEach(([key, value]) => {
+                params[param.name + '[0].' + key] = value
+              })
             } else {
               params[key] = input
             }

ui/src/views/extension/ExternalConfigurationDetails.vue

@@ -37,6 +37,7 @@
 <script>
 import { getAPI } from '@/api'
 import ObjectListTable from '@/components/view/ObjectListTable'
+import { getFilteredExternalDetails } from '@/utils/extension'
 
 export default {
   name: 'ExternalConfigurationDetails',
@@ -78,18 +79,7 @@ export default {
       if (!detailsKey || !this.resource) {
         return null
       }
-      const details = this.resource[detailsKey]
-      if (!details || typeof details !== 'object') {
-        return null
-      }
-      const prefix = 'External:'
-      const result = {}
-      for (const key in details) {
-        if (key.startsWith(prefix)) {
-          result[key.substring(prefix.length)] = details[key]
-        }
-      }
-      return Object.keys(result).length > 0 ? result : null
+      return getFilteredExternalDetails(this.resource[detailsKey])
     },
     extensionResourceDetails () {
       if (!this.resource?.id || !this.extension?.resources) {

ui/src/views/infra/HostUpdate.vue

@@ -103,6 +103,7 @@ import { ref, reactive, toRaw } from 'vue'
 import { getAPI, postAPI } from '@/api'
 import TooltipLabel from '@/components/widgets/TooltipLabel'
 import DetailsInput from '@/components/widgets/DetailsInput'
+import { getFilteredExternalDetails } from '@/utils/extension'
 
 export default {
   name: 'HostUpdate',
@@ -142,17 +143,7 @@ export default {
   },
   computed: {
     resourceExternalDetails () {
-      const prefix = 'External:'
-      if (!this.resource.details || typeof this.resource.details !== 'object' || Object.keys(this.resource.details).length === 0) {
-        return null
-      }
-      const result = {}
-      for (const key in this.resource.details) {
-        if (key.startsWith(prefix)) {
-          result[key.substring(prefix.length)] = this.resource.details[key]
-        }
-      }
-      return result
+      return getFilteredExternalDetails(this.resource.details)
     }
   },
   methods: {