didiermis commented 7 months ago

Validation Fixes and Tests in Gated Marketplace

Overview

The changes implemented focus on enhancing the gated marketplace pallet by introducing error handling for application setup and enforcing validation checks. The motivation behind these changes is to ensure that applications to the marketplace meet specific criteria, such as having the required fields and adhering to the constraints for custodian relationships. This improvement in validation prevents potential runtime errors and enhances the overall robustness of the marketplace application process.

Tickets

[ ] Fix #29

Implementation notes

The implementation involves modifying the set_up_application function to return a Result type, enabling the function to handle errors gracefully by leveraging Rust's error handling paradigm. Additional checks are introduced to ensure that:

The fields provided for an application are not empty.
The number of custodian fields matches the number of application fields when custodians are involved.
The maximum number of files specified for an application is not exceeded.

These checks are accomplished using the ensure! macro for concise assertions and the .map_err method to transform errors from the try_from method into pallet-specific errors.

Furthermore, corresponding changes are made in the callers of set_up_application within the module to handle the Result returned by the

Interesting/controversial decisions

The decision to enforce strict validation at the application setup stage could be seen as restrictive, especially in scenarios where marketplace dynamics might demand more flexibility.

Test coverage

New tests were added in tests.rs to cover scenarios involving the new validations. These include tests for applying without fields, applying with mismatched numbers of fields and custodian fields, and exceeding the maximum allowed fields. The tests verify that the system correctly rejects invalid or incomplete applications, and they help ensure that the validations work as intended.