Skip to content

Commit 47a1325

Browse files
author
NyanKiyoshi
authored
Merge pull request #40 from NyanKiyoshi/feature/duplicate-count
Added new field: duplicates -- counts the number of duplicate queries
2 parents b5d543a + 04d7305 commit 47a1325

File tree

15 files changed

+195
-118
lines changed

15 files changed

+195
-118
lines changed

‎CHANGELOG.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
v1.1.0 - June 1st 2019
2+
++++++++++++++++++++++
3+
4+
- The cli tools now display the number of duplicated queries.
5+
6+
17
v1.0.0 - June 7th 2019
28
++++++++++++++++++++++
39

‎README.md‎

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
<a href='https://pypi.python.org/pypi/pytest-django-queries'>
1616
<img src='https://img.shields.io/pypi/v/pytest-django-queries.svg' alt='Version' />
1717
</a>
18-
<a href="https://pypi.org/project/pytest-django-queries/1.0.0/">
19-
<img src="https://img.shields.io/badge/pypi%20unstable-v1.0.0-FF0000.svg" alt="Latest Unstable on pypi">
18+
<a href="https://pypi.org/project/pytest-django-queries/1.1.0/">
19+
<img src="https://img.shields.io/badge/pypi%20unstable-v1.1.0-FF0000.svg" alt="Latest Unstable on pypi">
2020
</a>
2121
</p>
2222
<p>
23-
<a href='https://github.com/NyanKiyoshi/pytest-django-queries/compare/v1.0.0...master'>
24-
<img src='https://img.shields.io/github/commits-since/NyanKiyoshi/pytest-django-queries/v1.0.0.svg' alt='Commits since latest release' />
23+
<a href='https://github.com/NyanKiyoshi/pytest-django-queries/compare/v1.1.0...master'>
24+
<img src='https://img.shields.io/github/commits-since/NyanKiyoshi/pytest-django-queries/v1.1.0.svg' alt='Commits since latest release' />
2525
</a>
2626
<a href='https://pypi.python.org/pypi/pytest-django-queries'>
2727
<img src='https://img.shields.io/pypi/pyversions/pytest-django-queries.svg' alt='Supported versions' />
@@ -117,25 +117,23 @@ django-queries show
117117

118118
You will get something like this to represent the results:
119119
```shell
120-
+---------+-------------------------+
121-
| Module | Tests |
122-
+---------+-------------------------+
123-
| module1 | +-----------+---------+ |
124-
| | | Test Name | Queries | |
125-
| | +-----------+---------+ |
126-
| | | test1 | 0 | |
127-
| | +-----------+---------+ |
128-
| | | test2 | 1 | |
129-
| | +-----------+---------+ |
130-
+---------+-------------------------+
131-
| module2 | +-----------+---------+ |
132-
| | | Test Name | Queries | |
133-
| | +-----------+---------+ |
134-
| | | test1 | 123 | |
135-
| | +-----------+---------+ |
136-
+---------+-------------------------+
137-
| module3 | |
138-
+---------+-------------------------+
120+
+---------+--------------------------------------+
121+
| Module | Tests |
122+
+---------+--------------------------------------+
123+
| module1 | +-----------+---------+------------+ |
124+
| | | Test Name | Queries | Duplicated | |
125+
| | +-----------+---------+------------+ |
126+
| | | test1 | 0 | 0 | |
127+
| | +-----------+---------+------------+ |
128+
| | | test2 | 1 | 0 | |
129+
| | +-----------+---------+------------+ |
130+
+---------+--------------------------------------+
131+
| module2 | +-----------+---------+------------+ |
132+
| | | Test Name | Queries | Duplicated | |
133+
| | +-----------+---------+------------+ |
134+
| | | test1 | 123 | 0 | |
135+
| | +-----------+---------+------------+ |
136+
+---------+--------------------------------------+
139137
```
140138

141139
## Exporting the Results (HTML)

‎VERSION.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.0.0
1+
1.1.0

‎docs/_static/diff_results.png‎

47.5 KB
Loading

‎docs/_static/html_export_results.png‎

85.3 KB
Loading

‎docs/index.rst‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,23 @@ Quick Start
3434

