Merge pull request #1779 from lnash94/service-contract-issue

[master]Fix the `openapi:ServiceInfo` annotation is not supported in the service contract type
ballerina-platform · Nov 8, 2024 · d1b1e18 · d1b1e18
2 parents 00f7fff + 64292fc
commit d1b1e18
Show file tree

Hide file tree

Showing 12 changed files with 193 additions and 7 deletions.
diff --git a/build.gradle b/build.gradle
@@ -60,6 +60,7 @@ ext.stdlibGrpcVersion = project.stdlibGrpcVersion
 ext.stdlibWebsubVersion = project.stdlibWebsubVersion
 ext.stdlibConstraintVersion = project.stdlibConstraintVersion
 ext.stdlibWebsocketVersion = project.stdlibWebsocketVersion
+ext.stdlibDataJsonDataVersion = project.stdlibDataJsonDataVersion
 ext.jacocoVersion = project.jacocoVersion
 ext.puppycrawlCheckstyleVersion = project.puppycrawlCheckstyleVersion
 
@@ -136,6 +137,7 @@ subprojects {
         ballerinaStdLibs "io.ballerina.stdlib:websub-ballerina:${stdlibWebsubVersion}"
         ballerinaStdLibs "io.ballerina.stdlib:websocket-ballerina:${stdlibWebsocketVersion}"
         ballerinaStdLibs "io.ballerina.stdlib:constraint-ballerina:${stdlibConstraintVersion}"
+        ballerinaStdLibs "io.ballerina.lib:data.jsondata-ballerina:${stdlibDataJsonDataVersion}"
 
     }
 }

diff --git a/gradle.properties b/gradle.properties
@@ -10,7 +10,7 @@ clientNativeVersion=1.0.1-SNAPSHOT
 clientNativePublish=false
 
 #dependency
-ballerinaLangVersion=2201.10.0
+ballerinaLangVersion=2201.11.0-20241008-112400-81975006
 testngVersion=7.6.1
 slf4jVersion=1.7.30
 org.gradle.jvmargs=-Xmx4096M -Dfile.encoding=UTF-8
@@ -45,11 +45,12 @@ stdlibUuidVersion=1.8.0
 
 # Stdlib Level 04
 stdlibAuthVersion=2.12.0
+stdlibDataJsonDataVersion=0.3.0-20241105-101100-661d11f
 stdlibJwtVersion=2.13.0
 stdlibOAuth2Version=2.12.0
 
 # Stdlib Level 05
-stdlibHttpVersion=2.12.1-20240922-195800-82c5e76
+stdlibHttpVersion=2.13.0-20241106-120000-d375c3b
 
 # Stdlib Level 06
 stdlibGrpcVersion=1.12.0

