Acammm/unit tests -- Add more unit tests feat @cnek

[acamill]

As titled.

[acamill]

Still a few things to iron out

[cnek]

the range shd be 100_000 * 10^9 here for generate a random price in lamport according to the comments?

[cnek]

slippage in 1..SLIPPAGE_BASIS here is equivalent to 0.1% -> 100%

[Orelsanpls]

Great tests! :)

[Orelsanpls]

Should remove this comment, or sort the tests and insert two comments:

// MINT

// REDEEM

[Orelsanpls]

How do you define a test as a non regression test versus a regular unit test?

[Orelsanpls]

may be interesting to wrap the tests into a dedicated mod:

mod check_effective_order_price_versus_limit_price {
        use super::*;

        #[test]
        pub fn test_mint_valid_small_slippage() {
            // Order.price must be below the perpInfo.price within slippage
            let perp_info = mocked_perp_info(0.09000);
            let order = mocked_order(&perp_info, 0.09000, Side::Bid).unwrap();
            let ret = check_effective_order_price_versus_limit_price(
                &perp_info, &order, 1, // 0.1%
            );
            assert!(ret.is_ok());
        }

        #[test]
        pub fn test_mint_valid() {
            let perp_info = mocked_perp_info(0.090);
            let order = mocked_order(&perp_info, 0.08911, Side::Bid).unwrap();
            let ret = check_effective_order_price_versus_limit_price(
                &perp_info, &order, 10, // 1%
            );
            assert!(ret.is_ok());
        }

        #[test]
        pub fn test_redeem_valid_small_slippage() {
            let perp_info = mocked_perp_info(0.090);
            let order = mocked_order(&perp_info, 0.09000, Side::Ask).unwrap();
            let ret = check_effective_order_price_versus_limit_price(
                &perp_info, &order, 1, // 0.1%
            );
            assert!(ret.is_ok());
        }

        #[test]
        pub fn test_mint_invalid() {
            let perp_info = mocked_perp_info(0.090);
            let order = mocked_order(&perp_info, 0.08909, Side::Bid).unwrap();
            let ret = check_effective_order_price_versus_limit_price(
                &perp_info, &order, 10, // 1%
            );
            assert!(ret.is_err());
        }

        #[test]
        pub fn test_redeem_valid() {
            let perp_info = mocked_perp_info(0.090);
            let order = mocked_order(&perp_info, 0.09089, Side::Ask).unwrap();
            let ret = check_effective_order_price_versus_limit_price(
                &perp_info, &order, 10, // 1%
            );
            assert!(ret.is_ok());
        }

        #[test]
        pub fn test_redeem_invalid() {
            let perp_info = mocked_perp_info(0.090);
            let order = mocked_order(&perp_info, 0.09091, Side::Ask).unwrap();
            let ret = check_effective_order_price_versus_limit_price(
                &perp_info, &order, 10, // 1%
            );
            assert!(ret.is_err());
        }
    }

Produce the given output:

test mango_utils::limit_utils::tests::check_effective_order_price_versus_limit_price::test_mint_invalid ... ok
test mango_utils::limit_utils::tests::check_effective_order_price_versus_limit_price::test_mint_valid ... ok
test mango_utils::limit_utils::tests::check_effective_order_price_versus_limit_price::test_mint_valid_small_slippage ... ok
test mango_utils::limit_utils::tests::check_effective_order_price_versus_limit_price::test_redeem_invalid ... ok
test mango_utils::limit_utils::tests::check_effective_order_price_versus_limit_price::test_redeem_valid ... ok
test mango_utils::limit_utils::tests::check_effective_order_price_versus_limit_price::test_redeem_valid_small_slippage ... ok

[acamill]

Good point

[acamill]

Feel free to do some edits btw. I'll tend to these but free to add anything

[Orelsanpls]

thinking... may even use:

mod tests {
     mod check_effective_order_price_versus_limit_price {
         use super::*;
        
         mod mint {
               use super::*;
               // ....
         }

         mod redeem {
               use super::*;
               // ....
         }
     }
}

[cnek]

shd be just <

[cnek]

shd be just >

[cnek]

shdn't expect any MathError for any value received here in the legit range,
better assert false here,
and add them to the seed for failure cases of proptest,
and fix the actual program

[cnek]

similar comments for all proptest in this PR

[acamill]

I've not sent value in the "legit range" iirc

Ok makes sense

[acamill]

I go back to CI and let you have a look at discussed