test: add metadata unit tests #45

ivanayov · 2023-06-09T17:37:56Z

This change adds unit tests for part of the metadata methods.

codecov · 2023-06-12T10:38:50Z

Codecov Report

Patch coverage has no change and project coverage change: +32.24 🎉

Comparison is base (6d84b95) 19.82% compared to head (cc2bfee) 52.06%.

Additional details and impacted files

@@             Coverage Diff             @@
##             main      #45       +/-   ##
===========================================
+ Coverage   19.82%   52.06%   +32.24%     
===========================================
  Files           7        7               
  Lines        1281     1281               
===========================================
+ Hits          254      667      +413     
+ Misses       1017      540      -477     
- Partials       10       74       +64

Flag	Coverage Δ
Go-1.19	`52.06% <ø> (+32.24%)`	⬆️
Go-1.20	`52.06% <ø> (+32.24%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 4 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

metadata/metadata_test.go

rdimitrov

It's a start, but there's still work to be done.

I'd strongly suggest having a look at the existing tests in python-tuf, and tuf-js for inspiration and ideas - that should help you get a better idea of what you should be testing and how the test cases should be organized.

This change adds repository data to use in unit testing, keeping it the same as in python-tuf Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

This change adds a mock for os functions Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

This change implements client simulator for working with local repositories Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

This change adds unit tests for part of the metadata methods Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

This change implements api unit tests for metadata with the same logic as in python-tuf Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

This change fixes go linter error of not checking errors returned by methods in the file system and test client simulators Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

As the `signature` package allows loading keys from RSA PEM files only, the keys and roles from the python-tuf implementation are not suitable for the current implementation. This is why a clean repo is created with new keys in the appropriate format Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

This change adds test coverage for signing and verigying metadata with a pre-set keys Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

This change removes unused keys and test utils for the metadata unit tests. The removed test utils include filesystem simulator, which is replaced by the setup functionality and some tidy-up around the changes Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

This change updates error assertions in the metadata api tests to compare error types rather than only a message Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

ivanayov · 2023-06-30T14:48:10Z

Force-pushed a squash with the fixed roles json an the metadata repository, so that commits between them are not broken.

rdimitrov

I've left several comments on things that need to be addressed but otherwise, it looks great 👍

metadata/metadata_api_test.go

metadata/metadata.go

metadata/metadata_api_test.go

metadata/metadata_test.go

This change provides improvements to the metadata api tests Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com>

* Add test repository data This change adds repository data to use in unit testing, keeping it the same as in python-tuf Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Add file system simulator This change adds a mock for os functions Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Add test client simulator This change implements client simulator for working with local repositories Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Add metadata unit tests This change adds unit tests for part of the metadata methods Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Add metadata api tests This change implements api unit tests for metadata with the same logic as in python-tuf Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Fix go linter in test simulators This change fixes go linter error of not checking errors returned by methods in the file system and test client simulators Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Create clean test metadata repository As the `signature` package allows loading keys from RSA PEM files only, the keys and roles from the python-tuf implementation are not suitable for the current implementation. This is why a clean repo is created with new keys in the appropriate format Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Add metadata sign/verify test This change adds test coverage for signing and verigying metadata with a pre-set keys Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Cleanup unnecessary functionality This change removes unused keys and test utils for the metadata unit tests. The removed test utils include filesystem simulator, which is replaced by the setup functionality and some tidy-up around the changes Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Fix metadata api tests to verify error type This change updates error assertions in the metadata api tests to compare error types rather than only a message Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> * Improve metadata tests This change provides improvements to the metadata api tests Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> --------- Signed-off-by: Ivana Atanasova <iyovcheva@vmware.com> Co-authored-by: Ivana Atanasova <iyovcheva@iyovcheva7MD6R.vmware.com>