Adding the Dimension Data Tag API interface.

dimensiondata/pom.xml

@@ -145,7 +145,7 @@
                                         <test.dimensiondata-cloudcontrol.credential>
                                             ${test.dimensiondata-cloudcontrol.credential}
                                         </test.dimensiondata-cloudcontrol.credential>
-                                        <jclouds.zones>EU6</jclouds.zones>
+                                        <jclouds.zones>NA9</jclouds.zones>
                                     </systemPropertyVariables>
                                 </configuration>
                             </execution>

dimensiondata/src/main/java/org/jclouds/dimensiondata/cloudcontrol/DimensionDataCloudControlApi.java

@@ -21,6 +21,7 @@
 import org.jclouds.dimensiondata.cloudcontrol.features.NetworkApi;
 import org.jclouds.dimensiondata.cloudcontrol.features.ServerApi;
 import org.jclouds.dimensiondata.cloudcontrol.features.ServerImageApi;
+import org.jclouds.dimensiondata.cloudcontrol.features.TagApi;
 import org.jclouds.rest.annotations.Delegate;
 
 import java.io.Closeable;
@@ -41,4 +42,7 @@ public interface DimensionDataCloudControlApi extends Closeable {
 
    @Delegate
    ServerApi getServerApi();
+
+   @Delegate
+   TagApi getTagApi();
 }

dimensiondata/src/main/java/org/jclouds/dimensiondata/cloudcontrol/domain/Tag.java

