Add import helper function to optimize data uploading time (#43)

* Add import doc if needed function to optimize data uploading time Signed-off-by: Qingyang(Abby) Hu <[email protected]> * bump version Signed-off-by: Qingyang(Abby) Hu <[email protected]> * fix comments Signed-off-by: Qingyang(Abby) Hu <[email protected]> * check string type Signed-off-by: Qingyang(Abby) Hu <[email protected]> --------- Signed-off-by: Qingyang(Abby) Hu <[email protected]>
opensearch-project · Oct 4, 2023 · 200bc9d · 200bc9d
1 parent 96bb1d8
commit 200bc9d
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/common-utils/network/test-fixture-handler.js b/common-utils/network/test-fixture-handler.js
@@ -88,4 +88,24 @@ export class TestFixtureHandler {
       })
     })
   }
+
+  /**
+   * Read docs from a file and import them to OpenSearch only when the indices do not already exist
+   * in order to optimize the data uploading time
+   * @param {string, array} index An index or a set of indices 
+   * @param {string} indexMappingPath File path for mapping data
+   * @param {string} indexDataPath File path for the actual data
+   */
+  importJSONDocIfNeeded(index, indexMappingPath, indexDataPath) {
+    const items = (Array.isArray(index) ? index : [index]);
+    if (items.some(value => typeof value !== 'string')) throw 'Invalid indices';
+    const queryString = items.join(',');
+
+    cy.getIndices(queryString).then((response) => {
+      if(response.status === 404){
+        this.importJSONMapping(indexMappingPath);
+        this.importJSONDoc(indexDataPath);
+      }
+    });
+  }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@opensearch-dashboards-test/opensearch-dashboards-test-library",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Provides utility functions, page object models, test fixture handling for developers to write functional tests for OpenSearch Dashboards and plugins",
   "main": "index.js",
   "type": "module",