3535
.. code-block:: text
3636
37-
+---------+-------------------------+
38-
| Module | Tests |
39-
+---------+-------------------------+
40-
| module1 | +-----------+---------+ |
41-
| | | Test Name | Queries | |
42-
| | +-----------+---------+ |
43-
| | | test1 | 0 | |
44-
| | +-----------+---------+ |
45-
| | | test2 | 1 | |
46-
| | +-----------+---------+ |
47-
+---------+-------------------------+
48-
| module2 | +-----------+---------+ |
49-
| | | Test Name | Queries | |
50-
| | +-----------+---------+ |
51-
| | | test1 | 123 | |
52-
| | +-----------+---------+ |
53-
+---------+-------------------------+
54-
| module3 | |
55-
+---------+-------------------------+
37+
+---------+--------------------------------------+
38+
| Module | Tests |
39+
+---------+--------------------------------------+
40+
| module1 | +-----------+---------+------------+ |
41+
| | | Test Name | Queries | Duplicated | |
42+
| | +-----------+---------+------------+ |
43+
| | | test1 | 0 | 0 | |
44+
| | +-----------+---------+------------+ |
45+
| | | test2 | 1 | 0 | |
46+
| | +-----------+---------+------------+ |
47+
+---------+--------------------------------------+
48+
| module2 | +-----------+---------+------------+ |
49+
| | | Test Name | Queries | Duplicated | |
50+
| | +-----------+---------+------------+ |
51+
| | | test1 | 123 | 0 | |
52+
| | +-----------+---------+------------+ |
53+
+---------+--------------------------------------+
5654
5755
5. Or for a nicer presentation, use ``django-queries html`` to export the results as HTML. See `this example <./html_export_results.html>`_ for a demo!
5856

‎pytest_django_queries/diff.py‎

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# coding=utf-8
22
from collections import namedtuple
33

4-
from pytest_django_queries.entry import Entry
4+
from pytest_django_queries.entry import Entry # noqa
55
from pytest_django_queries.filters import format_underscore_name_to_human
66

77
_ROW_FIELD = namedtuple("_RowField", ("comp_field", "align_char", "length_field"))
88
_ROW_FIELDS = (
99
_ROW_FIELD("test_name", "<", "test_name"),
1010
_ROW_FIELD("left_count", ">", "query_count"),
1111
_ROW_FIELD("right_count", ">", "query_count"),
12+
_ROW_FIELD("duplicate_count", ">", "duplicate_count"),
1213
)
1314
_ROW_PREFIX = " "
1415
_NA_CHAR = "-"
@@ -18,7 +19,7 @@ def entry_row(entry_comp, lengths):
1819
cols = []
1920

2021
for field, align, length_key in _ROW_FIELDS:
21-
fmt = "{cmp.%s: %s{lengths[%s]}}" % (field, align, length_key)
22+
fmt = "{cmp.%s: %s%d}" % (field, align, lengths[length_key])
2223
cols.append(fmt.format(cmp=entry_comp, lengths=lengths))
2324

