#24 - Use json for storing data instead of text

Author: js-dieu

docs/sources/changelog.rst

@@ -2,6 +2,12 @@
 Changelog
 =========
 
+* :release:`1.6.0 <2021-04-16>`
+* :feature:`#0` Support for python 3.5
+* :feature:`#35` Better support for Doctest item.
+* :feature:`#24` Prefer JSON data type for storing session extended information instead of plain text.
+
+
 * :release:`1.5.1 <2021-02-05>`
 * :bug:`#31` Rename option --remote into --remote-server as it seems to conflict with some plugins.  
 * :bug:`#23` Fix requirements minimum version.

pytest_monitor/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "1.5.1"
+__version__ = "1.6.0"
 __author__ = "Jean-Sebastien Dieu"

pytest_monitor/handler.py

@@ -46,7 +46,7 @@ def prepare(self):
     SESSION_H varchar(64) primary key not null unique, -- Session identifier
     RUN_DATE varchar(64), -- Date of test run
     SCM_ID varchar(128), -- SCM change id
-    RUN_DESCRIPTION varchar(1024)
+    RUN_DESCRIPTION json
 );''')
         cursor.execute('''
 CREATE TABLE IF NOT EXISTS TEST_METRICS (

tests/test_monitor.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import json
 import pathlib
 import pytest
 import sqlite3
@@ -9,8 +10,8 @@ def test_monitor_basic_test(testdir):
     # create a temporary pytest test module
     testdir.makepyfile("""
     import time
-    
-    
+
+
     def test_ok():
         time.sleep(0.5)
         x = ['a' * i for i in range(100)]
@@ -19,21 +20,64 @@ def test_ok():
 """)
 
     # run pytest with the following cmd args
-    result = testdir.runpytest('-v')
+    result = testdir.runpytest('-vv', '--tag', 'version=12.3.5')
 
     # fnmatch_lines does an assertion internally
     result.stdout.fnmatch_lines(['*::test_ok PASSED*'])
 
     pymon_path = pathlib.Path(str(testdir)) / '.pymon'
     assert pymon_path.exists()
 
-    # make sure that that we get a '0' exit code for the testsuite
+    # make sure that that we get a '0' exit code for the test suite
     result.assert_outcomes(passed=1)
 
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
     assert 1 == len(cursor.fetchall())  # current test
+    cursor = db.cursor()
+    tags = json.loads(cursor.execute('SELECT RUN_DESCRIPTION FROM TEST_SESSIONS;').fetchone()[0])
+    assert 'description' not in tags
+    assert 'version' in tags
+    assert tags['version'] == "12.3.5"
+
+
+def test_monitor_basic_test_description(testdir):
+    """Make sure that pytest-monitor does the job without impacting user tests."""
+    # create a temporary pytest test module
+    testdir.makepyfile("""
+    import time
+
+
+    def test_ok():
+        time.sleep(0.5)
+        x = ['a' * i for i in range(100)]
+        assert len(x) == 100
+
+""")
+
+    # run pytest with the following cmd args
+    result = testdir.runpytest('-vv', '--description', '"Test"', '--tag', 'version=12.3.5')
+
+    # fnmatch_lines does an assertion internally
+    result.stdout.fnmatch_lines(['*::test_ok PASSED*'])
+
+    pymon_path = pathlib.Path(str(testdir)) / '.pymon'
+    assert pymon_path.exists()
+
+    # make sure that that we get a '0' exit code for the test suite
+    result.assert_outcomes(passed=1)
+
+    db = sqlite3.connect(str(pymon_path))
+    cursor = db.cursor()
+    cursor.execute('SELECT ITEM FROM TEST_METRICS;')
+    assert 1 == len(cursor.fetchall())  # current test
+    cursor = db.cursor()
+    tags = json.loads(cursor.execute('SELECT RUN_DESCRIPTION FROM TEST_SESSIONS;').fetchone()[0])
+    assert 'description' in tags
+    assert tags['description'] == '"Test"'
+    assert 'version' in tags
+    assert tags['version'] == "12.3.5"
 
 
 def test_monitor_pytest_skip_marker(testdir):