Nova client to support getting availability zones and UTs

Issue-ID: SO-3074
Change-Id: Ic8aaa0728a43936cd4c6e1ed590e01ba8f0fb911
Signed-off-by: Boslet, Cory (cb645j) <cb645j@att.com>

7 files changed, 330 insertions, 0 deletions

diff --git a/nova-client/src/main/java/com/woorea/openstack/nova/Nova.java b/nova-client/src/main/java/com/woorea/openstack/nova/Nova.java
index 908e1e9..4073568 100644
--- a/nova-client/src/main/java/com/woorea/openstack/nova/Nova.java
+++ b/nova-client/src/main/java/com/woorea/openstack/nova/Nova.java
@@ -19,6 +19,7 @@ package com.woorea.openstack.nova;
 
 import com.woorea.openstack.base.client.OpenStackClient;
 import com.woorea.openstack.base.client.OpenStackClientConnector;
+import com.woorea.openstack.nova.api.AvailabilityZoneResource;
 import com.woorea.openstack.nova.api.ExtensionsResource;
 import com.woorea.openstack.nova.api.FlavorsResource;
 import com.woorea.openstack.nova.api.ImagesResource;
@@ -61,6 +62,8 @@ public class Nova extends OpenStackClient {
 
     private final HypervisorsExtension hypervisor;
 
+    private final AvailabilityZoneResource availabilityZones;
+
     public Nova(String endpoint, OpenStackClientConnector connector) {
         super(endpoint, connector);
         extensions = new ExtensionsResource(this);
@@ -76,6 +79,7 @@ public class Nova extends OpenStackClient {
         quotaSets = new QuotaSetsResource(this);
         hosts = new HostsExtension(this);
         hypervisor = new HypervisorsExtension(this);
+        availabilityZones = new AvailabilityZoneResource(this);
     }
 
     public Nova(String endpoint) {
@@ -133,4 +137,8 @@ public class Nova extends OpenStackClient {
     public HypervisorsExtension hypervisors() {
         return hypervisor;
     }
+
+    public AvailabilityZoneResource availabilityZones() {
+        return availabilityZones;
+    }
 }
diff --git a/nova-client/src/main/java/com/woorea/openstack/nova/api/AvailabilityZoneResource.java b/nova-client/src/main/java/com/woorea/openstack/nova/api/AvailabilityZoneResource.java
new file mode 100644
index 0000000..e97839e
--- /dev/null
+++ b/nova-client/src/main/java/com/woorea/openstack/nova/api/AvailabilityZoneResource.java
@@ -0,0 +1,45 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Licensed 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package com.woorea.openstack.nova.api;
+
+
+import com.woorea.openstack.base.client.HttpMethod;
+import com.woorea.openstack.base.client.OpenStackClient;
+import com.woorea.openstack.base.client.OpenStackRequest;
+import com.woorea.openstack.nova.model.AvailabilityZones;
+
+public class AvailabilityZoneResource {
+
+    private final OpenStackClient client;
+
+    public AvailabilityZoneResource(OpenStackClient client) {
+        this.client = client;
+    }
+
+    public List list() {
+        return new List(false);
+    }
+
+    public class List extends OpenStackRequest<AvailabilityZones> {
+
+        public List(boolean detail) {
+            super(client, HttpMethod.GET, detail ? "/os-availability-zone/detail" : "/os-availability-zone", null,
+                    AvailabilityZones.class);
+        }
+    }
+
+}
diff --git a/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZone.java b/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZone.java
new file mode 100644
index 0000000..be30f8a
--- /dev/null
+++ b/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZone.java
@@ -0,0 +1,59 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Licensed 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package com.woorea.openstack.nova.model;
+
+import java.io.Serializable;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+
+public class AvailabilityZone implements Serializable {
+
+    private static final long serialVersionUID = 8725482654277645419L;
+
+    @JsonProperty("zoneName")
+    private String name;
+
+    @JsonProperty("zoneState")
+    private AvailabilityZoneState state;
+
+    private String hosts;
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public AvailabilityZoneState getState() {
+        return state;
+    }
+
+    public void setState(AvailabilityZoneState state) {
+        this.state = state;
+    }
+
+    public String getHosts() {
+        return hosts;
+    }
+
+    public void setHosts(String hosts) {
+        this.hosts = hosts;
+    }
+
+}
diff --git a/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZoneState.java b/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZoneState.java
new file mode 100644
index 0000000..f3036a9
--- /dev/null
+++ b/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZoneState.java
@@ -0,0 +1,37 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Licensed 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package com.woorea.openstack.nova.model;
+
+import java.io.Serializable;
+import com.fasterxml.jackson.annotation.JsonRootName;
+
+@JsonRootName("zoneState")
+public class AvailabilityZoneState implements Serializable {
+
+    private static final long serialVersionUID = -8796079699189565186L;
+
+    private boolean available;
+
+    public boolean isAvailable() {
+        return available;
+    }
+
+    public void setAvailable(boolean available) {
+        this.available = available;
+    }
+
+}
diff --git a/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZones.java b/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZones.java
new file mode 100644
index 0000000..93df472
--- /dev/null
+++ b/nova-model/src/main/java/com/woorea/openstack/nova/model/AvailabilityZones.java
@@ -0,0 +1,49 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Licensed 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package com.woorea.openstack.nova.model;
+
+import java.io.Serializable;
+import java.util.Iterator;
+import java.util.List;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+
+public class AvailabilityZones implements Iterable<AvailabilityZone>, Serializable {
+
+    private static final long serialVersionUID = 2497845349603397080L;
+
+    @JsonProperty("availabilityZoneInfo")
+    private List<AvailabilityZone> list;
+
+    /**
+     * @return the list
+     */
+    public List<AvailabilityZone> getList() {
+        return list;
+    }
+
+    @Override
+    public Iterator<AvailabilityZone> iterator() {
+        return list.iterator();
+    }
+
+    @Override
+    public String toString() {
+        return "AvailabilityZones [list=" + list + "]";
+    }
+
+}
diff --git a/nova-model/src/test/java/com/woorea/openstack/nova/model/AvailabilityZoneTest.java b/nova-model/src/test/java/com/woorea/openstack/nova/model/AvailabilityZoneTest.java
new file mode 100644
index 0000000..a7adc13
--- /dev/null
+++ b/nova-model/src/test/java/com/woorea/openstack/nova/model/AvailabilityZoneTest.java
@@ -0,0 +1,60 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2018 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package com.woorea.openstack.nova.model;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.skyscreamer.jsonassert.JSONAssert;
+import org.skyscreamer.jsonassert.JSONCompareMode;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+
+public class AvailabilityZoneTest {
+
+    private static final String EOL = System.lineSeparator();
+
+    private static final String JSON_FULL = "{" + EOL + "\"hosts\": null," + EOL + "\"zoneName\": \"zoneName1\"," + EOL
+            + "\"zoneState\": {" + EOL + "\"available\": true" + EOL + "}" + EOL + "}";
+
+    private ObjectMapper objectMapper = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT)
+            .enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
+            .enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY);
+
+    @Test
+    public void testSerialization() throws Exception {
+        System.out.println("CLASS: " + AvailabilityZone.class.getName());
+        System.out.println("TEST JSON: " + JSON_FULL);
+        AvailabilityZone az = objectMapper.readValue(JSON_FULL, AvailabilityZone.class);
+        String json = objectMapper.writeValueAsString(az);
+        System.out.println("RE-SERIALIZED OBJECT: " + json);
+        JSONAssert.assertEquals(JSON_FULL, json, JSONCompareMode.LENIENT);
+    }
+
+    @Test
+    public void testMethods() throws Exception {
+        AvailabilityZone az = objectMapper.readValue(JSON_FULL, AvailabilityZone.class);
+
+        Assert.assertEquals("zoneName1", az.getName());
+        Assert.assertTrue(az.getState().isAvailable());
+        Assert.assertNull(az.getHosts());
+    }
+}
diff --git a/nova-model/src/test/java/com/woorea/openstack/nova/model/AvailabilityZonesTest.java b/nova-model/src/test/java/com/woorea/openstack/nova/model/AvailabilityZonesTest.java
new file mode 100644
index 0000000..cebc748
--- /dev/null
+++ b/nova-model/src/test/java/com/woorea/openstack/nova/model/AvailabilityZonesTest.java
@@ -0,0 +1,72 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2018 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package com.woorea.openstack.nova.model;
+
+import java.util.List;
+import org.junit.Assert;
+import org.junit.Test;
+import org.skyscreamer.jsonassert.JSONAssert;
+import org.skyscreamer.jsonassert.JSONCompareMode;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+
+public class AvailabilityZonesTest {
+
+    private static final String EOL = System.lineSeparator();
+
+    private static final String JSON_FULL = "{" + EOL + "\"availabilityZoneInfo\": [" + EOL + "{" + EOL
+            + "\"hosts\": null," + EOL + "\"zoneName\": \"zoneName1\"," + EOL + "\"zoneState\": {" + EOL
+            + "\"available\": true" + EOL + "}" + EOL + "}," + EOL + "{" + EOL + "\"hosts\": null," + EOL
+            + "\"zoneName\": \"zoneName2\"," + EOL + "\"zoneState\": {" + EOL + "\"available\": true" + EOL + "}" + EOL
+            + "}" + EOL + "]" + EOL + "}";
+
+    private ObjectMapper objectMapper = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT)
+            .enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
+            .enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY);
+
+    @Test
+    public void testSerialization() throws Exception {
+        System.out.println("CLASS: " + AvailabilityZones.class.getName());
+        System.out.println("TEST JSON: " + JSON_FULL);
+        AvailabilityZones az = objectMapper.readValue(JSON_FULL, AvailabilityZones.class);
+        String json = objectMapper.writeValueAsString(az);
+        System.out.println("RE-SERIALIZED OBJECT: " + json);
+        JSONAssert.assertEquals(JSON_FULL, json, JSONCompareMode.LENIENT);
+    }
+
+    @Test
+    public void testMethods() throws Exception {
+        AvailabilityZones azs = objectMapper.readValue(JSON_FULL, AvailabilityZones.class);
+
+        List<AvailabilityZone> list = azs.getList();
+        Assert.assertNotNull(list);
+        Assert.assertEquals(2, list.size());
+        Assert.assertEquals("zoneName1", azs.getList().get(0).getName());
+
+        int cnt = 0;
+        for (@SuppressWarnings("unused")
+        AvailabilityZone x : azs) {
+            ++cnt;
+        }
+        Assert.assertEquals(2, cnt);
+    }
+}