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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
|
from ford.fortran_project import Project
from ford import ProjectSettings
from ford.graphs import graphviz_installed, GraphManager
import ford.sourceform
from ford._markdown import MetaMarkdown
from ford.settings import INTRINSIC_MODS
from textwrap import dedent
from typing import Dict
import pytest
from bs4 import BeautifulSoup
def create_project(settings: ProjectSettings):
project = Project(settings)
md = MetaMarkdown(project=project)
project.markdown(md)
project.correlate()
return project
project_graphs: Dict[str, GraphManager] = {}
@pytest.fixture(scope="module")
def make_project_graphs(tmp_path_factory, request):
data = """\
module a
end module a
module b
use a
end module b
module c
use b
use iso_fortran_env
use external_mod
type base
end type base
type, extends(base) :: derived
end type derived
type, extends(derived) :: leaf
type(external_type) :: component
end type leaf
type thing
type(derived) :: part
end type thing
type alpha
contains
procedure :: five
procedure :: six
procedure :: ei => eight
procedure :: ni => nine
procedure :: ten
generic :: eight_nine => ei, ni
end type alpha
private :: ten
interface
subroutine defined_elsewhere
end subroutine
module subroutine submod_proc
end subroutine
end interface
contains
subroutine one
end subroutine one
subroutine two
call one
end subroutine two
subroutine five
end subroutine five
function six(this) result(res)
real :: res
res = 1
end function six
subroutine seven
contains
call seven_one
call seven_two
subroutine seven_one
call seven_two
end subroutine seven_one
subroutine seven_two
call one
end subroutine seven_two
end subroutine seven
subroutine eight(this,x)
class(alpha) :: this
real :: x
end subroutine eight
subroutine nine(this,x)
class(alpha) :: this
integer :: x
end subroutine nine
subroutine ten(this)
class(alpha) :: this
end subroutine then
end module c
submodule (c) c_submod
end submodule c_submod
submodule (c:c_submod) c_subsubmod
!! display: private
contains
module subroutine submod_proc
end subroutine
end submodule c_subsubmod
program foo
use c
call three
real :: x
type(alpha) :: y
call y%five()
x = y%six()
call y%ei(1.0)
call y%eight_nine(1.0)
call y%ten()
contains
subroutine three
use external_mod
call one
call two
call two
call other_sub
end subroutine three
recursive subroutine four
call four
end subroutine four
end program foo
"""
# check if we've already created the graphs for this test
request_params = getattr(request, "param", {})
proc_internals = request_params.get("proc_internals", False)
if f"proc_internals_{proc_internals}" in project_graphs:
yield project_graphs[f"proc_internals_{proc_internals}"]
return
src_dir = tmp_path_factory.getbasetemp() / "graphs" / "src"
src_dir.mkdir(exist_ok=True, parents=True)
full_filename = src_dir / "test.f90"
with open(full_filename, "w") as f:
f.write(dedent(data))
settings = ProjectSettings(
src_dir=src_dir, graph=True, proc_internals=proc_internals
)
project = create_project(settings)
graphs = GraphManager(
graphdir="",
parentdir="..",
coloured_edges=True,
show_proc_parent=proc_internals,
)
for entity_list in [
project.types,
project.procedures,
project.submodprocedures,
project.modules,
project.submodules,
project.programs,
project.files,
project.blockdata,
]:
for item in entity_list:
graphs.register(item)
graphs.graph_all()
graphs.output_graphs(0)
# save graphs for future use
project_graphs[f"proc_internals_{proc_internals}"] = graphs
yield graphs
# reset namelist so it doesn't affect future generated graphs
ford.sourceform.namelist = ford.sourceform.NameSelector()
MOD_GRAPH_KEY = ["Module", "Submodule", "Subroutine", "Function", "Program"]
PROC_GRAPH_KEY = [
"Subroutine",
"Function",
"Interface",
"Type Bound Procedure",
"Unknown Procedure Type",
"Program",
]
TYPE_GRAPH_KEY = ["Type"]
@pytest.mark.skipif(not graphviz_installed, reason="Requires graphviz")
@pytest.mark.parametrize(
(
"make_project_graphs",
"graph_name",
"expected_nodes",
"expected_edges",
"expected_legend_nodes",
),
[
(
{"proc_internals": False},
["usegraph"],
[
"a",
"b",
"c",
"c_submod",
"c_subsubmod",
"iso_fortran_env",
"external_mod",
"three",
"foo",
],
[
"module~b->module~a",
"module~c->module~b",
"module~c->iso_fortran_env",
"module~c->external_mod",
"module~c_submod->module~c",
"module~c_subsubmod->module~c_submod",
"proc~three->external_mod",
"program~foo->module~c",
],
MOD_GRAPH_KEY,
),
(
{"proc_internals": False},
["callgraph"],
[
"defined_elsewhere",
"submod_proc",
"submod_proc",
"one",
"three",
"two",
"four",
"other_sub",
"foo",
"alpha%five",
"alpha%six",
"seven",
"alpha%eight",
"alpha%nine",
"alpha%eight_nine",
"alpha%ten",
],
[
"proc~three->proc~one",
"proc~three->proc~two",
"proc~two->proc~one",
"proc~three->other_sub",
"program~foo->proc~three",
"proc~four->proc~four",
"program~foo->proc~five",
"program~foo->proc~six",
"proc~seven->proc~one",
"program~foo->proc~eight",
"program~foo->none~eight_nine",
"none~eight_nine->proc~eight",
"none~eight_nine->proc~nine",
"interface~submod_proc->proc~submod_proc",
"program~foo->none~ten",
],
PROC_GRAPH_KEY,
),
(
{"proc_internals": True},
["callgraph"],
[
"c::defined_elsewhere",
"c::submod_proc",
"c_subsubmod::submod_proc",
"c::one",
"foo::three",
"c::two",
"foo::four",
"other_sub",
"foo",
"c::alpha%five",
"c::alpha%six",
"c::seven",
"seven::seven_one",
"seven::seven_two",
"c::alpha%eight",
"c::alpha%nine",
"c::alpha%eight_nine",
"c::alpha%ten",
],
[
"proc~three->proc~one",
"proc~three->proc~two",
"proc~two->proc~one",
"proc~three->other_sub",
"program~foo->proc~three",
"proc~four->proc~four",
"program~foo->proc~five",
"program~foo->proc~six",
"proc~seven->none~seven_one",
"proc~seven->none~seven_two",
"none~seven_one->none~seven_two",
"none~seven_two->proc~one",
"program~foo->proc~eight",
"program~foo->none~eight_nine",
"none~eight_nine->proc~eight",
"none~eight_nine->proc~nine",
"interface~submod_proc->proc~submod_proc",
"program~foo->none~ten",
],
PROC_GRAPH_KEY,
),
(
{"proc_internals": False},
["typegraph"],
["base", "derived", "leaf", "external_type", "thing", "alpha"],
[
"type~leaf->type~derived",
"type~derived->type~base",
"type~leaf->external_type",
"type~thing->type~derived",
],
TYPE_GRAPH_KEY,
),
(
{"proc_internals": False},
["modules", "b", "usesgraph"],
["a", "b"],
["module~b->module~a"],
MOD_GRAPH_KEY,
),
(
{"proc_internals": False},
["modules", "b", "usedbygraph"],
["b", "c", "c_submod", "c_subsubmod", "foo"],
[
"module~c->module~b",
"module~c_submod->module~c",
"module~c_subsubmod->module~c_submod",
"program~foo->module~c",
],
MOD_GRAPH_KEY,
),
(
{"proc_internals": False},
["types", "derived", "inhergraph"],
["base", "derived"],
["type~derived->type~base"],
TYPE_GRAPH_KEY,
),
(
{"proc_internals": False},
["types", "derived", "inherbygraph"],
["derived", "leaf", "thing"],
["type~leaf->type~derived", "type~thing->type~derived"],
TYPE_GRAPH_KEY,
),
(
{"proc_internals": False},
["procedures", "two", "callsgraph"],
["one", "two"],
["proc~two->proc~one"],
PROC_GRAPH_KEY,
),
(
{"proc_internals": True},
["procedures", "seven", "callsgraph"],
["c::seven", "c::one", "seven::seven_one", "seven::seven_two"],
[
"proc~seven->none~seven_one",
"proc~seven->none~seven_two",
"none~seven_one->none~seven_two",
"none~seven_two->proc~one",
],
PROC_GRAPH_KEY,
),
(
{"proc_internals": False},
["procedures", "two", "calledbygraph"],
["three", "two", "foo"],
["proc~three->proc~two", "program~foo->proc~three"],
PROC_GRAPH_KEY,
),
(
{"proc_internals": False},
["procedures", "three", "usesgraph"],
["external_mod", "three"],
["proc~three->external_mod"],
MOD_GRAPH_KEY,
),
(
{"proc_internals": True},
[
"procedures",
# This is awful, but both the interface and the
# implementation have the same name, so we need to
# further disambiguate them
{"name": "submod_proc", "proctype": "Interface"},
"callsgraph",
],
["c::submod_proc", "c_subsubmod::submod_proc"],
[
"interface~submod_proc->proc~submod_proc",
],
PROC_GRAPH_KEY,
),
],
indirect=["make_project_graphs"],
)
def test_graphs(
make_project_graphs,
graph_name,
expected_nodes,
expected_edges,
expected_legend_nodes,
):
graphs = make_project_graphs
# Get the graph we want from the graph manager. This might be a
# top-level graph, showing an overview of the project, or it might
# be a graph for a particular object. In the latter case, we need
# to also find the object from the appropriate collection
if len(graph_name) == 1:
graph = getattr(graphs, graph_name[0])
else:
collection, properties, name = graph_name
if isinstance(properties, str):
properties = {"name": properties}
for g in sorted(getattr(graphs, collection)):
if properties == {attr: getattr(g, attr, None) for attr in properties}:
break
graph = getattr(g, name)
soup = BeautifulSoup(str(graph), features="html.parser")
# Get nodes and edges just in the graph, and not in the legend
node_names = [s.find("text").text for s in soup.svg.find_all("g", class_="node")]
edge_names = [s.title.text for s in soup.svg.find_all("g", class_="edge")]
assert sorted(node_names) == sorted(expected_nodes)
assert sorted(edge_names) == sorted(expected_edges)
svgs = soup.find_all("svg")
assert len(svgs) == 2, "Graph and legend"
legend = svgs[1]
legend_nodes = [s.title.text for s in legend.find_all("g", class_="node")]
assert legend_nodes == expected_legend_nodes + ["This Page's Entity"]
assert legend.find_all("g", class_="edge") == []
@pytest.mark.skipif(not graphviz_installed, reason="Requires graphviz")
def test_external_module_links(make_project_graphs):
graphs = make_project_graphs
soup = BeautifulSoup(str(graphs.usegraph), features="html.parser")
iso_fortran_env_node = soup.find(string="iso_fortran_env").parent.parent
link = iso_fortran_env_node.a["xlink:href"]
assert link == INTRINSIC_MODS["iso_fortran_env"]
def test_graphs_as_table(tmp_path):
data = """\
program foo
contains
subroutine one
end subroutine one
subroutine a
call one()
end subroutine a
subroutine b
call one()
end subroutine b
subroutine c
call one()
end subroutine c
subroutine d
call one()
end subroutine d
subroutine e
call one()
end subroutine e
subroutine f
call one()
end subroutine f
subroutine g
call one()
end subroutine g
subroutine h
call one()
end subroutine h
end program foo
"""
src_dir = tmp_path / "graphs" / "src"
src_dir.mkdir(exist_ok=True, parents=True)
full_filename = src_dir / "test.f90"
with open(full_filename, "w") as f:
f.write(dedent(data))
settings = ProjectSettings(src_dir=src_dir, graph=True, graph_maxnodes=4)
project = create_project((settings))
graphs = GraphManager(
graphdir="", parentdir="..", coloured_edges=True, show_proc_parent=True
)
for entity_list in [
project.procedures,
project.programs,
]:
for item in entity_list:
graphs.register(item)
graphs.graph_all()
graphs.output_graphs(0)
for graph in graphs.procedures:
if graph.name == "one":
break
graph = graph.calledbygraph
soup = BeautifulSoup(str(graph), features="html.parser")
node_names = sorted([n.text for n in soup.table.find_all(class_="node")])
num_arrows = len(soup.table.find_all(class_="triangle-right"))
# These are the spacing 'w's
num_ws = len(soup.table.find_all(class_="solidBottom"))
expected_node_names = [
"foo::a",
"foo::b",
"foo::c",
"foo::d",
"foo::e",
"foo::f",
"foo::g",
"foo::h",
]
assert node_names == expected_node_names
assert num_arrows == len(expected_node_names)
assert num_ws == len(expected_node_names)
|