add tests

.travis.yml

@@ -8,4 +8,7 @@ os:
 cache: pip
 install:
   - pip install flask pytz pyyaml pylint
+script:
+  - pylint sunportal.py util --disable=R,C
+  - python -m test.tests
 

test/sbfspot_sqlite_db_creation.sql

@@ -0,0 +1,261 @@
+PRAGMA journal_mode=WAL;
+
+CREATE Table Config (
+	`Key` varchar(32),
+	`Value` varchar(200),
+	PRIMARY KEY (`Key`)
+);
+
+INSERT INTO Config VALUES('SchemaVersion','1');
+
+CREATE Table Inverters (
+	Serial int(4) NOT NULL,
+	Name varchar(32),
+	Type varchar(32),
+	SW_Version varchar(32),
+	TimeStamp datetime,
+	TotalPac int,
+	EToday int(8),
+	ETotal int(8),
+	OperatingTime double,
+	FeedInTime double,
+	Status varchar(10),
+	GridRelay varchar(10),
+	Temperature float,
+	PRIMARY KEY (Serial)
+);
+
+CREATE View vwInverters AS
+	Select Serial,
+	Name,Type,SW_Version,
+	datetime(TimeStamp, 'unixepoch', 'localtime') AS TimeStamp,
+	TotalPac,
+	EToday,ETotal,
+	OperatingTime,FeedInTime,
+	Status,GridRelay,
+	Temperature
+	FROM Inverters;
+
+CREATE Table SpotData (
+	TimeStamp datetime NOT NULL,
+	Serial int(4) NOT NULL,
+	Pdc1 int, Pdc2 int,
+	Idc1 float, Idc2 float,
+	Udc1 float, Udc2 float,
+	Pac1 int, Pac2 int, Pac3 int,
+	Iac1 float, Iac2 float, Iac3 float,
+	Uac1 float, Uac2 float, Uac3 float,
+	EToday int(8), ETotal int(8),
+	Frequency float,
+	OperatingTime double,
+	FeedInTime double,
+	BT_Signal float,
+	Status varchar(10),
+	GridRelay varchar(10),
+	Temperature float,
+	PRIMARY KEY (TimeStamp, Serial)
+);
+
+CREATE View vwSpotData AS
+SELECT datetime(Dat.TimeStamp, 'unixepoch', 'localtime') TimeStamp, 
+	datetime(CASE WHEN (Dat.TimeStamp % 300) < 150
+	THEN Dat.TimeStamp - (Dat.TimeStamp % 300)
+	ELSE Dat.TimeStamp - (Dat.TimeStamp % 300) + 300
+	END, 'unixepoch', 'localtime') AS Nearest5min,
+	Inv.Name,
+	Inv.Type,
+	Dat.Serial,
+	Pdc1,Pdc2,
+	Idc1,Idc2,
+	Udc1,Udc2,
+	Pac1,Pac2,Pac3,
+	Iac1,Iac2,Iac3,
+	Uac1,Uac2,Uac3,
+	Pdc1+Pdc2 AS PdcTot,
+	Pac1+Pac2+Pac3 AS PacTot,
+	CASE WHEN Pdc1+Pdc2 = 0 THEN
+	    0
+	ELSE
+	    CASE WHEN Pdc1+Pdc2>Pac1+Pac2+Pac3 THEN
+	        ROUND(1.0*(Pac1+Pac2+Pac3)/(Pdc1+Pdc2)*100,1)
+	    ELSE
+	        100.0
+	    END
+	END AS Efficiency,
+	Dat.EToday,
+	Dat.ETotal,
+	Frequency,
+	Dat.OperatingTime,
+	Dat.FeedInTime,
+	ROUND(BT_Signal,1) AS BT_Signal,
+	Dat.Status,
+	Dat.GridRelay,
+	ROUND(Dat.Temperature,1) AS Temperature
+	FROM [SpotData] Dat
+INNER JOIN Inverters Inv ON Dat.Serial = Inv.Serial
+ORDER BY Dat.Timestamp Desc;
+
+
+CREATE Table DayData (
+	TimeStamp datetime NOT NULL,
+	Serial int(4) NOT NULL,
+	TotalYield int(8),
+	Power int(8),
+	PVoutput int(1),
+	PRIMARY KEY (TimeStamp, Serial)
+);
+
+CREATE View vwDayData AS
+	select datetime(Dat.TimeStamp, 'unixepoch', 'localtime') AS TimeStamp,
+	Inv.Name, Inv.Type, Dat.Serial,
+	TotalYield,
+	Power,
+	PVOutput FROM DayData Dat
+INNER JOIN Inverters Inv ON Dat.Serial=Inv.Serial
+ORDER BY Dat.Timestamp Desc;
+
+CREATE Table MonthData (
+	TimeStamp datetime NOT NULL,
+	Serial int(4) NOT NULL,
+	TotalYield int(8),
+	DayYield int(8),
+	PRIMARY KEY (TimeStamp, Serial)
+);
+
+CREATE View vwMonthData AS
+	select date(Dat.TimeStamp, 'unixepoch') AS TimeStamp,
+	Inv.Name, Inv.Type, Dat.Serial,
+	TotalYield, DayYield FROM MonthData Dat
+INNER JOIN Inverters Inv ON Dat.Serial=Inv.Serial
+ORDER BY Dat.Timestamp Desc;
+
+CREATE Table EventData (
+	EntryID int(4),
+	TimeStamp datetime NOT NULL,
+	Serial int(4) NOT NULL,
+	SusyID int(2),
+	EventCode int(4),
+	EventType varchar(32),
+	Category varchar(32),
+	EventGroup varchar(32),
+	Tag varchar(200),
+	OldValue varchar(32),
+	NewValue varchar(32),
+	UserGroup varchar(10),
+	PRIMARY KEY (Serial, EntryID)
+);
+
+CREATE View vwEventData AS
+	select datetime(Dat.TimeStamp, 'unixepoch', 'localtime') AS TimeStamp,
+	Inv.Name, Inv.Type, Dat.Serial,
+	SusyID, EntryID,
+	EventCode, EventType,
+	Category, EventGroup, Tag,
+	OldValue, NewValue,
+	UserGroup FROM EventData Dat
+INNER JOIN Inverters Inv ON Dat.Serial=Inv.Serial
+ORDER BY EntryID Desc;
+
+CREATE Table Consumption (
+	TimeStamp datetime NOT NULL,
+	EnergyUsed int(4),
+	PowerUsed int(4),
+	PRIMARY KEY (TimeStamp)
+);
+
+CREATE VIEW vwConsumption AS
+SELECT datetime(TimeStamp, 'unixepoch', 'localtime') TimeStamp, 
+	datetime(CASE WHEN (TimeStamp % 300) < 150
+	THEN TimeStamp - (TimeStamp % 300)
+	ELSE TimeStamp - (TimeStamp % 300) + 300
+	END, 'unixepoch', 'localtime') AS Nearest5min,
+	EnergyUsed,
+	PowerUsed
+	FROM Consumption;
+
+CREATE VIEW vwAvgConsumption AS
+	SELECT Timestamp,
+		Nearest5min,
+		avg(EnergyUsed) As EnergyUsed,
+		avg(PowerUsed) As PowerUsed
+	FROM vwConsumption
+	GROUP BY Nearest5Min;
+
+CREATE VIEW vwAvgSpotData AS
+       SELECT nearest5min,
+              serial,
+              avg(Pdc1) AS Pdc1,
+              avg(Pdc2) AS Pdc2,
+              avg(Idc1) AS Idc1,
+              avg(Idc2) AS Idc2,
+              avg(Udc1) AS Udc1,
+              avg(Udc2) AS Udc2,
+              avg(Pac1) AS Pac1,
+              avg(Pac2) AS Pac2,
+              avg(Pac3) AS Pac3,
+              avg(Iac1) AS Iac1,
+              avg(Iac2) AS Iac2,
+              avg(Iac3) AS Iac3,
+              avg(Uac1) AS Uac1,
+              avg(Uac2) AS Uac2,
+              avg(Uac3) AS Uac3,
+              avg(Temperature) AS Temperature
+        FROM vwSpotData
+        GROUP BY serial, nearest5min;
+
+CREATE VIEW vwPvoData AS
+       SELECT dd.Timestamp,
+              dd.Name,
+              dd.Type,
+              dd.Serial,
+              dd.TotalYield AS V1,
+              dd.Power AS V2,
+              cons.EnergyUsed AS V3,
+              cons.PowerUsed AS V4,
+              spot.Temperature AS V5,
+              spot.Uac1 AS V6,
+              NULL AS V7,
+              NULL AS V8,
+              NULL AS V9,
+              NULL AS V10,
+              NULL AS V11,
+              NULL AS V12,
+              dd.PVoutput
+         FROM vwDayData AS dd
+              LEFT JOIN vwAvgSpotData AS spot
+                     ON dd.Serial = spot.Serial AND dd.Timestamp = spot.Nearest5min
+              LEFT JOIN vwAvgConsumption AS cons
+                     ON dd.Timestamp = cons.Nearest5min
+        ORDER BY dd.Timestamp DESC;
+
+-- Fix 09-JAN-2017 See Issue 54: SQL Support for battery inverters
+CREATE TABLE SpotDataX (
+    [TimeStamp] INTEGER (4) NOT NULL,
+    [Serial]    INTEGER (4) NOT NULL,
+    [Key]       INTEGER (4) NOT NULL,
+    [Value]     INTEGER (4),
+    PRIMARY KEY (
+        [TimeStamp] ASC,
+        [Serial] ASC,
+        [Key]
+    )
+)
+WITHOUT ROWID;
+
+DROP VIEW IF EXISTS vwBatteryData;
+
+CREATE VIEW vwBatteryData AS
+    SELECT DATETIME(sdx.[TimeStamp] - (sdx.[TimeStamp] % 300), 'unixepoch', 'localtime') AS [5min],
+           sdx.[Serial],
+           inv.[Name],
+           AVG(CASE WHEN [Key] = 10586 THEN [Value] END) AS ChaStatus,
+           AVG(CASE WHEN [Key] = 18779 THEN CAST([Value] AS REAL) / 10 END) AS Temperature,
+           AVG(CASE WHEN [Key] = 18781 THEN CAST([Value] AS REAL) / 1000 END) AS ChaCurrent,
+           AVG(CASE WHEN [Key] = 18780 THEN CAST([Value] AS REAL) / 100 END) AS ChaVoltage,
+           AVG(CASE WHEN [Key] = 17974 THEN [Value] END) AS GridMsTotWOut,
+           AVG(CASE WHEN [Key] = 17975 THEN [Value] END) AS GridMsTotWIn
+      FROM SpotDataX AS sdx
+           INNER JOIN
+           Inverters AS inv ON sdx.[Serial] = inv.[Serial]
+     GROUP BY [5min];
+