diff --git a/module-ballerina-openapi/annotation.bal b/module-ballerina-openapi/annotation.bal
@@ -103,7 +103,8 @@ public type Examples readonly & record {|
 public const annotation ResourceInformation ResourceInfo on object function;
 
 # Annotation for additional OpenAPI information of a Ballerina service.
-public annotation ServiceInformation ServiceInfo on service;
+public annotation ServiceInformation ServiceInfo on service, type;
+
 // # Annotation for additional OpenAPI configurations of a Ballerina client.
 // public const annotation ClientConfiguration ClientConfig on source client;
 

diff --git a/openapi-client-native/ballerina-tests/Dependencies.toml b/openapi-client-native/ballerina-tests/Dependencies.toml
@@ -5,7 +5,7 @@
 
 [ballerina]
 dependencies-toml-version = "2"
-distribution-version = "2201.10.0"
+distribution-version = "2201.11.0-20241008-112400-81975006"
 
 [[package]]
 org = "ballerina"
@@ -61,6 +61,15 @@ dependencies = [
 	{org = "ballerina", name = "time"}
 ]
 
+[[package]]
+org = "ballerina"
+name = "data.jsondata"
+version = "0.3.0"
+dependencies = [
+	{org = "ballerina", name = "jballerina.java"},
+	{org = "ballerina", name = "lang.object"}
+]
+
 [[package]]
 org = "ballerina"
 name = "file"
@@ -75,12 +84,13 @@ dependencies = [
 [[package]]
 org = "ballerina"
 name = "http"
-version = "2.12.0"
+version = "2.13.0"
 dependencies = [
 	{org = "ballerina", name = "auth"},
 	{org = "ballerina", name = "cache"},
 	{org = "ballerina", name = "constraint"},
 	{org = "ballerina", name = "crypto"},
+	{org = "ballerina", name = "data.jsondata"},
 	{org = "ballerina", name = "file"},
 	{org = "ballerina", name = "io"},
 	{org = "ballerina", name = "jballerina.java"},
@@ -233,7 +243,7 @@ dependencies = [
 [[package]]
 org = "ballerina"
 name = "mime"
-version = "2.10.0"
+version = "2.10.1"
 dependencies = [
 	{org = "ballerina", name = "io"},
 	{org = "ballerina", name = "jballerina.java"},
@@ -297,7 +307,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "time"
-version = "2.4.0"
+version = "2.5.0"
 dependencies = [
 	{org = "ballerina", name = "jballerina.java"}
 ]

diff --git a/...tion-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPICLINegativeTests.java b/...tion-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPICLINegativeTests.java
@@ -99,6 +99,27 @@ public void testForExamplesHasCompilerErrorse() throws IOException, InterruptedE
         assertOnErrorStream(process, out);
     }
 
+    @Test(description = "Generate with openapi serviceConfig annotation to service contract type " +
+            "and service declaration")
+    public void openapiServiceConfigForServiceContractTypeWithServiceDeclaration() throws IOException,
+            InterruptedException {
+        String balFilePath = "project_openapi_info_with_service_contract_type_and_declaration/service_file.bal";
+        List<String> buildArgs = new LinkedList<>();
+        buildArgs.add(0, "openapi");
+        buildArgs.add("-i");
+        buildArgs.add(balFilePath);
+        buildArgs.add("-o");
+        buildArgs.add(tmpDir.toString());
+
+        Process process = getProcess(buildArgs, TEST_RESOURCE);
+        //Thread for wait out put generate
+        Thread.sleep(5000);
+        // compare generated file has not included constraint annotation for scenario record field.
+        Assert.assertTrue(Files.exists(TEST_RESOURCE.resolve("service_contract_openapi.yaml")));
+        Assert.assertTrue(Files.exists(TEST_RESOURCE.resolve("v1_openapi.yaml")));
+        process.waitFor();
+    }
+
     @AfterClass
     public void cleanUp() throws IOException {
         TestUtil.cleanDistribution();

diff --git a/...api-integration-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPITests.java b/...api-integration-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPITests.java
@@ -178,6 +178,13 @@ public void openAPIGenWithBalExt() throws IOException, InterruptedException {
                 "project_openapi_bal_ext/result_1.yaml", true);
     }
 
+    @Test(description = "Generate with openapi serviceConfig annotation to service contract type")
+    public void openapiServiceConfigForServiceContractType() throws IOException, InterruptedException {
+        executeCommand("project_openapi_info_with_service_contract_type/service_file.bal",
+                "v1_openapi.yaml",
+                "project_openapi_info_with_service_contract_type/result.yaml", true);
+    }
+
     @AfterClass
     public void cleanUp() throws IOException {
         TestUtil.cleanDistribution();

diff --git a/...esources/ballerina_sources/project_openapi_info_with_service_contract_type/Ballerina.toml b/...esources/ballerina_sources/project_openapi_info_with_service_contract_type/Ballerina.toml
@@ -0,0 +1,4 @@
+[package]
+org= "ballerina"
+name= "openapi_service_contract"
+version= "2.0.0"
diff --git a/...t/resources/ballerina_sources/project_openapi_info_with_service_contract_type/result.yaml b/...t/resources/ballerina_sources/project_openapi_info_with_service_contract_type/result.yaml
@@ -0,0 +1,33 @@
+openapi: 3.0.1
+info:
+  title: Pet Store
+  description: API system description
+  termsOfService: http://mock-api-doc
+  contact:
+    name: sumudu
+    url: http://mock-api-contact
+    email: [email protected]
+  license:
+    name: ABC
+    url: http://abc.com
+  version: 1.0.0
+servers:
+  - url: "http://{server}:{port}/v1"
+    variables:
+      server:
+        default: localhost
+      port:
+        default: "8080"
+paths:
+  /users:
+    get:
+      operationId: getUsers
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
diff --git a/...ources/ballerina_sources/project_openapi_info_with_service_contract_type/service_file.bal b/...ources/ballerina_sources/project_openapi_info_with_service_contract_type/service_file.bal
@@ -0,0 +1,35 @@
+// Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com).
+//
+// 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/openapi;
+
+@openapi:ServiceInfo {
+    version: "1.0.0",
+    title: "Pet store",
+    description: "API system description",
+    email: "[email protected]",
+    contactName: "sumudu",
+    contactURL: "http://mock-api-contact",
+    termsOfService: "http://mock-api-doc",
+    licenseName: "ABC",
+    licenseURL: "http://abc.com"
+}
+@http:ServiceConfig {basePath: "/v1"}
+type OASServiceType service object {
+    *http:ServiceContract;
+    resource function get users() returns string[];
+};
diff --git a/...na_sources/project_openapi_info_with_service_contract_type_and_declaration/Ballerina.toml b/...na_sources/project_openapi_info_with_service_contract_type_and_declaration/Ballerina.toml
@@ -0,0 +1,4 @@
+[package]
+org= "ballerina"
+name= "openapi_service_contract"
+version= "2.0.0"
diff --git a/...erina_sources/project_openapi_info_with_service_contract_type_and_declaration/result.yaml b/...erina_sources/project_openapi_info_with_service_contract_type_and_declaration/result.yaml
@@ -0,0 +1,33 @@
+openapi: 3.0.1
+info:
+  title: Pet Store
+  description: API system description
+  termsOfService: http://mock-api-doc
+  contact:
+    name: sumudu
+    url: http://mock-api-contact
+    email: [email protected]
+  license:
+    name: ABC
+    url: http://abc.com
+  version: 1.0.0
+servers:
+  - url: "http://{server}:{port}/v1"
+    variables:
+      server:
+        default: localhost
+      port:
+        default: "8080"
+paths:
+  /users:
+    get:
+      operationId: getUsers
+      responses:
+        "200":
+          description: Ok
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
diff --git a/..._sources/project_openapi_info_with_service_contract_type_and_declaration/service_file.bal b/..._sources/project_openapi_info_with_service_contract_type_and_declaration/service_file.bal
@@ -0,0 +1,35 @@
+// Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com).
+//
+// 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/openapi;
+
+@openapi:ServiceInfo {
+    version: "1.0.0",
+    title: "Pet store",
+    description: "API system description",
+    email: "[email protected]",
+    contactName: "sumudu",
+    contactURL: "http://mock-api-contact",
+    termsOfService: "http://mock-api-doc",
+    licenseName: "ABC",
+    licenseURL: "http://abc.com"
+}
+@http:ServiceConfig {basePath: "/v1"}
+type OASServiceType service object {
+    *http:ServiceContract;
+    resource function get users() returns string[];
+};