Merge pull request liberkee#47 from hufsm/feature/XPLHUFRO-64_sample_…

…updates Feature/xplhufro 64 sample updates
suretec · Feb 1, 2018 · 52a2d66 · 52a2d66
2 parents d0243fc + 5e95a02
commit 52a2d66
Show file tree

Hide file tree

Showing 15 changed files with 68 additions and 62 deletions.
diff --git a/.gitignore b/.gitignore
@@ -37,5 +37,3 @@ modify.ldif
 ./build/**
 .vscode/settings.json
 build/*
-TSdeclaration/**/*
-libBuildTLS/**/*
diff --git a/populate.js b/populate.js
@@ -33,13 +33,13 @@ const validEntryObject = [
 ];
 
 
-const ldapClient = new Client(configFile.ldapTestEntries.host);
+const ldapClient = new Client(configFile.ldapAuthentication.host);
 
 ldapClient.initialize()
   .then(() => {
     return ldapClient.bind(
-      configFile.ldapTestEntries.userDn,
-      configFile.ldapTestEntries.userPassword);
+      configFile.ldapAuthentication.dnAdmin,
+      configFile.ldapAuthentication.passwordAdmin);
   })
   .then(() => {
     ldapClient.add(dn, validEntryObject)
@@ -51,6 +51,6 @@ ldapClient.initialize()
 
         Promise.map(args, (arg) => {
           return ldapClient.add(arg, validEntryObject);
-        }, {concurrency: 1});
+        }, {concurrency: 4});
       });
   });
diff --git a/sample/README.MD b/sample/README.MD
@@ -0,0 +1,18 @@
+# Code Samples
+
+Sample code for all function calls:
+
+- [Add](./add_operation.js)
+- [Delete](./delete_operation.js)
+- [Compare](./compare_operation.js)
+- [Change Password](./change_password_operation.js)
+- [Extended Operations](./extended_operation.js)
+- [Modify](./modify_operation.js)
+- [Paged Search](./page_search_operation.js)
+- [Rename](./rename_operation.js)
+- [Search](./search_operation.js)
+
+
+The samples use credentials and parameter values from the [config](./config.json) file, check that out for further  info on how to use the library.
+
+For more details on the control parameters, please check the [documentation](../docs/controls.MD)
diff --git a/sample/add_operation.js b/sample/add_operation.js
@@ -1,7 +1,6 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
-const ldif = require('ldif');
+const LdapClientLib = require('../index').Client;
 const config = require('./config.json');
 
 const newClient = new LdapClientLib(config.ldapAuthentication.host);
