/*
* 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.
*/
package org.jclouds.cloudstack.features;
import static com.google.common.collect.Iterables.find;
import static org.jclouds.cloudstack.predicates.NetworkPredicates.supportsPortForwarding;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
import java.util.NoSuchElementException;
import java.util.Set;
import org.jclouds.cloudstack.domain.AsyncCreateResponse;
import org.jclouds.cloudstack.domain.FirewallRule;
import org.jclouds.cloudstack.domain.Network;
import org.jclouds.cloudstack.domain.PortForwardingRule;
import org.jclouds.cloudstack.domain.PublicIPAddress;
import org.jclouds.cloudstack.domain.VirtualMachine;
import org.jclouds.cloudstack.internal.BaseCloudStackClientLiveTest;
import org.jclouds.cloudstack.options.CreateFirewallRuleOptions;
import org.jclouds.logging.Logger;
import org.testng.annotations.AfterGroups;
import org.testng.annotations.BeforeGroups;
import org.testng.annotations.Test;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.net.HostAndPort;
/**
* Tests behavior of {@code FirewallClientLiveTest}
*
* @author Adrian Cole
*/
@Test(groups = "live", singleThreaded = true, testName = "FirewallClientLiveTest")
public class FirewallClientLiveTest extends BaseCloudStackClientLiveTest {
private PublicIPAddress ip = null;
private VirtualMachine vm;
private FirewallRule firewallRule;
private FirewallRule egressFirewallRule;
private PortForwardingRule portForwardingRule;
private Network network;
private boolean networksDisabled;
@BeforeGroups(groups = "live")
public void setupContext() {
super.setupContext();
prefix += "rule";
try {
network = find(client.getNetworkClient().listNetworks(), Predicates.and(supportsPortForwarding(),
new Predicate<Network>() {
@Override
public boolean apply(Network network) {
return network.isDefault()
&& !network.isSecurityGroupEnabled()
&& network.getAccount().equals(user.getAccount());
}
}));
String defaultTemplate = template != null ? template.getImageId() : null;
vm = VirtualMachineClientLiveTest.createVirtualMachineInNetwork(network,
defaultTemplateOrPreferredInZone(defaultTemplate, client, network.getZoneId()),
client, jobComplete, virtualMachineRunning);
if (vm.getPassword() != null && loginCredentials.getOptionalPassword() == null)
loginCredentials = loginCredentials.toBuilder().password(vm.getPassword()).build();
} catch (NoSuchElementException e) {
networksDisabled = true;
}
}
public void testCreatePortForwardingRule() throws Exception {
if (networksDisabled)
return;
while (portForwardingRule == null) {
ip = reuseOrAssociate.apply(network);
try {
AsyncCreateResponse job = client.getFirewallClient()
.createPortForwardingRuleForVirtualMachine(ip.getId(), PortForwardingRule.Protocol.TCP, 22, vm.getId(), 22);
assertTrue(jobComplete.apply(job.getJobId()));
portForwardingRule = client.getFirewallClient().getPortForwardingRule(job.getId());
} catch (IllegalStateException e) {
Logger.CONSOLE.error("Failed while trying to allocate ip: " + e);
// very likely an ip conflict, so retry;
}
}
assertEquals(portForwardingRule.getIPAddressId(), ip.getId());
assertEquals(portForwardingRule.getVirtualMachineId(), vm.getId());
assertEquals(portForwardingRule.getPublicPort(), 22);
assertEquals(portForwardingRule.getProtocol(), PortForwardingRule.Protocol.TCP);
checkPortForwardingRule(portForwardingRule);
checkSSH(HostAndPort.fromParts(ip.getIPAddress(), 22));
}
@Test(dependsOnMethods = "testCreatePortForwardingRule")
public void testListPortForwardingRules() throws Exception {
Set<PortForwardingRule> response = client.getFirewallClient().listPortForwardingRules();
assert null != response;
assertTrue(response.size() >= 0);
for (final PortForwardingRule rule : response) {
checkPortForwardingRule(rule);
}
}
@Test(dependsOnMethods = "testCreatePortForwardingRule")
public void testCreateFirewallRule() {
if (networksDisabled)
return;
AsyncCreateResponse job = client.getFirewallClient().createFirewallRuleForIpAndProtocol(
ip.getId(), FirewallRule.Protocol.TCP, CreateFirewallRuleOptions.Builder.startPort(30).endPort(35));
assertTrue(jobComplete.apply(job.getJobId()));
firewallRule = client.getFirewallClient().getFirewallRule(job.getId());
assertEquals(firewallRule.getStartPort(), 30);
assertEquals(firewallRule.getEndPort(), 35);
assertEquals(firewallRule.getProtocol(), FirewallRule.Protocol.TCP);
checkFirewallRule(firewallRule);
}
@Test(dependsOnMethods = "testCreateFirewallRule")
public void testListFirewallRules() {
Set<FirewallRule> rules = client.getFirewallClient().listFirewallRules();
assert rules != null;
assertTrue(rules.size() > 0);
for(FirewallRule rule : rules) {
checkFirewallRule(rule);
}
}
@Test(dependsOnMethods = "testCreatePortForwardingRule")
public void testCreateEgressFirewallRule() {
if (networksDisabled)
return;
AsyncCreateResponse job = client.getFirewallClient().createEgressFirewallRuleForIpAndProtocol(
ip.getId(), FirewallRule.Protocol.TCP, CreateFirewallRuleOptions.Builder.startPort(30).endPort(35));
assertTrue(jobComplete.apply(job.getJobId()));
egressFirewallRule = client.getFirewallClient().getEgressFirewallRule(job.getId());
assertEquals(egressFirewallRule.getStartPort(), 30);
assertEquals(egressFirewallRule.getEndPort(), 35);
assertEquals(egressFirewallRule.getProtocol(), FirewallRule.Protocol.TCP);
checkEgressFirewallRule(egressFirewallRule);
}
@Test(dependsOnMethods = "testCreateEgressFirewallRule")
public void testListEgressFirewallRules() {
Set<FirewallRule> rules = client.getFirewallClient().listEgressFirewallRules();
assert rules != null;
assertTrue(rules.size() > 0);
for(FirewallRule rule : rules) {
checkEgressFirewallRule(rule);
}
}
@AfterGroups(groups = "live")
@Override
protected void tearDownContext() {
if (firewallRule != null) {
client.getFirewallClient().deleteFirewallRule(firewallRule.getId());
}
if (egressFirewallRule != null) {
client.getFirewallClient().deleteEgressFirewallRule(egressFirewallRule.getId());
}
if (portForwardingRule != null) {
client.getFirewallClient().deletePortForwardingRule(portForwardingRule.getId());
}
if (vm != null) {
jobComplete.apply(client.getVirtualMachineClient().destroyVirtualMachine(vm.getId()));
}
if (ip != null) {
client.getAddressClient().disassociateIPAddress(ip.getId());
}
super.tearDownContext();
}
protected void checkFirewallRule(FirewallRule rule) {
assertEquals(rule,
client.getFirewallClient().getFirewallRule(rule.getId()));
assert rule.getId() != null : rule;
assert rule.getStartPort() > 0 : rule;
assert rule.getEndPort() >= rule.getStartPort() : rule;
assert rule.getProtocol() != null;
}
protected void checkEgressFirewallRule(FirewallRule rule) {
assertEquals(rule,
client.getFirewallClient().getEgressFirewallRule(rule.getId()));
assert rule.getId() != null : rule;
assert rule.getStartPort() > 0 : rule;
assert rule.getEndPort() >= rule.getStartPort() : rule;
assert rule.getProtocol() != null;
}
protected void checkPortForwardingRule(PortForwardingRule rule) {
assertEquals(rule,
client.getFirewallClient().getPortForwardingRule(rule.getId()));
assert rule.getId() != null : rule;
assert rule.getIPAddress() != null : rule;
assert rule.getIPAddressId() != null : rule;
assert rule.getPrivatePort() > 0 : rule;
assert rule.getProtocol() != null : rule;
assert rule.getPublicPort() > 0 : rule;
assert rule.getState() != null : rule;
assert rule.getVirtualMachineId() != null : rule;
assert rule.getVirtualMachineName() != null : rule;
}
}