providers/softlayer/src/test/java/org/jclouds/softlayer/features/VirtualGuestApiLiveTest.java

/*
 * 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.softlayer.features;

import static com.google.common.base.Preconditions.checkState;
import static org.assertj.core.api.Assertions.assertThat;
import static org.jclouds.util.Predicates2.retry;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertNull;
import static org.testng.Assert.assertTrue;
import java.util.Properties;
import java.util.Set;

import org.jclouds.softlayer.SoftLayerApi;
import org.jclouds.softlayer.compute.strategy.SoftLayerComputeServiceAdapter.VirtualGuestHasLoginDetailsPresent;
import org.jclouds.softlayer.domain.ContainerVirtualGuestConfiguration;
import org.jclouds.softlayer.domain.Datacenter;
import org.jclouds.softlayer.domain.OperatingSystem;
import org.jclouds.softlayer.domain.TagReference;
import org.jclouds.softlayer.domain.VirtualGuest;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;

import com.google.common.base.Predicate;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.inject.Injector;
import com.google.inject.Module;

/**
 * Tests behavior of {@code VirtualGuestApi}
 */
@Test(groups = "live")
public class VirtualGuestApiLiveTest extends BaseSoftLayerApiLiveTest {

   private VirtualGuestApi virtualGuestApi;
   private Predicate<VirtualGuest> loginDetailsTester;
   private VirtualGuestHasLoginDetailsPresent virtualGuestHasLoginDetailsPresent;
   private long guestLoginDelay = 60 * 60 * 1000;

   private VirtualGuest virtualGuest = null;
   private Datacenter datacenter = null;

   @BeforeClass(groups = {"integration", "live"})
   @Override
   public void setup() {
      super.setup();
      virtualGuestApi = api.getVirtualGuestApi();
      datacenter = Iterables.get(api.getDatacenterApi().listDatacenters(), 0);
      assertNotNull(datacenter, "Datacenter must not be null");
   }

   @AfterClass(groups = {"integration", "live"})
   protected void tearDownContext() {
      if (virtualGuest != null) {
         destroyMachine(virtualGuest);
         virtualGuest = null;
      }
   }

   @Override
   protected SoftLayerApi create(Properties props, Iterable<Module> modules) {
      Injector injector = newBuilder().modules(modules).overrides(props).buildInjector();
      virtualGuestHasLoginDetailsPresent = injector.getInstance(VirtualGuestHasLoginDetailsPresent.class);
      loginDetailsTester = retry(virtualGuestHasLoginDetailsPresent, guestLoginDelay);
      return injector.getInstance(SoftLayerApi.class);
   }

   @Test
   public void testGetCreateObjectOptions() {
      ContainerVirtualGuestConfiguration configurationOption = api().getCreateObjectOptions();
      assertNotNull(configurationOption);
   }

   @Test
   public void testCreateVirtualGuest() throws Exception {
      VirtualGuest virtualGuestRequest = VirtualGuest.builder()
              .domain("jclouds.org")
              .hostname("virtualGuestApiLiveTest")
              .startCpus(1)
              .maxMemory(1024)
              .operatingSystem(OperatingSystem.builder().id("CENTOS_6_64").operatingSystemReferenceCode("CENTOS_6_64").build())
              .datacenter(Datacenter.builder().name(datacenter.getName()).build())
              .build();

      virtualGuest = virtualGuestApi.createVirtualGuest(virtualGuestRequest);
      boolean orderInSystem = loginDetailsTester.apply(virtualGuest);
      checkState(orderInSystem, "order for guest %s doesn't have login details within %sms", virtualGuest,
              Long.toString(guestLoginDelay));
      virtualGuest = virtualGuestApi.getVirtualGuest(virtualGuest.getId());
      checkVirtualGuest(virtualGuest);
      assertNotNull(virtualGuest.getPrimaryIpAddress(), "primaryIpAddress must be not null");
      assertNotNull(virtualGuest.getPrimaryBackendIpAddress(), "backendIpAddress must be not null");
   }

   @Test(dependsOnMethods = "testCreateVirtualGuest")
   public void testGetVirtualGuest() throws Exception {
      VirtualGuest found = virtualGuestApi.getVirtualGuest(virtualGuest.getId());
      assertEquals(found, virtualGuest);
      assertNull(found.getPrimaryBackendNetworkComponent(), "backendNetworkComponent should be null");
   }

