repo updates to match main repo

Author: shaswot77

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,12 @@
-Tenant to Deploy to: 
+Tenant to Deploy to:
 
 # Description
 
 Please include a description of the new feature/changes/bug fix
 Please include screenshots if relevant.
 
 # PR Creation Checklist:
+
 - [ ] PR title includes a descriptive title
 - [ ] Added a label: `breaking` or `non-breaking`
 - [ ] Added a label: `bug-fix`, `new-plugin`, `internal` or `enhancement`

.github/workflows/enforce-labels.yml

@@ -17,5 +17,5 @@ jobs:
             - name: Enforce second set of labels
               uses: yogevbd/enforce-label-action@2.2.2
               with:
-                  REQUIRED_LABELS_ANY: 'bug-fix,internal,enhancement,new-plugin'
-                  REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label ['bug-fix','internal','enhancement','new-plugin']"
+                  REQUIRED_LABELS_ANY: 'bug,new-plugin,enhancement,automated-test,internal'
+                  REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label ['bug','new-plugin','enhancement', 'automated-test', 'internal']"

.github/workflows/unit-test.yml

@@ -28,23 +28,23 @@ jobs:
                   $pattern = '(?<=\/[v][0-9]\/).*'
                   $changes = git diff --name-only origin/main... ./plugins
                   $pluginsToTest = $changes -replace $pattern | Sort-Object -Unique
+                  $pluginsToTest = $pluginsToTest | Where-Object { Test-Path -PathType Leaf (Join-Path "." $_ "metadata.json") } # Don't try to test deleted plugins
 
                   if ( $null -eq $pluginsToTest ) {
                       Write-Output "Nothing to Test as no changes were found in plugins folder..."
                       exit 0
                   }
                   elseif ( $pluginsToTest.Count -eq 1 ) {
+                      Write-Output "Testing only one Plugin"
                       $pluginName = ($pluginsToTest.TrimEnd('/')) -replace "plugins/" -replace "/", "-"
-                      Write-Output "Only Testing $pluginsToTest"
-                      npm test -- --ci  --path="./$pluginsToTest" --pluginName="$pluginName"
-                      Write-Output "Tested $pluginsToTest"
+                      pnpm run test --ci  --path="./$pluginsToTest" --pluginName="$pluginName"
                   }
                   else {
                       Write-Output "Testing $($pluginsToTest.Count) Plugins..."
                       foreach ( $plugin in $pluginsToTest ) {
                           Write-Output "Testing $plugin"
                           $pluginName = ($plugin.TrimEnd('/')) -replace "plugins/" -replace "/", "-"
-                          npm test -- --ci  --path="./$plugin" --pluginName="$pluginName"
+                          pnpm run test --ci  --path="./$plugin" --pluginName="$pluginName"
                           Write-Output "Tested $plugin"
                       }
                   }

.gitignore

@@ -17,6 +17,9 @@
 .idea/**/contentModel.xml
 /plugins/package.json
 /plugins/package-lock.json
+/plugins/pnpm-workspace.yaml
+/plugins/pnpm-lock.yaml
+
 
 # Sensitive or high-churn files
 .idea/**/dataSources/
@@ -501,8 +504,6 @@ PublishScripts/
 *.nupkg
 # NuGet Symbol Packages
 *.snupkg
-# The packages folder can be ignored because of Package Restore
-**/[Pp]ackages/*
 # except build/, which is used as an MSBuild target.
 !**/[Pp]ackages/build/
 # Uncomment if necessary however generally it will be regenerated when needed
@@ -679,26 +680,28 @@ serverless.yml
 wrappedHandler.js
 handlerCloud.js
 handlerOnPrem.js
+graphDump.json
 
 # Test files
 testConfig.json
 env-testConfig.json
 testDatastreamConfig.json
 junit.xml
-pluginUnitTests/test_output/
+**/test_output/
 testDatastreamLocally.js
 datastream_test_results/
+oauth_test_results/
 testResults.datastreamResults.json
 **/testPluginLocally.js
 **/testResults.json
 **/importResults.json
 **/datastreamResults.json
-pluginsIntegrationTestUtils/reports/html/
-pluginsIntegrationTestUtils/reports/junit/
-pluginsIntegrationTestUtils/configs/env-Config.json
-pluginsIntegrationTestUtils/configs/env-testConfig.json
+packages/@squaredup/integration-test-utilities/reports/**
+env-Config.json
 testTargetNodeConfig.json
 testDataSourceConfig.json
+plugins/**/allure-*/
 
 # CI files
 PluginsToUpload/*
+PluginsToPackage/*

.npmrc

@@ -0,0 +1,2 @@
+node-linker=hoisted
+engine-strict=true

.prettierignore

@@ -1,2 +1,3 @@
 **/node_modules
 package*.json
+pnpm-lock.yaml

.prettierrc.json

@@ -4,5 +4,6 @@
     "singleQuote": true,
     "tabWidth": 4,
     "trailingComma": "none",
-    "endOfLine": "auto"
+    "endOfLine": "auto",
+    "plugins": ["prettier-plugin-organize-imports"]
 }

.vscode/extensions.json

@@ -5,7 +5,10 @@
     // List of extensions which should be recommended for users of this workspace.
     "recommendations": [
         "dbaeumer.vscode-eslint",
+        "orta.vscode-jest",
         "esbenp.prettier-vscode",
         "streetsidesoftware.code-spell-checker"
-    ]
+    ],
+    // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+    "unwantedRecommendations": ["amatiasq.sort-imports"]
 }