2425
return "%(diff_char)s %(results)s" % (
@@ -99,6 +100,14 @@ def left_count(self):
99100
def right_count(self):
100101
return str(self.right.query_count) if self.right else _NA_CHAR
101102

103+
@property
104+
def duplicate_count(self):
105+
if self.right:
106+
return self.right.duplicate_count
107+
elif self.left:
108+
return self.left.duplicate_count
109+
return _NA_CHAR
110+
102111
@property
103112
def diff(self):
104113
return self._diff_from_newest()
@@ -123,31 +132,18 @@ def __init__(self, entries_left, entries_right):
123132

124133
self._mapping = {}
125134
self._generate_mapping()
126-
self.longest_props = self._get_longest_per_prop({"query_count", "test_name"})
135+
self.longest_props = self._get_longest_per_prop()
127136
self.header_rows = get_header_row(lengths=self.longest_props)
128137

129-
def _get_longest_per_prop(self, props):
130-
"""
131-
:param props:
132-
:type props: set
133-
:return:
134-
"""
135-
136-
longest = {prop: 0 for prop in props}
137-
entries = (
138-
self.entries_left
139-
+ self.entries_right
140-
+ [field for field, _, _ in _ROW_FIELDS]
141-
)
138+
def _get_longest_per_prop(self):
139+
longest = {field.length_field: len(field.comp_field) for field in _ROW_FIELDS}
140+
entries = self.entries_left + self.entries_right
142141

143142
for entry in entries:
144-
for prop in props:
145-
if isinstance(entry, Entry):
146-
current_length = len(str(getattr(entry, prop, None)))
147-
else:
148-
current_length = len(entry)
149-
if current_length > longest[prop]:
150-
longest[prop] = current_length
143+
for field in _ROW_FIELDS:
144+
current_length = len(str(getattr(entry, field.comp_field, None)))
145+
if current_length > longest[field.length_field]:
146+
longest[field.length_field] = current_length
151147

152148
return longest
153149

‎pytest_django_queries/entry.py‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
class Entry(object):
55
BASE_FIELDS = [("test_name", "Test Name")]
66
REQUIRED_FIELDS = [("query-count", "Queries")]
7-
FIELDS = BASE_FIELDS + REQUIRED_FIELDS
7+
OPTIONAL_FIELDS = [("duplicates", "Duplicated")]
8+
FIELDS = BASE_FIELDS + REQUIRED_FIELDS + OPTIONAL_FIELDS
89

910
def __init__(self, test_name, module_name, data):
1011
"""
@@ -21,13 +22,23 @@ def __init__(self, test_name, module_name, data):
2122
for field, _ in self.REQUIRED_FIELDS:
2223
setattr(self, field, self._get_required_key(field))
2324

25+
for field, _ in self.OPTIONAL_FIELDS:
26+
setattr(self, field, self._get_key(field, "UNK"))
27+
2428
def __getitem__(self, item):
2529
return getattr(self, item)
2630

2731
@property
2832
def query_count(self):
2933
return self["query-count"]
3034

35+
@property
36+
def duplicate_count(self):
37+
return self["duplicates"]
38+
39+
def _get_key(self, key, default):
40+
return self._raw_data.get(key, default)
41+
3142
def _get_required_key(self, key):
3243
if key in self._raw_data:
3344
return self._raw_data.get(key)

‎pytest_django_queries/plugin.py‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,16 @@ def save_results_to_json(save_path, backup_path, data):
3939
def add_entry(request, queries, dirout):
4040
module_name = request.node.module.__name__
4141
test_name = request.node.name
42+
queries = queries[:]
4243
query_count = len(queries)
44+
duplicate_count = query_count - len(set((q["sql"] for q in queries)))
4345

44-
result_line = "%s\t%s\t%s\n" % (module_name, test_name, query_count)
46+
result_line = "%s\t%s\t%d\t%d\n" % (
47+
module_name,
48+
test_name,
49+
query_count,
50+
duplicate_count,
51+
)
4552
save_path = os.path.join(dirout, get_slaveid(request.config))
4653
if os.path.isfile(save_path):
4754
mode = "a"
@@ -137,10 +144,15 @@ def pytest_unconfigure(config):
137144
if not result_line:
138145
continue
139146

140-
module_name, test_name, query_count = result_line.split("\t")
147+
module_name, test_name, query_count, duplicates = result_line.split(
148+
"\t"
149+
)
141150

142151
module_entries = test_results.setdefault(module_name, {})
143-
module_entries[test_name] = {"query-count": int(query_count)}
152+
module_entries[test_name] = {
153+
"query-count": int(query_count),
154+
"duplicates": int(duplicates),
155+
}
144156

145157
if test_results:
146158
save_results_to_json(

‎pytest_django_queries/templates/default_bootstrap.jinja2‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
<tr>
2626
<th>Benchmark name</th>
2727
<th>Query count</th>
28+
<th>Duplicated count</th>
2829
</tr>
2930
</thead>
3031

@@ -37,10 +38,13 @@
3738
<td>
3839
<strong>{{ test_entry['query-count'] }}</strong>
3940
</td>
41+
<td>
42+
<strong>{{ test_entry.duplicate_count }}</strong>
43+
</td>
4044
</tr>
4145
{% else %}
4246
<tr>
43-
<td colspan="2">
47+
<td colspan="3">
4448
<p>No data.</p>
4549
</td>
4650
</tr>

0 commit comments

Comments
 (0)