Merge branch 'master' into revert-945-revert-942-task/default_attribute_value_null_instead_blank

Author: AlvaroVega

CHANGES_NEXT_RELEASE

@@ -1,4 +1,5 @@
 Use null instead of ' ' as default attribute value in entity provisioned (#938)
+Add: defaultEntityNameConjunction config (env var IOTA_DEFAULT_ENTITY_NAME_CONJUNCTION) and configuration group API field for default entity_name conjunction (#944)
 Add basic NGSI-LD support as experimental feature (#842)
 - Active measures
 - GeoJSON and DateTime, unitCode and observedAt NGSI-LD support

doc/api.md

@@ -93,6 +93,7 @@ correspondence between the API resource fields and the same fields in the databa
 | `expressionLanguage`  | `expresionLanguage`  | optional boolean value, to set expression language used to compute expressions, possible values are: legacy or jexl. When not set or wrongly set, `legacy` is used as default value.                                                                                      |
 | `explicitAttrs`       | `explicitAttrs`      | optional boolean value, to support selective ignore of measures so that IOTA doesn’t progress. If not specified default is `false`.                                                                                                                                       |
 | `ngsiVersion`         | `ngsiVersion`        | optional string value used in mixed mode to switch between **NGSI-v2** and **NGSI-LD** payloads. Possible values are: `v2` or `ld`. The default is `v2`. When not running in mixed mode, this field is ignored.
+| `defaultEntityNameConjunction` | `defaultEntityNameConjunction` | optional string value to set default conjunction string used to compose a default `entity_name` when is not provided at device provisioning time.                                                                                             |
 
 ### Service Group Endpoint
 

doc/installationguide.md

@@ -278,6 +278,9 @@ used for the same purpose. For instance:
     standard, but the final decision has yet been confirmed), take into account it could change
 -   **explicitAttrs**: if this flag is activated, only provisioned attributes will be processed to Context Broker. This
     flag is overwritten by `explicitAttrs` flag in group or device provision.
+-   **defaultEntityNameConjunction**: the default conjunction string used to compose a default `entity_name` when is not 
+    provided at device provisioning time; in that case `entity_name` is composed by `type` + `:` + `device_id`. 
+    Default value is `:`. This value is overwritten by `defaultEntityNameConjunction` in group provision.
 -   **relaxTemplateValidation**: if this flag is activated, `objectId` attributes for incoming devices are not
     validated, and may exceptionally include characters (such as semi-colons) which are
     [forbidden](https://fiware-orion.readthedocs.io/en/master/user/forbidden_characters/index.html) according to the
@@ -345,6 +348,7 @@ overrides.
 | IOTA_FALLBACK_PATH               | `fallbackPath`                  |
 | IOTA_DEFAULT_EXPRESSION_LANGUAGE | `defaultExpressionLanguage`     |
 | IOTA_EXPLICIT_ATTRS              | `explicitAttrs`                 |
+| IOTA_DEFAULT_ENTITY_NAME_CONJUNCTION | `defaultEntityNameConjunction` |
 | IOTA_RELAX_TEMPLATE_VALIDATION   | `relaxTemplateValidation`       |
 
 Note:

lib/commonConfig.js

@@ -155,6 +155,7 @@ function processEnvironmentVariables() {
         'IOTA_MULTI_CORE',
         'IOTA_DEFAULT_EXPRESSION_LANGUAGE',
         'IOTA_RELAX_TEMPLATE_VALIDATION',
+        'IOTA_DEFAULT_ENTITY_NAME_CONJUNCTION',
         'IOTA_JSON_LD_CONTEXT',
         'IOTA_FALLBACK_TENANT',
         'IOTA_FALLBACK_PATH'
@@ -462,6 +463,11 @@ function processEnvironmentVariables() {
     } else {
         config.relaxTemplateValidation = config.relaxTemplateValidation === true;
     }
+    if (process.env.IOTA_DEFAULT_ENTITY_NAME_CONJUNCTION) {
+        config.defaultEntityNameConjunction = process.env.IOTA_DEFAULT_ENTITY_NAME_CONJUNCTION;
+    } else {
+        config.defaultEntityNameConjunction = config.defaultEntityNameConjunction ? config.defaultEntityNameConjunction : ':';
+    }
 }
 
 function setConfig(newConfig) {
@@ -515,6 +521,24 @@ function ngsiVersion() {
     return 'unknown';
 }
 
+/**
+ * It checks if the configuration file states the use of NGSIv2
+ * Returns the supported NGSI format
+ *
+ * FIXME: this function was removed in https://github.com/telefonicaid/iotagent-node-lib/pull/947. However
+ * it is used by IOTAs code (e.g. https://github.com/telefonicaid/iotagent-ul/blob/c59bcb21f7408a6c7cc3b50d1d0c4e38fc7478c3/lib/iotaUtils.js#L327)
+ * We re-introduce this function to fix CI e2e test but a definitive fix should probably done (in the IOTAs code maybe)
+ *
+ * @return     {boolean}  Result of the checking
+ */
+/* eslint-disable-next-line no-unused-vars */
+function checkNgsi2() {
+    if (ngsiVersion() === 'v2') {
+        return true;
+    }
+    return false;
+}
+
 /**
  * It checks if the configuration file states a non-legacy format,
  * either v2, LD or mixed.
@@ -555,6 +579,8 @@ exports.getGroupRegistry = getGroupRegistry;
 exports.setCommandRegistry = setCommandRegistry;
 exports.getCommandRegistry = getCommandRegistry;
 exports.ngsiVersion = ngsiVersion;
+// FIXME: We re-introduce this function to fix CI e2e test but a definitive fix should probably done (in the IOTAs code maybe)
+exports.checkNgsi2 = checkNgsi2;
 exports.checkNgsiLD = checkNgsiLD;
 exports.isCurrentNgsi = isCurrentNgsi;
 exports.setSecurityService = setSecurityService;

lib/model/Group.js

@@ -44,6 +44,7 @@ const Group = new Schema({
     autoprovision: Boolean,
     expressionLanguage: String,
     explicitAttrs: Boolean,
+    defaultEntityNameConjunction: String,
     ngsiVersion: String
 });
 

lib/services/common/iotManagerService.js

@@ -57,6 +57,7 @@ function register(callback) {
             autoprovision: service.autoprovision,
             explicitAttrs: service.explicitAttrs,
             expressionLanguage: service.expressionLanguage,
+            defaultEntityNameConjunction: service.defaultEntityNameConjunction,
             ngsiVersion: service.ngsiVersion
         };
     }

lib/services/devices/deviceService.js

@@ -262,11 +262,17 @@ function registerDevice(deviceObj, callback) {
         }
 
         if (!deviceData.name) {
-            deviceData.name = deviceData.type + ':' + deviceData.id;
-            if (config.checkNgsiLD(configuration)) {
-                deviceData.name = 'urn:ngsi-ld:' + deviceData.type + ':' + deviceData.id;
+            var conjunction;
+            if (configuration && configuration.defaultEntityNameConjunction !== undefined) {
+                 conjunction = configuration.defaultEntityNameConjunction;
+            } else {
+                conjunction = config.getConfig().defaultEntityNameConjunction;
             }
-            logger.debug(context, 'Device name not found, falling back to deviceType:deviceId [%s]', deviceData.name);
+            deviceData.name = deviceData.type + conjunction + deviceData.id;
+            if (config.checkNgsiLD(configuration)) {
+                deviceData.name = 'urn:ngsi-ld:' + deviceData.type + conjunction + deviceData.id;
+            }            
+            logger.debug(context, 'Device name not found, falling back to deviceType%sdeviceId [%s]', conjunction, deviceData.name);
         }
 
         if (!configuration && config.getConfig().types[deviceData.type]) {

lib/services/groups/groupRegistryMongoDB.js

@@ -78,6 +78,7 @@ function createGroup(group, callback) {
         'autoprovision',
         'explicitAttrs',
         'expressionLanguage',
+        'defaultEntityNameConjunction',
         'ngsiVersion'
     ];
 
@@ -272,6 +273,7 @@ function update(id, body, callback) {
                 'internalAttributes',
                 'explicitAttrs',
                 'expressionLanguage',
+                'defaultEntityNameConjunction',
                 'ngsiVersion'
             ];
 

package.json

@@ -36,7 +36,7 @@
     "lint:text": "textlint '*.md' 'doc/*.md'",
     "prettier": "prettier --config .prettierrc.json --write '**/**/**/**/*.js' '**/**/**/*.js' '**/**/*.js' '**/*.js' '*.js'",
     "prettier:text": "prettier 'README.md' 'doc/*.md' 'doc/**/*.md' --no-config --tab-width 4 --print-width 120 --write --prose-wrap always",
-    "test": "nyc --reporter=text mocha --recursive 'test/**/*.js' --reporter spec --timeout 5000 --ui bdd --exit",
+    "test": "nyc --reporter=text mocha --recursive 'test/**/*.js' --reporter spec --timeout 5000 --ui bdd --exit --color true",
     "test:coverage": "nyc --reporter=lcov mocha -- --recursive 'test/**/*.js' --reporter spec --timeout 5000 --exit",
     "test:coveralls": "npm run test:coverage && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage",
     "test:watch": "npm run test -- -w ./lib",
@@ -79,7 +79,6 @@
     "textlint": "~11.7.6",
     "textlint-filter-rule-comments": "~1.2.2",
     "textlint-rule-common-misspellings": "~1.0.1",
-    "textlint-rule-no-dead-link": "~4.7.0",
     "textlint-rule-terminology": "~2.1.4",
     "textlint-rule-write-good": "~1.6.2",
     "timekeeper": "2.2.0",