Skip to content

Commit e4117e6

Browse files
weizhouapacheDaanHoogland
weizhouapache
and
DaanHoogland
authored
engine/schema: fix duplicated guest OSes in 4.18.0.0 (#7799)
Co-authored-by: Daan Hoogland <daan@onecht.net>
1 parent 0e9a19f commit e4117e6

19 files changed

Lines changed: 295 additions & 61 deletions

File tree

‎api/src/main/java/com/cloud/storage/GuestOS.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,6 @@ public interface GuestOS extends InternalIdentity, Identity {
3434
Date getRemoved();
3535

3636
boolean getIsUserDefined();
37+
38+
boolean getForDisplay();
3739
}

‎api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsCmd.java‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import org.apache.cloudstack.api.ServerApiException;
2828
import org.apache.cloudstack.api.response.GuestOSCategoryResponse;
2929
import org.apache.cloudstack.api.response.GuestOSResponse;
30+
import org.apache.cloudstack.acl.RoleType;
3031
import org.apache.cloudstack.context.CallContext;
3132

3233
import com.cloud.event.EventTypes;
@@ -60,6 +61,8 @@ public class AddGuestOsCmd extends BaseAsyncCreateCmd {
6061
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, required = false, description = "Map of (key/value pairs)")
6162
private Map details;
6263

64+
@Parameter(name="forDisplay", type=CommandType.BOOLEAN, description="whether this guest OS is available for end users", authorized = {RoleType.Admin})
65+
private Boolean display;
6366

6467
/////////////////////////////////////////////////////
6568
/////////////////// Accessors ///////////////////////
@@ -78,7 +81,7 @@ public String getOsName() {
7881
}
7982

8083
public Map getDetails() {
81-
Map<String, String> detailsMap = new HashMap<String, String>();
84+
Map<String, String> detailsMap = new HashMap<>();
8285
if (!details.isEmpty()) {
8386
Collection<?> servicesCollection = details.values();
8487
Iterator<?> iter = servicesCollection.iterator();
@@ -92,6 +95,9 @@ public Map getDetails() {
9295
return detailsMap;
9396
}
9497

98+
public Boolean getForDisplay() {
99+
return display;
100+
}
95101

96102
/////////////////////////////////////////////////////
97103
/////////////// API Implementation///////////////////

‎api/src/main/java/org/apache/cloudstack/api/command/admin/guest/UpdateGuestOsCmd.java‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import org.apache.cloudstack.api.Parameter;
2727
import org.apache.cloudstack.api.ServerApiException;
2828
import org.apache.cloudstack.api.response.GuestOSResponse;
29+
import org.apache.cloudstack.acl.RoleType;
2930

3031
import com.cloud.event.EventTypes;
3132
import com.cloud.storage.GuestOS;
@@ -56,8 +57,10 @@ public class UpdateGuestOsCmd extends BaseAsyncCmd {
5657
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, required = true, description = "Map of (key/value pairs)")
5758
private Map details;
5859

60+
@Parameter(name="forDisplay", type=CommandType.BOOLEAN, description="whether this guest OS is available for end users", authorized = {RoleType.Admin})
61+
private Boolean display;
5962

60-
/////////////////////////////////////////////////////
63+
/////////////////////////////////////////////////////
6164
/////////////////// Accessors ///////////////////////
6265
/////////////////////////////////////////////////////
6366

@@ -70,7 +73,7 @@ public String getOsDisplayName() {
7073
}
7174

7275
public Map getDetails() {
73-
Map<String, String> detailsMap = new HashMap<String, String>();;
76+
Map<String, String> detailsMap = new HashMap<>();;
7477
if (!details.isEmpty()) {
7578
Collection<?> servicesCollection = details.values();
7679
Iterator<?> iter = servicesCollection.iterator();
@@ -84,6 +87,10 @@ public Map getDetails() {
8487
return detailsMap;
8588
}
8689

90+
public Boolean getForDisplay() {
91+
return display;
92+
}
93+
8794
/////////////////////////////////////////////////////
8895
/////////////// API Implementation///////////////////
8996
/////////////////////////////////////////////////////

‎api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCmd.java‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@
1919
import java.util.ArrayList;
2020
import java.util.List;
2121

22+
import org.apache.commons.lang3.BooleanUtils;
2223
import org.apache.log4j.Logger;
2324

25+
import org.apache.cloudstack.acl.RoleType;
2426
import org.apache.cloudstack.api.APICommand;
2527
import org.apache.cloudstack.api.ApiConstants;
2628
import org.apache.cloudstack.api.BaseListCmd;
@@ -51,6 +53,10 @@ public class ListGuestOsCmd extends BaseListCmd {
5153
@Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "list os by description", since = "3.0.1")
5254
private String description;
5355

56+
@Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter",
57+
since = "4.18.1", authorized = {RoleType.Admin})
58+
private Boolean display;
59+
5460
/////////////////////////////////////////////////////
5561
/////////////////// Accessors ///////////////////////
5662
/////////////////////////////////////////////////////
@@ -67,15 +73,19 @@ public String getDescription() {
6773
return description;
6874
}
6975

76+
public Boolean getDisplay() {
77+
return BooleanUtils.toBooleanDefaultIfNull(display, true);
78+
}
79+
7080
/////////////////////////////////////////////////////
7181
/////////////// API Implementation///////////////////
7282
/////////////////////////////////////////////////////
7383

7484
@Override
7585
public void execute() {
7686
Pair<List<? extends GuestOS>, Integer> result = _mgr.listGuestOSByCriteria(this);
77-
ListResponse<GuestOSResponse> response = new ListResponse<GuestOSResponse>();
78-
List<GuestOSResponse> osResponses = new ArrayList<GuestOSResponse>();
87+
ListResponse<GuestOSResponse> response = new ListResponse<>();
88+
List<GuestOSResponse> osResponses = new ArrayList<>();
7989
for (GuestOS guestOS : result.first()) {
8090
GuestOSResponse guestOSResponse = _responseGenerator.createGuestOSResponse(guestOS);
8191
osResponses.add(guestOSResponse);

‎api/src/main/java/org/apache/cloudstack/api/response/GuestOSResponse.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ public class GuestOSResponse extends BaseResponse {
4343
@Param(description = "is the guest OS user defined")
4444
private Boolean isUserDefined;
4545

46+
@SerializedName(ApiConstants.FOR_DISPLAY)
47+
@Param(description = "is the guest OS visible for the users")
48+
private Boolean forDisplay;
49+
4650
public String getId() {
4751
return id;
4852
}
@@ -75,4 +79,12 @@ public void setIsUserDefined(Boolean isUserDefined) {
7579
this.isUserDefined = isUserDefined;
7680
}
7781

82+
public Boolean getForDisplay() {
83+
return this.forDisplay;
84+
}
85+
86+
public void setForDisplay(final Boolean forDisplay) {
87+
this.forDisplay = forDisplay;
88+
}
89+
7890
}

‎engine/schema/src/main/java/com/cloud/storage/GuestOSVO.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ public class GuestOSVO implements GuestOS {
5757
@Column(name = "is_user_defined")
5858
private boolean isUserDefined;
5959

60+
@Column(name = "display", updatable = true, nullable = false)
61+
protected boolean display = true;
62+
6063
@Override
6164
public long getId() {
6265
return id;
@@ -120,4 +123,15 @@ public boolean getIsUserDefined() {
120123
public void setIsUserDefined(boolean isUserDefined) {
121124
this.isUserDefined = isUserDefined;
122125
}
126+
127+
public boolean getForDisplay() {
128+
return isDisplay();
129+
}
130+
public boolean isDisplay() {
131+
return display;
132+
}
133+
134+
public void setDisplay(boolean display) {
135+
this.display = display;
136+
}
123137
}

‎engine/schema/src/main/java/com/cloud/storage/dao/GuestOSDao.java‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,23 @@
1616
// under the License.
1717
package com.cloud.storage.dao;
1818

19+
import com.cloud.storage.GuestOS;
1920
import com.cloud.storage.GuestOSVO;
21+
import com.cloud.utils.Pair;
2022
import com.cloud.utils.db.GenericDao;
2123

24+
import java.util.List;
25+
import java.util.Set;
26+
2227
public interface GuestOSDao extends GenericDao<GuestOSVO, Long> {
2328

24-
GuestOSVO listByDisplayName(String displayName);
29+
GuestOSVO findOneByDisplayName(String displayName);
2530

2631
GuestOSVO findByCategoryIdAndDisplayNameOrderByCreatedDesc(long categoryId, String displayName);
32+
33+
Set<String> findDoubleNames();
34+
35+
List<GuestOSVO> listByDisplayName(String displayName);
36+
37+
Pair<List<? extends GuestOS>, Integer> listGuestOSByCriteria(Long startIndex, Long pageSize, Long id, Long osCategoryId, String description, String keyword, Boolean forDisplay);
2738
}

‎engine/schema/src/main/java/com/cloud/storage/dao/GuestOSDaoImpl.java‎

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,19 @@
1717
package com.cloud.storage.dao;
1818

1919

20+
import java.sql.Connection;
21+
import java.sql.PreparedStatement;
22+
import java.sql.ResultSet;
23+
import java.sql.SQLException;
24+
import java.util.HashSet;
2025
import java.util.List;
26+
import java.util.Set;
2127

28+
import com.cloud.storage.GuestOS;
29+
import com.cloud.utils.Pair;
30+
import com.cloud.utils.db.DB;
31+
import com.cloud.utils.db.TransactionLegacy;
32+
import com.cloud.utils.exception.CloudRuntimeException;
2233
import org.apache.commons.collections.CollectionUtils;
2334
import org.springframework.stereotype.Component;
2435

@@ -42,7 +53,7 @@ public GuestOSDaoImpl() {
4253
}
4354

4455
@Override
45-
public GuestOSVO listByDisplayName(String displayName) {
56+
public GuestOSVO findOneByDisplayName(String displayName) {
4657
SearchCriteria<GuestOSVO> sc = Search.create();
4758
sc.setParameters("display_name", displayName);
4859
return findOneBy(sc);
@@ -62,4 +73,69 @@ public GuestOSVO findByCategoryIdAndDisplayNameOrderByCreatedDesc(long categoryI
6273
}
6374
return null;
6475
}
76+
77+
/**
78+
+ "select display_name from"
79+
+ "(select display_name, count(1) as count from guest_os go1 where removed is null group by display_name having count > 1) tab0";
80+
*
81+
* @return
82+
*/
83+
@Override
84+
@DB
85+
public Set<String> findDoubleNames() {
86+
String selectSql = "SELECT display_name FROM (SELECT display_name, count(1) AS count FROM guest_os go1 WHERE removed IS NULL GROUP BY display_name HAVING count > 1) tab0";
87+
Set<String> names = new HashSet<>();
88+
Connection conn = TransactionLegacy.getStandaloneConnection();
89+
try {
90+
PreparedStatement stmt = conn.prepareStatement(selectSql);
91+
ResultSet rs = stmt.executeQuery();
92+
while (rs != null && rs.next()) {
93+
names.add(rs.getString(1));
94+
}
95+
} catch (SQLException ex) {
96+
throw new CloudRuntimeException("Error while trying to find duplicate guest OSses", ex);
97+
}
98+
return names;
99+
}
100+
101+
/**
102+
* get all with a certain display name
103+
* @param displayName
104+
* @return a list with GuestOS objects
105+
*/
106+
@Override
107+
public List<GuestOSVO> listByDisplayName(String displayName) {
108+
SearchCriteria<GuestOSVO> sc = Search.create();
109+
sc.setParameters("display_name", displayName);
110+
return listBy(sc);
111+
}
112+
113+
public Pair<List<? extends GuestOS>, Integer> listGuestOSByCriteria(Long startIndex, Long pageSize, Long id, Long osCategoryId, String description, String keyword, Boolean forDisplay) {
114+
final Filter searchFilter = new Filter(GuestOSVO.class, "displayName", true, startIndex, pageSize);
115+
final SearchCriteria<GuestOSVO> sc = createSearchCriteria();
116+
117+
if (id != null) {
118+
sc.addAnd("id", SearchCriteria.Op.EQ, id);
119+
}
120+
121+
if (osCategoryId != null) {
122+
sc.addAnd("categoryId", SearchCriteria.Op.EQ, osCategoryId);
123+
}
124+
125+
if (description != null) {
126+
sc.addAnd("displayName", SearchCriteria.Op.LIKE, "%" + description + "%");
127+
}
128+
129+
if (keyword != null) {
130+
sc.addAnd("displayName", SearchCriteria.Op.LIKE, "%" + keyword + "%");
131+
}
132+
133+
if (forDisplay != null) {
134+
sc.addAnd("display", SearchCriteria.Op.EQ, forDisplay);
135+
}
136+
137+
final Pair<List<GuestOSVO>, Integer> result = searchAndCount(sc, searchFilter);
138+
return new Pair<>(result.first(), result.second());
139+
}
140+
65141
}

‎engine/schema/src/main/java/com/cloud/storage/dao/GuestOSHypervisorDao.java‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,19 @@
1616
// under the License.
1717
package com.cloud.storage.dao;
1818

19-
import com.cloud.hypervisor.Hypervisor.HypervisorType;
2019
import com.cloud.storage.GuestOSHypervisorVO;
2120
import com.cloud.utils.db.GenericDao;
2221

2322
import java.util.List;
2423

2524
public interface GuestOSHypervisorDao extends GenericDao<GuestOSHypervisorVO, Long> {
2625

27-
HypervisorType findHypervisorTypeByGuestOsId(long guestOsId);
26+
/**
27+
* list all the mappings for a guesos id
28+
* @param guestOsId the guestos to look for
29+
* @return a list of mappings
30+
*/
31+
List<GuestOSHypervisorVO> listByGuestOsId(long guestOsId);
2832

2933
GuestOSHypervisorVO findByOsIdAndHypervisor(long guestOsId, String hypervisorType, String hypervisorVersion);
3034

‎engine/schema/src/main/java/com/cloud/storage/dao/GuestOSHypervisorDaoImpl.java‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,12 @@
2020
import java.util.Date;
2121
import java.util.List;
2222

23-
import com.cloud.utils.db.QueryBuilder;
2423
import org.apache.commons.collections.CollectionUtils;
2524
import org.springframework.stereotype.Component;
2625

27-
import com.cloud.hypervisor.Hypervisor.HypervisorType;
2826
import com.cloud.storage.GuestOSHypervisorVO;
2927
import com.cloud.utils.db.Filter;
28+
import com.cloud.utils.db.QueryBuilder;
3029
import com.cloud.utils.db.GenericDaoBase;
3130
import com.cloud.utils.db.SearchBuilder;
3231
import com.cloud.utils.db.SearchCriteria;
@@ -82,11 +81,10 @@ public GuestOSHypervisorDaoImpl() {
8281
}
8382

8483
@Override
85-
public HypervisorType findHypervisorTypeByGuestOsId(long guestOsId) {
84+
public List<GuestOSHypervisorVO> listByGuestOsId(long guestOsId) {
8685
SearchCriteria<GuestOSHypervisorVO> sc = guestOsSearch.create();
8786
sc.setParameters("guest_os_id", guestOsId);
88-
GuestOSHypervisorVO goh = findOneBy(sc);
89-
return HypervisorType.getType(goh.getHypervisorType());
87+
return listBy(sc);
9088
}
9189

9290
@Override

0 commit comments

Comments
 (0)