add is_sdo() et al functions #483

chisholm · 2021-01-21T02:05:55Z

Fixes #450

Other changes include:

Added many unit tests to test the new is_sdo() et al functions
stix2.version._detect_spec_version() is moved to stix2.utils.detect_spec_version(), to resolve a circular import problem. And it could be thought of as a general utility function anyway.
add stix2.registry.class_for_type(). This gives a nicer way to look up a stix2 library class from a STIX type string. This factored out some code from the versioning module, and is generally useful anywhere classes need to be looked up.
Change the internal class mapping data structure to be keyed at the top level by version strings in "X.Y" syntax, which is used by all public APIs, not the "vXY" syntax used for the python packages. This allows us to eliminate nearly all the ugly code which translated between the two syntaxes. All dependent code in this library is updated accordingly.
Update stix2.versioning.new_version() to enforce ID contributing property restrictions when versioning dicts (not just parsed stix2 objects).
Update stix2.versioning.new_version() to make use of the is_*() functions to simplify implementation and make it more readable
added unit tests for stix2.versioning.new_version() which exercise code which ensures callers can't change ID contributing properties of 2.1 SCOs when creating a new version.
Update stix2.parsing to make use of the new class_for_type() function, to simplify implementation and make it more readable
Remove some ugly python2 compatibility code from stix2.versioning

while I address circular import problems.

circular import refactoring. I think I just forgot to include this in the previous commit...

really just a simple accessor into the class maps table), and change other code to use it, in places where it was simple and made sense.

since this *is* in the stix2 library!

level with STIX versions in the same format as is used everywhere else in the API: "X.Y", as opposed to the "vXY" format used by the version-specific python packages. This eliminates all of the awkward conversion from public API format to "vXX" format. Also a little bit of code rearranging in the registration module to ensure that some STIX 2.1-specific checks are done whether version 2.1 is given explicitly or is defaulted to. In the same module I also added a missing import of stix2.properties, since my IDE was claiming it could not find a function from that module.

class map structure is keyed by normal "X.Y" style versions, the convenience that function provided is no longer necessary. So it no longer makes sense to have the function (at least, not for that reason). Change users of that function to use the STIX2_OBJ_MAPS structure directly.

and I probably forgot some stuff...

dict/mapping values: do a simple verification of the value's STIX version, not just its type. Added a lot more unit tests to test behavior on dicts. To make the implementation work, I had to move the detect_spec_version() function out of the parsing module and into utils. So that required small changes at all its previous call sites.

functions. Changed some ">= 2.1" stix version semantics to be "== 2.1", because we don't have any version >= 2.1, so they are currently equivalent, and the is_*() functions don't support STIX version ranges. They only support exact versions. We can look at this again if a newer STIX version ever emerges. Also added a class_for_type() function to the registry module, which was useful for the versioning module changes described above. I thought that function would be helpful in the parsing module, to simplify code there, so I changed that module a bit to use it.

properties of a 2.1 SCO with UUIDv5 ID, when creating a new version.

class in the registry when you have an instance of one of those classes. Because in that case, you can just get the class of the instance and not deal with the registry at all.

module, since we no longer support python2.

clenk

Looks good! Just a couple comments.

stix2/utils.py

update to is_sro() as well, so it doesn't talk as if you can register custom SROs. That didn't actually make sense.

stix2.core module.

stix2/utils.py

codecov-io · 2021-01-29T03:56:03Z

Codecov Report

Merging #483 (3878788) into master (03b3423) will increase coverage by 0.03%.
The diff coverage is 90.50%.

@@            Coverage Diff             @@
##           master     #483      +/-   ##
==========================================
+ Coverage   89.27%   89.31%   +0.03%     
==========================================
  Files         146      147       +1     
  Lines       16032    16245     +213     
==========================================
+ Hits        14313    14509     +196     
- Misses       1719     1736      +17

Impacted Files	Coverage Δ
stix2/registry.py	`22.22% <47.05%> (+22.22%)`	⬆️
stix2/registration.py	`81.17% <72.72%> (-0.85%)`	⬇️
stix2/utils.py	`78.74% <83.69%> (+5.41%)`	⬆️
stix2/versioning.py	`82.29% <90.47%> (+1.48%)`	⬆️
stix2/parsing.py	`80.00% <91.66%> (-4.32%)`	⬇️
stix2/properties.py	`74.33% <100.00%> (-0.07%)`	⬇️
stix2/test/test_spec_version_detect.py	`100.00% <100.00%> (ø)`
stix2/test/test_utils_type_checks.py	`100.00% <100.00%> (ø)`
stix2/test/v20/test_custom.py	`100.00% <100.00%> (ø)`
stix2/test/v20/test_parsing.py	`100.00% <100.00%> (ø)`
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 03b3423...3878788. Read the comment docs.

clenk

Thanks, @chisholm!

chisholm added 16 commits January 20, 2021 16:59

WIP adding is_sdo() et al functions to this library. On hold

fa6cff8

while I address circular import problems.

Fix to an import statement which was necessary due to the

5193723

circular import refactoring. I think I just forgot to include this in the previous commit...

Add unit tests for the is_*() utility type checking functions.

0f2ce0a

Move get_stix2_class_maps() from .utils to .registry (since it's

2430762

really just a simple accessor into the class maps table), and change other code to use it, in places where it was simple and made sense.

Remove a "this needs to be moved into the stix2 library" comment,

188f704

since this *is* in the stix2 library!

Fix silly docstring copy-paste typo

bf284d0

Fixups after a rebase. There were several conflict resolutions

f8c86f7

and I probably forgot some stuff...

Add some unit tests for attempting to change ID contributing

5aadf1a

properties of a 2.1 SCO with UUIDv5 ID, when creating a new version.

A minor revision to stix2.versioning: it's silly to look up a

92a478b

class in the registry when you have an instance of one of those classes. Because in that case, you can just get the class of the instance and not deal with the registry at all.

pre-commit stylistic fixes

38067a6

Remove some ugly python2 compatibilty code from stix2.versioning

404fcd0

module, since we no longer support python2.

pre-commit stylistic fixes

f9b9e0d

emmanvg added this to the 3.0.0 milestone Jan 22, 2021

clenk reviewed Jan 28, 2021

View reviewed changes

stix2/utils.py Show resolved Hide resolved

stix2/utils.py Outdated Show resolved Hide resolved

chisholm added 3 commits January 27, 2021 22:25

Fix docstring typo in is_marking(). Made a minor docstring

eead72a

update to is_sro() as well, so it doesn't talk as if you can register custom SROs. That didn't actually make sense.

Remove old compatibility code regarding importing the old

83abf78

stix2.core module.

pre-commit stylistic fix

98b0b2e

clenk reviewed Jan 29, 2021

View reviewed changes

stix2/utils.py Outdated Show resolved Hide resolved

Update is_sro docstring

3878788

clenk approved these changes Jan 29, 2021

View reviewed changes

clenk merged commit 5e2d888 into oasis-open:master Jan 29, 2021

chisholm deleted the is_functions branch January 29, 2021 04:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add is_sdo() et al functions #483

add is_sdo() et al functions #483

chisholm commented Jan 21, 2021

clenk left a comment

codecov-io commented Jan 29, 2021 •

edited

Loading

clenk left a comment

add is_sdo() et al functions #483

add is_sdo() et al functions #483

Conversation

chisholm commented Jan 21, 2021

clenk left a comment

Choose a reason for hiding this comment

codecov-io commented Jan 29, 2021 • edited Loading

Codecov Report

clenk left a comment

Choose a reason for hiding this comment

codecov-io commented Jan 29, 2021 •

edited

Loading