Moved the model context from the TM class into the TM object #175

raphaelahrens · 2021-09-23T09:01:25Z

To make it possible to import other models into the current model
without adding all elements the elements of the model are now stored in
the TM object and not the class.

I addition I added some test models to check how they differ between each other and between the current master branch.
But the result of the models have to be compared manual, because the UUID and the order often differ even though the resulting report and the diagrams are similar. Maybe it is possible to automate this process more.

Since I can only do manual checking it would be good if someone else checked if this PR is not changing the original behavior.

izar · 2021-09-23T12:56:47Z

@nineinchnick you're WAY better at this stuff than I am, do you mind taking a look?

nineinchnick · 2021-09-28T20:51:03Z

I'll try tomorrow, I just rebased #75, and that took like 2 hours so I'm spent.

ghost · 2021-10-02T04:36:43Z

CodeSee Review Map:

Review in an interactive map

View more CodeSee Maps

Legend

raphaelahrens · 2021-10-05T10:03:32Z

@nineinchnick I wanted to ask what the opinion is about this PR?
Is it worth keeping it up to date with master?

nineinchnick · 2021-10-05T10:14:31Z

@nineinchnick I wanted to ask what the opinion is about this PR? Is it worth keeping it up to date with master?

Sorry, it's rather big and I'm struggling to find time to review it as a whole, not just nitpicking.

In the description you mentioned something about UUIDs being different and having to do manual tests. Can you try using random.seed(0)? We won't accept this without automated tests.

raphaelahrens · 2021-10-05T20:32:17Z

Yes I do set the seed to zero with import norandom.
The issue is the order in which the elements are created.
For example the test files test0.py and test1.py produce the same model. But the order of the element creation differs. To then check if the models are the same I have to manually look at the diff to see that the uuids are switched.

Maybe you can just ignore the commit with my test cases 623d1f5
They might only be useful to me.

raphaelahrens · 2021-10-08T20:18:21Z

I added some unit tests which are similar to the original tests.
While doing this I also found out that it is no longer necessary to set random.seed(0), see 3c0267a.

But still as soon as the creation order differs the uuids will change, which is rather annoying when comparing two threat models that are the same except for the import. See diff seq.plantuml import_data/seq.plantuml for example.

raphaelahrens · 2022-02-18T09:44:38Z

Hi,

should I close the PR?

izar · 2022-02-18T17:11:43Z

Sorry, it looks like we are all busy with life I am looking for @nineinchnick 's review, but he seems to be unable at this time. Let's wait a bit more for his chiming in before we decide where this goes.

…late and updated documentation

…ar to existing logic for json.

To make it possible to import other models into the current model without adding all elements the elements of the model are now stored in the TM object and not the class.

To add the imported elements and data objects it is necessary to figure out which elements an attributes are not part of the current TM. For this `TM._add_imported_elements(self)` collects all elements and data objects which are used by all `Dataflows` and then gets the difference between the set of elements found in the flows and the set of elements defined in the TM. The result of `TM._add_imported_elements(self)` is merged by just adding the imported elements to the lists * `tm._actors` * `tm._assets` * `tm._boundaries` * `tm._data` * `tm._elements` The behavior of `TM._add_imported_elements(self)` is very similar to `_get_elements_and_boundaries(flows)`, only that `_add_imported_elements` also needs to check if there are instances of Data, Actor and Asset to add them to the specific list.

I hopes this would return more comparable results, but the oder of the elements and there given uuid is affect by the creation time. So the diffs need to be checked manually. My make skills are a bit rusty so the make files might not be very portable.

While keeping uptodaate with master some changes needed to be adjusted to use the TM objects instead of the class

Added unit tests with models which import a test module

izar · 2022-04-28T20:17:35Z

Hi @raphaelahrens - I think this got superseded by #190 - please let me know if that's not the case..

raphaelahrens · 2022-04-29T05:23:03Z

Hi,

the problem is the commit is all over the place and keeping it in sync with upstream requires to much time.

It will be easier to start fresh.

izar · 2022-10-11T09:06:04Z

Got it.

…

