Skip to content

Allow users to view reserved System VM IPs, if they're already allocated to user #5902

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
weizhouapache merged 8 commits into from
Apr 19, 2022
Merged

Allow users to view reserved System VM IPs, if they're already allocated to user #5902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
263da4c
Allow users to view reserved system VM IPs, if this IPs are already a…
Jan 25, 2022
71fb817
Fix checkstyle
Jan 26, 2022
525cbcc
Merge branch 'main' into allow-users-to-see-reserved-ips-if-this-ips-…
Feb 8, 2022
5fac1d1
Address reviews
Feb 8, 2022
f8f8950
Merge branch 'main' into allow-users-to-see-reserved-ips-if-this-ips-…
Feb 14, 2022
3fbb224
Merge 'main' into 'allow-users-to-see-reserved-ips-if-this-ips-are-al…
Apr 13, 2022
c5a9d52
Address reviews
Apr 13, 2022
cf2cdee
Apply @weizhouapache changes
Apr 18, 2022
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
6 changes: 5 additions & 1 deletion server/src/main/java/com/cloud/network/IpAddressManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ public class IpAddressManagerImpl extends ManagerBase implements IpAddressManage

private static final ConfigKey<Boolean> SystemVmPublicIpReservationModeStrictness = new ConfigKey<Boolean>("Advanced",
Boolean.class, "system.vm.public.ip.reservation.mode.strictness", "false",
"If enabled, the use of System VMs public IP reservation is strict, preferred if not.", false, ConfigKey.Scope.Global);
"If enabled, the use of System VMs public IP reservation is strict, preferred if not.", true, ConfigKey.Scope.Global);

private Random rand = new Random(System.currentTimeMillis());

Expand Down Expand Up @@ -2306,4 +2306,8 @@ public boolean isUsageHidden(IPAddressVO ip) {
NetworkDetailVO networkDetail = _networkDetailsDao.findDetail(networkId, Network.hideIpAddressUsage);
return networkDetail != null && "true".equals(networkDetail.getValue());
}

public static ConfigKey<Boolean> getSystemvmpublicipreservationmodestrictness() {
return SystemVmPublicIpReservationModeStrictness;
}
}
7 changes: 5 additions & 2 deletions server/src/main/java/com/cloud/server/ManagementServerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,7 @@
import com.cloud.info.ConsoleProxyInfo;
import com.cloud.network.IpAddress;
import com.cloud.network.IpAddressManager;
import com.cloud.network.IpAddressManagerImpl;
import com.cloud.network.Network;
import com.cloud.network.NetworkModel;
import com.cloud.network.dao.IPAddressDao;
Expand Down Expand Up @@ -2382,7 +2383,7 @@ private void buildParameters(final SearchBuilder<IPAddressVO> sb, final ListPubl
}
}