@@ -31,14 +30,13 @@ newClient.initialize()
       config.ldapControls.ldapModificationControlPostRead);
   })
   .then((result) => {
-    const resultJson = ldif.parse(result);
     const outputOptions = {};
 
-    const JSONstructure = resultJson.toObject(outputOptions);
+    const JSONstructure = result.toObject(outputOptions);
     JSONstructure.entries.forEach((element) => {
       console.log(element);
     });
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
diff --git a/sample/change_password_operation.js b/sample/change_password_operation.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
+const LdapClientLib = require('../index').Client;
 const config = require('./config.json');
 
 const newClient = new LdapClientLib(config.ldapAuthentication.host);
@@ -23,5 +23,5 @@ newClient.initialize()
     console.log('The user\'s password was changed with success');
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
diff --git a/sample/compare_operation.js b/sample/compare_operation.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
+const LdapClientLib = require('../index').Client;
 
 const config = require('./config.json');
 
@@ -31,5 +31,5 @@ newClient.initialize()
     console.log(`Compare result: ${result}`);
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
diff --git a/sample/config.json b/sample/config.json
@@ -1,6 +1,6 @@
 {
   "ldapAuthentication": {
-    "host": "ldap://localhost:389",
+    "host": "ldap://10.16.0.179:389",
     "dnUser": "cn=managerUser,ou=users,o=myhost,dc=demoApp,dc=com",
     "passwordUser": "secret",
     "pathFileToCert": "/etc/ldap/ca_certs.pem"

diff --git a/sample/delete_operation.js b/sample/delete_operation.js
@@ -1,7 +1,6 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
-const ldif = require('ldif');
+const LdapClientLib = require('../index').Client;
 
 const config = require('./config.json');
 
@@ -26,14 +25,13 @@ newClient.initialize()
       config.ldapControls.ldapModificationControlPreRead);
   })
   .then((result) => {
-    const resultJson = ldif.parse(result);
     const outputOptions = {};
 
-    const JSONstructure = resultJson.toObject(outputOptions);
+    const JSONstructure = result.toObject(outputOptions);
     JSONstructure.entries.forEach((element) => {
       console.log(element);
     });
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
diff --git a/sample/extended_operation.js b/sample/extended_operation.js
@@ -1,6 +1,6 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
+const LdapClientLib = require('../index').Client;
 
 const config = require('./config.json');
 
@@ -34,6 +34,6 @@ newClient.initialize()
     console.log(`The current user is: ${res}`);
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
 
diff --git a/sample/modify_operation.js b/sample/modify_operation.js
@@ -1,8 +1,6 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
-
-const ldif = require('ldif');
+const LdapClientLib = require('../index').Client;
 
 const dn = 'ou=users,o=myhost,dc=demoApp,dc=com';
 
@@ -17,8 +15,16 @@ const changes = [
 ];
 
 const prePostReadControls = [
-  config.ldapControls.ldapModificationControlPostRead,
-  config.ldapControls.ldapModificationControlPreRead,
+  {
+    oid: '1.3.6.1.1.13.1',
+    value: ['cn'],
+    isCritical: false,
+  },
+  {
+    oid: '1.3.6.1.1.13.2',
+    value: ['cn'],
+    isCritical: false,
+  },
 ];
 
 newClient.initialize()
@@ -39,14 +45,13 @@ newClient.initialize()
     return newClient.modify(config.ldapModify.secondDNEntry, changes, prePostReadControls);
   })
   .then((result) => {
-    const resultJson = ldif.parse(result);
     const outputOptions = {};
 
-    const JSONstructure = resultJson.toObject(outputOptions);
+    const JSONstructure = result.toObject(outputOptions);
     JSONstructure.entries.forEach((element) => {
       console.log(element);
     });
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
diff --git a/sample/page_search_operation.js b/sample/page_search_operation.js
@@ -1,8 +1,6 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
-
-const ldif = require('ldif');
+const LdapClientLib = require('../index').Client;
 
 const config = require('./config.json');
 
@@ -28,10 +26,9 @@ newClient.initialize()
       console.log('-----------------------------------');
       console.log(`The page number is ${pageNumber += 1}`);
       console.log('-----------------------------------');
-      const resultJson = ldif.parse(data.toString());
       const outputOptions = {};
 
-      const JSONstructure = resultJson.toObject(outputOptions);
+      const JSONstructure = data.toObject(outputOptions);
       console.log(`LDIF structure: ${data.toString()}`);
       JSONstructure.entries.forEach((element) => {
         console.log(element);
@@ -41,8 +38,8 @@ newClient.initialize()
     result.on('err', (err) => {
       console.log('-----------------');
       console.error(`Error name: ${err.name}`);
-      console.error(`Error code: ${err.constructor.code}`);
-      console.error(`Error description: ${err.constructor.description}`);
+      console.error(`Error code: ${err.code}`);
+      console.error(`Error description: ${err.description}`);
       console.log('-----------------');
     });
 
@@ -51,5 +48,5 @@ newClient.initialize()
     });
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
diff --git a/sample/rename_oparation.js → sample/rename_operation.js b/sample/rename_oparation.js → sample/rename_operation.js
@@ -1,15 +1,14 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
-const ldif = require('ldif');
+const LdapClientLib = require('../index').Client;
 
 const config = require('./config.json');
 
 const newClient = new LdapClientLib(config.ldapAuthentication.host);
 
 const prePostReadControls = [
-  config.ldapControls.ldapModificationControlPostRead,
-  config.ldapControls.ldapModificationControlPreRead,
+  '1.3.6.1.1.13.2',
+  '1.3.6.1.1.13.1',
 ];
 
 newClient.initialize()
@@ -32,14 +31,13 @@ newClient.initialize()
       config.ldapRename.newParent, prePostReadControls);
   })
   .then((result) => {
-    const resultJson = ldif.parse(result);
     const outputOptions = {};
 
-    const JSONstructure = resultJson.toObject(outputOptions);
+    const JSONstructure = result.toObject(outputOptions);
     JSONstructure.entries.forEach((element) => {
       console.log(element);
     });
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
diff --git a/sample/search_operation.js b/sample/search_operation.js
@@ -1,8 +1,6 @@
 'use strict';
 
-const LdapClientLib = require('../libs/ldap_async_wrap.js');
-
-const ldif = require('ldif');
+const LdapClientLib = require('../index').Client;
 
 const config = require('./config.json');
 
@@ -23,15 +21,14 @@ newClient.initialize()
       config.ldapSearch.filter);
   })
   .then((result) => {
-    const resultJson = ldif.parse(result);
     const outputOptions = {};
-    const JSONstructure = resultJson.toObject(outputOptions);
+    const JSONstructure = result.toObject(outputOptions);
     console.log(`LDIF structure: ${result}`);
     console.log('\n\n');
     JSONstructure.entries.forEach((element) => {
       console.log(element);
     });
   })
   .catch((err) => {
-    console.log(`${err.name} ${err.constructor.description}`);
+    console.log(err.toString());
   });
