Rust SDK: Reserved

Implements Reserved, as well as associated tests and examples updated. Completes Rust work on googleforgames#927
markmandel · Sep 9, 2019 · 77355f6 · 77355f6
1 parent 3f96ee1
commit 77355f6
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 6 deletions.
diff --git a/build/includes/sdk.mk b/build/includes/sdk.mk
@@ -126,7 +126,7 @@ run-sdk-conformance-local: ensure-agones-sdk-image
 run-sdk-conformance-no-build: TIMEOUT ?= 30
 run-sdk-conformance-no-build: RANDOM := $(shell bash -c 'echo $$RANDOM')
 run-sdk-conformance-no-build: DELAY ?= $(shell bash -c "echo $$[ ($(RANDOM) % 5 ) + 1 ]s")
-run-sdk-conformance-no-build: TESTS ?= ready,allocate,setlabel,setannotation,gameserver,health,shutdown,watch
+run-sdk-conformance-no-build: TESTS ?= ready,allocate,setlabel,setannotation,gameserver,health,shutdown,watch,reserve
 run-sdk-conformance-no-build: ensure-agones-sdk-image
 run-sdk-conformance-no-build: ensure-build-sdk-image
 	DOCKER_RUN_ARGS="--network=host $(DOCKER_RUN_ARGS)" COMMAND=sdktest $(MAKE) run-sdk-command & \
@@ -140,8 +140,8 @@ run-sdk-conformance-test:
 
 # Run a conformance test for all SDKs supported
 run-sdk-conformance-tests:
-	$(MAKE) run-sdk-conformance-test SDK_FOLDER=node TESTS=ready,allocate,setlabel,setannotation,gameserver,health,shutdown,watch,reserve
-	$(MAKE) run-sdk-conformance-test SDK_FOLDER=go TESTS=ready,allocate,setlabel,setannotation,gameserver,health,shutdown,watch,reserve
+	$(MAKE) run-sdk-conformance-test SDK_FOLDER=node
+	$(MAKE) run-sdk-conformance-test SDK_FOLDER=go
 	$(MAKE) run-sdk-conformance-test SDK_FOLDER=rust
 
 # Clean package directories and binary files left

diff --git a/examples/rust-simple/Makefile b/examples/rust-simple/Makefile
@@ -27,7 +27,7 @@ REPOSITORY ?= gcr.io/agones-images
 
 mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
 project_path := $(dir $(mkfile_path))
-server_tag = $(REPOSITORY)/rust-simple-server:0.4
+server_tag = $(REPOSITORY)/rust-simple-server:0.5
 
 #   _____                    _
 #  |_   _|_ _ _ __ __ _  ___| |_ ___

diff --git a/examples/rust-simple/src/main.rs b/examples/rust-simple/src/main.rs
@@ -84,6 +84,12 @@ fn run() -> Result<(), String> {
 
     println!("...marked Ready");
 
+    println!("Setting as Reserved for 5 seconds");
+    sdk.reserve(Duration::new(5, 0)).map_err(|e| format!("Could not run Reserve(): {}. Exiting!", e))?;
+    println!("...Reserved");
+
+    thread::sleep(Duration::new(6, 0));
+
     println!("Getting GameServer details...");
     let gameserver = sdk
         .get_gameserver()

diff --git a/sdks/rust/src/sdk.rs b/sdks/rust/src/sdk.rs
@@ -18,7 +18,6 @@ use std::time::Duration;
 
 use futures::{Future, Sink, Stream};
 use grpcio;
-use grpcio::CallOption;
 use protobuf::Message;
 
 use errors::*;
@@ -151,6 +150,17 @@ impl Sdk {
         Ok(res)
     }
 
+    /// Reserve marks the Game Server as Reserved for a given duration, at which point
+    /// it will return the GameServer to a Ready state.
+    /// Do note, the smallest unit available in the time.Duration argument is a second.
+    pub fn reserve(&self, duration: Duration) -> Result<()> {
+        let mut d = sdk::Duration::new();
+        d.set_seconds(duration.as_secs() as i64);
+
+        let res = self.client.reserve(&d).map(|_| ())?;
+        Ok(res)
+    }
+
     /// Watch the backing GameServer configuration on updated
     pub fn watch_gameserver<F>(&self, mut watcher: F) -> Result<()>
     where

diff --git a/site/content/en/docs/Guides/Client SDKs/rust.md b/site/content/en/docs/Guides/Client SDKs/rust.md
@@ -52,6 +52,15 @@ To mark the [game session as ready]({{< relref "_index.md#ready" >}}) call `sdk.
 sdk.ready()?;
 ```
 
+
+{{% feature publishVersion-="1.0.0" %}}
+To mark the game server as [reserved]({{< relref "_index.md#reserve-seconds" >}}) for a period of time, call `sdk.reserve(duration)`.
+
+```rust
+sdk.reserve(Duration::new(5, 0))?;
+```
+{{% /feature %}}
+
 To mark that the [game session is completed]({{< relref "_index.md#shutdown" >}}) and the game server should be shut down call `sdk.shutdown()`.
 
 ```rust

diff --git a/test/sdk/rust/src/main.rs b/test/sdk/rust/src/main.rs
@@ -86,6 +86,11 @@ fn run() -> Result<(), String> {
 
     println!("...marked Ready");
 
+    println!("Reserving for 5 seconds");
+    sdk.reserve(Duration::new(5, 0))
+        .map_err(|e| format!("Could not run Reserve(): {}. Exiting!", e))?;
+    println!("...Reserved");
+
     println!("Allocate game server ...");
     sdk.allocate()
         .map_err(|e| format!("Could not run Allocate(): {}. Exiting!", e))?;
@@ -97,7 +102,10 @@ fn run() -> Result<(), String> {
         .get_gameserver()
         .map_err(|e| format!("Could not run GameServer(): {}. Exiting!", e))?;
 
-    println!("GameServer name: {}", gameserver.object_meta.clone().unwrap().name);
+    println!(
+        "GameServer name: {}",
+        gameserver.object_meta.clone().unwrap().name
+    );
 
     println!("Setting a label");
     let creation_ts = gameserver.object_meta.clone().unwrap().creation_timestamp;