ref(wadm): simplify PutResult WIP

Signed-off-by: Márk Kővári <kovarimarkofficial@gmail.com>
wasmCloud · Jan 5, 2025 · bbf5445 · bbf5445
1 parent 77f5bc8
commit bbf5445
Show file tree

Hide file tree

Showing 10 changed files with 120 additions and 33 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-22.04]
-        nats_version: [2.10.7]
+        nats_version: [2.10.18]
 
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

diff --git a/Makefile b/Makefile
@@ -78,7 +78,7 @@ CARGO_TEST_TARGET ?=
 
 test:: ## Run tests
 ifeq ($(shell nc $(NC_FLAGS) -w1 127.0.0.1 4222 || echo fail),fail)
-	$(DOCKER) run --rm -d --name wadm-test -p 127.0.0.1:4222:4222 nats:2.10 -js
+	$(DOCKER) run --rm -d --name wadm-test -p 127.0.0.1:4222:4222 nats:2.10.18-alpine -js
 	$(CARGO) test $(CARGO_TEST_TARGET) -- --nocapture
 	$(DOCKER) stop wadm-test
 else

diff --git a/crates/wadm-types/src/api.rs b/crates/wadm-types/src/api.rs
@@ -54,13 +54,18 @@ pub struct PutModelResponse {
     pub name: String,
 }
 
+#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
+pub enum PutResultSuccess {
+    Created,
+    NewVersion(String),
+}
+
 /// Possible outcomes of a put request
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "lowercase")]
 pub enum PutResult {
+    Success(PutResultSuccess),
     Error,
-    Created,
-    NewVersion,
 }
 
 /// Summary of a given model returned when listing

diff --git a/crates/wadm/src/server/handlers.rs b/crates/wadm/src/server/handlers.rs
@@ -10,8 +10,8 @@ use wadm_types::{
     api::{
         DeleteModelRequest, DeleteModelResponse, DeleteResult, DeployModelRequest,
         DeployModelResponse, DeployResult, GetModelRequest, GetModelResponse, GetResult,
-        ListModelsResponse, PutModelResponse, PutResult, Status, StatusResponse, StatusResult,
-        UndeployModelRequest, VersionInfo, VersionResponse,
+        ListModelsResponse, PutModelResponse, PutResult, PutResultSuccess, Status, StatusResponse,
+        StatusResult, UndeployModelRequest, VersionInfo, VersionResponse,
     },
     CapabilityProperties, Manifest, Properties,
 };
@@ -139,13 +139,15 @@ impl<P: Publisher> Handler<P> {
             return;
         }
 
-        let resp = PutModelResponse {
+        let resp: PutModelResponse = PutModelResponse {
             // If we successfully insert, the given manifest version will be the new current version
             current_version: current_manifests.current_version().to_string(),
             result: if current_manifests.count() == 1 {
-                PutResult::Created
+                PutResult::Success(PutResultSuccess::Created)
             } else {
-                PutResult::NewVersion
+                PutResult::Success(PutResultSuccess::NewVersion(
+                    current_manifests.current_version().to_string(),
+                ))
             },
             name: manifest_name.clone(),
             total_versions: current_manifests.count(),

diff --git a/tests/api_model_operations.rs b/tests/api_model_operations.rs
@@ -151,7 +151,12 @@ async fn test_crud_operations() {
 
     println!("Response: {resp:?}");
 
-    assert_put_response(resp, PutResult::Created, "v0.0.1", 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        "v0.0.1",
+        1,
+    );
 
     let raw = tokio::fs::read("./oam/simple1.yaml")
         .await
@@ -165,7 +170,12 @@ async fn test_crud_operations() {
         .await;
     // This manifest has no version, so it's assigned on as a ULID
     let example_version = resp.current_version.clone();
-    assert_put_response(resp, PutResult::Created, &example_version, 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        &example_version,
+        1,
+    );
 
     // Check that we can get back the manifest
     let resp: GetModelResponse = test_server
@@ -214,7 +224,12 @@ async fn test_crud_operations() {
             None,
         )
         .await;
-    assert_put_response(resp, PutResult::NewVersion, "v0.0.2", 2);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::NewVersion("v0.0.2".to_string())),
+        "v0.0.2",
+        2,
+    );
 
     manifest
         .metadata
@@ -227,7 +242,12 @@ async fn test_crud_operations() {
             None,
         )
         .await;
-    assert_put_response(resp, PutResult::NewVersion, "v0.0.3", 3);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::NewVersion("v0.0.3".to_string())),
+        "v0.0.3",
+        3,
+    );
 
     // Make sure we still only have 2 manifests
     let ListModelsResponse { models: resp, .. } = test_server
