Apply suggestions from the API review

.github/workflows/pull-request.yml

@@ -13,7 +13,4 @@ jobs:
         uses: ballerina-platform/ballerina-library/.github/workflows/pull-request-build-template.yml@main
         secrets: inherit
         with:
-            additional-ubuntu-build-flags: "-x test"
-            additional-ubuntu-test-flags: "-x test"
-            additional-windows-build-flags: "-x test"
             additional-windows-test-flags: "-x test"

README.md

@@ -62,7 +62,7 @@ public function main() returns error? {
 
 #### `modifyDN` API
 
-Updates information of an entry.
+Renames an entry in a directory server.
 
 ```ballerina
 import ballerina/ldap;

ballerina/Module.md

@@ -55,7 +55,7 @@ public function main() returns error? {
 
 #### `modifyDN` API
 
-Updates information of an entry.
+Renames an entry in a directory server.
 
 ```ballerina
 import ballerina/ldap;

ballerina/Package.md

@@ -55,7 +55,7 @@ public function main() returns error? {
 
 #### `modifyDN` API
 
-Updates information of an entry.
+Renames an entry in a directory server.
 
 ```ballerina
 import ballerina/ldap;

ballerina/build.gradle

@@ -93,10 +93,60 @@ clean {
     delete 'build'
 }
 
+task startLdapServer() {
+    doLast {
+        if (!Os.isFamily(Os.FAMILY_WINDOWS)) {
+            def stdOut = new ByteArrayOutputStream()
+            exec {
+                commandLine 'sh', '-c', "docker ps --filter name=openldap-server"
+                standardOutput = stdOut
+            }
+            if (!stdOut.toString().contains("openldap-server")) {
+                println "Starting LDAP server."
+                exec {
+                    commandLine 'sh', '-c', "docker-compose -f $project.projectDir/tests/resources/openldap/docker-compose.yml up -d"
+                    standardOutput = stdOut
+                }
+                println stdOut.toString()
+                println "Waiting 15s until the LDAP server get initiated."
+                sleep(15 * 1000)
+            } else {
+                println "LDAP server is already started."
+            }
+        }
+    }
+}
+
+task stopLdapServer() {
+    doLast {
+        if (!Os.isFamily(Os.FAMILY_WINDOWS)) {
+            def stdOut = new ByteArrayOutputStream()
+            exec {
+                commandLine 'sh', '-c', "docker ps --filter name=openldap-server"
+                standardOutput = stdOut
+            }
+            if (stdOut.toString().contains("openldap-server")) {
+                println "Stopping LDAP server."
+                exec {
+                    commandLine 'sh', '-c', "docker stop openldap-server"
+                    standardOutput = stdOut
+                }
+                println stdOut.toString()
+                println "Waiting 5s until the LDAP server get stopped."
+                sleep(5 * 1000)
+            } else {
+                println "LDAP server is not started."
+            }
+        }
+    }
+}
+
 updateTomlFiles.dependsOn copyStdlibs
 build.dependsOn copyToLib
 
 test.dependsOn ":${packageName}-native:build"
+build.finalizedBy stopLdapServer
+build.dependsOn startLdapServer
 build.dependsOn ":${packageName}-native:build"
 
 publishToMavenLocal.dependsOn build

ballerina/client.bal

@@ -28,103 +28,101 @@ public isolated client class Client {
     }
 
     private isolated function initLdapConnection(ConnectionConfig config) returns Error? = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Creates an entry in a directory server.
     #
-    # + distinguishedName - The distinguished name of the entry
+    # + dN - The distinguished name of the entry
     # + entry - The information to add
     # + return - A `ldap:Error` if the operation fails or `ldap:LdapResponse` if successfully created
-    remote isolated function add(string distinguishedName, record {|anydata...;|} entry)
-        returns LdapResponse|Error = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+    remote isolated function add(string dN, Entry entry) returns LdapResponse|Error = @java:Method {
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Removes an entry in a directory server.
     #
-    # + distinguishedName - The distinguished name of the entry to remove
+    # + dN - The distinguished name of the entry to remove
     # + return - A `ldap:Error` if the operation fails or `ldap:LdapResponse` if successfully removed
-    remote isolated function delete(string distinguishedName) returns LdapResponse|Error = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+    remote isolated function delete(string dN) returns LdapResponse|Error = @java:Method {
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Updates information of an entry.
     # 
-    # + distinguishedName - The distinguished name of the entry
+    # + dN - The distinguished name of the entry
     # + entry - The information to update
     # + return - A `ldap:Error` if the operation fails or `LdapResponse` if successfully updated
-    remote isolated function modify(string distinguishedName, record {|anydata...;|} entry)
-        returns LdapResponse|Error = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+    remote isolated function modify(string dN, Entry entry) returns LdapResponse|Error = @java:Method {
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Renames an entry in a directory server.
     #
-    # + currentDN - The current distinguished name of the entry
-    # + newRDN - The new relative distinguished name
-    # + deleteOldRDN - A boolean value to determine whether to delete the old RDN
+    # + currentDn - The current distinguished name of the entry
+    # + newRdn - The new relative distinguished name
+    # + deleteOldRdn - A boolean value to determine whether to delete the old RDN
     # + return - A `ldap:Error` if the operation fails or `ldap:LdapResponse` if successfully renamed
-    remote isolated function modifyDN(string currentDN, string newRDN, boolean deleteOldRDN = true)
+    remote isolated function modifyDn(string currentDn, string newRdn, boolean deleteOldRdn = false)
         returns LdapResponse|Error = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Determines whether a given entry has a specified attribute value.
     # 
-    # + distinguishedName - The distinguished name of the entry
-    # + attribiteName - The name of the target attribute for which the comparison is to be performed
+    # + dN - The distinguished name of the entry
+    # + attributeName - The name of the target attribute for which the comparison is to be performed
     # + assertionValue - The assertion value to verify within the entry
-    # + return - A `ldap:Error` if the operation fails or `ldap:LdapResponse` if successfully executed
-    remote isolated function compare(string distinguishedName, string attribiteName, string assertionValue)
-        returns LdapResponse|Error = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+    # + return - A `boolean` value indicating whether the values match, or an `ldap:Error` if the operation fails
+    remote isolated function compare(string dN, string attributeName, string assertionValue)
+        returns boolean|Error = @java:Method {
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Gets information of an entry.
     # 
-    # + distinguishedName - The distinguished name of the entry
+    # + dN - The distinguished name of the entry
     # + targetType - Default parameter use to infer the user specified type
     # + return - An entry result with the given type or else `ldap:Error`
-    remote isolated function getEntry(string distinguishedName, typedesc<anydata> targetType = <>)
+    remote isolated function getEntry(string dN, typedesc<anydata> targetType = <>)
         returns targetType|Error = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Returns a list of entries that match the given search parameters.
-    # 
-    # + baseDN - The base distinguished name of the entry
+    #
+    # + baseDn - The base distinguished name of the entry
     # + filter - The filter to be used in the search
     # + scope - The scope of the search
     # + targetType - Default parameter use to infer the user specified type
     # + return - An array of entries with the given type or else `ldap:Error`
-    remote isolated function searchWithType(string baseDN, string filter, 
-                                            SearchScope scope, typedesc<anydata[]> targetType = <>)
+    remote isolated function searchWithType(string baseDn, string filter, 
+                                            SearchScope scope, typedesc<record{}[]> targetType = <>)
         returns targetType|Error = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Returns a record containing search result entries and references that match the given search parameters.
     # 
-    # + baseDN - The base distinguished name of the entry
+    # + baseDn - The base distinguished name of the entry
     # + filter - The filter to be used in the search
     # + scope - The scope of the search
     # + return - An `ldap:SearchResult` if successful, or else `ldap:Error`
-    remote isolated function search(string baseDN, string filter, SearchScope scope)
+    remote isolated function search(string baseDn, string filter, SearchScope scope)
         returns SearchResult|Error = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Unbinds from the server and closes the LDAP connection. 
     # 
     remote isolated function close() = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 
     # Determines whether the client is connected to the server.
     # 
     # + return - A boolean value indicating the connection status
     remote isolated function isConnected() returns boolean = @java:Method {
-        'class: "io.ballerina.lib.ldap.Ldap"
+        'class: "io.ballerina.lib.ldap.Client"
     } external;
 }

ballerina/error.bal

@@ -20,8 +20,6 @@ public type Error distinct error<ErrorDetails>;
 # The error details type for the Ballerina LDAP module.
 #
 # + resultCode - The status of the error
-# + message - The error message
 public type ErrorDetails record {|
     string resultCode?;
-    string message?;
 |};

ballerina/tests/Config.toml

@@ -1,5 +1,5 @@
-hostName = "host-name"
+hostName = "localhost"
 port = 389
-domainName = "domain@ad.com"
-password = "password"
-userDN = "CN=User,OU=People,DC=ad,DC=com"
+domainName = "cn=admin,dc=mycompany,dc=com"
+password = "adminpassword"
+userDN = "CN=User,dc=mycompany,dc=com"

ballerina/tests/resources/openldap/bootstrap.ldif

@@ -0,0 +1,44 @@
+dn: ou=Users,dc=mycompany,dc=com
+changetype: add
+objectClass: organizationalUnit
+ou: Users
+
+dn: ou=Groups,dc=mycompany,dc=com
+changetype: add
+objectClass: organizationalUnit
+ou: Groups
+
+dn: uid=ldclakmal,ou=Users,dc=mycompany,dc=com
+changetype: add
+objectClass: inetOrgPerson
+cn: John
+givenName: John
+sn: John
+uid: john
+displayName: John Doe
+mail: [email protected]
+userpassword: johndoe@123
+
+dn: uid=alice,ou=Users,dc=mycompany,dc=com
+changetype: add
+objectClass: inetOrgPerson
+cn: Test Developer
+givenName: Alice
+sn: Parker
+uid: alice
+displayName: Alice Parker
+mail: [email protected]
+userpassword: alice@123
+
+dn: cn=admin,ou=Groups,dc=mycompany,dc=com
+changetype: add
+cn: admin
+objectClass: groupOfNames
+member: uid=johndoe,ou=Users,dc=mycompany,dc=com
+
+dn: cn=developer,ou=Groups,dc=mycompany,dc=com
+changetype: add
+cn: developer
+objectClass: groupOfNames
+member: uid=johndoe,ou=Users,dc=mycompany,dc=com
+member: uid=alice,ou=Users,dc=mycompany,dc=com

ballerina/tests/resources/openldap/docker-compose.yml

@@ -0,0 +1,14 @@
+version: '3.7'
+
+services:
+    ldap_server:
+        image: osixia/openldap:latest
+        container_name: my-openldap-container
+        environment:
+            LDAP_ORGANISATION: "My Company"
+            LDAP_DOMAIN: "mycompany.com"
+            LDAP_ADMIN_PASSWORD: "adminpassword"
+        ports:
+            - "389:389"
+            - "636:636"
+        command: --copy-service