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

feat(validator): Add workflow for validator tests #1570

Merged
merged 1 commit into from
Jul 3, 2024

Conversation

vprashar2929
Copy link
Collaborator

@vprashar2929 vprashar2929 commented Jun 26, 2024

This PR introduces a workflow to execute validator tests on CI Additionally, it includes a Makefile within e2e/tools/validator, enabling the execution of targets such as make fmt and make test for local testing

Copy link
Contributor

github-actions bot commented Jun 26, 2024

🤖 SeineSailor

Here is a concise summary of the pull request changes:

This pull request introduces a new workflow for running validator tests in the CI pipeline, adding two new make targets (fmt and test) to the e2e/tools/validator directory. The changes are internal, using hatch for code formatting and testing, and do not affect the external interface or behavior of the code. The new workflow and Makefile targets will help maintain code quality and test coverage for the validator feature, ensuring consistent testing and ease of use for developers.

Observation: The changes are well-contained within the Makefiles and do not introduce any external dependencies or breaking changes. The addition of the fmt target for code formatting is a good practice, as it helps maintain a consistent code style.

Suggestion for improvement: Consider adding a brief description or comment in the Makefile to explain the purpose and usage of the new targets, making it easier for developers to understand and utilize the new workflow.

@vprashar2929
Copy link
Collaborator Author

@vprashar2929 vprashar2929 requested a review from sthaha June 26, 2024 18:14
@vprashar2929 vprashar2929 changed the title feat(validator): Add workflow to run validator tests [WIP]feat(validator): Add workflow to run validator tests Jun 26, 2024
Makefile Outdated
@echo "Running validator tests..."
@cd ./e2e/tools/validator && \
hatch env create && \
hatch run test || { echo 'validator-test failed'; exit 1; }
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
hatch run test || { echo 'validator-test failed'; exit 1; }
hatch run test

- name: Set up Python
uses: actions/[email protected]
with:
python-version: "3.12"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
python-version: "3.12"
python-version: "3.11"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Do we have any hard requirements on 3.11 ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Indeed we do :( .. rhel 9

Copy link
Collaborator

Choose a reason for hiding this comment

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

I have pinned the python version in #1573

Makefile Outdated
validator-test: ## Run validator tests.
@echo "Running validator tests..."
@cd ./e2e/tools/validator && \
hatch env create && \
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it is better to have a validator-env target that test depends on

Copy link
Collaborator

Choose a reason for hiding this comment

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

@vprashar2929 , gentle reminder for a separate makefile for Validator :) but actually think hatch makes it really unnecessary to have a Makefile

@KaiyiLiu1234
Copy link
Collaborator

This is great to add to the github actions workflow. The unit tests however need some more work last time I checked. Maybe we can improve it? @vprashar2929 I can raise it as an issue and hop on that if you would like.

Makefile Outdated
validator-test: ## Run validator tests.
@echo "Running validator tests..."
@cd ./e2e/tools/validator && \
hatch env create && \
Copy link
Collaborator

Choose a reason for hiding this comment

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

@vprashar2929 , gentle reminder for a separate makefile for Validator :) but actually think hatch makes it really unnecessary to have a Makefile

@vprashar2929 vprashar2929 force-pushed the add-val-worflow branch 3 times, most recently from 0d21c46 to cc2d6aa Compare July 3, 2024 06:03
@vprashar2929 vprashar2929 changed the title [WIP]feat(validator): Add workflow to run validator tests feat(validator): Add workflow for validator tests Jul 3, 2024
@vprashar2929 vprashar2929 requested a review from sthaha July 3, 2024 06:04
This PR introduces a workflow to execute validator tests on CI
Additionally, it includes a Makefile within `e2e/tools/validator`
enabling the execution of targets such as `make fmt` and `make test` for local testing

Signed-off-by: Vibhu Prashar <[email protected]>
@sthaha sthaha merged commit 91fc8d4 into sustainable-computing-io:main Jul 3, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants