Create Index method now checks if a given Index-Template exists

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/).
 
+## [2.1.0] 2021-09-16
+### Added
+- Create Index method now checks if a given Index-Template exists
+
 ## [2.0.0] 2021-09-14
 ### Changed
 - Search method now provides missingIndex & noResult exists making it easier to control your flow

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

@@ -1,6 +1,6 @@
 {
 	"name": "@axway-api-builder-ext/api-builder-plugin-fn-elasticsearch",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"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",

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

@@ -79,27 +79,35 @@ async function indicesRollover(params, options) {
 
 async function indicesCreate(params, options) {
 	const elasticSearchConfig = options.pluginConfig.elastic;
+	const { index, alias, indexTemplate } = params;
 
 	if (typeof elasticSearchConfig.node === 'undefined' && typeof elasticSearchConfig.nodes === 'undefined') {
 		options.logger.error('Elasticsearch configuration is invalid: nodes or node is missing.');
 		throw new Error('Elasticsearch configuration is invalid: nodes or node is missing.');
 	}
-	if (!params.index) {
+	if (!index) {
 		throw new Error('Missing required parameter: index');
 	}
 	try {
-		var aliasName;
-		if(params.alias) {
-			aliasName = params.alias;
-			delete params.alias;
+		if(alias) {
 			if(params.body) { // a body might be given
 				if(params.body.aliases == undefined) {
 					params.body.aliases = {};
 				}
 			} else {
 				params.body = { aliases: { }};
 			}
-			params.body.aliases[aliasName] = {};
+			params.body.aliases[alias] = {};
+			delete params.alias;
+		}
+		// Check if the index template exists
+		if(indexTemplate) {
+			var client = new ElasticsearchClient(elasticSearchConfig).client;
+			var result = await client.indices.existsTemplate( { name: indexTemplate }, { maxRetries: 3 });
+			if(result.statusCode == 404) {
+				throw new Error(`The index template: '${indexTemplate}' is missing. Index wont be created.`);
+			}
+			delete params.indexTemplate;
 		}
 		var client = new ElasticsearchClient(elasticSearchConfig).client;
 		var result = await client.indices.create( params, { ignore: [404], maxRetries: 3 });

api-builder-plugin-fn-elasticsearch/src/flow-nodes.yml

@@ -987,6 +987,13 @@ flow-nodes:
             initialType: string
             schema:
               type: string
+          indexTemplate:
+            name: Index template name
+            description: If given, the index will only be created if the index-template already exists.
+            required: false
+            initialType: string
+            schema:
+              type: string
           body:
             name: Index configuration
             description: The configuration for the index (settings and mappings)

api-builder-plugin-fn-elasticsearch/test/indices/indices-Test.js

@@ -135,6 +135,30 @@ describe('Indices rollover tests', () => {
 			expect(mockedIndicesCreate.lastCall.arg.body.aliases["existingAlias"]).to.be.a('object');
 			expect(mockedIndicesCreate.lastCall.arg.body.settings["number_of_shards"]).to.equal(1);
 		});
+
+		it.only('should fail if the given index-template does not exist', async () => {
+			const mockedIndexTemplateExists = setupElasticsearchMock(client, 'indices.existsTemplate', './test/mock/indexTemplates/indexTemplateNotExistsResponse.json', false);
+
+			const inputParameter = { index: "my_index_to_be_created", indexTemplate: "this_template_is_missing" };
+			const { value, output } = await flowNode.indicesCreate(inputParameter);
+
+			expect(value).to.be.instanceOf(Error)
+				.and.to.have.property('message', "The index template: 'this_template_is_missing' is missing. Index wont be created.");
+			expect(output).to.equal('error');
+			expect(mockedIndexTemplateExists.callCount).to.equals(1);
+		});
+
+		it.only('should pass when the index is created including a given index_template name', async () => {
+			const mockedIndexTemplateExists = setupElasticsearchMock(client, 'indices.existsTemplate', './test/mock/indexTemplates/indexTemplateExistsResponse.json', false);
+			const mockedIndicesCreate = setupElasticsearchMock(client, 'indices.create', './test/mock/indices/indexCreatedResponse.json', false);
+
+			const inputParameter = { index: "my_index_to_be_created", indexTemplate: "management-kpis"  }; 
+			const { value, output } = await flowNode.indicesCreate(inputParameter);
+
+			expect(output).to.equal('next');
+			expect(mockedIndexTemplateExists.callCount).to.equals(1);
+			expect(mockedIndicesCreate.callCount).to.equals(1);
+		});
 	});
 
 	describe('#Index exists tests', () => {

api-builder-plugin-fn-elasticsearch/test/mock/indexTemplates/indexTemplateExistsResponse.json

@@ -0,0 +1,49 @@
+{
+    "body": true,
+    "statusCode": 200,
+    "headers": {
+      "x-elastic-product": "Elasticsearch",
+      "content-type": "application/json; charset=UTF-8",
+      "content-length": "892"
+    },
+    "meta": {
+      "context": null,
+      "request": {
+        "params": {
+          "method": "HEAD",
+          "path": "/_template/management-kpis",
+          "body": null,
+          "querystring": "",
+          "headers": {
+            "user-agent": "elasticsearch-js/7.14.1 (win32 10.0.19043-x64; Node.js v12.13.1)",
+            "x-elastic-client-meta": "es=7.14.1,js=12.13.1,t=7.14.1,hc=12.13.1"
+          },
+          "timeout": 30000
+        },
+        "options": {
+          "maxRetries": 3
+        },
+        "id": 1
+      },
+      "name": "elasticsearch-js",
+      "connection": {
+        "url": "https://api-env:9200/",
+        "id": "https://api-env:9200/",
+        "headers": {
+          
+        },
+        "deadCount": 0,
+        "resurrectTimeout": 0,
+        "_openRequests": 0,
+        "status": "alive",
+        "roles": {
+          "master": true,
+          "data": true,
+          "ingest": true,
+          "ml": false
+        }
+      },
+      "attempts": 0,
+      "aborted": false
+    }
+  }

api-builder-plugin-fn-elasticsearch/test/mock/indexTemplates/indexTemplateNotExistsResponse.json

@@ -0,0 +1,49 @@
+{
+  "body": false,
+  "statusCode": 404,
+  "headers": {
+    "x-elastic-product": "Elasticsearch",
+    "content-type": "application/json; charset=UTF-8",
+    "content-length": "2"
+  },
+  "meta": {
+    "context": null,
+    "request": {
+      "params": {
+        "method": "HEAD",
+        "path": "/_template/this_template_is_missing",
+        "body": null,
+        "querystring": "",
+        "headers": {
+          "user-agent": "elasticsearch-js/7.14.1 (win32 10.0.19043-x64; Node.js v12.13.1)",
+          "x-elastic-client-meta": "es=7.14.1,js=12.13.1,t=7.14.1,hc=12.13.1"
+        },
+        "timeout": 30000
+      },
+      "options": {
+        "maxRetries": 3
+      },
+      "id": 1
+    },
+    "name": "elasticsearch-js",
+    "connection": {
+      "url": "https://api-env:9200/",
+      "id": "https://api-env:9200/",
+      "headers": {
+        
+      },
+      "deadCount": 0,
+      "resurrectTimeout": 0,
+      "_openRequests": 0,
+      "status": "alive",
+      "roles": {
+        "master": true,
+        "data": true,
+        "ingest": true,
+        "ml": false
+      }
+    },
+    "attempts": 0,
+    "aborted": false
+  }
+}