test/tests.py

@@ -0,0 +1,52 @@
+#!/usr/bin/python3
+"""
+Test class for sunportal
+"""
+
+import unittest
+
+from util.database import Database
+
+class TestDatabase(unittest.TestCase):
+
+    def test_get_epoch_day(self):
+
+        res = Database.get_epoch_day(None, '1994-04-04')
+        self.assertEqual(res, (765417600, 765503999))
+
+
+    def test_get_last_day_of_month_leap_year(self):
+
+        res = Database.get_last_day_of_month(None, '2020-02-05')
+        self.assertEqual(res, 29)
+
+    def test_get_last_day_of_month_no_leap_year(self):
+
+        res = Database.get_last_day_of_month(None, '2019-02-05')
+        self.assertEqual(res, 28)
+
+    def test_get_last_day_of_month_month_and_year_swapped(self):
+        with self.assertRaises(ValueError):
+            Database.get_last_day_of_month(None, '2019-13-01')
+
+    def test_convert_local_ts_to_utc_on_local_timezone(self):
+        """
+        The database sunportal uses contains timestamps not in UTC timezone (as per definition), but
+        instead in local timezone. convert_local_ts_to_utc converts those timestamps back to UTC for
+        further processing and timezone independent front-ends.
+        """
+
+        import time
+        ts_in_utc = int(time.time()) # unix timestamps are per definition always in utc
+
+        timezone = Database.get_local_timezone(None)
+        utc_offset = timezone.utcoffset(None).seconds
+        ts_in_local_time = ts_in_utc + utc_offset
+
+        res = Database.convert_local_ts_to_utc(None, ts_in_local_time, timezone)
+        self.assertEqual(res, ts_in_utc)
+
+
+if __name__ == '__main__':
+
+    unittest.main()