Introduce status code response binding in the client side

ballerina-tests/http-advanced-tests/Ballerina.toml

@@ -1,17 +1,17 @@
 [package]
 org = "ballerina"
 name = "http_advanced_tests"
-version = "2.10.13"
+version = "2.11.0"
 
 [[dependency]]
 org = "ballerina"
 name = "http_test_common"
 repository = "local"
-version = "2.10.13"
+version = "2.11.0"
 
 [platform.java17]
 graalvmCompatible = true
 
 [[platform.java17.dependency]]
 scope = "testOnly"
-path = "../../test-utils/build/libs/http-test-utils-2.10.13-SNAPSHOT.jar"
+path = "../../test-utils/build/libs/http-test-utils-2.11.0-SNAPSHOT.jar"

ballerina-tests/http-advanced-tests/Dependencies.toml

@@ -35,7 +35,7 @@ dependencies = [
 [[package]]
 org = "ballerina"
 name = "constraint"
-version = "1.4.0"
+version = "1.5.0"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "jballerina.java"}
@@ -44,7 +44,7 @@ dependencies = [
 [[package]]
 org = "ballerina"
 name = "crypto"
-version = "2.5.0"
+version = "2.6.2"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "jballerina.java"},
@@ -72,7 +72,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "http"
-version = "2.10.13"
+version = "2.11.0"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "auth"},
@@ -105,7 +105,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "http_advanced_tests"
-version = "2.10.13"
+version = "2.11.0"
 dependencies = [
 	{org = "ballerina", name = "crypto"},
 	{org = "ballerina", name = "file"},
@@ -125,7 +125,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "http_test_common"
-version = "2.10.13"
+version = "2.11.0"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "lang.string"},

ballerina-tests/http-client-tests/Ballerina.toml

@@ -1,17 +1,17 @@
 [package]
 org = "ballerina"
 name = "http_client_tests"
-version = "2.10.13"
+version = "2.11.0"
 
 [[dependency]]
 org = "ballerina"
 name = "http_test_common"
 repository = "local"
-version = "2.10.13"
+version = "2.11.0"
 
 [platform.java17]
 graalvmCompatible = true
 
 [[platform.java17.dependency]]
 scope = "testOnly"
-path = "../../test-utils/build/libs/http-test-utils-2.10.13-SNAPSHOT.jar"
+path = "../../test-utils/build/libs/http-test-utils-2.11.0-SNAPSHOT.jar"

ballerina-tests/http-client-tests/Dependencies.toml