private void setParameters(SearchCriteria<IPAddressVO> sc, final ListPublicIpAddressesCmd cmd, VlanType vlanType, Boolean isAllocated) {
protected void setParameters(SearchCriteria<IPAddressVO> sc, final ListPublicIpAddressesCmd cmd, VlanType vlanType, Boolean isAllocated) {
final Object keyword = cmd.getKeyword();
final Long physicalNetworkId = cmd.getPhysicalNetworkId();
final Long sourceNetworkId = cmd.getNetworkId();
Expand Down Expand Up @@ -2454,7 +2455,9 @@ private void setParameters(SearchCriteria<IPAddressVO> sc, final ListPublicIpAdd
sc.setParameters("state", IpAddress.State.Allocated);
}

sc.setParameters( "forsystemvms", false);
if (IpAddressManagerImpl.getSystemvmpublicipreservationmodestrictness().value() && IpAddress.State.Free.name().equalsIgnoreCase(state)) {
sc.setParameters("forsystemvms", false);
}
Comment thread
SadiJr marked this conversation as resolved.
}

@Override
Expand Down
114 changes: 114 additions & 0 deletions server/src/test/java/com/cloud/server/ManagementServerImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,35 @@
import static org.mockito.Mockito.lenient;
import static org.mockito.Mockito.when;

import org.apache.cloudstack.api.command.user.address.ListPublicIpAddressesCmd;
import org.apache.cloudstack.api.command.user.ssh.RegisterSSHKeyPairCmd;
import org.apache.cloudstack.framework.config.ConfigKey;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.Spy;
import org.mockito.runners.MockitoJUnitRunner;
import org.powermock.reflect.Whitebox;

import com.cloud.dc.Vlan.VlanType;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.network.IpAddress;
import com.cloud.network.IpAddressManagerImpl;
import com.cloud.network.dao.IPAddressVO;
import com.cloud.user.Account;
import com.cloud.user.SSHKeyPair;
import com.cloud.user.SSHKeyPairVO;
import com.cloud.user.dao.SSHKeyPairDao;
import com.cloud.utils.db.SearchCriteria;

@RunWith(MockitoJUnitRunner.class)
public class ManagementServerImplTest {

@Mock
SearchCriteria<IPAddressVO> sc;

@Mock
RegisterSSHKeyPairCmd regCmd;

Expand All @@ -54,9 +66,20 @@ public class ManagementServerImplTest {
@Mock
SSHKeyPair sshKeyPair;

@Mock
IpAddressManagerImpl ipAddressManagerImpl;

@Spy
ManagementServerImpl spy;

ConfigKey mockConfig;

@Before
public void setup() {
mockConfig = Mockito.mock(ConfigKey.class);
Whitebox.setInternalState(ipAddressManagerImpl.getClass(), "SystemVmPublicIpReservationModeStrictness", mockConfig);
}

@Test(expected = InvalidParameterValueException.class)
public void testDuplicateRegistraitons(){
String accountName = "account";
Expand Down Expand Up @@ -107,4 +130,95 @@ public void testSuccess(){
spy.registerSSHKeyPair(regCmd);
Mockito.verify(spy, Mockito.times(3)).getPublicKeyFromKeyKeyMaterial(anyString());
}

@Test
public void setParametersTestWhenStateIsFreeAndSystemVmPublicIsTrue() throws IllegalArgumentException, IllegalAccessException, NoSuchFieldException, SecurityException {
Mockito.when(mockConfig.value()).thenReturn(Boolean.TRUE);

ListPublicIpAddressesCmd cmd = Mockito.mock(ListPublicIpAddressesCmd.class);
Mockito.when(cmd.getNetworkId()).thenReturn(10L);
Mockito.when(cmd.getZoneId()).thenReturn(null);
Mockito.when(cmd.getIpAddress()).thenReturn(null);
Mockito.when(cmd.getPhysicalNetworkId()).thenReturn(null);
Mockito.when(cmd.getVlanId()).thenReturn(null);
Mockito.when(cmd.getId()).thenReturn(null);
Mockito.when(cmd.isSourceNat()).thenReturn(null);
Mockito.when(cmd.isStaticNat()).thenReturn(null);
Mockito.when(cmd.getState()).thenReturn(IpAddress.State.Free.name());
Mockito.when(cmd.getTags()).thenReturn(null);
spy.setParameters(sc, cmd, VlanType.VirtualNetwork, Boolean.FALSE);

Mockito.verify(sc, Mockito.times(1)).setJoinParameters("vlanSearch", "vlanType", VlanType.VirtualNetwork);
Mockito.verify(sc, Mockito.times(1)).setParameters("display", false);
Mockito.verify(sc, Mockito.times(1)).setParameters("sourceNetworkId", 10L);
Mockito.verify(sc, Mockito.times(1)).setParameters("state", "Free");
Mockito.verify(sc, Mockito.times(1)).setParameters("forsystemvms", false);
}

@Test
public void setParametersTestWhenStateIsFreeAndSystemVmPublicIsFalse() {
Mockito.when(mockConfig.value()).thenReturn(Boolean.FALSE);
ListPublicIpAddressesCmd cmd = Mockito.mock(ListPublicIpAddressesCmd.class);
Mockito.when(cmd.getNetworkId()).thenReturn(10L);
Mockito.when(cmd.getZoneId()).thenReturn(null);
Mockito.when(cmd.getIpAddress()).thenReturn(null);
Mockito.when(cmd.getPhysicalNetworkId()).thenReturn(null);
Mockito.when(cmd.getVlanId()).thenReturn(null);
Mockito.when(cmd.getId()).thenReturn(null);
Mockito.when(cmd.isSourceNat()).thenReturn(null);
Mockito.when(cmd.isStaticNat()).thenReturn(null);
Mockito.when(cmd.getState()).thenReturn(IpAddress.State.Free.name());
Mockito.when(cmd.getTags()).thenReturn(null);
spy.setParameters(sc, cmd, VlanType.VirtualNetwork, Boolean.FALSE);

Mockito.verify(sc, Mockito.times(1)).setJoinParameters("vlanSearch", "vlanType", VlanType.VirtualNetwork);
Mockito.verify(sc, Mockito.times(1)).setParameters("display", false);
Mockito.verify(sc, Mockito.times(1)).setParameters("sourceNetworkId", 10L);
Mockito.verify(sc, Mockito.times(1)).setParameters("state", "Free");
Mockito.verify(sc, Mockito.never()).setParameters("forsystemvms", false);
}

@Test
public void setParametersTestWhenStateIsNullAndSystemVmPublicIsFalse() {
Mockito.when(mockConfig.value()).thenReturn(Boolean.FALSE);
ListPublicIpAddressesCmd cmd = Mockito.mock(ListPublicIpAddressesCmd.class);
Mockito.when(cmd.getNetworkId()).thenReturn(10L);
Mockito.when(cmd.getZoneId()).thenReturn(null);
Mockito.when(cmd.getIpAddress()).thenReturn(null);
Mockito.when(cmd.getPhysicalNetworkId()).thenReturn(null);
Mockito.when(cmd.getVlanId()).thenReturn(null);
Mockito.when(cmd.getId()).thenReturn(null);
Mockito.when(cmd.isSourceNat()).thenReturn(null);
Mockito.when(cmd.isStaticNat()).thenReturn(null);
Mockito.when(cmd.getState()).thenReturn(null);
Mockito.when(cmd.getTags()).thenReturn(null);
spy.setParameters(sc, cmd, VlanType.VirtualNetwork, Boolean.TRUE);

Mockito.verify(sc, Mockito.times(1)).setJoinParameters("vlanSearch", "vlanType", VlanType.VirtualNetwork);
Mockito.verify(sc, Mockito.times(1)).setParameters("display", false);
Mockito.verify(sc, Mockito.times(1)).setParameters("sourceNetworkId", 10L);
Mockito.verify(sc, Mockito.never()).setParameters("forsystemvms", false);
}

@Test
public void setParametersTestWhenStateIsNullAndSystemVmPublicIsTrue() {
Mockito.when(mockConfig.value()).thenReturn(Boolean.TRUE);
ListPublicIpAddressesCmd cmd = Mockito.mock(ListPublicIpAddressesCmd.class);
Mockito.when(cmd.getNetworkId()).thenReturn(10L);
Mockito.when(cmd.getZoneId()).thenReturn(null);
Mockito.when(cmd.getIpAddress()).thenReturn(null);
Mockito.when(cmd.getPhysicalNetworkId()).thenReturn(null);
Mockito.when(cmd.getVlanId()).thenReturn(null);
Mockito.when(cmd.getId()).thenReturn(null);
Mockito.when(cmd.isSourceNat()).thenReturn(null);
Mockito.when(cmd.isStaticNat()).thenReturn(null);
Mockito.when(cmd.getState()).thenReturn(null);
Mockito.when(cmd.getTags()).thenReturn(null);
spy.setParameters(sc, cmd, VlanType.VirtualNetwork, Boolean.TRUE);

Mockito.verify(sc, Mockito.times(1)).setJoinParameters("vlanSearch", "vlanType", VlanType.VirtualNetwork);
Mockito.verify(sc, Mockito.times(1)).setParameters("display", false);
Mockito.verify(sc, Mockito.times(1)).setParameters("sourceNetworkId", 10L);
Mockito.verify(sc, Mockito.never()).setParameters("forsystemvms", false);
}
}