feat: create a library of helper functions that make working with pepr easier

[schaeferka]

Description

Added module-helpers.ts and module-helpers.spec.ts.

module-helpers.ts has a containers function that accepts a request parameter and an optional containerTypes parameter. The request is a PeprValidateRequest<a.Pod> that identifies the pod from which a list of containers should be returned.

If no containerTypes parameter is included, all containers in the pod will be returned. If "containers" is passed in for the containerTypes, then only spec.containers will be returned. If "initContainers" is passed in for the containerTypes, then only spec.initContainers will be returned. If ephemeralContainers is passed in for the containerTypes, then only spec.ephemeralContainers will be returned.

In order to keep the flexibility of pulling the module-helpers into a separate module in the future, the containers function was put into the new module-helpers.ts file instead of modifying the PeprValidateRequest class.

Related Issue

Fixes #

Relates to #

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Other (security config, docs update, etc)

Checklist before merging

• Test, docs, adr added or updated as needed
• Contributor Guide Steps followed

[netlify]

✅ Deploy Preview for pepr-docs canceled.

Name	Link
🔨 Latest commit	e69117e
🔍 Latest deploy log	https://app.netlify.com/sites/pepr-docs/deploys/656e68ce13189d00086af101

[cmwylie19]

I like the test, like the function, but this would be even cleaner on the PeprValidationRequest. Overall great work

[cmwylie19]

I like the test, like the function, but this would be even cleaner on the PeprValidationRequest. Overall great work.

sorry missed your comment about flexibility in the PR.. I'm not sure I am following what you mean though. Can you elaborate " keep the flexibility of pulling the module-helpers into a separate module in the future"? Thanks!

This feels very coupled to the PeprValidateRequest.

The important element on this is to maintain parody with our Fluent API, When(a.Pod)....Mutate(pod => pod.SetLabel("")). This is a major part of our user experience that is built straight into the intellisense, which makes it easier to write even without having deep knowledge of Pepr

[jeff-mccoy]

Btw, we ended up needing it in mutate & validate: https://github.com/defenseunicorns/uds-core/blob/common-pepr/src/policies/common.ts#L23