compute: Introduce labels and meta-data for resources

This change adds the ability to define labels and meta-data for
resources. This can be used in the future to identify servers and pass
data between client and server.

3 files changed, 71 insertions, 20 deletions

diff --git a/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/ComputeClient.kt b/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/ComputeClient.kt
index c7c507ed..8ae08284 100644
--- a/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/ComputeClient.kt
+++ b/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/ComputeClient.kt
@@ -32,12 +32,16 @@ public interface ComputeClient : AutoCloseable {
      * @param name The name of the server to deploy.
      * @param image The image to be deployed.
      * @param flavor The flavor of the machine instance to run this [image] on.
+     * @param labels The identifying labels of the server.
+     * @param meta The non-identifying meta-data of the server.
      * @param start A flag to indicate that the server should be started immediately.
      */
     public suspend fun newServer(
         name: String,
         image: Image,
         flavor: Flavor,
+        labels: Map<String, String> = emptyMap(),
+        meta: Map<String, Any> = emptyMap(),
         start: Boolean = true
     ): Server
 
diff --git a/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/Resource.kt b/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/Resource.kt
new file mode 100644
index 00000000..08120848
--- /dev/null
+++ b/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/Resource.kt
@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2021 AtLarge Research
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.opendc.compute.api
+
+import java.util.UUID
+
+/**
+ * A generic resource provided by the OpenDC Compute service.
+ */
+public interface Resource {
+    /**
+     * The unique identifier of the resource.
+     */
+    public val uid: UUID
+
+    /**
+     * The name of the resource.
+     */
+    public val name: String
+
+    /**
+     * The identifying labels attached to the resource.
+     */
+    public val labels: Map<String, String>
+
+    /**
+     * The non-identifying metadata attached to the resource.
+     */
+    public val meta: Map<String, Any>
+
+    /**
+     * Refresh the local state of the resource.
+     */
+    public suspend fun refresh()
+}
diff --git a/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/Server.kt b/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/Server.kt
index a4f61c03..b508a9f8 100644
--- a/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/Server.kt
+++ b/simulator/opendc-compute/opendc-compute-api/src/main/kotlin/org/opendc/compute/api/Server.kt
@@ -22,18 +22,11 @@
 
 package org.opendc.compute.api
 
-import org.opendc.core.resource.Resource
-
 /**
  * A stateful object representing a server instance that is running on some physical or virtual machine.
  */
 public interface Server : Resource {
     /**
-     * The name of the server.
-     */
-    public override val name: String
-
-    /**
      * The flavor of the server.
      */
     public val flavor: Flavor
@@ -44,27 +37,31 @@ public interface Server : Resource {
     public val image: Image
 
     /**
-     * The tags assigned to the server.
-     */
-    public override val tags: Map<String, String>
-
-    /**
      * The last known state of the server.
      */
     public val state: ServerState
 
     /**
-     * Start the server.
+     * Request the server to be started.
+     *
+     * This method is guaranteed to return after the request was acknowledged, but might return before the server was
+     * started.
      */
     public suspend fun start()
 
     /**
-     * Stop the server.
+     * Request the server to be stopped.
+     *
+     * This method is guaranteed to return after the request was acknowledged, but might return before the server was
+     * stopped.
      */
     public suspend fun stop()
 
     /**
-     * Delete the server instance from the service.
+     * Request the server to be deleted.
+     *
+     * This method is guaranteed to return after the request was acknowledged, but might return before the server was
+     * deleted.
      */
     public suspend fun delete()
 
@@ -81,9 +78,4 @@ public interface Server : Resource {
      * @param watcher The watcher to de-register from the server.
      */
     public fun unwatch(watcher: ServerWatcher)
-
-    /**
-     * Refresh the local state of the resource.
-     */
-    public suspend fun refresh()
 }