   @Test(dependsOnMethods = "testGetVirtualGuest")
   public void testGetVirtualGuestFiltered() throws Exception {
      VirtualGuest found = virtualGuestApi.getVirtualGuestFiltered(virtualGuest.getId(), "id;primaryBackendNetworkComponent;primaryBackendNetworkComponent.networkVlan");
      assertEquals(found.getId(), virtualGuest.getId());
      assertNotNull(found.getPrimaryBackendNetworkComponent(), "backendNetworkComponent must be returned");
      assertNotNull(found.getPrimaryBackendNetworkComponent().getNetworkVlan(), "backendNetworkComponent networkVlan must be returned");
      assertTrue(found.getPrimaryBackendNetworkComponent().getNetworkVlan().getId() > 0, "backendNetworkComponent must have a valid networkVlan ID");
   }

   @Test(dependsOnMethods = "testGetVirtualGuestFiltered")
   public void testSetTagsOnVirtualGuest() throws Exception {
      ImmutableSet<String> tags = ImmutableSet.of("test", "jclouds");
      assertTrue(virtualGuestApi.setTags(virtualGuest.getId(), tags));
      VirtualGuest found = virtualGuestApi.getVirtualGuest(virtualGuest.getId());
      Set<TagReference> tagReferences = found.getTagReferences();
      assertNotNull(tagReferences);

      ImmutableSet.Builder<String> actualTagsBuilder = ImmutableSet.builder();
      for (TagReference ref : tagReferences) {
         actualTagsBuilder.add(ref.getTag().getName());
      }
      Set<String> actualTags = actualTagsBuilder.build();
      assertThat(actualTags).containsAll(tags);
   }

   @Test(dependsOnMethods = "testSetTagsOnVirtualGuest")
   public void testSetNotesOnVirtualGuest() throws Exception {
      // Test with maximum allowed notes length - 1000 characters.
      String notes = Strings.padStart("", 1000, 'x');
      assertTrue(virtualGuestApi.setNotes(virtualGuest.getId(), notes));
      VirtualGuest found = virtualGuestApi.getNotes(virtualGuest.getId());
      assertEquals(found.getNotes(), notes);
   }

   @Test(dependsOnMethods = "testSetNotesOnVirtualGuest")
   public void testPauseVirtualGuest() throws Exception {
      virtualGuestApi.pauseVirtualGuest(virtualGuest.getId());
      checkState(retry(new Predicate<VirtualGuest>() {
         public boolean apply(VirtualGuest guest) {
            guest = api().getVirtualGuest(virtualGuest.getId());
            return guest.getPowerState().getKeyName() == VirtualGuest.State.PAUSED;
         }
      }, 5 * 60 * 1000).apply(virtualGuest), "%s still not paused!", virtualGuest);
      VirtualGuest found = virtualGuestApi.getVirtualGuest(virtualGuest.getId());
      assertTrue(found.getPowerState().getKeyName() == VirtualGuest.State.PAUSED);
   }

   @Test(dependsOnMethods = "testPauseVirtualGuest")
   public void testResumeVirtualGuest() throws Exception {
      virtualGuestApi.resumeVirtualGuest(virtualGuest.getId());
      checkState(retry(new Predicate<VirtualGuest>() {
         public boolean apply(VirtualGuest guest) {
            guest = api().getVirtualGuest(virtualGuest.getId());
            return guest.getPowerState().getKeyName() == VirtualGuest.State.RUNNING;
         }
      }, 5 * 60 * 1000).apply(virtualGuest), "%s still not running!", virtualGuest);
      VirtualGuest found = virtualGuestApi.getVirtualGuest(virtualGuest.getId());
      assertTrue(found.getPowerState().getKeyName() == VirtualGuest.State.RUNNING);
   }

   private void destroyMachine(final VirtualGuest virtualGuest) {
      checkState(retry(new Predicate<VirtualGuest>() {
         public boolean apply(VirtualGuest guest) {
            guest = api().getVirtualGuest(virtualGuest.getId());
            return guest.getActiveTransactionCount() == 0;
         }
      }, 5 * 60 * 1000).apply(virtualGuest), "%s still has active transactions!", virtualGuest);
      assertTrue(api().deleteVirtualGuest(virtualGuest.getId()));
   }

   private VirtualGuestApi api() {
      return api.getVirtualGuestApi();
   }

   private void checkVirtualGuest(VirtualGuest vg) {
      if (vg.getActiveTransactionCount() == 0) {
         assertNotNull(vg.getDomain(), "domain must be not null");
         assertNotNull(vg.getFullyQualifiedDomainName(), "fullyQualifiedDomainName must be not null");
         assertNotNull(vg.getHostname(), "hostname must be not null");
         assertTrue(vg.getId() > 0, "id must be greater than 0");
         assertTrue(vg.getMaxCpu() > 0, "maxCpu must be greater than 0");
         assertTrue(vg.getMaxMemory() > 0, "maxMemory must be greater than 0");
         assertTrue(vg.getStatusId() > 0, "statusId must be greater than 0");
      }
   }

}