Initial implementation of WSDL to Ballerina tool #14

AzeemMuzammil · 2024-07-10T07:57:59Z

Purpose

$title. ballerina-platform/ballerina-library#6717

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

Unit tests

Code coverage information
Integration tests

Details about the test cases and coverage

Security checks

Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
Ran FindSecurityBugs plugin and verified report? yes/no
Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

.gitignore

ayeshLK · 2024-07-10T08:01:37Z

@AzeemMuzammil why have we committed the .idea directory. AFAIK this is something we should omit.

build-config/checkstyle/build.gradle

build-config/resources/package/BalTool.toml

build-config/resources/package/Ballerina.toml

ayeshLK · 2024-07-10T08:06:51Z

@AzeemMuzammil any reason to commit dependency JARs (in the module-ballerina-wsdl/resources directory) ? I think we can download them into a lib folder during the build time, rather than committing them to repo.

module-ballerina-wsdl/target/build

wsdl-cli/src/main/java/io/ballerina/wsdl/cli/ErrorMessages.java

wsdl-core/src/main/java/io/ballerina/wsdl/core/GeneratedSourceFile.java

wsdl-core/src/main/java/io/ballerina/wsdl/core/GeneratorUtils.java

wsdl-core/src/main/java/io/ballerina/wsdl/core/OperationProcessor.java

ayeshLK · 2024-07-10T08:13:55Z

wsdl-core/src/main/java/io/ballerina/wsdl/core/OperationProcessor.java

