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

Unit test GH workflow #134

Merged
merged 33 commits into from
Aug 3, 2023
Merged

Unit test GH workflow #134

merged 33 commits into from
Aug 3, 2023

Conversation

pandu-k
Copy link
Collaborator

@pandu-k pandu-k commented Aug 1, 2023

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes/features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    new CI pipeline

  • What is the current behavior? (You can also link to an open issue here)
    no unit test pipeline for py-marqo

  • What is the new behavior (if this is a feature change)?
    a unit test pipeline for py-marqo

Test notes

  • Tested and confirmed that this pipeline triggers after commits to a PR branch: https://github.com/marqo-ai/py-marqo/actions/runs/5733088797/ (failing because of a broken unit test)
  • Does this pipeline trigger and work after a push to mainline: to be tested
  • Does this pipeline work with manually specifying an ECR image: to be tested (must be merged into mainline before testing)
  • Does this pipeline work with manually specifying an Docker image: to be tested (must be merged into mainline before testing)

Specifications:

  • The test pipeline should run:
    • every time a PR is opened
    • every time code is merged into mainline
    • it can also be run manually
  • Marqo should be pulled from an image repo and ran (to keep this pipeline fast)
  • When manually running the pipeline, we indicate the Marqo image location, see attached image for a similar existing example
  • To keep things simple, Marqo should run OpenSearch in a docker-in-docker configuration

image

Determining the Marqo version to use

The Marqo used for each py-marqo pipeline is:

  • Default to the Dockerhub Marqo version specified in py-marqo.supported_marqo_version .
  • Error out if it doesn’t exist

When we run manually we can specify a DockerHub or ECR image tag to run
When testing

  • build your feature branch into an ECR image to test against your py-marqo branch

@pandu-k pandu-k changed the title Create unit-tests.py Unit test GH workflow Aug 1, 2023
@pandu-k pandu-k marked this pull request as ready for review August 2, 2023 00:21
Copy link
Contributor

@vicilliar vicilliar left a comment

Choose a reason for hiding this comment

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

good work on this! this will definitely be super useful.

.github/workflows/open-source-unit-tests.yml Show resolved Hide resolved
.github/workflows/open-source-unit-tests.yml Outdated Show resolved Hide resolved
@pandu-k pandu-k merged commit b738bd6 into mainline Aug 3, 2023
2 of 3 checks passed
@pandu-k pandu-k deleted the pandu/py-marqo-test-pipeline branch August 3, 2023 11:17
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.

2 participants