cache_create: Extended the command to extract from envelope #155
Conversation
ahasztag
requested review from
tomchy,
SylwesterKonczyk,
robertstypa and
kszromek-nordic
ahasztag
force-pushed
the
NCSDK-28932_hierarchical_cache_create
branch
from
d2c6f52 to
75a8ee7
Compare
ahasztag
force-pushed
the
NCSDK-28932_hierarchical_cache_create
branch
2 times, most recently
from
d138c4b to
05af7e5
Compare
| args = single_input.split(",") | ||
| if len(args) < 2: | ||
| raise ValueError("Invalid number of input arguments: " + single_input) | ||
| uri, input_file = args |
There was a problem hiding this comment.
Please, consider validation of uri's duplication.
There was a problem hiding this comment.
Added such validation
suit_generator/cmd_cache_create.py
Outdated
| raise ValueError("Number of required padding bytes exceeds assumed max size 0xFFFF") | ||
| cmd_cache_create_from_envelope.add_argument( | ||
| "--dependency-regex", | ||
| help="Integrated payloads matching the regular expression will be treated as dependency envelopes and parsed hierarchically." |
There was a problem hiding this comment.
nit: Missing space will result in following output:
--dependency-regex DEPENDENCY_REGEX
Integrated payloads matching the regular expression will be treated as dependency envelopes and parsed hierarchically.The
payloads extracted from the dependency envelopes will be added to the cache.
| else: | ||
| raise GeneratorError("The provided envelope/dependency envelope is not a valid envelope!") | ||
|
|
||
| if dependency_regex is not None: |
There was a problem hiding this comment.
Since --dependency-regex is optional argument user can execute script and ecounter error due to uninitialized integrated_dependencies
There was a problem hiding this comment.
Ok, probably this is better now
suit_generator/cmd_cache_create.py
Outdated
| :param omit_payload_regex: Integrated payloads matching the regular expression will not be extracted to the cache | ||
| :param dependency_regex: Integrated payloads matching the regular expression will be treated as dependency envelopes | ||
| """ | ||
| envelope = cbor2.loads(envelope_data) |
There was a problem hiding this comment.
Data which is not a valid suit envelope can potentialy crash during cbor decoding or (if decoded as non taged structure) during access to envelope.value in line 224.
Example for nordic_top envelope with --dependency-regex ".*sys.*":
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x90 in position 0: invalid start byte
Example for nordic_top envelope with --dependency-regex ".*sec.*":
AttributeError: 'int' object has no attribute 'value'
There was a problem hiding this comment.
Modified error logging so that this results in a hopefully clearer error
| Add a cache slot to the cache from the given URI and data. | ||
|
|
||
| This function creates a cache slot from the given URI and data, and pads the data to align with the specified | ||
| erase block size (eb_size). The first slot in the cache is created with indefinite length CBOR map. |
There was a problem hiding this comment.
I am not sure here but what about last slot - should it include break byte so whole binary length is multiplicity of eb_size (and not bigger by this one break byte)?
There was a problem hiding this comment.
As discussed - the end of map marker 0xFF must be placed in a new erase block.
If the device itself would try to add a new cache slot it would otherwise face a problem - the current end of map marker would have to be removed. This would cause the need to erase the whole previous erase block with data from the previous slot.
Though we might need to waste one erase block (at the end of the cache), this is unavoidable.
ahasztag
force-pushed
the
NCSDK-28932_hierarchical_cache_create
branch
from
05af7e5 to
92e013c
Compare
|
pytest coverage results
Note: This message is automatically posted and updated by the CI (latest/test-sdk-dfu/master/248) |
ahasztag
force-pushed
the
NCSDK-28932_hierarchical_cache_create
branch
3 times, most recently
from
38639bb to
4841671
Compare
ahasztag
force-pushed
the
NCSDK-28932_hierarchical_cache_create
branch
2 times, most recently
from
50da469 to
4342a03
Compare
This commit extends the suit-generator cache_create command. It now has three subcommands: from_payloads, from_envelopei and merge. from_payload has the same functionality as the old version of the cache_create command from_envelope allows extracting payloads directly from the envelope - also with the possibility to parse the envelope hierarchically and omit certain payloads. merge allows to merge multiple cache partition files into one. Ref: NCSDK-28932 Signed-off-by: Artur Hadasz <[email protected]>
ahasztag
force-pushed
the
NCSDK-28932_hierarchical_cache_create
branch
from
4342a03 to
145f904
Compare
This commit extends the suit-generator cache_create command.
It splits it into two commands: from_payloads and from_envelope.
from_payload has the same functionality as the old version of the cache_create command
from_envelope allows extracting payloads directly from the envelope