@@ -35,7 +35,7 @@ dependencies = [
 [[package]]
 org = "ballerina"
 name = "constraint"
-version = "1.4.0"
+version = "1.5.0"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "jballerina.java"}
@@ -47,7 +47,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "crypto"
-version = "2.5.0"
+version = "2.6.2"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "jballerina.java"},
@@ -69,7 +69,7 @@ dependencies = [
 [[package]]
 org = "ballerina"
 name = "http"
-version = "2.10.13"
+version = "2.11.0"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "auth"},
@@ -102,7 +102,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "http_client_tests"
-version = "2.10.13"
+version = "2.11.0"
 dependencies = [
 	{org = "ballerina", name = "constraint"},
 	{org = "ballerina", name = "http"},
@@ -121,7 +121,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "http_test_common"
-version = "2.10.13"
+version = "2.11.0"
 scope = "testOnly"
 dependencies = [
 	{org = "ballerina", name = "lang.string"},

ballerina-tests/http-client-tests/tests/sc_res_binding_tests.bal

@@ -0,0 +1,267 @@
+// Copyright (c) 2024 WSO2 LLC. (http://www.wso2.org).
+//
+// WSO2 LLC. 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.
+
+import ballerina/http;
+import ballerina/test;
+
+type Album record {|
+    readonly string id;
+    string name;
+    string artist;
+    string genre;
+|};
+
+table<Album> key(id) albums = table [
+    {id: "1", name: "The Dark Side of the Moon", artist: "Pink Floyd", genre: "Progressive Rock"},
+    {id: "2", name: "Back in Black", artist: "AC/DC", genre: "Hard Rock"},
+    {id: "3", name: "The Wall", artist: "Pink Floyd", genre: "Progressive Rock"}
+];
+
+type ErrorMessage record {|
+    string albumId;
+    string message;
+|};
+
+type Headers record {|
+    string user\-id;
+    int req\-id;
+|};
+
+type AlbumNotFound record {|
+    *http:NotFound;
+    ErrorMessage body;
+    Headers headers;
+|};
+
+type AlbumFound record {|
+    *http:Ok;
+    Album body;
+    Headers headers;
+|};
+
+service /api on new http:Listener(statusCodeBindingPort2) {
+
+    resource function get albums/[string id]() returns AlbumFound|AlbumNotFound {
+        if albums.hasKey(id) {
+            return {
+                body: albums.get(id),
+                headers: {user\-id: "user-1", req\-id: 1}
+            };
+        }
+        return {
+            body: {albumId: id, message: "Album not found"},
+            headers: {user\-id: "user-1", req\-id: 1}
+        };
+    }
+}
+
+final http:Client albumClient = check new (string `localhost:${statusCodeBindingPort2}/api`);
+
+public function main() returns error? {
+    Album _ = check albumClient->/albums/'1;
+
+    AlbumFound _ = check albumClient->/albums/'1;
+
+    Album|AlbumNotFound _ = check albumClient->/albums/'1;
+
+    AlbumFound|AlbumNotFound _ = check albumClient->/albums/'1;
+
+    Album|http:Response _ = check albumClient->/albums/'1;
+}
+
+@test:Config {}
+function testGetSuccessStatusCodeResponse() returns error? {
+    Album album = check albumClient->/albums/'1;
+    Album expectedAlbum = albums.get("1");
+    test:assertEquals(album, expectedAlbum, "Invalid album returned");
+
+    AlbumFound albumFound = check albumClient->/albums/'1;
+    test:assertEquals(albumFound.body, expectedAlbum, "Invalid album returned");
+    test:assertEquals(albumFound.headers.user\-id, "user-1", "Invalid user-id header");
+    test:assertEquals(albumFound.headers.req\-id, 1, "Invalid req-id header");
+    test:assertEquals(albumFound.mediaType, "application/json", "Invalid media type");
+
+    http:Response res = check albumClient->/albums/'1;
+    test:assertEquals(res.statusCode, 200, "Invalid status code");
+    json payload = check res.getJsonPayload();
+    album = check payload.fromJsonWithType();
+    test:assertEquals(album, expectedAlbum, "Invalid album returned");
+
+    Album|AlbumFound res1 = check albumClient->/albums/'1;
+    if res1 is AlbumFound {
+        test:assertEquals(res1.body, expectedAlbum, "Invalid album returned");
+        test:assertEquals(res1.headers.user\-id, "user-1", "Invalid user-id header");
+        test:assertEquals(res1.headers.req\-id, 1, "Invalid req-id header");
+        test:assertEquals(res1.mediaType, "application/json", "Invalid media type");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    AlbumFound|Album res2 = check albumClient->/albums/'1;
+    if res2 is AlbumFound {
+        test:assertEquals(res2.body, expectedAlbum, "Invalid album returned");
+        test:assertEquals(res2.headers.user\-id, "user-1", "Invalid user-id header");
+        test:assertEquals(res2.headers.req\-id, 1, "Invalid req-id header");
+        test:assertEquals(res2.mediaType, "application/json", "Invalid media type");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    Album|AlbumNotFound res3 = check albumClient->/albums/'1;
+    if res3 is Album {
+        test:assertEquals(res3, expectedAlbum, "Invalid album returned");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    AlbumFound|AlbumNotFound res4 = check albumClient->/albums/'1;
+    if res4 is AlbumFound {
+        test:assertEquals(res4.body, expectedAlbum, "Invalid album returned");
+        test:assertEquals(res4.headers.user\-id, "user-1", "Invalid user-id header");
+        test:assertEquals(res4.headers.req\-id, 1, "Invalid req-id header");
+        test:assertEquals(res4.mediaType, "application/json", "Invalid media type");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    Album|AlbumFound|AlbumNotFound res5 = check albumClient->/albums/'1;
+    if res5 is AlbumFound {
+        test:assertEquals(res5.body, expectedAlbum, "Invalid album returned");
+        test:assertEquals(res5.headers.user\-id, "user-1", "Invalid user-id header");
+        test:assertEquals(res5.headers.req\-id, 1, "Invalid req-id header");
+        test:assertEquals(res5.mediaType, "application/json", "Invalid media type");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    Album|AlbumNotFound|http:Response res6 = check albumClient->/albums/'1;
+    if res6 is Album {
+        test:assertEquals(res6, expectedAlbum, "Invalid album returned");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    AlbumNotFound|http:Response res7 = check albumClient->/albums/'1;
+    if res7 is http:Response {
+        test:assertEquals(res.statusCode, 200, "Invalid status code");
+        payload = check res.getJsonPayload();
+        album = check payload.fromJsonWithType();
+        test:assertEquals(album, expectedAlbum, "Invalid album returned");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    AlbumNotFound|error res8 = albumClient->/albums/'1;
+    if res8 is error {
+        test:assertTrue(res8 is http:PayloadBindingError);
+        test:assertEquals(res8.message(), "incompatible http_client_tests:AlbumNotFound found for response with 200",
+            "Invalid error message");
+        error? cause = res8.cause();
+        if cause is error {
+            test:assertEquals(cause.message(), "no 'anydata' type found in the target type", "Invalid cause error message");
+        }
+    } else {
+        test:assertFail("Invalid response type");
+    }
+}
+
+@test:Config {}
+function testGetFailureStatusCodeResponse() returns error? {
+    AlbumNotFound albumNotFound = check albumClient->/albums/'4;
+    ErrorMessage expectedErrorMessage = {albumId: "4", message: "Album not found"};
+    test:assertEquals(albumNotFound.body, expectedErrorMessage, "Invalid error message");
+    test:assertEquals(albumNotFound.headers.user\-id, "user-1", "Invalid user-id header");
+    test:assertEquals(albumNotFound.headers.req\-id, 1, "Invalid req-id header");
+    test:assertEquals(albumNotFound.mediaType, "application/json", "Invalid media type");
+
+    http:Response res = check albumClient->/albums/'4;
+    test:assertEquals(res.statusCode, 404, "Invalid status code");
+    json payload = check res.getJsonPayload();
+    ErrorMessage errorMessage = check payload.fromJsonWithType();
+    test:assertEquals(errorMessage, expectedErrorMessage, "Invalid error message");
+
+    Album|AlbumNotFound res1 = check albumClient->/albums/'4;
+    if res1 is AlbumNotFound {
+        test:assertEquals(res1.body, expectedErrorMessage, "Invalid error message");
+        test:assertEquals(res1.headers.user\-id, "user-1", "Invalid user-id header");
+        test:assertEquals(res1.headers.req\-id, 1, "Invalid req-id header");
+        test:assertEquals(res1.mediaType, "application/json", "Invalid media type");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    AlbumNotFound|http:Response res2 = check albumClient->/albums/'4;
+    if res2 is AlbumNotFound {
+        test:assertEquals(res2.body, expectedErrorMessage, "Invalid error message");
+        test:assertEquals(res2.headers.user\-id, "user-1", "Invalid user-id header");
+        test:assertEquals(res2.headers.req\-id, 1, "Invalid req-id header");
+        test:assertEquals(res2.mediaType, "application/json", "Invalid media type");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    Album|http:Response res3 = check albumClient->/albums/'4;
+    if res3 is http:Response {
+        test:assertEquals(res3.statusCode, 404, "Invalid status code");
+        payload = check res3.getJsonPayload();
+        errorMessage = check payload.fromJsonWithType();
+        test:assertEquals(errorMessage, expectedErrorMessage, "Invalid error message");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    http:Response|AlbumFound res4 = check albumClient->/albums/'4;
+    if res4 is http:Response {
+        test:assertEquals(res4.statusCode, 404, "Invalid status code");
+        payload = check res4.getJsonPayload();
+        errorMessage = check payload.fromJsonWithType();
+        test:assertEquals(errorMessage, expectedErrorMessage, "Invalid error message");
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    Album|error res5 = albumClient->/albums/'4;
+    if res5 is error {
+        test:assertTrue(res5 is http:ClientRequestError);
+        test:assertEquals(res5.message(), "Not Found", "Invalid error message");
+        test:assertEquals(res5.detail()["statusCode"], 404, "Invalid status code");
+        test:assertEquals(res5.detail()["body"], expectedErrorMessage, "Invalid error message");
+        if res5.detail()["headers"] is map<string[]> {
+            map<string[]> headers = check res5.detail()["headers"].ensureType();
+            test:assertEquals(headers.get("user-id")[0], "user-1", "Invalid user-id header");
+            test:assertEquals(headers.get("req-id")[0], "1", "Invalid req-id header");
+        }
+
+    } else {
+        test:assertFail("Invalid response type");
+    }
+
+    AlbumFound|error res6 = albumClient->/albums/'4;
+    if res6 is error {
+        test:assertTrue(res6 is http:ClientRequestError);
+        test:assertEquals(res6.message(), "Not Found", "Invalid error message");
+        test:assertEquals(res6.detail()["statusCode"], 404, "Invalid status code");
+        test:assertEquals(res6.detail()["body"], expectedErrorMessage, "Invalid error message");
+        if res6.detail()["headers"] is map<string[]> {
+            map<string[]> headers = check res6.detail()["headers"].ensureType();
+            test:assertEquals(headers.get("user-id")[0], "user-1", "Invalid user-id header");
+            test:assertEquals(headers.get("req-id")[0], "1", "Invalid req-id header");
+        }
+
+    } else {
+        test:assertFail("Invalid response type");
+    }
+}