Introducing EmptyElement to avoid showing "invalid" elements on diagrams #232
Conversation
pytm/pytm.py
Outdated
|
|
||
| def __init__(self): | ||
| super().__init__("AutoGenerated", description="Autogenerated element for Finding") | ||
| self._is_drawn = True # Prevent drawing on a DFD diagram |
There was a problem hiding this comment.
This seems backwards. I have not checked yet, but if this is correct it should be refactored to represent the intention better.
There was a problem hiding this comment.
Ahh after reading the code and your comment self._is_drawn is an indicator to mark if the element has already been drawn.
I read it as "is it supposed to be drawn" . So I was just confused by the name.
But now I wonder if it is necessary as a member variable at all and if it could be moved into a drawing function. But this would require a mayor change I guess, since the drawing is split between all the dfd methods. I mean they are very similar and have duplicated code.
There was a problem hiding this comment.
I can exclude this element from drawing procedure using if clause (like if not isinstance(e, EmptyElement) )...
Or introduce a variable and appropriate function/property like def is_visible()
Just tell me what is better to do in your opinion!
pytm/pytm.py
Outdated
| @@ -1016,7 +1016,7 @@ def seq(self): | |||
| participants.append( | |||
| 'database {0} as "{1}"'.format(e._uniq_name(), e.display_name()) | |||
| ) | |||
| elif not isinstance(e, Dataflow) and not isinstance(e, Boundary): | |||
| elif not any((isinstance(e, Dataflow), isinstance(e, Boundary), isinstance(e, EmptyElement))): | |||
There was a problem hiding this comment.
You can use isinstance with a tuple of types.
instance(e, (A,B,C))
oleh-mykytyuk
force-pushed
the
add_fake_element
branch
from
3d063a3
to
64e13e1
Compare
|
Included this situation in tests |
- added EmptyElement - skipped generation EmptyElement on DFD and SEQ diagrams
oleh-mykytyuk
force-pushed
the
add_fake_element
branch
from
64e13e1
to
9d36821
Compare
|
hey, thanks for the PR. I am a bit full this week but will be taking a look asap. |
Greetings! Sorry for disturbing, but how about this PR? |
|
sorry, still prioritizing work, but i have not forgotten this! |
In the issue #222 was mentioned creation of the spurious "invalid" elements. Also, in the PR #223 tried to override the name of auto-generated elements.
This PR goal is to skip using "invalid" elements on DFD and SEQ diagrams. Such elements can be a problem when a lot of Finding used for overriding findings (add additional information to the threats). This approach is mentioned in the official documentation (README file), but leads to problems on the diagrams.
What is done: