@itentialopensource/adapter-db_postgresql 0.2.1 → 1.0.1

package/changelogs/changelog.md

@@ -0,0 +1,40 @@
+
+## 0.2.1 [11-22-2019]
+
+* fix pipeline
+
+See merge request itentialopensource/adapters/persistence/adapter-db_postgresql!2
+
+---
+
+## 0.2.0 [11-22-2019]
+
+* adding ssl support
+
+See merge request itentialopensource/adapters/persistence/adapter-db_postgresql!1
+
+---
+
+## 0.1.3 [11-21-2019]
+
+* Bug fixes and performance improvements
+
+See commit 8ffc69e
+
+---
+
+## 0.1.2 [11-21-2019]
+
+* Bug fixes and performance improvements
+
+See commit 4b1b47f
+
+---
+
+## 0.1.1 [11-19-2019]
+
+* Bug fixes and performance improvements
+
+See commit 77e4b6c
+
+---

package/compliance-report.json

@@ -0,0 +1,9 @@
+{
+  "ComplianceEntries": [
+    {
+      "name": "Compliance Summary",
+      "numInvalidProjects": 0,
+      "numValidProjects": 0
+    }
+  ]
+}

package/compliance-report.txt

@@ -0,0 +1,5 @@
+---------------------------------------------------------------------------------------------
+**** Project Compliance Summary ****
+0 project(s) are not valid
+0 project(s) are valid
+---------------------------------------------------------------------------------------------

package/error.json

@@ -96,6 +96,12 @@
       "displayString": "Invalid properties: $VARIABLE$",
       "recommendation": "Verify the properties for the adapter"
     },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
     {
       "key": "Query Not Translated",
       "icode": "AD.310",
@@ -168,6 +174,12 @@
       "displayString": "Failure response received for $VARIABLE$",
       "recommendation": "Check the reason for failure in the stack trace"
     },
+    {
+      "key": "Suspended Adapter",
+      "icode": "AD.600",
+      "displayString": "Adapter is suspended",
+      "recommendation": "Check if external system is functional and unsuspend if appropriate"
+    },
     {
       "key": "Caught Exception",
       "icode": "AD.900",

package/metadata.json

@@ -0,0 +1,77 @@
+{
+  "name": "adapter-db_postgresql",
+  "webName": "Adapter for Integration to PostgreSQL Database",
+  "vendor": "PostgreSQL",
+  "product": "PostgreSQL",
+  "osVersion": [],
+  "apiVersions": [],
+  "iapVersions": [
+    "2021.1.x",
+    "2021.2.x",
+    "2022.1.x",
+    "2023.1.x"
+  ],
+  "method": "Library",
+  "type": "Adapter",
+  "domains": [
+    "Data Storage"
+  ],
+  "tags": [
+    "Database & Repository Operations"
+  ],
+  "useCases": [
+    "CRUD Operations",
+    "Persist Data"
+  ],
+  "deprecated": {
+    "isDeprecated": false
+  },
+  "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "Database Auth",
+      "subtypes": [],
+      "primary": true
+    }
+  ],
+  "documentation": {
+    "storeLink": "",
+    "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-db_postgresql",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-db_postgresql",
+    "docLink": "",
+    "demoLinks": [],
+    "trainingLinks": [
+      {
+        "title": "Itential Academy",
+        "link": "https://www.itential.com/itential-academy/"
+      }
+    ],
+    "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
+    "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
+    "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
+    "webLink": "https://www.itential.com/adapters/postgresql/",
+    "vendorLink": "https://www.postgresql.org/",
+    "productLink": "https://www.postgresql.org/",
+    "apiLinks": [
+      {
+        "title": "PostgreSQL SQL Reference",
+        "link": "https://www.postgresqltutorial.com/",
+        "public": true
+      },
+      {
+        "title": "PostgreSQL Node Library Documentation",
+        "link": "https://www.npmjs.com/package/pg",
+        "public": true
+      }
+    ]
+  },
+  "assets": [],
+  "relatedItems": {
+    "adapters": [],
+    "integrations": [],
+    "ecosystemApplications": [],
+    "workflowProjects": [],
+    "transformationProjects": [],
+    "exampleProjects": []
+  }
+}

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@itentialopensource/adapter-db_postgresql",
-  "version": "0.2.1",
+  "version": "1.0.1",
   "description": "Itential adapter to connect to postgresql",
   "main": "adapter.js",
-  "wizardVersion": "2.41.0",
-  "engineVersion": "1.44.2",
+  "wizardVersion": "2.44.7",
+  "engineVersion": "1.67.14",
+  "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
     "preinstall": "node utils/setup.js",
