1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
# -*- coding: utf-8 -*-
import json
import os
import re
import tempfile
from contextlib import contextmanager
from io import StringIO
from django.core.management import call_command
from django.core.management.base import CommandError
from django.test import TestCase
def assert_looks_like_dotfile(output):
assert output.startswith("digraph model_graph {\n")
assert output.endswith("}\n")
assert "// Dotfile by Django-Extensions graph_models\n" in output
assert "// Labels\n" in output
assert "// Relations\n" in output
def assert_looks_like_jsonfile(output):
assert '"created_at": ' in output
assert '"cli_options": ' in output
assert '"app_name": "django.contrib.auth"' in output
assert "created_at" in json.loads(output)
@contextmanager
def temp_output_file(extension=""):
"""Create writable tempfile in filesystem and ensure it gets deleted"""
tmpfile = tempfile.NamedTemporaryFile(suffix=extension, delete=False)
tmpfile.close()
yield tmpfile.name
os.unlink(tmpfile.name)
class GraphModelsOutputTests(TestCase):
def test_graph_models_no_output_options(self):
# Given no output-related options, default to output a Dotfile
stdout = StringIO()
call_command("graph_models", all_applications=True, stdout=stdout)
assert_looks_like_dotfile(stdout.getvalue())
def test_graph_models_dot_option_to_stdout(self):
# --dot set but --output not set
stdout = StringIO()
call_command("graph_models", all_applications=True, dot=True, stdout=stdout)
assert_looks_like_dotfile(stdout.getvalue())
def test_graph_models_dot_option_to_file(self):
# --dot set and --output set
stdout = StringIO()
with temp_output_file(".dot") as tmpfname:
call_command(
"graph_models",
all_applications=True,
dot=True,
output=tmpfname,
stdout=stdout,
)
with open(tmpfname, "r") as outfile:
foutput = outfile.read()
assert_looks_like_dotfile(foutput)
assert stdout.getvalue() == ""
def test_graph_models_dot_extensions_to_file(self):
# --dot not set and --output set
stdout = StringIO()
with temp_output_file(".dot") as tmpfname:
call_command(
"graph_models", all_applications=True, output=tmpfname, stdout=stdout
)
with open(tmpfname, "r") as outfile:
foutput = outfile.read()
assert_looks_like_dotfile(foutput)
assert stdout.getvalue() == ""
def test_graph_models_dot_option_trumps_json_file_extension(self):
# --dot set and --output set to filename ending with .json
# assert that --dot option trumps .json file extension
stdout = StringIO()
with temp_output_file(".json") as tmpfname:
call_command(
"graph_models",
all_applications=True,
dot=True,
output=tmpfname,
stdout=stdout,
)
with open(tmpfname, "r") as outfile:
foutput = outfile.read()
assert_looks_like_dotfile(foutput)
assert stdout.getvalue() == ""
def test_graph_models_json_option_to_stdout(self):
# --json set but --output not set
out = StringIO()
call_command("graph_models", all_applications=True, json=True, stdout=out)
output = out.getvalue()
assert_looks_like_jsonfile(output)
def test_graph_models_json_option_to_file(self):
# --dot set and --output set
stdout = StringIO()
with temp_output_file(".json") as tmpfname:
call_command(
"graph_models",
all_applications=True,
json=True,
output=tmpfname,
stdout=stdout,
)
with open(tmpfname, "r") as outfile:
foutput = outfile.read()
assert_looks_like_jsonfile(foutput)
assert stdout.getvalue() == ""
def test_graph_models_pydot_without_file(self):
# use of --pydot requires specifying output file
with self.assertRaises(CommandError):
call_command("graph_models", all_applications=True, pydot=True)
def test_graph_models_pygraphviz_without_file(self):
# use of --pygraphviz requires specifying output file
with self.assertRaises(CommandError):
call_command("graph_models", all_applications=True, pygraphviz=True)
def test_graph_models_relation_fields_only(self):
# use of --relation-fields-only ignores all non-relation-fields
stdout = StringIO()
call_command("graph_models", all_applications=True, stdout=stdout, json=True)
with_no_flag = json.loads(stdout.getvalue())
stdout = StringIO()
call_command(
"graph_models",
all_applications=True,
relation_fields_only=True,
stdout=stdout,
json=True,
)
with_flag = json.loads(stdout.getvalue())
# delete all entries for fields that do not display relations
for graph_idx, graph in reversed(list(enumerate(with_no_flag["graphs"]))):
for model_idx, model in reversed(list(enumerate(graph["models"]))):
for field_idx, field in reversed(list(enumerate(model["fields"]))):
if (
field["type"]
not in ["ForeignKey (id)", "AutoField", "OneToOneField (id)"]
and not field["primary_key"]
):
del with_no_flag["graphs"][graph_idx]["models"][model_idx][
"fields"
][field_idx]
# assert that manually deleting all non-relation-fields is same as using the flag
self.assertEqual(with_no_flag, with_flag)
def test_disable_abstract_fields_not_active():
out = StringIO()
call_command(
"graph_models",
"django_extensions",
include_models=["AbstractInheritanceTestModelChild"],
disable_abstract_fields=False,
stdout=out,
)
output = out.getvalue()
assert "my_field_that_my_child_will_inherit" in output
def test_disable_abstract_fields_active():
out = StringIO()
call_command(
"graph_models",
"django_extensions",
include_models=["AbstractInheritanceTestModelChild"],
disable_abstract_fields=True,
stdout=out,
)
output = out.getvalue()
assert "my_field_that_my_child_will_inherit" not in output
def test_exclude_models_hides_relationships():
"""Expose bug #1229 where excluded models appear in relationships.
They are replaced with an underscore, but the relationship is still there.
"""
out = StringIO()
call_command(
"graph_models",
"django_extensions",
exclude_models=["Personality", "Note"],
stdout=out,
)
output = out.getvalue()
assert "tests_testapp_models_Person -> tests_testapp_models_Name" in output
assert "tests_testapp_models_Person -> _" not in output
def test_hide_edge_labels():
out = StringIO()
call_command(
"graph_models",
"django_extensions",
all_applications=True,
hide_edge_labels=True,
stdout=out,
)
output = out.getvalue()
assert not re.search(r'\[label=\"[a-zA-Z]+"\]', output)
|
