systematic parameter route testing

[huss]

Is your feature request related to a problem? Please describe.

For good practice and safety, OED should make sure all routes have parameter testing to validate that the code stops bad routes.

Describe the solution you'd like

See the route parameter testing design document.

Describe alternatives you've considered

None other than not testing.

Additional context

None

[omarraf]

My team and I are working on this

[omarraf]

Hey @huss I just had a few questions about the issue. In the design docs it's mentioned someone might still be working on a testing methodology for the units route, is there a PR for reference or is it still in progress? I'd like to review it and see how to apply it to other routes. And any preference on which routes to tackle first since there quite a few? Thanks

[huss]

@omarraf Thank you for reaching out. It was on my list to check in since I knew you needed access to previous work.

@maigbao is doing this work. I wanted to see if they could share their work as it is finishing up. I'll be talking with them soon if it does not happen before then.

As for which routes to do, I don't think I have a strong preference. Taking the current work that is trying to create general testing for types of parameters and applying it to a new route would be a good way to validate and improve on the work. Having said that, here are two quick thoughts:

• src/server/routes/conversions.js probably has similarities to units so would be an easier one to try with the current ideas.
• src/server/routes/meters.js has a lot of params so it may need new types of tests to push the envelope forward.

Know that I am available to talk with you and your team. This can be when you need help or we can arrange a regular time to talk about your work (this does not exclude talking at other times). I want to make sure you have the support you want.

[maigbao]

Hi, @omarraf, I am really for replying this late. Here this the link to my work, https://github.com/maigbao/OED/tree/unitTest_v2 and it is still in progress but I am looking forward to have a pull request soon.

[omarraf]

Hello! I took a look at the units test PR and see two testing approaches: helper functions for systematic parameter validation (validateString, validateInt) and the declarative test case approach using generateUnitValidationTests.

I'm planning to:

• Use helper functions for all parameter validation (required, types, constraints)
• Create route-specific mutation tests only when there's complex business logic
• Add missing helpers to the shared framework if needed

Does this plan sound reasonable for tackling the remaining routes, or did I miss anything? Thanks!

[huss]

@omarraf Thank you for asking and your plan sounds fine. As you may plan, it is fine to generalize any helper functions as you do more routes including renaming. Note PR #1512 now has the proposed code for units.