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.

Sign up for GitHub

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

Jump to bottom

[New] Add test submission schema version 1 #6

Merged
merged 43 commits into from
Dec 15, 2024
Merged

[New] Add test submission schema version 1 #6

merged 43 commits into from
Dec 15, 2024

Conversation

douglasdotc
Copy link
Collaborator

@douglasdotc douglasdotc commented Dec 4, 2024 •
edited
Loading

Description

This PR adds our first version of the test submission schema following the JSON schema 2020-12 version

Resolved issues

CERT-2807
CERT-2812

Documentation

Generated

Tests

@douglasdotc douglasdotc requested a review from p-gentili December 4, 2024 20:37
@douglasdotc
Add hyphen for category id regex.
36b9687 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix spellings and links.
65c5720 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix spelling.
bb88f32 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Auto generate markdown schema docs.
ff0943e 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix make file.
1ab8a07 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix make file.
c3b4d07 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Attempt to fix make file.
c2e29eb 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Attempt to fix make file.
887d4e9 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Change schema doc description.
444ce8a 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix version in schema.
415aea6 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix spelling.
4dcf906 
Signed-off-by: Douglas Chiang <[email protected]>
p-gentili
p-gentili requested changes Dec 6, 2024
View reviewed changes
Copy link

@p-gentili p-gentili left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments below but the biggest thing we're missing is the category_map which is AFAIK required.

docs/.sphinx/test_submission_schema/generate_schema_doc.py Outdated Show resolved Hide resolved
test_submission_schema/v1.json Outdated Show resolved Hide resolved
test_submission_schema/v1.json Outdated Show resolved Hide resolved
test_submission_schema/v1.json Outdated Show resolved Hide resolved
test_submission_schema/v1.json Outdated Show resolved Hide resolved
@douglasdotc
Address PR comments.
6ed2019 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc douglasdotc marked this pull request as ready for review December 10, 2024 15:03
pieqq
pieqq reviewed Dec 10, 2024
View reviewed changes
Copy link
Contributor

@pieqq pieqq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had done an initial review... and forgot to submit it! :)

Trying again.

test_submission_schema/schemas/v1.json Outdated Show resolved Hide resolved
test_submission_schema/schemas/v1.json Outdated Show resolved Hide resolved
test_submission_schema/schemas/v1.json Outdated Show resolved Hide resolved
test_submission_schema/schemas/v1.json Outdated Show resolved Hide resolved
test_submission_schema/schemas/v1.json Outdated Show resolved Hide resolved
test_submission_schema/schemas/v1.json Outdated Show resolved Hide resolved
test_submission_schema/schemas/v1.json Outdated Show resolved Hide resolved
test_submission_schema/schemas/v1.json Outdated Show resolved Hide resolved
@douglasdotc
Change packaging type to a enum.
71ec8b0 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix docs.
d7199f2 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add project management with hatchling and precommit with JSON schema …
9af3885 
…validator.

Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add main and init py for packaging.
dfb11c6 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add pre=commit GHA
ef1dea4 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add example for test_group_id
62fdde6 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix pre-commit errors.
4e6ce76 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add readme.
a827d4e 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Use py3.13 and add gitignore
cb5a32c 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
refactor readme
84290f4 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add gitignore
ea0ce10 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add pre-commit install in readme.
3fbcd17 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add verbosity for pre-commit
e04db76 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Use python 3.12 instead.
2ee0840 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Change description.
a9c3d21 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Lift the pattern for id and test_plan_id.
6245733 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Add CSS to erase the bullet points.
4aed688 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Fix docs.
7ce2b53 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Drop test type, which is hardcoded as test
91ca48b 
Signed-off-by: Douglas Chiang <[email protected]>
p-gentili
p-gentili approved these changes Dec 15, 2024
View reviewed changes
Copy link

@p-gentili p-gentili left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would get rid of any yarf mention for the time being.

Apart from that, LGTM!

pyproject.toml Outdated Show resolved Hide resolved
@douglasdotc
Fix pyproject.
c9a903b 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc
Remove entry point for now.
3650976 
Signed-off-by: Douglas Chiang <[email protected]>
@douglasdotc douglasdotc merged commit c2dc3f8 into main Dec 15, 2024
6 checks passed
@douglasdotc douglasdotc deleted the impl-submission-schema branch December 15, 2024 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Hook25 Hook25 Hook25 left review comments

@tang-mm tang-mm tang-mm left review comments

@pieqq pieqq pieqq left review comments

@p-gentili p-gentili p-gentili approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@douglasdotc @pieqq @tang-mm @Hook25 @p-gentili