-    "lint": "eslint . --ext .json --ext .js",
+    "deinstall": "node utils/removeHooks.js",
+    "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
+    "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
-    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:unit && npm run test:integration",
-    "deploy": "npm publish --registry=http://registry.npmjs.org --access=public",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
     "build": "npm run deploy"
   },
   "keywords": [
@@ -29,32 +31,31 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 0.12.7"
+    "node": ">=14.0.0",
+    "npm": ">=6.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:itentialopensource/adapters/persistence/adapter-db_postgresql.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-db_postgresql.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_postgresql#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-db_postgresql#readme",
   "dependencies": {
-    "ajv": "^6.10.0",
-    "fs-extra": "^7.0.0",
-    "pg": "^7.12.1",
-    "package-json-validator": "^0.6.3",
-    "readline-sync": "^1.4.9",
+    "ajv": "^8.12.0",
+    "fs-extra": "^11.1.1",
+    "pg": "^8.11.3",
+    "readline-sync": "^1.4.10",
     "uuid": "^3.0.1"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^5.14.1",
-    "eslint-config-airbnb-base": "^13.1.0",
-    "eslint-plugin-import": "^2.16.0",
-    "eslint-plugin-json": "^1.4.0",
-    "mocha": "^5.2.0",
-    "nyc": "^14.1.1",
-    "testdouble": "^3.8.1",
-    "winston": "^2.4.0"
+    "chai": "^4.3.7",
+    "eslint": "^8.44.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-json": "^3.1.0",
+    "mocha": "^10.7.0",
+    "testdouble": "^3.18.0",
+    "winston": "^3.13.1"
   },
   "private": false
 }

package/propertiesDecorators.json

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "encryption",
+    "pointer": "/authentication/password"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/authentication/token"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/mongo/password"
+  }
+]

package/report/adapterInfo.json

@@ -0,0 +1,10 @@
+{
+  "version": "0.2.1",
+  "configLines": 468,
+  "scriptLines": 516,
+  "codeLines": 532,
+  "testLines": 964,
+  "testCases": 45,
+  "totalCodeLines": 2012,
+  "wfTasks": 7
+}

package/sampleProperties.json

@@ -6,12 +6,12 @@
     "host": "localhost",
     "port": 5432,
     "authentication": {
-        "username": "your username",
-        "password": "your password"
+      "username": "your username",
+      "password": "your password"
     },
     "ssl": {
       "enabled": false,
-      "accept_invalid_cert": true,
+      "accept_invalid_cert": false,
       "ca_file": ""
     }
   },
@@ -19,4 +19,4 @@
   "brokers": [],
   "logLevel": "none",
   "timeout": 60000
-}
+}

package/test/.eslintrc.js

@@ -1,16 +1,16 @@
 module.exports = {
   env: {
-    mocha: true,
+    mocha: true
   },
   globals: {
     // Pronghorn globals.
-    log: true,
+    log: true
   },
   rules: {
     // Mocha preference for describe context.
     'prefer-arrow-callback': 'off',
     'func-names': 'off',
     // We want to isolate dependencies.
-    'global-require': 'off',
-  },
+    'global-require': 'off'
+  }
 };

package/test/integration/adapterTestIntegration.js

@@ -1,7 +1,7 @@
 /* @copyright Itential, LLC 2019 (pre-modifications) */
 
 // Set globals
-/* global describe it log pronghornProps */
+/* global pronghornProps */
 /* eslint no-unused-vars: warn */
 /* eslint no-underscore-dangle: warn  */
 
@@ -93,7 +93,7 @@ process.argv.forEach((val) => {
 });
 
 // need to set global logging
