#21 - Using json format to describe a pytest session (#22)

Author: js-dieu

docs/sources/changelog.rst

@@ -2,6 +2,9 @@
 Changelog
 =========
 
+* :release:`1.4.0 <2020-06-04>`
+* :feature:`21` Using json format to populate the RUN_DESCRIPTION field (through --description and --tag fields)
+
 * :release:`1.3.0 <2020-05-12>`
 * :feature:`19` Normalized http codes used for sending metrics to a remote server.
 

docs/sources/configuration.rst

@@ -83,10 +83,45 @@ Adding a description to a run
 -----------------------------
 
 Sometimes, you might want to compare identical state of your code. In such cases, relying only on the scm
-references and the run date of the session. For that, `pytest-monitor` can assist you by adding a
-description field to your session.
+references and the run date of the session. For that, `pytest-monitor` can assist you by tagging
+your session using description and tags.
+The description should be used to provide a brief summary of your run while tags can be used to
+set special information you want to focus during your analysis. 
 Setting a description is as simple as this:
 
 .. code-block:: shell
 
     bash $> pytest --description "Any run description you want"
+
+
+Flagging your session with specific information is as complex as setting the description:
+
+.. code-block:: shell
+
+    bash $> pytest --tag pandas=1.0.1 --tag numpy=1.17
+
+This will result in a session with the following description:
+
+.. code-block:: text
+
+    {
+        "pandas": "1.0.1",
+        "numpy": "1.17"
+    }
+
+
+You can perfectly use both options to fully describe your session:
+
+.. code-block:: shell
+
+    bash $> pytest --tag pandas=1.0.1 --tag numpy=1.17 --description "Your summary"
+
+This will result in a session with the following description:
+
+.. code-block:: text
+
+    {
+        "msg": "Your summary",
+        "pandas": "1.0.1",
+        "numpy": "1.17"
+    }

pytest_monitor/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "1.3.0"
+__version__ = "1.4.0"
 __author__ = "Jean-Sebastien Dieu"

pytest_monitor/pytest_monitor.py

@@ -27,23 +27,25 @@ def pytest_addoption(parser):
                     help='Select the scope to monitor. By default, only function is monitored.'
                          'Values are function, class, module, session. You can set one or more of these'
                          'by listing them using a comma separated list')
-    group.addoption('--parametrization-explicit', dest='want_explicit_ids', action='store_true',
+    group.addoption('--parametrization-explicit', dest='mtr_want_explicit_ids', action='store_true',
                     help='Set this option to distinguish parametrized tests given their values.'
                          ' This requires the parameters to be stringifiable.')
     group.addoption('--no-monitor', action='store_true', dest='mtr_none', help='Disable all traces')
-    group.addoption('--remote', action='store', dest='remote',
+    group.addoption('--remote', action='store', dest='mtr_remote',
                     help='Remote server to send the results to. Format is <ADRESS>:<PORT>')
     group.addoption('--db', action='store', dest='mtr_db_out', default='.pymon',
                     help='Use the given sqlite database for storing results.')
-    group.addoption('--no-db', action='store_true', help='Do not store results in local db.')
-    group.addoption('--force-component', action='store',
+    group.addoption('--no-db', action='store_true', dest='mtr_no_db', help='Do not store results in local db.')
+    group.addoption('--force-component', action='store', dest='mtr_force_component', 
                     help='Force the component to be set at the given value for the all tests run'
                          ' in this session.')
-    group.addoption('--component-prefix', action='store',
+    group.addoption('--component-prefix', action='store', dest='mtr_component_prefix',
                     help='Prefix each found components with the given value (applies to all tests'
                          ' run in this session).')
-    group.addoption('--description', action='store', default='',
+    group.addoption('--description', action='store', default='', dest='mtr_description',
                     help='Use this option to provide a small summary about this run.')
+    group.addoption('--tag', action='append', dest='mtr_tags', default=[],
+                    help='Provide meaningfull flags to your run. This can help you in your analysis.')
 
 
 def pytest_configure(config):
@@ -143,7 +145,7 @@ def prof():
 
 
 def pytest_make_parametrize_id(config, val, argname):
-    if config.option.want_explicit_ids:
+    if config.option.mtr_want_explicit_ids:
         return f'{argname}={val}'
 
 
@@ -153,22 +155,23 @@ def pytest_sessionstart(session):
     Instantiate a monitor session to save collected metrics.
     We yield at the end to let pytest pursue the execution.
     """
-    if session.config.option.force_component and session.config.option.component_prefix:
+    if session.config.option.mtr_force_component and session.config.option.mtr_component_prefix:
         raise pytest.UsageError('Invalid usage: --force-component and --component-prefix are incompatible options!')
-    if session.config.option.no_db and not session.config.option.remote and not session.config.option.mtr_none:
+    if session.config.option.mtr_no_db and not session.config.option.mtr_remote and not session.config.option.mtr_none:
         warnings.warn('pytest-monitor: No storage specified but monitoring is requested. Disabling monitoring.')
         session.config.option.mtr_none = True
-    component = session.config.option.force_component or session.config.option.component_prefix 
-    if session.config.option.component_prefix:
+    component = session.config.option.mtr_force_component or session.config.option.mtr_component_prefix 
+    if session.config.option.mtr_component_prefix:
         component += '.{user_component}'
     if not component:
         component = '{user_component}'
-    db = None if (session.config.option.mtr_none or session.config.option.no_db) else session.config.option.mtr_db_out
-    remote = None if session.config.option.mtr_none else session.config.option.remote
+    db = None if (session.config.option.mtr_none or session.config.option.mtr_no_db) else session.config.option.mtr_db_out
+    remote = None if session.config.option.mtr_none else session.config.option.mtr_remote
     session.pytest_monitor = PyTestMonitorSession(db=db, remote=remote,
                                                   component=component,
                                                   scope=session.config.option.mtr_scope)
-    session.pytest_monitor.compute_info(session.config.option.description)
+    session.pytest_monitor.compute_info(session.config.option.mtr_description,
+                                        session.config.option.mtr_tags)
     yield
 
 

pytest_monitor/session.py

@@ -54,14 +54,27 @@ def get_env_id(self, env):
                     remote = None
         return db, remote
 
-    def compute_info(self, description):
+    def compute_info(self, description, tags):
         run_date = datetime.datetime.now().isoformat()
         scm = determine_scm_revision()
         h = hashlib.md5()
         h.update(scm.encode())
         h.update(run_date.encode())
         h.update(description.encode())
         self.__session = h.hexdigest()
+        # From description + tags to JSON format
+        d=dict()
+        if description:
+            d['description'] = description
+        for tag in tags:
+            if type(tag) is str:
+                _tag_info = tag.split('=', 1)
+                d[_tag_info[0]] = _tag_info[1]
+            else:
+                for sub_tag in tag:
+                    _tag_info = subtag.split('=', 1)
+                    d[_tag_info[0]] = _tag_info[1]
+        description = json.dumps(d)
         # Now get memory usage base and create the database
         self.prepare()
         self.set_environment_info(ExecutionContext())