@@ -30,6 +30,7 @@ public abstract class Tag {
 
    public abstract String assetId();
 
+   @Nullable
    public abstract String datacenterId();
 
    public abstract String tagKeyId();

dimensiondata/src/main/java/org/jclouds/dimensiondata/cloudcontrol/features/TagApi.java

@@ -0,0 +1,210 @@
+/*
+ * 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.dimensiondata.cloudcontrol.features;
+
+import com.google.common.base.Function;
+import com.google.common.base.Optional;
+import com.google.inject.TypeLiteral;
+import org.jclouds.Fallbacks;
+import org.jclouds.collect.IterableWithMarker;
+import org.jclouds.collect.PagedIterable;
+import org.jclouds.collect.internal.Arg0ToPagedIterable;
+import org.jclouds.dimensiondata.cloudcontrol.DimensionDataCloudControlApi;
+import org.jclouds.dimensiondata.cloudcontrol.domain.PaginatedCollection;
+import org.jclouds.dimensiondata.cloudcontrol.domain.Tag;
+import org.jclouds.dimensiondata.cloudcontrol.domain.TagInfo;
+import org.jclouds.dimensiondata.cloudcontrol.domain.TagKey;
+import org.jclouds.dimensiondata.cloudcontrol.domain.TagKeys;
+import org.jclouds.dimensiondata.cloudcontrol.domain.Tags;
+import org.jclouds.dimensiondata.cloudcontrol.filters.OrganisationIdFilter;
+import org.jclouds.dimensiondata.cloudcontrol.options.PaginationOptions;
+import org.jclouds.dimensiondata.cloudcontrol.utils.ParseResponse;
+import org.jclouds.http.filters.BasicAuthentication;
+import org.jclouds.http.functions.ParseJson;
+import org.jclouds.json.Json;
+import org.jclouds.rest.annotations.Fallback;
+import org.jclouds.rest.annotations.MapBinder;
+import org.jclouds.rest.annotations.PayloadParam;
+import org.jclouds.rest.annotations.RequestFilters;
+import org.jclouds.rest.annotations.ResponseParser;
+import org.jclouds.rest.annotations.Transform;
+import org.jclouds.rest.binders.BindToJsonPayload;
+
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.inject.Singleton;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import java.util.List;
+
+@RequestFilters({ BasicAuthentication.class, OrganisationIdFilter.class })
+@Consumes(MediaType.APPLICATION_JSON)
+@Path("/{jclouds.api-version}/tag")
+public interface TagApi {
+
+   @Named("tag:createTagKey")
+   @POST
+   @Path("/createTagKey")
+   @Produces(MediaType.APPLICATION_JSON)
+   @MapBinder(BindToJsonPayload.class)
+   @ResponseParser(TagKeyId.class)
+   String createTagKey(@PayloadParam("name") String name, @PayloadParam("description") String description,
+         @PayloadParam("valueRequired") boolean valueRequired,
+         @PayloadParam("displayOnReport") boolean displayOnReport);
+
+   @Named("tag:applyTags")
+   @POST
+   @Path("/applyTags")
+   @MapBinder(BindToJsonPayload.class)
+   void applyTags(@PayloadParam("assetId") String assetId, @PayloadParam("assetType") String assetType,
+         @PayloadParam("tagById") List<TagInfo> tagById);
+
+   @Named("tag:removeTags")
+   @POST
+   @Path("/removeTags")
+   @MapBinder(BindToJsonPayload.class)
+   void removeTags(@PayloadParam("assetId") String assetId, @PayloadParam("assetType") String assetType,
+         @PayloadParam("tagKeyId") List<String> tagKeyName);
+
+   @Named("tag:tagKey")
+   @GET
+   @Path("/tagKey")
+   @Fallback(Fallbacks.EmptyIterableWithMarkerOnNotFoundOr404.class)
+   @ResponseParser(ParseTagKeys.class)
+   PaginatedCollection<TagKey> listTagKeys(PaginationOptions options);
+
+   @Named("tag:tagKey")
+   @GET
+   @Path("/tagKey")
+   @Fallback(Fallbacks.EmptyPagedIterableOnNotFoundOr404.class)
+   @ResponseParser(ParseTagKeys.class)
+   @Transform(ParseTagKeys.ToPagedIterable.class)
+   PagedIterable<TagKey> listTagKeys();
+
+   @Named("tag:tagKeyById")
+   @GET
+   @Path("/tagKey/{tagKeyId}")
+   @Fallback(Fallbacks.NullOnNotFoundOr404.class)
+   TagKey tagKeyById(@PathParam("tagKeyId") String tagKeyId);
+
+   @Named("tag:editTagKey")
+   @POST
+   @Path("/editTagKey")
+   @Produces(MediaType.APPLICATION_JSON)
+   @MapBinder(BindToJsonPayload.class)
+   void editTagKey(@PayloadParam("name") String name, @PayloadParam("id") String id,
+         @PayloadParam("description") String description, @PayloadParam("valueRequired") Boolean valueRequired,
+         @PayloadParam("displayOnReport") Boolean displayOnReport);
+
+   @Named("tag:deleteTagKey")
+   @POST
+   @Path("/deleteTagKey")
+   @Produces(MediaType.APPLICATION_JSON)
+   @MapBinder(BindToJsonPayload.class)
+   @Fallback(Fallbacks.VoidOnNotFoundOr404.class)
+   void deleteTagKey(@PayloadParam("id") String id);
+
+   @Named("tag:tags")
+   @GET
+   @Path("/tag")
+   @Fallback(Fallbacks.EmptyIterableWithMarkerOnNotFoundOr404.class)
+   @ResponseParser(ParseTags.class)
+   PaginatedCollection<Tag> listTags(PaginationOptions options);
+
+   @Named("tag:tags")
+   @GET
+   @Path("/tag")
+   @Fallback(Fallbacks.EmptyPagedIterableOnNotFoundOr404.class)
+   @ResponseParser(ParseTags.class)
+   @Transform(ParseTags.ToPagedIterable.class)
+   PagedIterable<Tag> listTags();
+
+   @Singleton
+   final class ParseTagKeys extends ParseJson<TagKeys> {
+
+      @Inject
+      ParseTagKeys(final Json json, final TypeLiteral<TagKeys> type) {
+         super(json, type);
+      }
+
+      private static class ToPagedIterable extends Arg0ToPagedIterable<TagKey, ToPagedIterable> {
+
+         private final DimensionDataCloudControlApi api;
+
+         @Inject
+         ToPagedIterable(final DimensionDataCloudControlApi api) {
+            this.api = api;
+         }
+
+         @Override
+         protected Function<Object, IterableWithMarker<TagKey>> markerToNextForArg0(Optional<Object> arg0) {
+            return new Function<Object, IterableWithMarker<TagKey>>() {
+               @Override
+               public IterableWithMarker<TagKey> apply(Object input) {
+                  PaginationOptions paginationOptions = PaginationOptions.class.cast(input);
+                  return api.getTagApi().listTagKeys(paginationOptions);
+               }
+            };
+         }
+      }
+   }
+
+   @Singleton
+   final class ParseTags extends ParseJson<Tags> {
+
+      @Inject
+      ParseTags(final Json json, final TypeLiteral<Tags> type) {
+         super(json, type);
+      }
+
+      private static class ToPagedIterable extends Arg0ToPagedIterable<Tag, ToPagedIterable> {
+
+         private final DimensionDataCloudControlApi api;
+
+         @Inject
+         ToPagedIterable(final DimensionDataCloudControlApi api) {
+            this.api = api;
+         }
+
+         @Override
+         protected Function<Object, IterableWithMarker<Tag>> markerToNextForArg0(Optional<Object> optional) {
+            return new Function<Object, IterableWithMarker<Tag>>() {
+               @Override
+               public IterableWithMarker<Tag> apply(Object input) {
+                  PaginationOptions paginationOptions = PaginationOptions.class.cast(input);
+                  return api.getTagApi().listTags(paginationOptions);
+               }
+            };
+         }
+      }
+   }
+
+   @Singleton
+   final class TagKeyId extends ParseResponse {
+
+      @Inject
+      TagKeyId(final Json json) {
+         super(json, "tagKeyId");
+      }
+   }
+
+}

dimensiondata/src/test/java/org/jclouds/dimensiondata/cloudcontrol/features/TagApiLiveTest.java

@@ -0,0 +1,137 @@
+/*
+ * 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.dimensiondata.cloudcontrol.features;
+
+import com.google.common.base.Predicate;
+import com.google.common.collect.FluentIterable;
+import org.jclouds.collect.PagedIterable;
+import org.jclouds.dimensiondata.cloudcontrol.domain.Tag;
+import org.jclouds.dimensiondata.cloudcontrol.domain.TagInfo;
+import org.jclouds.dimensiondata.cloudcontrol.domain.TagKey;
+import org.jclouds.dimensiondata.cloudcontrol.internal.BaseDimensionDataCloudControlApiLiveTest;
+import org.testng.annotations.AfterClass;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
+import java.util.Collections;
+
+import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertNotNull;
+import static org.testng.Assert.assertTrue;
+import static org.testng.AssertJUnit.assertEquals;
+
+@Test(groups = "live", testName = "TagApiLiveTest", singleThreaded = true)
+public class TagApiLiveTest extends BaseDimensionDataCloudControlApiLiveTest {
+
+   private String tagKeyId;
+   private String tagKeyName;
+   private String assetType = "SERVER";
+
+   @BeforeClass
+   public void setup() {
+      super.setup();
+      createTagKeyIfNotExist();
+      applyTagToAsset();
+   }
+
+   private void applyTagToAsset() {
+      if (tagKeyId != null) {
+         api().applyTags(SERVER_ID, assetType, Collections.singletonList(TagInfo.create(tagKeyId, "jcloudsValue")));
+      }
+   }
+
+   private String createTagKey() {
+      tagKeyName = "jcloudsTagKeyName" + System.currentTimeMillis();
+      tagKeyId = api().createTagKey(tagKeyName, "jcloudsTagKeyDescription", Boolean.TRUE, Boolean.FALSE);
+      assertNotNull(tagKeyId);
+      assertTagKeyExistsAndIsValid(tagKeyId, tagKeyName, "jcloudsTagKeyDescription", Boolean.TRUE, Boolean.FALSE);
+      return tagKeyId;
+   }
+
+   @Test
+   public void testEditTagKey() {
+      tagKeyName = "jcloudsTagKeyName" + System.currentTimeMillis();
+      api().editTagKey(tagKeyName, tagKeyId, "newDescription", Boolean.FALSE, Boolean.FALSE);
+      assertTagKeyExistsAndIsValid(tagKeyId, tagKeyName, "newDescription", Boolean.FALSE, Boolean.FALSE);
+   }
+
+   @Test
+   public void testListTagKeys() {
+      PagedIterable<TagKey> response = api().listTagKeys();
+      // assert that the created tag is present in the list of tag keys.
+      assertTrue(FluentIterable.from(response.concat().toList()).anyMatch(new Predicate<TagKey>() {
+         @Override
+         public boolean apply(TagKey input) {
+            return input.id().equals(tagKeyId);
+         }
+      }));
+   }
+
+   private void createTagKeyIfNotExist() {
+      if (tagKeyId == null) {
+         createTagKey();
+      }
+   }
+
+   @Test
+   public void testApplyTags() {
+      api().applyTags(SERVER_ID, assetType, Collections.singletonList(TagInfo.create(tagKeyId, "jcloudsValue")));
+   }
+
+   @Test
+   public void testListTags() {
+      PagedIterable<Tag> response = api().listTags();
+      assertTrue(FluentIterable.from(response.concat().toList()).anyMatch(new Predicate<Tag>() {
+         @Override
+         public boolean apply(Tag input) {
+            return input.tagKeyId().equals(tagKeyId);
+         }
+      }), String.format("Couldn't find tagKeyId %s in listTags response", tagKeyId));
+   }
+
+   @Test(dependsOnMethods = { "testListTags", "testListTagKeys" })
+   public void testRemoveTags() {
+      api().removeTags(SERVER_ID, assetType, Collections.singletonList(tagKeyId));
+      assertFalse(FluentIterable.from(api().listTags().concat().toList()).anyMatch(new Predicate<Tag>() {
+         @Override
+         public boolean apply(Tag input) {
+            return input.tagKeyId().equals(tagKeyId);
+         }
+      }));
+   }
+
+   private void assertTagKeyExistsAndIsValid(String tagKeyId, String tagKeyName, String description,
+         boolean valueRequired, boolean displayOnReport) {
+      TagKey tagKey = api().tagKeyById(tagKeyId);
+      assertNotNull(tagKey);
+      assertEquals(tagKey.name(), tagKeyName);
+      assertEquals(tagKey.description(), description);
+      assertEquals(tagKey.valueRequired(), valueRequired);
+      assertEquals(tagKey.displayOnReport(), displayOnReport);
+   }
+
+   @AfterClass(alwaysRun = true)
+   public void cleanup() {
+      if (tagKeyId != null && !tagKeyId.isEmpty()) {
+         api().deleteTagKey(tagKeyId);
+      }
+   }
+
+   private TagApi api() {
+      return api.getTagApi();
+   }
+}