-global.log = new (winston.Logger)({
+global.log = winston.createLogger({
   level: logLevel,
   levels: myCustomLevels.levels,
   transports: [
@@ -129,7 +129,7 @@ function runErrorAsserts(data, error, code, origin, displayStr) {
 }
 
 // require the adapter that we are going to be using
-const PostgreSQL = require('../../adapter.js');
+const PostgreSQL = require('../../adapter');
 
 // begin the testing - these should be pretty well defined between the describe and the it!
 describe('[integration] PostgreSQL Adapter Test', () => {
@@ -183,7 +183,7 @@ describe('[integration] PostgreSQL Adapter Test', () => {
       }
     });
 
-    describe('heatlhCheck should yield', function () {
+    describe('heatlhCheck should yield', () => {
       if (!stub) {
         it('healthcheck should succeed', (done) => {
           try {
@@ -216,7 +216,7 @@ describe('[integration] PostgreSQL Adapter Test', () => {
     */
 
     const createSQL = 'CREATE TABLE Dogs (DogID int, Name varchar(255));';
-    describe('#create', function () {
+    describe('#create', () => {
       if (!stub) {
         it('should create a table', (done) => {
           try {
@@ -239,7 +239,7 @@ describe('[integration] PostgreSQL Adapter Test', () => {
     });
 
     const insertSQL = 'INSERT INTO Dogs (DogID, Name) VALUES (001, \'dog001\');';
-    describe('#insert', function () {
+    describe('#insert', () => {
       if (!stub) {
         it('should insert a record', (done) => {
           try {
@@ -262,7 +262,7 @@ describe('[integration] PostgreSQL Adapter Test', () => {
     });
 
     const selectSQL = 'SELECT Name FROM Dogs;';
-    describe('#select', function () {
+    describe('#select', () => {
       if (!stub) {
         it('should select a record', (done) => {
           try {
@@ -285,7 +285,7 @@ describe('[integration] PostgreSQL Adapter Test', () => {
     });
 
     const querySQL = 'SELECT Name FROM Dogs;';
-    describe('#query', function () {
+    describe('#query', () => {
       if (!stub) {
         it('should query a record', (done) => {
           try {
@@ -308,7 +308,7 @@ describe('[integration] PostgreSQL Adapter Test', () => {
     });
 
     const updateSQL = 'UPDATE Dogs SET Name=\'dogs001\' WHERE DogID=1;';
-    describe('#update', function () {
+    describe('#update', () => {
       if (!stub) {
         it('should update a record', (done) => {
           try {
@@ -331,7 +331,7 @@ describe('[integration] PostgreSQL Adapter Test', () => {
     });
 
     const deleteSQL = 'DELETE FROM Dogs WHERE DogID=1;';
-    describe('#delete', function () {
+    describe('#delete', () => {
       if (!stub) {
         it('should delete a record', (done) => {
           try {
@@ -354,7 +354,7 @@ describe('[integration] PostgreSQL Adapter Test', () => {
     });
 
     const dropSQL = 'DROP TABLE Dogs;';
-    describe('#drop', function () {
+    describe('#drop', () => {
       if (!stub) {
         it('should drop a record', (done) => {
           try {

package/test/unit/adapterTestUnit.js

@@ -1,7 +1,7 @@
 /* @copyright Itential, LLC 2019 (pre-modifications) */
 
 // Set globals
-/* global describe it log pronghornProps */
+/* global pronghornProps */
 /* eslint global-require:warn */
 /* eslint no-unused-vars: warn */
 
@@ -16,7 +16,9 @@ const execute = require('child_process').execSync;
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
+const Ajv = require('ajv');
 
+const ajv = new Ajv({ strictSchema: false, allErrors: true, allowUnionTypes: true });
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
@@ -97,7 +99,7 @@ process.argv.forEach((val) => {
 });
 
 // need to set global logging
-global.log = new (winston.Logger)({
+global.log = winston.createLogger({
   level: logLevel,
   levels: myCustomLevels.levels,
   transports: [
@@ -121,9 +123,8 @@ function runErrorAsserts(data, error, code, origin, displayStr) {
   assert.equal(displayStr, error.IAPerror.displayString);
 }
 
-
 // require the adapter that we are going to be using
-const PostgreSQL = require('../../adapter.js');
+const PostgreSQL = require('../../adapter');
 
 // delete the .DS_Store directory in entities -- otherwise this will cause errors
 const dirPath = path.join(__dirname, '../../entities/.DS_Store');
@@ -187,23 +188,33 @@ describe('[unit] PostgreSQL Adapter Test', () => {
         });
       });
       it('package.json should be validated', (done) => {
-        const packageDotJson = require('../../package.json');
-        const { PJV } = require('package-json-validator');
-        const options = {
-          warnings: true, // show warnings
-          recommendations: true // show recommendations
-        };
-        const results = PJV.validate(JSON.stringify(packageDotJson), 'npm', options);
-
-        if (results.valid === false) {
-          log.error('The package.json contains the following errors: ');
-          log.error(util.inspect(results));
-          assert.equal(true, results.valid);
-        } else {
-          assert.equal(true, results.valid);
-        }
+        try {
+          const packageDotJson = require('../../package.json');
+          // Define the JSON schema for package.json
+          const packageJsonSchema = {
+            type: 'object',
+            properties: {
+              name: { type: 'string' },
+              version: { type: 'string' }
+              // May need to add more properties as needed
+            },
+            required: ['name', 'version']
+          };
+          const validate = ajv.compile(packageJsonSchema);
+          const isValid = validate(packageDotJson);
+
+          if (isValid === false) {
+            log.error('The package.json contains errors');
+            assert.equal(true, isValid);
+          } else {
+            assert.equal(true, isValid);
+          }
 
-        done();
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
       });
       it('package.json should be customized', (done) => {
         const packageDotJson = require('../../package.json');