Adding upstream version 1.12.0.upstream/1.12.0upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

4 files changed, 725 insertions, 0 deletions

diff --git a/tests/node.d/fronius.chart.spec.js b/tests/node.d/fronius.chart.spec.js
new file mode 100644
index 0000000..92e88d2
--- /dev/null
+++ b/tests/node.d/fronius.chart.spec.js
@@ -0,0 +1,162 @@
+"use strict";
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+var netdata = require("../../node.d/node_modules/netdata");
+// remember: subject will be a singleton!
+var subject = require("../../node.d/fronius.node");
+
+var service = netdata.service({
+    name: "chart",
+    module: this
+});
+
+describe("fronius chart creation", function () {
+
+    var chartPrefix = "fronius_chart.";
+
+    beforeAll(function () {
+        // change this to enable debug log
+        netdata.options.DEBUG = false;
+    });
+
+    afterAll(function () {
+        deleteProperties(subject.charts)
+    });
+
+    it("should return a basic chart dimension", function () {
+        var result = subject.createBasicDimension("id", "name", 2);
+
+        expect(result.divisor).toBe(2);
+        expect(result.id).toBe("id");
+        expect(result.algorithm).toEqual(netdata.chartAlgorithms.absolute);
+        expect(result.multiplier).toBe(1);
+    });
+
+    it("should return the power chart definition", function () {
+        var suffix = "power";
+        var result = subject.getSitePowerChart(service, suffix);
+
+        expect(result.id).toBe(chartPrefix + suffix);
+        expect(result.units).toBe("W");
+        expect(result.type).toBe(netdata.chartTypes.area);
+        expect(result.family).toBe("power");
+        expect(result.context).toBe("fronius.power");
+        expect(result.dimensions[subject.powerGridId].name).toBe("grid");
+        expect(result.dimensions[subject.powerPvId].name).toBe("photovoltaics");
+        expect(result.dimensions[subject.powerAccuId].name).toBe("accumulator");
+        expect(Object.keys(result.dimensions).length).toBe(3);
+    });
+
+    it("should return the consumption chart definition", function () {
+        var suffix = "Load";
+        var result = subject.getSiteConsumptionChart(service, suffix);
+
+        expect(result.id).toBe(chartPrefix + suffix);
+        expect(result.units).toBe("W");
+        expect(result.type).toBe(netdata.chartTypes.area);
+        expect(result.family).toBe("consumption");
+        expect(result.context).toBe("fronius.consumption");
+        expect(Object.keys(result.dimensions).length).toBe(1);
+        expect(result.dimensions[subject.consumptionLoadId].name).toBe("load");
+    });
+
+    it("should return the autonomy chart definition", function () {
+        var suffix = "Autonomy";
+        var result = subject.getSiteAutonomyChart(service, suffix);
+
+        expect(result.id).toBe(chartPrefix + suffix);
+        expect(result.units).toBe("%");
+        expect(result.type).toBe(netdata.chartTypes.area);
+        expect(result.family).toBe("autonomy");
+        expect(result.context).toBe("fronius.autonomy");
+        expect(Object.keys(result.dimensions).length).toBe(3);
+        expect(result.dimensions[subject.autonomyId].name).toBe("autonomy");
+        expect(result.dimensions[subject.consumptionSelfId].name).toBe("self_consumption");
+    });
+
+    it("should return the energy today chart definition", function () {
+        var suffix = "Energy today";
+        var result = subject.getSiteEnergyTodayChart(service, suffix);
+
+        expect(result.id).toBe(chartPrefix + suffix);
+        expect(result.units).toBe("kWh");
+        expect(result.type).toBe(netdata.chartTypes.area);
+        expect(result.family).toBe("energy");
+        expect(result.context).toBe("fronius.energy.today");
+        expect(Object.keys(result.dimensions).length).toBe(1);
+        expect(result.dimensions[subject.energyTodayId].name).toBe("today");
+    });
+
+    it("should return the energy year chart definition", function () {
+        var suffix = "Energy year";
+        var result = subject.getSiteEnergyYearChart(service, suffix);
+
+        expect(result.id).toBe(chartPrefix + suffix);
+        expect(result.units).toBe("kWh");
+        expect(result.type).toBe(netdata.chartTypes.area);
+        expect(result.family).toBe("energy");
+        expect(result.context).toBe("fronius.energy.year");
+        expect(Object.keys(result.dimensions).length).toBe(1);
+        expect(result.dimensions[subject.energyYearId].name).toBe("year");
+    });
+
+    it("should return the inverter chart definition with a single numerical inverter", function () {
+        var inverters = {
+            "1": {}
+        };
+        var suffix = "numerical";
+        var result = subject.getInverterPowerChart(service, suffix, inverters);
+
+        expect(result.id).toBe(chartPrefix + suffix);
+        expect(result.units).toBe("W");
+        expect(result.type).toBe(netdata.chartTypes.stacked);
+        expect(result.family).toBe("inverters");
+        expect(result.context).toBe("fronius.inverter.output");
+        expect(Object.keys(result.dimensions).length).toBe(1);
+        expect(result.dimensions["1"].name).toBe("inverter_1");
+    });
+
+    it("should return the inverter chart definition with a single alphabetical inverter", function () {
+        var key = "Cellar";
+        var inverters = {
+            "Cellar": {}
+        };
+        var suffix = "alphabetical";
+        var result = subject.getInverterPowerChart(service, suffix, inverters);
+
+        expect(result.id).toBe(chartPrefix + suffix);
+        expect(result.units).toBe("W");
+        expect(result.type).toBe(netdata.chartTypes.stacked);
+        expect(result.family).toBe("inverters");
+        expect(result.context).toBe("fronius.inverter.output");
+        expect(Object.keys(result.dimensions).length).toBe(1);
+        expect(result.dimensions[key].name).toBe(key);
+    });
+
+    it("should return the inverter chart definition with multiple alphanumerical inverter", function () {
+        var alpha = "Cellar";
+        var numerical = 1;
+        var inverters = {
+            "Cellar": {},
+            "1": {}
+        };
+        var suffix = "alphanumerical";
+        var result = subject.getInverterPowerChart(service, suffix, inverters);
+
+        expect(result.id).toBe(chartPrefix + suffix);
+        expect(result.units).toBe("W");
+        expect(result.type).toBe(netdata.chartTypes.stacked);
+        expect(result.family).toBe("inverters");
+        expect(result.context).toBe("fronius.inverter.output");
+        expect(Object.keys(result.dimensions).length).toBe(2);
+        expect(result.dimensions[alpha].name).toBe(alpha);
+        expect(result.dimensions[numerical].name).toBe("inverter_" + numerical);
+    });
+
+    it("should return the same chart definition on second call for lazy loading", function () {
+        var first = subject.getSitePowerChart(service, "id");
+        var second = subject.getSitePowerChart(service, "id");
+
+        expect(first).toBe(second);
+    });
+});
diff --git a/tests/node.d/fronius.parse.spec.js b/tests/node.d/fronius.parse.spec.js
new file mode 100644
index 0000000..e6f308f
--- /dev/null
+++ b/tests/node.d/fronius.parse.spec.js
@@ -0,0 +1,333 @@
+"use strict";
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+var netdata = require("../../node.d/node_modules/netdata");
+// remember: subject will be a singleton!
+var subject = require("../../node.d/fronius.node");
+
+var service = netdata.service({
+    name: "parse",
+    module: this
+});
+
+var root = {
+    "Body": {
+        "Data": {
+            "Site": {},
+            "Inverters": {}
+        }
+    }
+};
+
+describe("fronius parsing for power chart", function () {
+
+    var site = root.Body.Data.Site;
+
+    afterEach(function () {
+        deleteProperties(site);
+    });
+
+    it("should return 3000 for P_Grid when rounded", function () {
+        site.P_Grid = 2999.501;
+        var result = subject.parsePowerChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.powerGridId);
+        expect(result.value).toBe(3000);
+    });
+
+    it("should return -3000 for P_Grid", function () {
+        site.P_Grid = -3000;
+        var result = subject.parsePowerChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.powerGridId);
+        expect(result.value).toBe(-3000);
+    });
+
+    it("should return 0 for P_Grid if it is null", function () {
+        site.P_Grid = null;
+        var result = subject.parsePowerChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.powerGridId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 0 for P_Grid if it is zero", function () {
+        site.P_Grid = 0;
+        var result = subject.parsePowerChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.powerGridId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return -100 for P_Akku", function () {
+        // it is unclear whether negative values are possible for p_akku (couln't test, nor any API docs found).
+        site.P_Akku = -100;
+        var result = subject.parsePowerChart(service, site).dimensions[2];
+
+        expect(result.name).toBe(subject.powerAccuId);
+        expect(result.value).toBe(-100);
+    });
+
+    it("should return 0 for P_Akku if it is null", function () {
+        site.P_Akku = null;
+        var result = subject.parsePowerChart(service, site).dimensions[2];
+
+        expect(result.name).toBe(subject.powerAccuId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 0 for P_Akku if it is zero", function () {
+        site.P_Akku = 0;
+        var result = subject.parsePowerChart(service, site).dimensions[2];
+
+        expect(result.name).toBe(subject.powerAccuId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 100 for P_PV", function () {
+        site.P_PV = 100;
+        var result = subject.parsePowerChart(service, site).dimensions[1];
+
+        expect(result.name).toBe(subject.powerPvId);
+        expect(result.value).toBe(100);
+    });
+
+    it("should return 0 for P_PV if it is zero", function () {
+        site.P_PV = 0;
+        var result = subject.parsePowerChart(service, site).dimensions[1];
+
+        expect(result.name).toBe(subject.powerPvId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 0 for P_PV if it is null", function () {
+        site.P_PV = null;
+        var result = subject.parsePowerChart(service, site).dimensions[1];
+
+        expect(result.name).toBe(subject.powerPvId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 0 for P_PV if it is negative", function () {
+        // solar panels shouldn't consume anything, only produce.
+        site.P_PV = -1;
+        var result = subject.parsePowerChart(service, site).dimensions[1];
+
+        expect(result.name).toBe(subject.powerPvId);
+        expect(result.value).toBe(0);
+    });
+
+});
+
+describe("fronius parsing for consumption", function () {
+
+    var site = root.Body.Data.Site;
+
+    afterEach(function () {
+        deleteProperties(site);
+    });
+
+    it("should return 1000 for P_Load when rounded", function () {
+        site.P_Load = 1000.499;
+        var result = subject.parseConsumptionChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.consumptionLoadId);
+        expect(result.value).toBe(1000);
+    });
+
+    it("should return absolute value for P_Load when negative", function () {
+        /*
+         with firmware 3.7.4 it is sometimes possible that negative values are returned for P_Load,
+         which makes absolutely no sense. There is always a device that consumes some electricity around the clock.
+         Best we can do is to make it a positive value, since 0 also doesn't make much sense.
+         This "workaround" seems to work, as there couldn't be any strange peaks observed during long-time testing.
+         */
+        site.P_Load = -50;
+        var result = subject.parseConsumptionChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.consumptionLoadId);
+        expect(result.value).toBe(50);
+    });
+
+    it("should return 0 for P_Load if it is null", function () {
+        site.P_Load = null;
+        var result = subject.parseConsumptionChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.consumptionLoadId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 0 for P_Load if it is zero", function () {
+        site.P_Load = 0;
+        var result = subject.parseConsumptionChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.consumptionLoadId);
+        expect(result.value).toBe(0);
+    });
+
+});
+
+describe("fronius parsing for autonomy", function () {
+
+    var site = root.Body.Data.Site;
+
+    afterEach(function () {
+        deleteProperties(site);
+    });
+
+    it("should return 100 for rel_Autonomy", function () {
+        site.rel_Autonomy = 100;
+        var result = subject.parseAutonomyChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.autonomyId);
+        expect(result.value).toBe(100);
+    });
+
+    it("should return 0 for rel_Autonomy if it is zero", function () {
+        site.rel_Autonomy = 0;
+        var result = subject.parseAutonomyChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.autonomyId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 0 for rel_Autonomy if it is null", function () {
+        site.rel_Autonomy = null;
+        var result = subject.parseAutonomyChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.autonomyId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 20 for rel_Autonomy if it is 20", function () {
+        site.rel_Autonomy = 20.1;
+        var result = subject.parseAutonomyChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.autonomyId);
+        expect(result.value).toBe(20);
+    });
+
+    it("should return 20 for rel_SelfConsumption if it is 19.5", function () {
+        site.rel_SelfConsumption = 19.5;
+        var result = subject.parseAutonomyChart(service, site).dimensions[1];
+
+        expect(result.name).toBe(subject.consumptionSelfId);
+        expect(result.value).toBe(20);
+    });
+
+    it("should return 100 for rel_SelfConsumption if it is null", function () {
+        /*
+         During testing it could be observed that the API is delivering null if the solar panels
+         do not produce enough energy to supply the local load. But in this case it should be 100, since all
+         the produced energy is directly consumed.
+         */
+        site.rel_SelfConsumption = null;
+        var result = subject.parseAutonomyChart(service, site).dimensions[1];
+
+        expect(result.name).toBe(subject.consumptionSelfId);
+        expect(result.value).toBe(100);
+    });
+
+    it("should return 0 for rel_SelfConsumption if it is zero", function () {
+        site.rel_SelfConsumption = 0;
+        var result = subject.parseAutonomyChart(service, site).dimensions[1];
+
+        expect(result.name).toBe(subject.consumptionSelfId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 0 for solarConsumption if PV is null", function () {
+        site.P_PV = null;
+        site.P_Load = -1000;
+        var result = subject.parseAutonomyChart(service, site).dimensions[2];
+
+        expect(result.name).toBe(subject.solarConsumptionId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 100 for solarConsumption if Load is higher than solar power", function () {
+        site.P_PV = 500;
+        site.P_Load = -1500;
+        var result = subject.parseAutonomyChart(service, site).dimensions[2];
+
+        expect(result.name).toBe(subject.solarConsumptionId);
+        expect(result.value).toBe(100);
+    });
+
+    it("should return 50 for solarConsumption if Load is half than solar power", function () {
+        site.P_PV = 3000;
+        site.P_Load = -1500;
+        var result = subject.parseAutonomyChart(service, site).dimensions[2];
+
+        expect(result.name).toBe(subject.solarConsumptionId);
+        expect(result.value).toBe(50);
+    });
+});
+
+describe("fronius parsing for energy", function () {
+
+    var site = root.Body.Data.Site;
+
+    afterEach(function () {
+        deleteProperties(site);
+    });
+
+    it("should return 10000 for E_Day", function () {
+        site.E_Day = 10000;
+        var result = subject.parseEnergyTodayChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.energyTodayId);
+        expect(result.value).toBe(10000);
+    });
+
+    it("should return 0 for E_Day if it is negative", function () {
+        /*
+         The solar panels can't produce negative energy, really. It would be a fault of the API.
+         */
+        site.E_Day = -0.4;
+        var result = subject.parseEnergyTodayChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.energyTodayId);
+        expect(result.value).toBe(0);
+    });
+
+    it("should return 100'000 for E_Year", function () {
+        site.E_Year = 100000.4;
+        var result = subject.parseEnergyYearChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.energyYearId);
+        expect(result.value).toBe(100000);
+    });
+
+    it("should return 0 for E_Year if it is negative", function () {
+        /*
+         A return value of 0 only makes sense in the silvester night anyway, when the counter is being reset.
+         A negative value is a fault from the API though. It wouldn't make sense.
+         */
+        site.E_Year = -1;
+        var result = subject.parseEnergyYearChart(service, site).dimensions[0];
+
+        expect(result.name).toBe(subject.energyYearId);
+        expect(result.value).toBe(0);
+    });
+});
+
+describe("fronius parsing for inverters", function () {
+
+    var inverters = root.Body.Data.Inverters;
+
+    afterEach(function () {
+        deleteProperties(inverters);
+    });
+
+    it("should return 1000 for P for inverter with name", function () {
+       inverters["cellar"] = {
+           P: 1000
+       };
+       var result = subject.parseInverterChart(service, inverters).dimensions[0];
+
+       expect(result.name).toBe("cellar");
+       expect(result.value).toBe(1000);
+    });
+
+});
diff --git a/tests/node.d/fronius.process.spec.js b/tests/node.d/fronius.process.spec.js
new file mode 100644
index 0000000..141fa8a
--- /dev/null
+++ b/tests/node.d/fronius.process.spec.js
@@ -0,0 +1,75 @@
+"use strict";
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+var netdata = require("../../node.d/node_modules/netdata");
+// remember: subject will be a singleton!
+var subject = require("../../node.d/fronius.node");
+
+var service = netdata.service({
+    name: "process",
+    module: this
+});
+
+var exampleResponse = {
+    "Body": {
+        "Data": {
+            "Site": {
+                "Mode": "meter",
+                "P_Grid": -3430.729923,
+                "P_Load": -910.270077,
+                "P_Akku": null,
+                "P_PV": 4341,
+                "rel_SelfConsumption": 20.969133,
+                "rel_Autonomy": 100,
+                "E_Day": 57230,
+                "E_Year": 6425915.5,
+                "E_Total": 15388710,
+                "Meter_Location": "grid"
+            },
+            "Inverters": {
+                "1": {
+                    "DT": 123,
+                    "P": 4341,
+                    "E_Day": 57230,
+                    "E_Year": 6425915.5,
+                    "E_Total": 15388710
+                }
+            }
+        }
+    }
+};
+
+describe("fronius main processing", function () {
+
+    beforeAll(function () {
+        // change this to enable debug log
+        netdata.options.DEBUG = false;
+    });
+
+    beforeEach(function () {
+        deleteProperties(subject.charts);
+    });
+
+    it("should send parsed values to netdata", function () {
+        netdata.send = jasmine.createSpy("send");
+
+        subject.processResponse(service, exampleResponse);
+
+        expect(netdata.send.calls.count()).toBe(6);
+
+        // check if some parsed values were sent.
+        var powerChart = netdata.send.calls.argsFor(5)[0];
+
+        expect(powerChart).toContain("SET p_grid = -3431");
+        expect(powerChart).toContain("SET p_pv = 4341");
+
+        var inverterChart = netdata.send.calls.argsFor(0)[0];
+
+        expect(inverterChart).toContain("SET 1 = 4341");
+
+        var autonomyChart = netdata.send.calls.argsFor(3)[0];
+        expect(autonomyChart).toContain("SET rel_selfconsumption = 21");
+    });
+
+
+});
diff --git a/tests/node.d/fronius.validation.spec.js b/tests/node.d/fronius.validation.spec.js
new file mode 100644
index 0000000..b7938d5
--- /dev/null
+++ b/tests/node.d/fronius.validation.spec.js
@@ -0,0 +1,155 @@
+"use strict";
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+var netdata = require("../../node.d/node_modules/netdata");
+// remember: subject will be a singleton!
+var subject = require("../../node.d/fronius.node");
+
+var service = netdata.service({
+    name: "validation",
+    module: this
+});
+
+describe("fronius response validation", function () {
+
+    it("should do nothing if response is null", function () {
+        netdata.send = jasmine.createSpy("send");
+
+        subject.processResponse(service, null);
+        var result = netdata.send.calls.count();
+
+        expect(result).toBe(0);
+    });
+
+    it("should return null if response is null", function () {
+        var result = subject.convertToJson(null);
+
+        expect(result).toBeNull();
+    });
+
+    it("should return null and log error if response cannot be parsed", function () {
+        netdata.error = jasmine.createSpy("error");
+
+        // trailing commas are enough to create syntax exceptions
+        var result = subject.convertToJson("{name,}");
+
+        expect(result).toBeNull();
+        expect(netdata.error.calls.count()).toBe(1);
+    });
+
+    it("should return true if response is valid", function () {
+        var result = subject.isResponseValid({
+            "Body": {
+                "Data": {
+                    "Site": {
+                        "Mode": "meter"
+                    },
+                    "Inverters": {
+                        "1": {}
+                    }
+                }
+            }
+        });
+
+        expect(result).toBeTruthy();
+    });
+
+    it("should return false if response is missing data", function () {
+        var result = subject.isResponseValid({
+            "Body": {}
+        });
+
+        expect(result).toBeFalsy();
+    });
+
+    it("should return false if response is missing inverter", function () {
+        var result = subject.isResponseValid({
+            "Body": {
+                "Data": {
+                    "Site": {}
+                }
+            }
+        });
+
+        expect(result).toBeFalsy();
+    });
+
+    it("should return false if response is missing inverter", function () {
+        var result = subject.isResponseValid({
+            "Body": {
+                "Data": {
+                    "Inverters": {}
+                }
+            }
+        });
+
+        expect(result).toBeFalsy();
+    });
+
+});
+
+describe("fronius configuration validation", function () {
+
+    it("should return 0 if there are no servers configured", function () {
+        var result = subject.configure({});
+
+        expect(result).toBe(0);
+    });
+
+    it("should return 0 if the servers array is empty", function () {
+        var result = subject.configure({
+            "servers": []
+        });
+
+        expect(result).toBe(0);
+    });
+
+    it("should return 0 if there is one server configured incorrectly", function () {
+        var result = subject.configure({
+            "servers": [{}]
+        });
+
+        expect(result).toBe(0);
+    });
+
+    it("should return 1 if there is one server configured", function () {
+        subject.serviceExecute = jasmine.createSpy("serviceExecute");
+        var name = "solar1";
+        var result = subject.configure({
+            "servers": [{
+                "name": name,
+                "api_path": "/api/",
+                "hostname": "solar1.local"
+            }]
+        });
+
+        expect(result).toBe(1);
+        expect(subject.serviceExecute).toHaveBeenCalledWith(name, "solar1.local/api/", 5);
+    });
+
+    it("should return 2 if there are two servers configured", function () {
+        subject.serviceExecute = jasmine.createSpy("serviceExecute");
+        var name1 = "solar 1";
+        var name2 = "solar 2";
+        var result = subject.configure({
+            "servers": [
+                {
+                    "name": name1,
+                    "api_path": "/",
+                    "hostname": "solar1.local"
+                },
+                {
+                    "name": name2,
+                    "api_path": "/",
+                    "hostname": "solar2.local",
+                    "update_every": 3
+                }
+            ]
+        });
+
+        expect(result).toBe(2);
+        expect(subject.serviceExecute).toHaveBeenCalledWith(name1, "solar1.local/", 5);
+        expect(subject.serviceExecute).toHaveBeenCalledWith(name2, "solar2.local/", 3);
+    });
+
+});