events for os category

shwstppr · shwstppr · commit 551ec476025a · 2025-05-21T23:31:20.000+05:30
Signed-off-by: Abhishek Kumar &lt;abhishek.mrt22@gmail.com&gt;
diff --git a/api/src/main/java/com/cloud/event/EventTypes.java b/api/src/main/java/com/cloud/event/EventTypes.java
@@ -687,6 +687,9 @@ public class EventTypes {
     public static final String EVENT_EXTERNAL_OPENDAYLIGHT_CONFIGURE_CONTROLLER = "PHYSICAL.ODLCONTROLLER.CONFIGURE";
 
     //Guest OS related events
+    public static final String EVENT_GUEST_OS_CATEGORY_ADD = "GUEST.OS.CATEGORY.ADD";
+    public static final String EVENT_GUEST_OS_CATEGORY_DELETE = "GUEST.OS.CATEGORY.DELETE";
+    public static final String EVENT_GUEST_OS_CATEGORY_UPDATE = "GUEST.OS.CATEGORY.UPDATE";
     public static final String EVENT_GUEST_OS_ADD = "GUEST.OS.ADD";
     public static final String EVENT_GUEST_OS_REMOVE = "GUEST.OS.REMOVE";
     public static final String EVENT_GUEST_OS_UPDATE = "GUEST.OS.UPDATE";
diff --git a/api/src/main/java/com/cloud/storage/GuestOsCategory.java b/api/src/main/java/com/cloud/storage/GuestOsCategory.java
@@ -16,6 +16,8 @@
 // under the License.
 package com.cloud.storage;
 
+import java.util.Date;
+
 import org.apache.cloudstack.api.Identity;
 import org.apache.cloudstack.api.InternalIdentity;
 
@@ -29,4 +31,5 @@ public interface GuestOsCategory extends Identity, InternalIdentity {
 
     boolean isFeatured();
 
+    Date getCreated();
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/ApiCommandResourceType.java b/api/src/main/java/org/apache/cloudstack/api/ApiCommandResourceType.java
@@ -61,6 +61,7 @@ public enum ApiCommandResourceType {
     AffinityGroup(org.apache.cloudstack.affinity.AffinityGroup.class),
     InternalLbVm(com.cloud.network.router.VirtualRouter.class),
     DedicatedGuestVlanRange(com.cloud.network.GuestVlan.class),
+    GuestOsCategory(com.cloud.storage.GuestOsCategory.class),
     GuestOs(com.cloud.storage.GuestOS.class),
     GuestOsMapping(com.cloud.storage.GuestOSHypervisor.class),
     Network(com.cloud.network.Network.class),
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsCategoryCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsCategoryCmd.java
@@ -19,6 +19,7 @@
 
 import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiCommandResourceType;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.ApiErrorCode;
 import org.apache.cloudstack.api.BaseCmd;
@@ -84,4 +85,9 @@ public void execute() {
     public long getEntityOwnerId() {
         return Account.ACCOUNT_ID_SYSTEM;
     }
+
+    @Override
+    public ApiCommandResourceType getApiResourceType() {
+        return ApiCommandResourceType.GuestOsCategory;
+    }
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/DeleteGuestOsCategoryCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/DeleteGuestOsCategoryCmd.java
@@ -19,6 +19,7 @@
 
 import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiCommandResourceType;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.ApiErrorCode;
 import org.apache.cloudstack.api.BaseCmd;
@@ -75,4 +76,14 @@ public void execute() {
     public long getEntityOwnerId() {
         return Account.ACCOUNT_ID_SYSTEM;
     }
+
+    @Override
+    public ApiCommandResourceType getApiResourceType() {
+        return ApiCommandResourceType.GuestOsCategory;
+    }
+
+    @Override
+    public Long getApiResourceId() {
+        return getId();
+    }
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/UpdateGuestOsCategoryCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/UpdateGuestOsCategoryCmd.java
@@ -19,6 +19,7 @@
 
 import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiCommandResourceType;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.ApiErrorCode;
 import org.apache.cloudstack.api.BaseCmd;
@@ -99,4 +100,14 @@ public void execute() {
             throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update OS category");
         }
     }
+
+    @Override
+    public ApiCommandResourceType getApiResourceType() {
+        return ApiCommandResourceType.GuestOsCategory;
+    }
+
+    @Override
+    public Long getApiResourceId() {
+        return getId();
+    }
 }
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GuestOSCategoryResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GuestOSCategoryResponse.java
@@ -16,6 +16,8 @@
 // under the License.
 package org.apache.cloudstack.api.response;
 
+import java.util.Date;
+
 import com.google.gson.annotations.SerializedName;
 
 import org.apache.cloudstack.api.ApiConstants;
@@ -43,6 +45,10 @@ public class GuestOSCategoryResponse extends BaseResponse implements SetResource
     @Param(description = "Base64 string representation of the resource icon", since = "4.20.1")
     private ResourceIconResponse resourceIconResponse;
 
+    @SerializedName(ApiConstants.CREATED)
+    @Param(description = "Date when the OS category was created." )
+    private Date created;
+
     public String getId() {
         return id;
     }
@@ -67,4 +73,8 @@ public void setFeatured(Boolean featured) {
     public void setResourceIconResponse(ResourceIconResponse resourceIconResponse) {
         this.resourceIconResponse = resourceIconResponse;
     }
+
+    public void setCreated(Date created) {
+        this.created = created;
+    }
 }
diff --git a/engine/schema/src/main/java/com/cloud/storage/GuestOSCategoryVO.java b/engine/schema/src/main/java/com/cloud/storage/GuestOSCategoryVO.java
@@ -16,6 +16,7 @@
 // under the License.
 package com.cloud.storage;
 
+import java.util.Date;
 import java.util.UUID;
 
 import javax.persistence.Column;
@@ -25,6 +26,8 @@
 import javax.persistence.Id;
 import javax.persistence.Table;
 
+import com.cloud.utils.db.GenericDao;
+
 @Entity
 @Table(name = "guest_os_category")
 public class GuestOSCategoryVO implements GuestOsCategory {
@@ -45,6 +48,20 @@ public class GuestOSCategoryVO implements GuestOsCategory {
     @Column(name = "sort_key")
     private int sortKey;
 
+    @Column(name = GenericDao.CREATED_COLUMN)
+    private Date created;
+
+    @Column(name = GenericDao.REMOVED_COLUMN)
+    private Date removed;
+
+    public GuestOSCategoryVO() {
+    }
+
+    public GuestOSCategoryVO(String name, boolean featured) {
+        this.name = name;
+        this.featured = featured;
+    }
+
     @Override
     public long getId() {
         return id;
@@ -65,10 +82,6 @@ public String getUuid() {
         return this.uuid;
     }
 
-    public void setUuid(String uuid) {
-        this.uuid = uuid;
-    }
-
     @Override
     public boolean isFeatured() {
         return featured;
@@ -85,4 +98,9 @@ public void setSortKey(int key) {
     public int getSortKey() {
         return sortKey;
     }
+
+    @Override
+    public Date getCreated() {
+        return created;
+    }
 }
diff --git a/engine/schema/src/main/resources/META-INF/db/schema-42000to42010.sql b/engine/schema/src/main/resources/META-INF/db/schema-42000to42010.sql
@@ -82,6 +82,8 @@ UPDATE `cloud`.`network_offerings` SET conserve_mode=1 WHERE name='DefaultIsolat
 -- Add featured column for guest_os_category
 CALL `cloud`.`IDEMPOTENT_ADD_COLUMN`('cloud.guest_os_category', 'featured', 'tinyint(1) NOT NULL DEFAULT 0 COMMENT "whether the category is featured or not" AFTER `uuid`');
 CALL `cloud`.`IDEMPOTENT_ADD_COLUMN`('cloud.guest_os_category', 'sort_key', 'int NOT NULL DEFAULT 0 COMMENT "sort key used for customising sort method" AFTER `featured`');
+CALL `cloud`.`IDEMPOTENT_ADD_COLUMN`('cloud.guest_os_category', 'created', 'date COMMENT "date on which the category was created" AFTER `sort_key`');
+CALL `cloud`.`IDEMPOTENT_ADD_COLUMN`('cloud.guest_os_category', 'removed', 'date COMMENT "date removed if not null" AFTER `created`');
 UPDATE `cloud`.`guest_os_category` SET `featured` = 1 WHERE `name` NOT IN ('Novel', 'None');
 
 -- Begin: Changes for Guest OS category cleanup
@@ -136,7 +138,7 @@ BEGIN
 ;   UPDATE `cloud`.`guest_os`
     SET `category_id` = to_category_id
     WHERE `category_id` = (SELECT `id` FROM `cloud`.`guest_os_category` WHERE `name` = from_category_name)
-;   DELETE FROM `cloud`.`guest_os_category` WHERE `name` = from_category_name
+;   UPDATE `cloud`.`guest_os_category` SET `removed``=now() WHERE `name` = from_category_name
 ; END;
 CALL `cloud`.`UPDATE_NEW_AND_DELETE_OLD_CATEGORY_FOR_GUEST_OS`('Other', 'Novel');
 CALL `cloud`.`UPDATE_NEW_AND_DELETE_OLD_CATEGORY_FOR_GUEST_OS`('Other', 'None');
diff --git a/server/src/main/java/com/cloud/api/ApiResponseHelper.java b/server/src/main/java/com/cloud/api/ApiResponseHelper.java
@@ -3891,6 +3891,7 @@ public GuestOSCategoryResponse createGuestOSCategoryResponse(GuestOsCategory gue
         categoryResponse.setId(guestOsCategory.getUuid());
         categoryResponse.setName(guestOsCategory.getName());
         categoryResponse.setFeatured(guestOsCategory.isFeatured());
+        categoryResponse.setCreated(guestOsCategory.getCreated());
         if (showIcon) {
             ResourceIconVO resourceIcon = ApiDBUtils.getResourceIconByResourceUUID(guestOsCategory.getUuid(),
                     ResourceObjectType.GuestOsCategory);
diff --git a/server/src/main/java/com/cloud/server/ManagementServerImpl.java b/server/src/main/java/com/cloud/server/ManagementServerImpl.java
@@ -2778,17 +2778,21 @@ public Pair<List<? extends GuestOsCategory>, Integer> listGuestOSCategoriesByCri
         return new Pair<>(result.first(), result.second());
     }
 
+
     @Override
+    @ActionEvent(eventType = EventTypes.EVENT_GUEST_OS_CATEGORY_ADD, eventDescription = "adding OS category")
     public GuestOsCategory addGuestOsCategory(AddGuestOsCategoryCmd cmd) {
         final String name = cmd.getName();
         final boolean featured = cmd.isFeatured();
-        final GuestOSCategoryVO guestOSCategory = new GuestOSCategoryVO();
-        guestOSCategory.setName(name);
-        guestOSCategory.setFeatured(featured);
-        return _guestOSCategoryDao.persist(guestOSCategory);
+        final GuestOSCategoryVO guestOSCategory = new GuestOSCategoryVO(name, featured);
+        GuestOsCategory guestOsCategory = _guestOSCategoryDao.persist(guestOSCategory);
+        CallContext.current().setEventResourceId(guestOsCategory.getId());
+        CallContext.current().setEventResourceType(ApiCommandResourceType.GuestOsCategory);
+        return guestOSCategory;
     }
 
     @Override
+    @ActionEvent(eventType = EventTypes.EVENT_GUEST_OS_CATEGORY_UPDATE, eventDescription = "updating OS category")
     public GuestOsCategory updateGuestOsCategory(UpdateGuestOsCategoryCmd cmd) {
         final long id = cmd.getId();
         final String name = cmd.getName();
@@ -2817,6 +2821,7 @@ public GuestOsCategory updateGuestOsCategory(UpdateGuestOsCategoryCmd cmd) {
     }
 
     @Override
+    @ActionEvent(eventType = EventTypes.EVENT_GUEST_OS_CATEGORY_DELETE, eventDescription = "deleting OS category")
     public boolean deleteGuestOsCategory(DeleteGuestOsCategoryCmd cmd) {
         final long id = cmd.getId();
         final GuestOSCategoryVO guestOSCategory = _guestOSCategoryDao.findById(id);
diff --git a/server/src/test/java/com/cloud/server/ManagementServerImplTest.java b/server/src/test/java/com/cloud/server/ManagementServerImplTest.java
@@ -718,7 +718,7 @@ public void testAddGuestOsCategory() {
     @Test
     public void testUpdateGuestOsCategory() {
         UpdateGuestOsCategoryCmd updateCmd = Mockito.mock(UpdateGuestOsCategoryCmd.class);
-        GuestOSCategoryVO guestOSCategory = new GuestOSCategoryVO();
+        GuestOSCategoryVO guestOSCategory = new GuestOSCategoryVO("Old name", false);
         long id = 1L;
         String name = "Updated Name";
         Boolean featured = true;
@@ -749,7 +749,7 @@ public void testUpdateGuestOsCategory_ThrowsExceptionWhenCategoryNotFound() {
     @Test
     public void testUpdateGuestOsCategory_NoChanges() {
         UpdateGuestOsCategoryCmd updateCmd = Mockito.mock(UpdateGuestOsCategoryCmd.class);
-        GuestOSCategoryVO guestOSCategory = new GuestOSCategoryVO();
+        GuestOSCategoryVO guestOSCategory = new GuestOSCategoryVO("Old name", false);
         long id = 1L;
         when(updateCmd.getId()).thenReturn(id);
         when(updateCmd.getName()).thenReturn(null);
@@ -767,11 +767,9 @@ public void testUpdateGuestOsCategory_NoChanges() {
     @Test
     public void testUpdateGuestOsCategory_UpdateNameOnly() {
         UpdateGuestOsCategoryCmd updateCmd = Mockito.mock(UpdateGuestOsCategoryCmd.class);
-        GuestOSCategoryVO guestOSCategory = new GuestOSCategoryVO();
+        GuestOSCategoryVO guestOSCategory = new GuestOSCategoryVO("Old name", false);
         long id = 1L;
         String name = "Updated Name";
-        Boolean featured = null;
-        Integer sortKey = null;
         Mockito.when(updateCmd.getId()).thenReturn(id);
         Mockito.when(updateCmd.getName()).thenReturn(name);
         Mockito.when(updateCmd.isFeatured()).thenReturn(null);
diff --git a/ui/public/locales/en.json b/ui/public/locales/en.json
@@ -1053,6 +1053,7 @@
 "label.guest.netmask": "Guest netmask",
 "label.guest.networks": "Guest Networks",
 "label.guest.os": "Guest OS",
+"label.guest.os.category": "Guest OS Category",
 "label.guest.os.categories": "Guest OS Categories",
 "label.guest.os.hypervisor.mappings": "Guest OS mappings",
 "label.guest.start.ip": "Guest start IP",
diff --git a/ui/src/config/section/config.js b/ui/src/config/section/config.js
@@ -193,8 +193,8 @@ export default {
       docHelp: 'adminguide/guest_os.html#guest-os-categories',
       icon: 'group-outlined',
       permission: ['listOsCategories', 'addOsCategory'],
-      columns: ['name', 'isfeatured', 'order'],
-      details: ['name', 'isfeatured'],
+      columns: ['name', 'isfeatured', 'created', 'order'],
+      details: ['name', 'isfeatured', 'created'],
       related: [{
         name: 'guestos',
         title: 'label.guest.os',
diff --git a/ui/src/utils/plugins.js b/ui/src/utils/plugins.js
@@ -412,6 +412,7 @@ export const resourceTypePlugin = {
         case 'VpnCustomerGateway':
         case 'AutoScaleVmGroup':
         case 'QuotaTariff':
+        case 'GuestOsCategory':
           return resourceType.toLowerCase()
       }
       return ''
