Making MockElasticsearchMethod available

to external clients to run tests.

Author: Chris Wiechmann

api-builder-plugin-fn-elasticsearch/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.14] 2020-12-09
+### Added
+- New method: mockElasticsearchMethod to mock requests to Elasticsearch
+
 ## [1.0.13] 2020-12-09
 ### Changed
 - Test & Logging of Elasticsearch connection improved

api-builder-plugin-fn-elasticsearch/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axway-api-builder-ext/api-builder-plugin-fn-elasticsearch",
-	"version": "1.0.13",
+	"version": "1.0.14",
 	"description": "Integrate Elasticsearch into your API-Builder flow to combine search data for instance with other data available in your flow.",
 	"author": "Chris Wiechmann <cwiechmann@axway.com> (http://www.axway.com)",
 	"license": "Apache-2.0",
@@ -32,16 +32,16 @@
 	"dependencies": {
 		"@axway/api-builder-sdk": "^1.0.8",
 		"@elastic/elasticsearch": "^7.10.0",
-		"deep-equal": "^2.0.4"
+		"deep-equal": "^2.0.4",
+		"simple-mock": "^0.8.0"
 	},
 	"peerDependencies": {
 		"@axway/api-builder-runtime": "^4.41.1"
 	},
 	"devDependencies": {
 		"@axway/api-builder-test-utils": "^1.1.4",
 		"chai": "^4.2.0",
-		"mocha": "^7.2.0",
-		"simple-mock": "^0.8.0"
+		"mocha": "^7.2.0"
 	},
 	"scripts": {
 		"test": "mocha ./test --recursive -R spec",

api-builder-plugin-fn-elasticsearch/src/actions/ElasticsearchClient.js

@@ -1,4 +1,6 @@
 const { Client } = require('@elastic/elasticsearch');
+const simple = require('simple-mock');
+const fs = require('fs');
 
 class ElasticsearchClient {
 
@@ -17,4 +19,33 @@ class ElasticsearchClient {
 	}
 }
 
-module.exports = { ElasticsearchClient }
+function mockElasticsearchMethod(client, methodName, responeFilename, shouldError) {
+    var mockedFn = simple.spy(function (params, options, callback) {
+        const resonse = JSON.parse(fs.readFileSync(responeFilename), null);
+        if(callback != undefined) {
+            if(shouldError) {
+                // Return the given response as an error
+                callback(resonse, null);
+            } else {
+                // Otherwise return the response as expected
+                callback(null, resonse);
+            }
+        } else {
+            return new Promise((resolve, reject) => {
+                if(shouldError) {
+                    reject(resonse);
+                } else {
+                    resolve(resonse);
+                }
+            });
+        }
+    });
+    // Use the extend functionality of the ES-Client to register the mocked method
+    client.extend(methodName, { force: true }, ({ makeRequest }) => {
+        return mockedFn;
+    });
+    // Return the mocked function to perform assertions
+    return mockedFn;
+}
+
+module.exports = { ElasticsearchClient, mockElasticsearchMethod }