diff --git a/test/config.json b/test/config.json
@@ -6,7 +6,7 @@
     "dnUserNoRight": "cn=simpleUser,ou=users,o=myhost,dc=demoApp,dc=com",
     "passwordAdmin": "secret",
     "passwordUser": "secret",
-    "pathFileToCert": "D:/HSM/ca_certs.pem"
+    "pathFileToCert": "ca_certs.pem"
   },
   "ldapExtendedOperation": {
     "oid": {
@@ -134,18 +134,15 @@
     "filterObjAll": "objectclass=*",
     "filterObjSpecific": "objectclass=aliens",
     "filterObjSpecific2": "objectClass=simpleSecurityObject",
-    "filterObjSpecific3": "objectClass=inetOrgPerson"
+    "filterObjSpecific3": "objectClass=inetOrgPerson",
+    "nrOfResults": 10000,
+    "pageSize": 10
   },
   "ldapDelete": {
     "rdnUser": "cn=testUsersDelete",
     "dn": ",cn=newPoint,ou=users,o=myhost,dc=demoApp,dc=com"
   },
   "ldapTestEntries": {
-    "host": "ldap://localhost:389",
-    "entryDn": "cn=newPoint,ou=users,o=myhost,dc=demoApp,dc=com",
-    "userDn": "cn=admin,dc=demoApp,dc=com",
-    "userPassword": "secret",
-    "nrOfResults": 10000,
-    "pageSize": 10
+    "entryDn": "cn=newPoint,ou=users,o=myhost,dc=demoApp,dc=com"
   }
 }
diff --git a/test/test_paged_search.js b/test/test_paged_search.js
@@ -23,9 +23,9 @@ describe('Testing the async LDAP paged search ', () => {
   let userLDAP = new LDAPWrap(host);
   let pagedSearchPromise;
 
-  const nrOfResults = config.ldapTestEntries.nrOfResults;
+  const nrOfResults = config.ldapSearch.nrOfResults;
 
-  const pageSize = config.ldapTestEntries.pageSize;
+  const pageSize = config.ldapSearch.pageSize;
 
   const searchScope = {
     base: 'BASE',