On Fri, Apr 29, 2022, 01:23 Raphael Ahrens ***@***.***> wrote: Hi, the problem is the commit is all over the place an keeping it in sync with upstream requires to much time. It will be easier to start fresh. — Reply to this email directly, view it on GitHub <#175 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAC2BAO45RXZZUOGPGGK6LDVHNW4DANCNFSM5ETFVLZA> . You are receiving this because your review was requested.Message ID: ***@***.***>

raphaelahrens requested a review from izar as a code owner September 23, 2021 09:01

raphaelahrens mentioned this pull request Sep 23, 2021

Remove usage of global attributes #75

Closed

izar requested review from nineinchnick and removed request for izar September 23, 2021 12:56

raphaelahrens force-pushed the object_context branch from f0f1922 to 6afea2d Compare September 23, 2021 13:34

raphaelahrens force-pushed the object_context branch from 6afea2d to 9d34ad6 Compare October 2, 2021 04:34

raphaelahrens force-pushed the object_context branch from 9d34ad6 to 4ec286b Compare October 5, 2021 09:58

raphaelahrens closed this Oct 5, 2021

raphaelahrens reopened this Oct 5, 2021

nozmore-vera and others added 12 commits April 28, 2022 21:44

Added output encoding for each Elements findings data

530a1e5

Updated object copy logic to allow tests to pass

a487115

Added a list of global assumptions about the design/model.

c356509

Added assumption in sample tm, added visibility in sample report temp…

8a56f28

…late and updated documentation

Updated test data.

7b4da5b

Updated report test to write the generated report file to disk, simil…

3dd076b

…ar to existing logic for json.

Fixed excluded threat IDs being ignored

5f29638

Add unittest for excluded threat IDs

520b4d4

Reset '_threatsExcluded' when calling TM.reset()

dc917a0

Moved the model context from the TM class into the TM object

5381e83

To make it possible to import other models into the current model without adding all elements the elements of the model are now stored in the TM object and not the class.

raphaelahrens added 2 commits April 28, 2022 21:45

Fixed merged in uses of TM

a46055b

While keeping uptodaate with master some changes needed to be adjusted to use the TM objects instead of the class

Added Unit tests

6429930

Added unit tests with models which import a test module

raphaelahrens force-pushed the object_context branch from 32256bb to 6429930 Compare April 28, 2022 19:48

raphaelahrens closed this Apr 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Moved the model context from the TM class into the TM object #175

Moved the model context from the TM class into the TM object #175

raphaelahrens commented Sep 23, 2021 •

edited

Loading

izar commented Sep 23, 2021

nineinchnick commented Sep 28, 2021

ghost commented Oct 2, 2021 •

edited by ghost

Loading

raphaelahrens commented Oct 5, 2021 •

edited

Loading

nineinchnick commented Oct 5, 2021

raphaelahrens commented Oct 5, 2021

raphaelahrens commented Oct 8, 2021

raphaelahrens commented Feb 18, 2022

izar commented Feb 18, 2022

izar commented Apr 28, 2022

raphaelahrens commented Apr 29, 2022 •

edited

Loading

izar commented Oct 11, 2022 via email

Moved the model context from the TM class into the TM object #175

Moved the model context from the TM class into the TM object #175

Conversation

raphaelahrens commented Sep 23, 2021 • edited Loading

izar commented Sep 23, 2021

nineinchnick commented Sep 28, 2021

ghost commented Oct 2, 2021 • edited by ghost Loading

CodeSee Review Map:

Legend

raphaelahrens commented Oct 5, 2021 • edited Loading

nineinchnick commented Oct 5, 2021

raphaelahrens commented Oct 5, 2021

raphaelahrens commented Oct 8, 2021

raphaelahrens commented Feb 18, 2022

izar commented Feb 18, 2022

izar commented Apr 28, 2022

raphaelahrens commented Apr 29, 2022 • edited Loading

izar commented Oct 11, 2022 via email

raphaelahrens commented Sep 23, 2021 •

edited

Loading

ghost commented Oct 2, 2021 •

edited by ghost

Loading

raphaelahrens commented Oct 5, 2021 •

edited

Loading

raphaelahrens commented Apr 29, 2022 •

edited

Loading