@@ -391,7 +411,12 @@ async fn test_bad_requests() {
         .get_response("default.model.put", raw, None)
         .await;
 
-    assert_put_response(resp, PutResult::Created, "v0.0.1", 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        "v0.0.1",
+        1,
+    );
 
     // https://imgflip.com/memegenerator/195657242/Do-it-again
     let raw = tokio::fs::read("./oam/sqldbpostgres.yaml")
@@ -489,7 +514,12 @@ async fn test_delete_noop() {
         .get_response("default.model.put", raw, None)
         .await;
 
-    assert_put_response(resp, PutResult::Created, "v0.0.1", 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        "v0.0.1",
+        1,
+    );
 
     let resp: DeleteModelResponse = test_server
         .get_response(
@@ -528,7 +558,12 @@ async fn test_invalid_topics() {
         .get_response("default.model.put", raw, None)
         .await;
 
-    assert_put_response(resp, PutResult::Created, "v0.0.1", 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        "v0.0.1",
+        1,
+    );
 
     // Too short
     let resp: HashMap<String, String> = test_server
@@ -610,7 +645,12 @@ async fn test_manifest_parsing() {
     // This manifest has no version, so it's assigned on as a ULID
     let version = resp.current_version.clone();
 
-    assert_put_response(resp, PutResult::Created, &version, 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        &version,
+        1,
+    );
 
     // Test yaml manifest with hint
     let raw = tokio::fs::read("./oam/sqldbpostgres.yaml")
@@ -624,7 +664,12 @@ async fn test_manifest_parsing() {
         )
         .await;
 
-    assert_put_response(resp, PutResult::Created, "v0.0.1", 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        "v0.0.1",
+        1,
+    );
 
     // Test json manifest with hint
     manifest
@@ -640,7 +685,12 @@ async fn test_manifest_parsing() {
         )
         .await;
 
-    assert_put_response(resp, PutResult::NewVersion, "v0.0.2", 2);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::NewVersion("v0.0.2".to_string())),
+        "v0.0.2",
+        2,
+    );
 
     // Smoke test to make sure the server can handle the various provider config options
     let raw = tokio::fs::read("./oam/config.yaml")
@@ -652,7 +702,12 @@ async fn test_manifest_parsing() {
     // This manifest has no version, so it's assigned on as a ULID
     let version = resp.current_version.clone();
 
-    assert_put_response(resp, PutResult::Created, &version, 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        &version,
+        1,
+    );
 }
 
 #[tokio::test]
@@ -675,7 +730,12 @@ async fn test_deploy() {
         .get_response("default.model.put", raw, None)
         .await;
 
-    assert_put_response(resp, PutResult::Created, "v0.0.1", 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        "v0.0.1",
+        1,
+    );
     manifest
         .metadata
         .annotations
@@ -687,7 +747,12 @@ async fn test_deploy() {
             None,
         )
         .await;
-    assert_put_response(resp, PutResult::NewVersion, "v0.0.2", 2);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::NewVersion("v0.0.2".to_string())),
+        "v0.0.2",
+        2,
+    );
 
     // Try to deploy and undeploy something that doesn't exist
     let resp: DeployModelResponse = test_server
@@ -850,7 +915,12 @@ async fn test_delete_deploy() {
         .get_response("default.model.put", raw, None)
         .await;
 
-    assert_put_response(resp, PutResult::Created, "v0.0.1", 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        "v0.0.1",
+        1,
+    );
     manifest
         .metadata
         .annotations
@@ -862,7 +932,12 @@ async fn test_delete_deploy() {
             None,
         )
         .await;
-    assert_put_response(resp, PutResult::NewVersion, "v0.0.2", 2);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::NewVersion("v0.0.2".to_string())),
+        "v0.0.2",
+        2,
+    );
 
     let resp: DeployModelResponse = test_server
         .get_response(
@@ -942,7 +1017,12 @@ async fn test_status() {
     let resp: PutModelResponse = test_server
         .get_response("default.model.put", raw, None)
         .await;
-    assert_put_response(resp, PutResult::Created, "v0.0.1", 1);
+    assert_put_response(
+        resp,
+        PutResult::Success(PutResultSuccess::Created),
+        "v0.0.1",
+        1,
+    );
 
     let resp: StatusResponse = test_server
         .get_response(

diff --git a/tests/docker-compose-e2e_multiple_hosts.yaml b/tests/docker-compose-e2e_multiple_hosts.yaml
@@ -1,6 +1,6 @@
 services:
   nats:
-    image: nats:2.10-alpine
+    image: nats:2.10.18-alpine
     command: ['-js']
     ports:
       - 4222:4222

diff --git a/tests/docker-compose-e2e_multitenant.yaml b/tests/docker-compose-e2e_multitenant.yaml
@@ -1,7 +1,7 @@
 services:
   # Set up a NATS core node and two leaf nodes which will connect with basic auth.
   nats-core:
-    image: nats:2.9.16-alpine
+    image: nats:2.10.18-alpine
     ports:
       - "127.0.0.1:5222:5222"
       - "127.0.0.1:7422:7422"
@@ -11,7 +11,7 @@ services:
   nats-leaf-wadm:
     depends_on:
       - nats-core
-    image: nats:2.9.16-alpine
+    image: nats:2.10.18-alpine
     ports:
       - "127.0.0.1:4222:4222"
     command: ["-js", "-a", "0.0.0.0", "-c", "/nats/config/nats-leaf-wadm.conf"]
@@ -20,7 +20,7 @@ services:
   nats-leaf-a:
     depends_on:
       - nats-core
-    image: nats:2.9.16-alpine
+    image: nats:2.10.18-alpine
     ports:
       - "127.0.0.1:4223:4222"
     command: ["-js", "-a", "0.0.0.0", "-c", "/nats/config/nats-leaf-a.conf"]
@@ -29,7 +29,7 @@ services:
   nats-leaf-b:
     depends_on:
       - nats-core
-    image: nats:2.9.16-alpine
+    image: nats:2.10.18-alpine
     ports:
       - "127.0.0.1:4224:4222"
     command: ["-js", "-a", "0.0.0.0", "-c", "/nats/config/nats-leaf-b.conf"]

diff --git a/tests/docker-compose-e2e_shared.yaml b/tests/docker-compose-e2e_shared.yaml
@@ -1,6 +1,6 @@
 services:
   nats:
-    image: nats:2.10-alpine
+    image: nats:2.10.18-alpine
     command: ['-js']
     ports:
       - 4222:4222

diff --git a/tests/docker-compose-e2e_upgrades.yaml b/tests/docker-compose-e2e_upgrades.yaml
@@ -1,6 +1,6 @@
 services:
   nats:
-    image: nats:2.10-alpine
+    image: nats:2.10.18-alpine
     command: ['-js']
     ports:
       - 4222:4222

diff --git a/tests/helpers.rs b/tests/helpers.rs
@@ -80,7 +80,7 @@ pub async fn setup_env() -> Result<TestEnv> {
 }
 
 async fn start_nats_server() -> Result<ContainerAsync<GenericImage>> {
-    GenericImage::new("nats", "2.10.18")
+    GenericImage::new("nats", "2.10.18-alpine")
         .with_exposed_port(DEFAULT_NATS_PORT.into())
         .with_wait_for(WaitFor::message_on_stderr("Server is ready"))
         .with_cmd(["-js"])