+        List<String> processedOpOutputNames =
+                processedOperations.stream().map(op -> op.getOperationOutput().getName()).toList();
+        if (processedOpOutputNames.contains(wsdlOperation.getOperationOutput().getName())) {
+            return new ArrayList<>();


Suggested change

return new ArrayList<>();

return Collections.emptyList();

wsdl-core/src/main/java/io/ballerina/wsdl/core/OperationProcessor.java

ayeshLK · 2024-07-10T08:16:51Z

wsdl-core/src/main/java/io/ballerina/wsdl/core/OperationProcessor.java

+        for (WSDLPart outputPart : outputParts) {
+            List<Field> outputFields = partProcessor.generateFields(outputPart);
+            fields.addAll(outputFields);
+        }


Shall we check whether we can do this ?

Suggested change

for (WSDLPart outputPart : outputParts) {

List<Field> outputFields = partProcessor.generateFields(outputPart);

fields.addAll(outputFields);

}

outputParts.map(part -> partProcessor.generateFields(outputPart)).forEach(outputFields -> fields.addAll(outputFields));

wsdl-core/src/main/java/io/ballerina/wsdl/core/SchemaManager.java

ayeshLK · 2024-07-10T08:18:47Z

wsdl-core/src/main/java/io/ballerina/wsdl/core/SchemaManager.java

+    public void initializeSchemas(Map<String, XmlSchema> targetNSToSchema) {
+        this.targetNSToSchema = targetNSToSchema;
+    }


We don't need this function to initialize the SchemeManager right ? We can do this within the constructor itself.

This is a singleton, Constructor is private

ayeshLK · 2024-07-10T08:19:25Z

wsdl-core/src/main/java/io/ballerina/wsdl/core/WSDLToBallerina.java

+    private WSDLService getSOAPService(Definition wsdlDefinition) {
+        @SuppressWarnings("unchecked")
+        Collection<Service> services = wsdlDefinition.getAllServices().values();
+        for (Service service : services) {
+            @SuppressWarnings("unchecked")
+            Collection<Port> ports = service.getPorts().values();


Suggested change

private WSDLService getSOAPService(Definition wsdlDefinition) {

@SuppressWarnings("unchecked")

Collection<Service> services = wsdlDefinition.getAllServices().values();

for (Service service : services) {

@SuppressWarnings("unchecked")

Collection<Port> ports = service.getPorts().values();

@SuppressWarnings("unchecked")

private WSDLService getSOAPService(Definition wsdlDefinition) {

Collection<Service> services = wsdlDefinition.getAllServices().values();

for (Service service : services) {

Collection<Port> ports = service.getPorts().values();

ayeshLK · 2024-07-10T08:21:17Z

wsdl-core/src/main/java/io/ballerina/wsdl/core/WSDLToBallerina.java

+            for (Port port : ports) {
+                List<?> extensions = port.getExtensibilityElements();
+                for (Object extension : extensions) {
+                    if (extension instanceof SOAPAddress || extension instanceof SOAP12Address) {


I would rather decouple this condition into if and if-else block. That would simplify the mental mapping and improve the readability. And it would allow us to use Java instanceOf pattern-matching [1] and remove the redundant casting.

[1] - https://www.baeldung.com/java-pattern-matching-instanceof

ayeshLK · 2024-07-10T08:23:38Z

wsdl-core/src/main/java/io/ballerina/wsdl/core/WSDLToBallerina.java

+                }
+            }
+        }
+        return null;


Any reason to return null here ? IMO null should be avoided and use Optionals instead. I think this answer [1] cover the why we should use optionals in a high-level

[1] - https://softwareengineering.stackexchange.com/questions/309134/why-is-using-an-optional-preferential-to-null-checking-the-variable

wsdl-core/src/main/java/io/ballerina/wsdl/core/XMLSchemaParser.java

.idea/.gitignore

module-ballerina-wsdl/wsdl_tool.bal

module-ballerina-wsdl/resources/XmlSchema-1.4.7.jar

module-ballerina-wsdl/build.gradle

wsdl-core/src/main/java/io/ballerina/wsdl/core/OperationProcessor.java

TharmiganK · 2024-07-11T03:28:04Z

build-config/checkstyle/build.gradle

@@ -0,0 +1,68 @@
+///*
+// * Copyright (c) 2022, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.


Licence should be updated

wsdl-core/src/main/java/io/ballerina/wsdl/core/GeneratorUtils.java

gayaldassanayake · 2024-07-16T09:05:29Z

wsdl-cli/src/main/java/io/ballerina/wsdl/cli/WsdlCmd.java

+
+    @Override
+    public void printLongDesc(StringBuilder out) {
+


Append your help text here to the out string builder. The CLI will print it from bal help wsdl

gayaldassanayake · 2024-07-16T09:14:25Z

wsdl-cli/src/main/java/io/ballerina/wsdl/cli/WsdlCmd.java

+
+    @Override
+    public void execute() {
+        if (inputPath == null || inputPath.isBlank()) {


Let's add a new --help flag. For this flag and for no options/ args, we can print the help command.

gayaldassanayake · 2024-07-16T09:16:27Z

wsdl-cli/src/main/java/io/ballerina/wsdl/cli/WsdlCmd.java

+    @CommandLine.Option(names = {"-i", "--input"}, description = "Relative path to the WSDL file")
+    private String inputPath;
+
+    @CommandLine.Option(names = {"--operations"}, description = "Comma-separated operation names to generate")


See if we can take operations into an array using the Picocli utilities itself.

gayaldassanayake · 2024-07-16T10:02:52Z

wsdl-cli/src/main/java/io/ballerina/wsdl/cli/Messages.java

+ * @since 0.1.0
+ */
+public class Messages {
+    public static final String MISSING_WSDL_PATH = "Error: Missing input WSDL file path. " +


Let's use a property file here

gayaldassanayake · 2024-07-16T10:04:40Z

module-ballerina-wsdl/wsdl_tool.bal

@@ -0,0 +1,20 @@
+// Copyright (c) 2024 WSO2 Inc. (http://www.wso2.org).


We don't need any Ballerina code inside our package. We can have empty projects when we do a bal pack for tools. So let's remove this

gayaldassanayake · 2024-07-16T10:45:09Z

module-ballerina-wsdl/Module.md

@@ -0,0 +1 @@
+Ballerina WSDL Tools


Let's have a proper Module.md that explains what this tool does. Although currently we don't display tool information in the Ballerina central, soon we will. The tool Module.md will be used to show the tool information (similar to what we do with packages)

gayaldassanayake · 2024-07-16T10:45:32Z

module-ballerina-wsdl/Dependencies.toml

+
+[ballerina]
+dependencies-toml-version = "2"
+distribution-version = "2201.9.1"


Let's use 2201.9.2 since it is published now

gayaldassanayake · 2024-07-16T10:47:06Z

build.gradle

+//publishToMavenLocal.dependsOn build
+//publish.dependsOn build


If we don't need this dependency, can remove

prakanth97 · 2024-07-19T11:20:17Z

wsdl-core/src/main/java/io/ballerina/wsdl/core/generator/xsdtorecord/XsdToRecordGenerator.java

+ *
+ * @since 0.1.0
+ */
+public class XsdToRecordGenerator {


Are we generating the closed record with this?

Implement WSDL to Ballerina

fd33cd7

AzeemMuzammil marked this pull request as draft July 10, 2024 07:58