Merge pull request #3 from elasticio/added-integr-tests

added integration tests

Author: A3a3e1

README.md

@@ -1,20 +1,64 @@
 # configuration-component
 
 ## Description
-elastic.io configuration component which allows to separate the modification of configurable values from the modification of the flow.
+elastic.io configuration component which allows separating the modification of configurable values from the modification of the flow.
 
 ### How works.  API version / SDK version
 Configuration component has a credential which is a text field with some valid JSON.  (JSON must be valid in order for credentials to be verified).
 It emits a message with an object equivalent to the JSON in the config. So any data which is used in the flow and is repeated in multiple places can be configured (or later changed) in the single step. After that new values are used where it is needed.
 
 ## Credentials
 Configuration data should be specified as credentials of a JSON format.
-JSON must be valid in order for credentials to be verified. Credentials verification will fail otherwise.
+JSON must be valid in order for credentials to be verified (except arrays, see *Known limitations* below). Credentials verification will fail otherwise.
 Input data example:
 ![Data sample](https://user-images.githubusercontent.com/8449044/48360400-d3138980-e6a7-11e8-8b79-87932eec66c1.png)
 ## Actions
 ### Emit data
 The only action. Emits configuration data (must be a valid JSON object) as a message.
 #### Output json schema location
 Very simple schema. Output JSON could be of **any** complexity.
+
 [lib/schemas/emitConfig.out.json](lib/schemas/emitConfig.out.json)
+
+## Known limitations
+Despite naked arrays are valid JSON, there are some platform limitations, which do not allow to access the data in such arrays, that has been emitted from a component, from the next step. This is why naked arrays should not be passed to the component directly.
+So instead of 
+ ```json
+[
+  {
+    "Product Name": "Bowler Hat",
+    "ProductID": 858383,
+    "SKU": "0406654608",
+    "Description": {
+      "Colour": "Purple",
+      "Width": 300,
+      "Height": 200,
+      "Depth": 210,
+      "Weight": 0.75
+    },
+    "Price": 34.45,
+    "Quantity": 2
+  }
+]
+```
+use something like:
+```json
+{
+  "Product": [
+    {
+      "Product Name": "Bowler Hat",
+      "ProductID": 858383,
+      "SKU": "0406654608",
+      "Description": {
+        "Colour": "Purple",
+        "Width": 300,
+        "Height": 200,
+        "Depth": 210,
+        "Weight": 0.75
+      },
+      "Price": 34.45,
+      "Quantity": 2
+    }
+  ]
+}
+```

component.json

@@ -14,6 +14,7 @@
     "emitConfig": {
       "main": "./lib/actions/emitConfig.js",
       "title": "Emit data",
+      "description": "Emits configuration data (must be a valid JSON object) as a message",
       "metadata": {
         "out": "./lib/schemas/emitConfig.out.json"
       }

lib/actions/emitConfig.js

@@ -1,4 +1,3 @@
-"use strict";
 const {messages} = require('elasticio-node');
 
 exports.process = processAction;
@@ -10,9 +9,7 @@ function processAction(msg, cfg) {
 
   // Access the configuration data from the field defined in credentials section of component.json
   const configData = cfg.configData;
-
   const jsonConfigData = JSON.parse(configData);
-  console.log(`cfg data: ${JSON.stringify(jsonConfigData)}`);
 
   if (!configData) {
     throw new Error('Config data is required.');