@itentialopensource/adapter-azure_devops 0.1.1 → 0.1.2

package/adapter_modifications/archive/UPD-2022-04-29T13:05:13.710Z/README.md

@@ -0,0 +1,59 @@
+# Update
+
+This update script will update an adapter by appending or updating API calls selected for modification. 
+
+Calls can be selected for change within an adapter by providing a specification document to the Update Tool in the adapter-engine and choosing which calls to modify via the CLI or adapter-wizard (to be implemented in later versions).
+
+Ability to properly delete API calls via this update script will be implemented in the future.
+
+## Usage
+
+Navigate to the directory of the adapter you want to update. If necessary, move an adapter-modifications folder generated by the Update Tool into the adapter directory.
+
+```
+cd adapter_modifications
+
+node update.js {sub-directory name}
+```
+
+The second argument in the above command should be identical to the name of a immediate sub-directory within adapter-modifications. The provided directory should contain the components required to update a certain adapter.
+
+The name of this folder is initialized based on the specification document you provide as input to the Update Tool. If you rename that folder, you will need to reflect that change in the given command argument.
+
+Running this command will update the adapter and run unit and integration tests.  If updated correctly, the adapter should pass all tests.
+
+In order to pass all tests, note that adapter names should be formatted as: 'adapter-name'. Names such as 'adapter-name-test' or similar will cause the tests to error at this point in time. 
+
+## Directory Structure
+
+A sub-directory within adapter-modifications should have the following file structure:
+
+```
+{name of sub-directory}
+  -- components
+    -- adapter.js
+    -- entities
+      -- {entity name}
+        -- schema.json
+        -- action.json
+        -- mockdatafiles
+          -- mockdata.json
+    -- pronghorn.json
+    -- test
+      -- unit
+        -- adapterTestUnit.js
+      -- integration
+        -- adapterTestIntegration.js
+```
+
+Each of these files contains the changes to their adapter equivalents that are enacted when an adapter is updated.
+
+Note that depending on how many calls are being updated, the number of sub-directories within entities/ will vary. Each entity sub-directory will have its own action.json, schema.json, and mockdatafiles/ directory.
+
+## Linting
+
+If this is an adapter built prior to update capabilities being added (9/2020) you may need to add a line to the .eslintignore (adapter_modifications/*) to ignore any lint errors in the update files. These files have lint errors because they are parital js files.
+
+## Testing
+
+Refer to the adapter's README file to perform unit and integration tests post-update. Integration tests can be performed in standalone or integrated mode.

package/adapter_modifications/archive/UPD-2022-04-29T13:05:13.710Z/specificCallScript.js

@@ -0,0 +1,97 @@
+/* @copyright Itential, LLC 2019 */
+
+/* eslint prefer-destructuring:warn */
+/* eslint prefer-template:warn */
+
+// const updateScript = require('update.js');
+const fs = require('fs-extra');
+const path = require('path');
+
+const folder = process.argv[2];
+
+/**
+ *
+ * This is the file to run in order to add specific calls to your existing adapter.
+ * Make sure the zip is in the adapter's top level directory, then navigate there in the terminal and run 'node specficCallScript {folderName}'.
+ *
+ */
+
+/**
+  *@summary the main function to be run in this file.
+  *@function main
+*/
+
+function main() {
+  const entityPath = path.join(__dirname, '../entities');
+  const entitiesFull = fs.readdirSync(entityPath, 'utf8').filter((entity) => (entity !== '.system' && entity !== '.DS_Store' && entity !== '.generic'));
+  const mockArray = [];
+
+  // loop through existing adapter entities
+  entitiesFull.forEach((e) => {
+    if (fs.existsSync(path.join(__dirname, `../entities/${e}/mockdatafiles`))) {
+      fs.readdirSync(path.join(__dirname, `../entities/${e}/mockdatafiles`)).forEach((file) => {
+        const mockObj = {};
+        mockObj.name = file;
+        mockObj.contents = JSON.parse(fs.readFileSync(path.join(__dirname, `../entities/${e}/mockdatafiles/${file}`), 'utf8'));
+        mockObj.entity = e;
+        mockObj.function = file.slice(0, -13);
+        mockArray.push(mockObj);
+      });
+    }
+    // find and loop through entities of methods being added
+    if (fs.existsSync(path.join(__dirname, `./${folder}/components/entities`))) {
+      const entityAddPath = path.join(__dirname, `./${folder}/components/entities`);
+      const entitiesAdding = fs.readdirSync(entityAddPath, 'utf8').filter((entity) => (entity !== '.system' && entity !== '.DS_Store' && entity !== '.generic'));
+
+      // for each entity in the specific additions, get the appropriate integration test info from generic call for the specific calls
+      let finalAddedIntegrationTest = '';
+      let entityIntegrationTests = '';
+      entitiesAdding.forEach((eSpecific) => {
+        const existingActionFile = JSON.parse(fs.readFileSync(path.join(__dirname, `../entities/${e}/action.json`), 'utf8'));
+        const existingIntegrationFile = fs.readFileSync(path.join(__dirname, '../test/integration/adapterTestIntegration.js'), 'utf8');
+        const testSplit = existingIntegrationFile.split('describe');
+        existingActionFile.actions.forEach((action) => {
+          let replaceTest = '';
+          testSplit.every((test) => {
+            const testSlice = test.slice(0, action.name.length + 3);
+            if (testSlice.includes(action.name)) {
+              replaceTest = test.split('if (stub) {\n');
+              replaceTest = replaceTest[1].split('} else {\n');
+              replaceTest = replaceTest[0];
+              return false;
+            }
+            return true;
+          });
+          if (replaceTest !== '') {
+            const addingIntegrationFile = fs.readFileSync(path.join(__dirname, `${folder}/components/test/integration/adapterTestIntegration.js`), 'utf8');
+            const addingTestSplit = addingIntegrationFile.split('describe');
+            const addingActionFile = JSON.parse(fs.readFileSync(path.join(__dirname, `./${folder}/components/entities/${eSpecific}/action.json`)), 'utf8');
+            addingActionFile.forEach((addingAction) => {
+              let replacedTest = '';
+              addingTestSplit.forEach((addedTest) => {
+                const addingTestSlice = addedTest.slice(0, addingAction.name.length + 3);
+                if (addingTestSlice.includes(addingAction.name) && (action.method === addingAction.method)) {
+                  replacedTest = addedTest.split('if (stub) {\n');
+                  replacedTest = replacedTest[1].split('} else {\n');
+                  replacedTest = replacedTest[0];
+                  let finalTest = addedTest.replace(replacedTest, replaceTest);
+                  finalTest = finalTest.replace('should work if integrated but since no mockdata should error when run standalone', 'should work if integrated or standalone with mockdata');
+                  finalTest = 'describe' + finalTest;
+                  entityIntegrationTests = finalTest;
+                  finalAddedIntegrationTest += entityIntegrationTests;
+                }
+              });
+            });
+          }
+        });
+        // clear out the action.json and schema.json file of the specific call so it does not get added to action.json and schema.json of generic adapter
+        fs.writeFileSync(path.join(__dirname, `./${folder}/components/entities/${eSpecific}/action.json`), '[]');
+        fs.writeFileSync(path.join(__dirname, `./${folder}/components/entities/${eSpecific}/schema.json`), '[]');
+      });
+      finalAddedIntegrationTest = '\n    ' + finalAddedIntegrationTest;
+      fs.writeFileSync(path.join(__dirname, `${folder}/components/test/integration/adapterTestIntegration.js`), finalAddedIntegrationTest);
+    }
+  });
+}
+
+main();