Merge pull request #107 from bonitoo-io/feat/default-tags

vlastahajek · web-flow · commit 4fda495ae160 · 2020-10-26T12:44:29.000+01:00
feat: default tags
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Changelog
 ## 3.5.0 [in progress]
 ### Features
+ - [#107](https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino/pull/107) - Added possibility to set default tags. Use `WriteOptions::addDefaultTag()` to add a tag that will be added to each written point using the `writePoint()` function.
 
 ### Documentation
 
diff --git a/src/InfluxDbClient.cpp b/src/InfluxDbClient.cpp
@@ -291,6 +291,7 @@ void InfluxDBClient::setWriteOptions(const WriteOptions & writeOptions) {
     _writeOptions._retryInterval = writeOptions._retryInterval;
     _writeOptions._maxRetryInterval = writeOptions._maxRetryInterval;
     _writeOptions._maxRetryAttempts = writeOptions._maxRetryAttempts;
+    _writeOptions._defaultTags = writeOptions._defaultTags;
 }
 
 void InfluxDBClient::setHTTPOptions(const HTTPOptions & httpOptions) {
@@ -339,7 +340,7 @@ bool InfluxDBClient::writePoint(Point & point) {
         if(_writeOptions._writePrecision != WritePrecision::NoTime && !point.hasTime()) {
             point.setTime(_writeOptions._writePrecision);
         }
-        String line = point.toLineProtocol();
+        String line = point.toLineProtocol(_writeOptions._defaultTags);
         return writeRecord(line);
     }
     return false;
diff --git a/src/Options.cpp b/src/Options.cpp
@@ -0,0 +1,39 @@
+/**
+ * 
+ * Options.cpp: InfluxDB Client write options and HTTP options
+ * 
+ * MIT License
+ * 
+ * Copyright (c) 2020 InfluxData
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+*/
+#include <Arduino.h>
+#include "Options.h"
+#include "util/helpers.h"
+
+WriteOptions& WriteOptions::addDefaultTag(String name, String value) { 
+    if(_defaultTags.length() > 0) {
+        _defaultTags += ',';
+    }
+    _defaultTags += escapeKey(name);
+    _defaultTags += '=';
+    _defaultTags += escapeKey(value);
+    return *this; 
+}
diff --git a/src/Options.h b/src/Options.h
@@ -59,6 +59,9 @@ class WriteOptions {
     uint16_t _maxRetryInterval;
     // Maximum count of retry attempts of failed writes, default 3
     uint16_t _maxRetryAttempts;
+    // Default tags. Default tags are added to every written point. 
+    // There cannot be duplicate tags in default tags and tags included in a point.
+    String _defaultTags;
 public:
     WriteOptions():
         _writePrecision(WritePrecision::NoTime),
@@ -76,6 +79,8 @@ class WriteOptions {
     WriteOptions& retryInterval(uint16_t retryIntervalSec) { _retryInterval = retryIntervalSec; return *this; }
     WriteOptions& maxRetryInterval(uint16_t maxRetryIntervalSec) { _maxRetryInterval = maxRetryIntervalSec; return *this; }
     WriteOptions& maxRetryAttempts(uint16_t maxRetryAttempts) { _maxRetryAttempts = maxRetryAttempts; return *this; }
+    WriteOptions& addDefaultTag(String name, String value);
+    WriteOptions& clearDefaultTags() { _defaultTags = (char *)nullptr; return *this; }
 };
 
 /**
diff --git a/src/Point.cpp b/src/Point.cpp
@@ -59,13 +59,17 @@ void Point::putField(String name, String value) {
     _fields += value;
 }
 
-String Point::toLineProtocol() const {
+String Point::toLineProtocol(String includeTags) const {
     String line =  _measurement;
-    line.reserve(1 + _tags.length() + 1 + _fields.length() + 1 + _timestamp.length());
+    line.reserve(1 + _tags.length() + 1 + includeTags.length() + 1 + _fields.length() + 1 + _timestamp.length());
     if(hasTags()) {
         line += ",";
         line += _tags;
     }
+    if(includeTags.length()>0) {
+        line += ",";
+        line += includeTags;
+    }
     if(hasFields()) {
         line += " ";
         line += _fields;
diff --git a/src/Point.h b/src/Point.h
@@ -67,8 +67,8 @@ class Point {
     bool hasTags() const   { return _tags.length() > 0; }
     // True if a point contains timestamp
     bool hasTime() const   { return _timestamp.length() > 0; }
-    // Creates line protocol
-    String toLineProtocol() const;
+    // Creates line protocol with optionaly added tags
+    String toLineProtocol(String includeTags = "") const;
     // returns current timestamp
     String getTime() const { return _timestamp; } 
   protected:
diff --git a/test/test.ino b/test/test.ino
@@ -75,6 +75,7 @@ private:
     static void testServerTempDownBatchsize5();
     static void testRetriesOnServerOverload();
     static void testRetryInterval();
+    static void testDefaultTags();
 };
 
 void loop() {
@@ -88,8 +89,8 @@ void loop() {
 void Test::run() {
     // Basic tests
     testOptions();
-    testEcaping();
     testPoint();
+    testEcaping();
     testFluxTypes();
     testFluxParserEmpty();
     testFluxParserSingleTable();
@@ -106,6 +107,7 @@ void Test::run() {
     testV1();
     testUserAgent();
     testHTTPReadTimeout();
+    testDefaultTags();
     // Advanced tests
     testFailedWrites();
     testTimestamp();
@@ -127,15 +129,17 @@ void Test::testOptions() {
         TEST_ASSERT(defWO._retryInterval == 5);
         TEST_ASSERT(defWO._maxRetryInterval == 300);
         TEST_ASSERT(defWO._maxRetryAttempts == 3);
+        TEST_ASSERT(defWO._defaultTags.length() == 0);
 
-        defWO = WriteOptions().writePrecision(WritePrecision::NS).batchSize(10).bufferSize(20).flushInterval(120).retryInterval(1).maxRetryInterval(20).maxRetryAttempts(5);
+        defWO = WriteOptions().writePrecision(WritePrecision::NS).batchSize(10).bufferSize(20).flushInterval(120).retryInterval(1).maxRetryInterval(20).maxRetryAttempts(5).addDefaultTag("tag1","val1").addDefaultTag("tag2","val2");
         TEST_ASSERT(defWO._writePrecision == WritePrecision::NS);
         TEST_ASSERT(defWO._batchSize == 10);
         TEST_ASSERT(defWO._bufferSize == 20);
         TEST_ASSERT(defWO._flushInterval == 120);
         TEST_ASSERT(defWO._retryInterval == 1);
         TEST_ASSERT(defWO._maxRetryInterval == 20);
         TEST_ASSERT(defWO._maxRetryAttempts == 5);
+        TEST_ASSERT(defWO._defaultTags == "tag1=val1,tag2=val2");
 
         HTTPOptions defHO;
         TEST_ASSERT(!defHO._connectionReuse);
@@ -200,9 +204,16 @@ void Test::testEcaping() {
     p.addField("fie ld", "val ue");
     p.addField("fie,ld", "val,ue");
     p.addField("fie\"ld", "val\"ue");
+
     
     String line = p.toLineProtocol();
-    TEST_ASSERTM(line == "t\\\re=s\\\nt\\\t_t\\ e\"s\\,t,ta\\=g=val\\=ue,ta\\\tg=val\\\tue,ta\\\rg=val\\\rue,ta\\\ng=val\\\nue,ta\\ g=valu\\ e,ta\\,g=valu\\,e,tag=value,ta\"g=val\"ue fie\\=ld=\"val=ue\",fie\\\tld=\"val\tue\",fie\\\rld=\"val\rue\",fie\\\nld=\"val\nue\",fie\\ ld=\"val ue\",fie\\,ld=\"val,ue\",fie\"ld=\"val\\\"ue\"", line);//
+    TEST_ASSERTM(line == "t\\\re=s\\\nt\\\t_t\\ e\"s\\,t,ta\\=g=val\\=ue,ta\\\tg=val\\\tue,ta\\\rg=val\\\rue,ta\\\ng=val\\\nue,ta\\ g=valu\\ e,ta\\,g=valu\\,e,tag=value,ta\"g=val\"ue fie\\=ld=\"val=ue\",fie\\\tld=\"val\tue\",fie\\\rld=\"val\rue\",fie\\\nld=\"val\nue\",fie\\ ld=\"val ue\",fie\\,ld=\"val,ue\",fie\"ld=\"val\\\"ue\"", line);
+
+    WriteOptions w;
+    w.addDefaultTag("dta=g","dval=ue");
+    w.addDefaultTag("dtag","dvalue");
+    line = p.toLineProtocol(w._defaultTags);
+    TEST_ASSERTM(line == "t\\\re=s\\\nt\\\t_t\\ e\"s\\,t,ta\\=g=val\\=ue,ta\\\tg=val\\\tue,ta\\\rg=val\\\rue,ta\\\ng=val\\\nue,ta\\ g=valu\\ e,ta\\,g=valu\\,e,tag=value,ta\"g=val\"ue,dta\\=g=dval\\=ue,dtag=dvalue fie\\=ld=\"val=ue\",fie\\\tld=\"val\tue\",fie\\\rld=\"val\rue\",fie\\\nld=\"val\nue\",fie\\ ld=\"val ue\",fie\\,ld=\"val,ue\",fie\"ld=\"val\\\"ue\"", line);
     TEST_END();
 }
 
@@ -233,6 +244,17 @@ void Test::testPoint() {
     String testLine = "test,tag1=tagvalue fieldInt=-23i,fieldBool=true,fieldFloat1=1.12,fieldFloat2=1.12345,fieldDouble1=1.12,fieldDouble2=1.12345,fieldChar=\"A\",fieldUChar=1i,fieldUInt=23i,fieldLong=123456i,fieldULong=123456i,fieldString=\"text test\"";
     TEST_ASSERTM(line == testLine, line);
 
+    String defaultTags="dtag=val";
+    line = p.toLineProtocol(defaultTags);
+    testLine = "test,tag1=tagvalue,dtag=val fieldInt=-23i,fieldBool=true,fieldFloat1=1.12,fieldFloat2=1.12345,fieldDouble1=1.12,fieldDouble2=1.12345,fieldChar=\"A\",fieldUChar=1i,fieldUInt=23i,fieldLong=123456i,fieldULong=123456i,fieldString=\"text test\"";
+    TEST_ASSERTM(line == testLine, line);
+
+    p.clearTags();
+    line = p.toLineProtocol(defaultTags);
+    testLine = "test,dtag=val fieldInt=-23i,fieldBool=true,fieldFloat1=1.12,fieldFloat2=1.12345,fieldDouble1=1.12,fieldDouble2=1.12345,fieldChar=\"A\",fieldUChar=1i,fieldUInt=23i,fieldLong=123456i,fieldULong=123456i,fieldString=\"text test\"";
+    TEST_ASSERTM(line == testLine, line);
+
+
     p.clearFields();
     p.clearTags();
 
@@ -355,6 +377,7 @@ void Test::testBasicFunction() {
     deleteAll(INFLUXDB_CLIENT_TESTING_URL);
 }
 
+
 void Test::testInit() {
     TEST_INIT("testInit");
     {
@@ -1696,6 +1719,66 @@ void Test::testRetryInterval() {
     deleteAll(INFLUXDB_CLIENT_TESTING_URL);
 }
 
+void Test::testDefaultTags() {
+    TEST_INIT("testDefaultTags");
+
+    InfluxDBClient client(INFLUXDB_CLIENT_TESTING_URL, INFLUXDB_CLIENT_TESTING_ORG, INFLUXDB_CLIENT_TESTING_BUC, INFLUXDB_CLIENT_TESTING_TOK);
+    
+    TEST_ASSERT(waitServer(client, true));
+    for (int i = 0; i < 5; i++) {
+        Point *p = createPoint("test1");
+        p->addField("index", i);
+        TEST_ASSERT(client.writePoint(*p));
+        delete p;
+    }
+    String query = "select";
+    FluxQueryResult q = client.query(query);
+    TEST_ASSERTM(q.getError()=="", q.getError());
+    TEST_ASSERT(q.next());
+    TEST_ASSERTM(q.getColumnsName().size()==10,String(q.getColumnsName().size()));
+    TEST_ASSERT(q.next());
+    TEST_ASSERT(q.next());
+    TEST_ASSERT(q.next());
+    TEST_ASSERTM(q.getColumnsName().size()==10,String(q.getColumnsName().size())) ;
+    TEST_ASSERT(q.next());
+    TEST_ASSERT(!q.next());
+    q.close();
+    deleteAll(INFLUXDB_CLIENT_TESTING_URL);
+
+    client.setWriteOptions(WriteOptions().addDefaultTag("dtag1","dval1").addDefaultTag("dtag2","dval2"));
+
+    for (int i = 0; i < 5; i++) {
+        Point *p = createPoint("test1");
+        p->addField("index", i);
+        TEST_ASSERT(client.writePoint(*p));
+        delete p;
+    }
+    q = client.query(query);
+    TEST_ASSERTM(q.getError()=="", q.getError());
+    TEST_ASSERT(q.next());
+    TEST_ASSERTM(q.getColumnsName().size()==12,String(q.getColumnsName().size()));
+    TEST_ASSERTM(q.getValueByName("dtag1").getString() == "dval1", q.getValueByName("dtag1").getString());
+    TEST_ASSERTM(q.getValueByName("dtag2").getString() == "dval2", q.getValueByName("dtag2").getString());
+    TEST_ASSERT(q.next());
+    TEST_ASSERTM(q.getValueByName("dtag1").getString() == "dval1",q.getValueByName("dtag1").getString());
+    TEST_ASSERTM(q.getValueByName("dtag2").getString() == "dval2", q.getValueByName("dtag2").getString());
+    TEST_ASSERT(q.next());
+    TEST_ASSERTM(q.getValueByName("dtag1").getString() == "dval1",q.getValueByName("dtag1").getString());
+    TEST_ASSERTM(q.getValueByName("dtag2").getString() == "dval2", q.getValueByName("dtag2").getString());
+    TEST_ASSERT(q.next());
+    TEST_ASSERTM(q.getColumnsName().size()==12,String(q.getColumnsName().size())) ;
+    TEST_ASSERTM(q.getValueByName("dtag1").getString() == "dval1",q.getValueByName("dtag1").getString());
+    TEST_ASSERTM(q.getValueByName("dtag2").getString() == "dval2", q.getValueByName("dtag2").getString());
+    TEST_ASSERT(q.next());
+    TEST_ASSERTM(q.getValueByName("dtag1").getString() == "dval1",q.getValueByName("dtag1").getString());
+    TEST_ASSERTM(q.getValueByName("dtag2").getString() == "dval2", q.getValueByName("dtag2").getString());
+    TEST_ASSERT(!q.next());
+    q.close();
+
+    TEST_END();
+    deleteAll(INFLUXDB_CLIENT_TESTING_URL);
+}
+
 Point *createPoint(String measurement) {
     Point *point = new Point(measurement);
     point->addTag("SSID", WiFi.SSID());

Original file line number	Diff line number	Diff line change
`@@ -291,6 +291,7 @@ void InfluxDBClient::setWriteOptions(const WriteOptions & writeOptions) {`
`291`	`291`	`_writeOptions._retryInterval = writeOptions._retryInterval;`
`292`	`292`	`_writeOptions._maxRetryInterval = writeOptions._maxRetryInterval;`
`293`	`293`	`_writeOptions._maxRetryAttempts = writeOptions._maxRetryAttempts;`
	`294`	`+ _writeOptions._defaultTags = writeOptions._defaultTags;`
`294`	`295`	`}`
`295`	`296`
`296`	`297`	`void InfluxDBClient::setHTTPOptions(const HTTPOptions & httpOptions) {`
`@@ -339,7 +340,7 @@ bool InfluxDBClient::writePoint(Point & point) {`
`339`	`340`	`if(_writeOptions._writePrecision != WritePrecision::NoTime && !point.hasTime()) {`
`340`	`341`	`point.setTime(_writeOptions._writePrecision);`
`341`	`342`	`}`
`342`		`- String line = point.toLineProtocol();`
	`343`	`+ String line = point.toLineProtocol(_writeOptions._defaultTags);`
`343`	`344`	`return writeRecord(line);`
`344`	`345`	`}`
`345`	`346`	`return false;`