Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

💡 [REQUEST] - ttpforge test --strict-validation mode #440

Open
d3sch41n opened this issue Nov 20, 2023 · 3 comments
Open

💡 [REQUEST] - ttpforge test --strict-validation mode #440

d3sch41n opened this issue Nov 20, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@d3sch41n
Copy link
Contributor

Implementation PR

No response

Reference Issues

No response

Summary

Add logic to ttpforge test that will enforce stricter standards on new TTPs to make TTP authors fully provide required metadata - it should throw an error if the following fields are empty:

  • The platforms list under requirements (TTPs must specify supported platforms)
  • The top-level tests: field (TTPs must have test cases)
  • Description field (TTPs must provide basic contextual information)

We can then make CI/CD for the TTP repos run this command against all .yaml stuff.

Basic Example

This TTP would pass the new validation

name: Awesome TTP
description: |
  Info about the TTP
requirements: 
  platforms:
    - os: linux
tests:
   - name a_valid_test_case 

Drawbacks

Can't enforce this against existing TTP portfolio until they are all updated

Unresolved questions

No response

@d3sch41n d3sch41n added the question Clarification and/or additional information required to move forward label Nov 20, 2023
@d3sch41n
Copy link
Contributor Author

@l50 relevant to our earlier discussions on metadata

@d3sch41n
Copy link
Contributor Author

@cedowens plz take this from me and give it to someone else once I'm actually gone :)

@d3sch41n
Copy link
Contributor Author

@godlovepenn relevant to oncall discussion

@d3sch41n d3sch41n self-assigned this Nov 20, 2023
@d3sch41n d3sch41n added enhancement New feature or request and removed question Clarification and/or additional information required to move forward labels Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant