Merge pull request #35 from ayeshLK/master

Fix documentation issues
ballerina-platform · Jan 29, 2024 · 96f8f28 · 96f8f28
2 parents c5ba608 + 2e3ed24
commit 96f8f28
Show file tree

Hide file tree

Showing 9 changed files with 126 additions and 37 deletions.
diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml
@@ -1,7 +1,7 @@
 [package]
 org = "ballerinax"
 name = "ibm.ibmmq"
-version = "0.1.3"
+version = "0.1.4"
 authors = ["Ballerina"]
 keywords = ["ibm-mq"]
 repository = "https://github.com/ballerina-platform/module-ballerinax-ibm.ibmmq"
@@ -12,8 +12,8 @@ distribution = "2201.8.0"
 [[platform.java17.dependency]]
 groupId = "io.ballerina.stdlib"
 artifactId = "ibm.ibmmq-native"
-version = "0.1.3"
-path = "../native/build/libs/ibm.ibmmq-native-0.1.3.jar"
+version = "0.1.4"
+path = "../native/build/libs/ibm.ibmmq-native-0.1.4-SNAPSHOT.jar"
 
 [[platform.java17.dependency]]
 groupId = "org.json"

diff --git a/ballerina/Dependencies.toml b/ballerina/Dependencies.toml
@@ -63,7 +63,7 @@ modules = [
 [[package]]
 org = "ballerinax"
 name = "ibm.ibmmq"
-version = "0.1.3"
+version = "0.1.4"
 dependencies = [
 	{org = "ballerina", name = "crypto"},
 	{org = "ballerina", name = "jballerina.java"},

diff --git a/ballerina/destination.bal b/ballerina/destination.bal
@@ -30,6 +30,9 @@ public isolated client class Queue {
     *Destination;
 
     # Puts a message to an IBM MQ queue.
+    # ```ballerina
+    # check queue->put({payload: "Hello World".toBytes()});
+    # ```
     # 
     # + message - IBM MQ message
     # + return - An `ibmmq:Error` if the operation fails or else `()`
@@ -39,6 +42,9 @@ public isolated client class Queue {
     } external;
 
     # Retrieves a message from an IBM MQ queue.
+    # ```ballerina
+    # ibmmq:Message? message = check queue->get();
+    # ```
     # 
     # + getMessageOptions - Options to control message retrieval
     # + return - An `ibmmq:Message` if there is a message in the queue, `()` if there 
@@ -49,6 +55,9 @@ public isolated client class Queue {
     } external;
 
     # Closes the IBM MQ queue object. No further operations on this object are permitted after it is closed.
+    # ```ballerina
+    # check queue->close();
+    # ```
     # 
     # + return - An `ibmmq:Error` if the operation fails or else `()`
     isolated remote function close() returns Error? =
@@ -62,6 +71,9 @@ public isolated client class Topic {
     *Destination;
 
     # Puts a message to an IBM MQ topic.
+    #```ballerina
+    # check topic->put({payload: "Hello World".toBytes()});
+    #```
     # 
     # + message - IBM MQ message
     # + return - An `ibmmq:Error` if the operation fails or else `()`
@@ -71,6 +83,9 @@ public isolated client class Topic {
     } external;
 
     # Retrieves a message from an IBM MQ topic.
+    #```ballerina
+    # ibmmq:Message? message = check topic->get();
+    #```
     # 
     # + getMessageOptions - Options to control message retrieval
     # + return - An `ibmmq:Message` if there is a message in the topic, `()` if there 
@@ -81,6 +96,9 @@ public isolated client class Topic {
     } external;
 
     # Closes the IBM MQ topic object. No further operations on this object are permitted after it is closed.
+    # ```ballerina
+    # check topic->close();
+    # ```
     # 
     # + return - An `ibmmq:Error` if the operation fails or else `()`
     isolated remote function close() returns Error? =

diff --git a/ballerina/queue_manager.bal b/ballerina/queue_manager.bal
@@ -66,6 +66,9 @@ public isolated class QueueManager {
         'class: "io.ballerina.lib.ibm.ibmmq.QueueManager"
     } external;
 
+    # Ends the connection to the IBM MQ queue manager.
+    #
+    # + return - An `ibmmq:Error` if the operation fails or else `()`
     public isolated function disconnect() returns Error? =
     @java:Method {
         'class: "io.ballerina.lib.ibm.ibmmq.QueueManager"

diff --git a/ballerina/tests/queue_producer_consumer_tests.bal b/ballerina/tests/queue_producer_consumer_tests.bal
@@ -21,7 +21,9 @@ import ballerina/time;
     groups: ["ibmmqQueue"]
 }
 function basicQueueProducerConsumerTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue producer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_OUTPUT);
     Queue consumer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_INPUT_AS_Q_DEF);
     check producer->put({
@@ -42,7 +44,9 @@ function basicQueueProducerConsumerTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function basicQueueProducerConsumerWithOneQueueObjectTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue queue = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_OUTPUT | MQOO_INPUT_AS_Q_DEF);
     check queue->put({
         payload: "Hello World with one queue".toBytes()
@@ -61,7 +65,9 @@ function basicQueueProducerConsumerWithOneQueueObjectTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function basicQueueProducerConsumerWithJsonPayloadTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue producer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_OUTPUT);
     Queue consumer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_INPUT_AS_Q_DEF);
     json messageBody = {
@@ -116,7 +122,9 @@ function basicQueueProducerConsumerWithJsonPayloadTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function pubSubMultipleMessagesQueueProducerConsumerTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue producer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_OUTPUT);
     Queue consumer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_INPUT_AS_Q_DEF);
     foreach int i in 0 ... 4 {
@@ -141,7 +149,9 @@ function pubSubMultipleMessagesQueueProducerConsumerTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function consumerWithoutProducingMessageTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue consumer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_INPUT_AS_Q_DEF);
     Message|Error? result = consumer->get(options = MQGMO_WAIT, waitInterval = 5);
     test:assertTrue(result is ());
@@ -153,7 +163,9 @@ function consumerWithoutProducingMessageTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function produceToNonExistingQueueTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue|Error result = queueManager.accessQueue("NON.EXISTING.QUEUE", MQOO_OUTPUT);
     if result is Error {
         test:assertEquals(result.message(), "Error occurred while accessing queue: MQJE001: Completion Code '2', Reason '2085'.");
@@ -169,7 +181,9 @@ function produceToNonExistingQueueTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function consumerConnectToNonExistingQueueTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue|Error result = queueManager.accessQueue("NON.EXISTING.QUEUE", MQOO_INPUT_AS_Q_DEF);
     if result is Error {
         test:assertEquals(result.message(), "Error occurred while accessing queue: MQJE001: Completion Code '2', Reason '2085'.");
@@ -185,7 +199,9 @@ function consumerConnectToNonExistingQueueTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function produceWithInvalidQueueNameTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue|Error result = queueManager.accessQueue("INVALID QUEUE", MQOO_INPUT_AS_Q_DEF);
     if result is Error {
         test:assertEquals(result.message(), "Error occurred while accessing queue: MQJE001: Completion Code '2', Reason '2085'.");
@@ -201,7 +217,9 @@ function produceWithInvalidQueueNameTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function consumeFromAnInvalidQueueNameTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue|Error result = queueManager.accessQueue("INVALID QUEUE", MQOO_INPUT_AS_Q_DEF);
     if result is Error {
         test:assertEquals(result.message(), "Error occurred while accessing queue: MQJE001: Completion Code '2', Reason '2085'.");
@@ -217,7 +235,9 @@ function consumeFromAnInvalidQueueNameTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function produceAndConsumerMessageWithAdditionalPropertiesTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue producer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_OUTPUT);
     Queue consumer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_INPUT_AS_Q_DEF);
     time:Utc timeNow = time:utcNow();
@@ -257,7 +277,9 @@ function produceAndConsumerMessageWithAdditionalPropertiesTest() returns error?
     groups: ["ibmmqQueue"]
 }
 function produceAndConsumerMessageWithAdditionalPropertiesWithJsonPayloadTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue producer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_OUTPUT);
     Queue consumer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_INPUT_AS_Q_DEF);
     time:Utc timeNow = time:utcNow();
@@ -332,7 +354,9 @@ function produceAndConsumerMessageWithAdditionalPropertiesWithJsonPayloadTest()
     groups: ["ibmmqQueue"]
 }
 function produceAndConsumerMessageWithMultipleHeaderTypesTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue producer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_OUTPUT);
     Queue consumer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_INPUT_AS_Q_DEF);
     check producer->put({
@@ -397,7 +421,9 @@ function produceAndConsumerMessageWithMultipleHeaderTypesTest() returns error? {
     groups: ["ibmmqQueue"]
 }
 function produceAndConsumerMessageWithMultipleHeaderTypesWithJsonPayloadTest() returns error? {
-    QueueManager queueManager = check new (name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
+    QueueManager queueManager = check new (
+        name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN", 
+        userID = "app", password = "password");
     Queue producer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_OUTPUT);
     Queue consumer = check queueManager.accessQueue("DEV.QUEUE.1", MQOO_INPUT_AS_Q_DEF);
     json messageBody = {

diff --git a/ballerina/tests/resources/docker-compose.yaml b/ballerina/tests/resources/docker-compose.yaml
@@ -12,6 +12,7 @@ services:
     environment:
       - LICENSE=accept
       - MQ_QMGR_NAME=QM1
+      - MQ_APP_PASSWORD=password
     healthcheck:
       test: ["CMD-SHELL", "chkmqstarted"]
       interval: 10s
@@ -26,6 +27,7 @@ services:
     environment:
       - LICENSE=accept
       - MQ_QMGR_NAME=QM2
+      - MQ_APP_PASSWORD=password
     volumes:
       - ./secrets/server.crt:/etc/mqm/pki/keys/mykey/server.crt
       - ./secrets/server.key:/etc/mqm/pki/keys/mykey/server.key

diff --git a/ballerina/tests/secure_socket_tests.bal b/ballerina/tests/secure_socket_tests.bal
@@ -25,6 +25,8 @@ function basicPublisherSubscriberSecureSocketTest() returns error? {
         host = "localhost",
         port = 1415, 
         channel = "DEV.APP.SVRCONN",
+        userID = "app", 
+        password = "password",
         sslCipherSuite = TLS12ORHIGHER,
         secureSocket = {
             cert: "./tests/resources/secrets/server.crt",
@@ -59,6 +61,8 @@ function basicQueueProducerConsumerSecureSocketTest() returns error? {
         host = "localhost",
         port = 1415,
         channel = "DEV.APP.SVRCONN",
+        userID = "app", 
+        password = "password",
         sslCipherSuite = TLS12ORHIGHER,
         secureSocket = {
             cert: "./tests/resources/secrets/server.crt",
@@ -93,6 +97,8 @@ function basicPublisherSubscriberSecureSocketJksTest() returns error? {
         host = "localhost",
         port = 1415,
         channel = "DEV.APP.SVRCONN",
+        userID = "app", 
+        password = "password",
         sslCipherSuite = TLS12ORHIGHER,
         secureSocket = {
             cert: {
@@ -130,6 +136,8 @@ function basicQueueProducerConsumerSecureSocketJksTest() returns error? {
         host = "localhost",
         port = 1415,
         channel = "DEV.APP.SVRCONN",
+        userID = "app", 
+        password = "password",
         sslCipherSuite = TLS12ORHIGHER,
         secureSocket = {
             cert: {