.vscode/settings.json

@@ -3,8 +3,22 @@
     "prettier.ignorePath": ".prettierignore",
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "prettier.requireConfig": true,
-    "eslint.workingDirectories": [{ "directory": "." }],
     "[javascript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode"
-    }
+    },
+    "eslint.workingDirectories": [{ "directory": "." }],
+    "json.schemas": [
+        {
+            "fileMatch": [
+                "**/data_streams.json"
+            ],
+            "url": "./packages/@squaredup/schema/data_streams.schema.json"
+        },
+        {
+            "fileMatch": [
+                "**/*.dash.json"
+            ],
+            "url": "./packages/@squaredup/schema/oob.schema.json"
+        }
+    ]
 }

README.md

@@ -36,6 +36,7 @@ Javascript (NodeJS) is currently the implementation language/runtime with fulles
 ## Structure of a plugin
 
 A plugin is a directory in this repo of the form `plugins/`_plugin-name_`/v1` containing certain key files:
+
 - `metadata.json` - a file containing high-level information about the plugin (for example: the execution location of the plugin, or the information that appears in the Data Source Gallery, above).
 - `ui.json` - a file describing the configuration that must be shown to a user who is in the process of adding the plugin to their tenant to connect with an instance of the back end system.
 - `custom_types.json` (Optional) - a file containing information about non-standard object types that will be imported by the plugin into the Data Mesh.
@@ -46,40 +47,70 @@ A plugin is a directory in this repo of the form `plugins/`_plugin-name_`/v1` co
 
 1. **Clone the Repository:**
     First, clone the repository to your local machine:
+
     ```bash
     git clone https://github.com/squaredup/squaredup-plugin-public.git
     cd squaredup-plugin-public
     ```
+
 2. **Create a New Branch:**
     You will need to create a new branch for your changes:
+
     ```bash
     git checkout -b add-new-plugin # Replace Branch Name
     ```
+
 3. **Creating the Plugin Folder:**
     The suggested way to write a new plugin is to make a copy of the `examplePlugins/hybrid/v1` directory in your `plugins/`_plugin-name_`/v1` directory.
+
    ```bash
    # Replace 'ExamplePlugin' with your plugin name
    mkdir -p 'plugins/ExamplePlugin/v1'
    cp -r 'examplePlugins/hybrid/v1/*' 'plugins/ExamplePlugin/v1/'
    ```
+
 4. **Tailoring the Example Plugin:**
     You will need to tailor the configuration and code to interact with the specific back end as Required.
     This process is described in more detail in [Writing a New Plugin](docs/writingANewPlugin.md).
-5. **Testing the Plugin:** There are two main ways to test your plugin.
-      1. Using the SquaredUp Test/Validation Script (`validate.js` at the root of this repo):
+5. **Using `pnpm` to Install Dependencies:**
+    `pnpm` is used for dependency management instead of `npm`. Check [pnpm](https://pnpm.io/pnpm-cli) to learn more about `pnpm`
+    Ensure `pnpm` is installed by running `pnpm -version`. If its not installed it can be installed by running the following command:
+
+    ```bash
+    npm install --location=global pnpm@9
+    ```
+
+    | **Description**                 | **Command**                 | **Notes**                              |
+    | ------------------------------- | --------------------------- | -------------------------------------- |
+    | Install all packages                               | `pnpm i`     | e.g. after merging main                |
+    | Install all packages without changing the lockfile | `pnpm fast`  | use `pnpm -w fast` if not in root      |
+    | Install packages for certain package only | `pnpm -F "examplehybrid-v1" i` | `examplehybrid-v1` is from `package.json`'s name field |
+    | Install packages for certain package without changing the lockfile | `pnpm -F "examplehybrid-v1" i --frozen-lockfile` | `examplehybrid-v1` is from `package.json`'s name field |
+    | Add a package to Azure v1 | `pnpm add myPackage -F "azure-v1"` | `azure-v1` is from `package.json`'s name field |
+
+6. **Testing the Plugin:** There are two main ways to test your plugin.
+      1. Using the SquaredUp Test/Validation Script (`validate.js` in `scripts\plugins-validator`):
+
           ```bash
-          npm ci
-          npm run validate
+          pnpm run -w validate
           ```
+
       2. Using the SquaredUp Unit Test Framework which can be executed by running:
+
           ```bash
-          npm ci
+          # If running from the plugins directory
+          pnpm run unitTest
+          # If running from the root of the repo
           # Replace 'ExamplePlugin' with your plugin name
-          npm test -- --pluginName="ExamplePlugin" --pluginPath="plugins/ExamplePlugin/v1"
+          pnpm run test -- --pluginName="ExamplePlugin" --pluginPath="plugins/ExamplePlugin/v1"
+          # OR
+          # Replace example-plugin-v1 with name from package.json of the plugin you are interested in
+          pnpm run -F "example-plugin-v1" unitTest
           ```
+
       You should aim to do as much testing as possible with the `validate.js` script as the turn-around time is much quicker.
       This process is described in more detail in [Testing a Plugin](docs/testingAPlugin.md).
-6. **Installation**
+7. **Installation**
     The plugin is only installed when a Pull Request has been submitted. During PR creation you will be
     asked for your Tenant (Organization) Name which can be retrieved from the [settings page](https://app.squaredup.com/settings/organization).
     This will be used for restricting the plugin to the specified tenant only.