Added postgresql

hpcc-systems · Oct 30, 2023 · abd099a · abd099a
1 parent a53b6c8
commit abd099a
Show file tree

Hide file tree

Showing 17 changed files with 3,677 additions and 2,001 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "packages/aws",
     "packages/core",
     "packages/defaultSQL",
+    "packages/postgresql",
     "packages/mysql",
     "packages/preprocessor",
     "packages/validations"
@@ -35,7 +36,10 @@
     "url": "https://github.com/hpcc-systems/MAF/issues"
   },
   "homepage": "https://github.com/hpcc-systems/MAF#readme",
+  "dependencies": {
+  },
   "devDependencies": {
+    "@cucumber/cucumber": "^9.0.0",
     "lerna": "^7.1.4",
     "multiple-cucumber-html-reporter": "^3.4.0",
     "nyc": "^15.1.0"

diff --git a/packages/mysql/features/mySQL.feature b/packages/mysql/features/mySQL.feature
@@ -1,4 +1,4 @@
 # Feature: MYSQL
 #   Scenario: 
 #       When mysql query from string "Insert into HelloWorld Values (7, 'What Up') " is run
-#       When mysql query from string "SELECT * FROM HelloWorld" is run
+#       And mysql query from string "SELECT * FROM HelloWorld" is run
diff --git a/packages/mysql/package.json b/packages/mysql/package.json
@@ -26,6 +26,7 @@
   "devDependencies": {
     "@cucumber/cucumber": "^9.0.0",
     "@ln-maf/core": "^2.0.1",
+    "@ln-maf/validations": "^2.0.3",
     "eslint": "^8.18.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",

diff --git a/packages/postgressql/.eslintrc.json b/packages/postgressql/.eslintrc.json
@@ -0,0 +1,22 @@
+{
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es2021": true
+  },
+  "extends": ["standard"],
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "rules": {
+    "indent": ["error", 4],
+    "space-before-function-paren": [
+      "error",
+      {
+        "anonymous": "always",
+        "named": "never",
+        "asyncArrow": "always"
+      }
+    ]
+  }
+}
diff --git a/packages/postgressql/.gitignore b/packages/postgressql/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+test/report
diff --git a/packages/postgressql/.npmignore b/packages/postgressql/.npmignore
@@ -0,0 +1,4 @@
+*.png
+.gitignore
+coverage
+tmp
diff --git a/packages/postgressql/LICENSE b/packages/postgressql/LICENSE
@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/packages/postgressql/README.md b/packages/postgressql/README.md
@@ -0,0 +1,56 @@
+# Node Sql Setup
+
+This module is created to allow other projects to easily utilize SQL when writing test cases.  Additionally, a utility function is used to test using this.
+
+[![npm package][npm-image]][npm-url] 
+[![GitHub Actions](https://github.com/hpcc-systems/MAF/workflows/Build/badge.svg)](https://github.com/hpcc-systems/MAF/actions)
+[![Dependencies][dep-image]][dep-url]
+
+
+# Setup
+
+To use this you must require this library after installing using npm.
+```
+npm i @ln-maf/postgresql
+```
+
+# Set up configs
+
+Keytar is used to store access to the username and password for sql. Alternatively, Environment Variables Can be used as well. The following environment variables are used:
+- POSTGRESQL_SQL_USERNAME: Your username for postgresql
+- POSTGRESQL_SQL_PASSWORD: Your password for postgresql
+- USE_ENV_VARIABLES: Set to `TRUE` to use environment variables instead of keytar.
+```
+To setup an sql config please run the following from your project root:
+```
+node node_modules/@ln-maf/postgresql/config.js
+```
+Or create a JSON with the name `postgresql.sqlConfig.json` in the root directory of your project.  The following is an example of the JSON:
+```
+{
+    "sql": {
+        "host": "localhost",
+        "port": 5432,
+        "database": "database"
+    }
+}
+```
+Note: Please run the Setup step first.
+
+
+## Steps
+Add a step definition file with the following line:
+```
+require('@ln-maf/postgresql)
+```
+
+## Given postgresql config from [{jsonObject}](../validations/JSONObject.md)
+Utilizes the sql system associated with the item provided.  By default will use `postgresql.sqlConfig.json` in the root directory of the project if none is provided.
+
+## When postgresql query from [{jsonObject}](../validations/JSONObject.md) is run
+Runs a query from the provided item.  Allows templated args as per the global cucumber projects.  Stores the results in `this.results.lastRun`.  Usable in cucubmer as `${lastRun}` or the it keyword.
+
+[npm-image]:https://img.shields.io/npm/v/@ln-maf/postgresql.svg
+[npm-url]:https://www.npmjs.com/package/@ln-maf/postgresql-sql
+[dep-image]:https://david-dm.org/hpcc-systems/MAF.svg?path=packages%2Fpostgresql
+[dep-url]:https://david-dm.org/hpcc-systems/MAF?path=packages%2Fpostgresql
diff --git a/packages/postgressql/config.js b/packages/postgressql/config.js
@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+const config = require('@ln-maf/default-sql/config')
+config('postgresql')
diff --git a/packages/postgressql/features/postgreSQL.feature b/packages/postgressql/features/postgreSQL.feature
@@ -0,0 +1,4 @@
+Feature: PostgreSQL
+  Scenario: 
+      When postgresql query from "Insert into users(email, firstname, lastname, age) Values ('[email protected]', 'John', 'Smith', 35);" is run
+      When postgresql query from "SELECT * FROM users;" is run
diff --git a/packages/postgressql/index.js b/packages/postgressql/index.js
@@ -0,0 +1 @@
+require('./stepDefinitions/postgresql.js')
diff --git a/packages/postgressql/package.json b/packages/postgressql/package.json
@@ -0,0 +1,53 @@
+{
+  "name": "@ln-maf/postgresql",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "2.0.0",
+  "description": "PostgreSQL support / step definitions for MAF",
+  "main": "index.js",
+  "scripts": {
+    "test": "sh runFeature.sh"
+  },
+  "bin": {
+    "postgresql-configure": "./config.js"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@ln-maf/default-sql": "^2.0.1",
+    "keytar": "^7.9.0",
+    "pg": "^8.0.0"
+  },
+  "peerDependencies": {
+    "@cucumber/cucumber": ">= 7.0.0",
+    "@ln-maf/core": "*"
+  },
+  "devDependencies": {
+    "@cucumber/cucumber": "^9.0.0",
+    "@ln-maf/core": "^2.0.0",
+    "@ln-maf/validations": "^2.0.3",
+    "eslint": "^8.0.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "multiple-cucumber-html-reporter": "^3.0.0",
+    "nyc": "^15.1.0"
+  },
+  "gitHead": "2a575448a74cfaee5ec68fa10db24cf4ccade849",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hpcc-systems/MAF.git"
+  },
+  "keywords": [
+    "cucumber-js",
+    "testing",
+    "gherkin",
+    "cucumber-steps"
+  ],
+  "bugs": {
+    "url": "https://github.com/hpcc-systems/MAF/issues"
+  },
+  "homepage": "https://github.com/hpcc-systems/MAF#readme"
+}