Change default analysis scope (#16)

* PM #13 - Set function as default analysis scope. Docs updated accordingly

docs/sources/changelog.rst

@@ -2,6 +2,9 @@
 Changelog
 =========
 
+* :release:`1.2.0 <2020-04-17>`
+* :feature:`13` Change default analysis scope to function.
+
 * :release:`1.1.1 <2020-03-31>`
 * :bug:`9` Fix remote server interface for sending measures.
 

docs/sources/configuration.rst

@@ -9,7 +9,7 @@ Scope Restriction
 -----------------
 
 `pytest-monitor` is able to restrict the scope of the analysis. As a default, 
-any test object discovered by pytest is monitored (test functions and test classes).
+only tests functions discovered by pytest are monitored.
 
 Sometime, you might want to monitor a whole module or test session. This can be
 achieved thanks to the *\-\-restrict-scope-to* option. 

pytest_monitor/pytest_monitor.py

@@ -23,7 +23,7 @@
 
 def pytest_addoption(parser):
     group = parser.getgroup('monitor')
-    group.addoption('--restrict-scope-to', dest='mtr_scope', default='function,module',
+    group.addoption('--restrict-scope-to', dest='mtr_scope', default='function',
                     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')

tests/test_monitor.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import pathlib
+import pytest
 import sqlite3
 
 
@@ -32,7 +33,7 @@ def test_ok():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 2 == len(cursor.fetchall())  # current test + test_ok
+    assert 1 == len(cursor.fetchall())  # current test
 
 
 def test_monitor_pytest_skip_marker(testdir):
@@ -99,7 +100,7 @@ def test_ok():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 2 == len(cursor.fetchall())  # current test + test_ok
+    assert 1 == len(cursor.fetchall())  # current test
 
 
 def test_monitor_skip_module(testdir):
@@ -136,7 +137,7 @@ def test_another_function_ok_not_monitored():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 1 == len(cursor.fetchall())  # current test + test_ok
+    assert not len(cursor.fetchall())  # Nothing ran
 
 
 def test_monitor_skip_test(testdir):
@@ -170,7 +171,7 @@ def test_not_monitored():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 1 == len(cursor.fetchall())  # current test + test_ok
+    assert not len(cursor.fetchall())  # nothing monitored
 
 
 def test_monitor_skip_test_if(testdir):
@@ -213,4 +214,4 @@ def test_monitored():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 2 == len(cursor.fetchall())  # current test + test_monitored
+    assert 1 == len(cursor.fetchall())

tests/test_monitor_component.py

@@ -34,7 +34,7 @@ def test_ok():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 2 == len(cursor.fetchall())  # current test + test_ok
+    assert 1 == len(cursor.fetchall())
     cursor.execute("SELECT ITEM FROM TEST_METRICS WHERE COMPONENT != '' AND ITEM LIKE '%test_ok';")
     assert not len(cursor.fetchall())
 
@@ -55,7 +55,7 @@ def test_force_ok():
 """)
 
     # run pytest with the following cmd args
-    result = testdir.runpytest('--force-component','my_component', '-v')
+    result = testdir.runpytest('--force-component', 'my_component', '-v')
 
     # fnmatch_lines does an assertion internally
     result.stdout.fnmatch_lines(['*::test_force_ok PASSED*'])
@@ -69,7 +69,7 @@ def test_force_ok():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 2 == len(cursor.fetchall())  # current test + test_ok
+    assert 1 == len(cursor.fetchall())
     cursor.execute("SELECT ITEM FROM TEST_METRICS"
                    " WHERE COMPONENT == 'my_component' AND ITEM LIKE '%test_force_ok%';")
     assert 1 == len(cursor.fetchall())
@@ -106,10 +106,10 @@ def test_prefix_ok():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 2 == len(cursor.fetchall())  # current test + test_ok
+    assert 1 == len(cursor.fetchall())
     cursor.execute("SELECT ITEM FROM TEST_METRICS"
                    " WHERE COMPONENT == 'my_component' AND ITEM LIKE '%test_prefix_ok%';")
-    assert 0 == len(cursor.fetchall())
+    assert not len(cursor.fetchall())
     cursor.execute("SELECT ITEM FROM TEST_METRICS"
                    " WHERE COMPONENT == 'my_component.internal' AND ITEM LIKE '%test_prefix_ok%';")
     assert 1 == len(cursor.fetchall())
@@ -145,7 +145,7 @@ def test_prefix_ok():
     db = sqlite3.connect(str(pymon_path))
     cursor = db.cursor()
     cursor.execute('SELECT ITEM FROM TEST_METRICS;')
-    assert 2 == len(cursor.fetchall())  # current test + test_ok
+    assert 1 == len(cursor.fetchall())
     cursor.execute("SELECT ITEM FROM TEST_METRICS"
                    " WHERE COMPONENT == 'my_component' AND ITEM LIKE '%test_prefix_ok%';")
     assert 1 == len(cursor.fetchall())