ci: replace Travis CI with GH Actions #60

psankhe28 · 2024-06-25T08:00:32Z

Description

Added GitHub actions for all drs-filer endpoints.

Fixes # (issue)
#58

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
I have not reduced the existing code coverage
I have added docstrings following the Python style guidelines of this project to all new modules, classes, methods and functions are documented with docstrings following; I have updated any previously existing docstrings, if applicable
I have updated any sections of the app's documentation that are affected by the proposed changes, if applicable

Summary by Sourcery

This pull request replaces Travis CI with GitHub Actions for continuous integration, including workflows for building and publishing Docker images, linting, and running tests. Additionally, it introduces new tests for DRS-Filer endpoints.

New Features:
- Added GitHub Actions workflows for building, publishing Docker images, linting, and running tests.
Enhancements:
- Replaced Travis CI with GitHub Actions for continuous integration.
CI:
- Introduced a GitHub Actions workflow for building and publishing Docker images on push to the 'dev' branch.
- Added a GitHub Actions workflow for linting and running unit tests on push and pull requests.
- Created a GitHub Actions workflow to test DRS-Filer API endpoints using Docker Compose and pytest.
Tests:
- Added comprehensive tests for DRS-Filer endpoints using pytest.

Signed-off-by: Prati28 <[email protected]>

sourcery-ai · 2024-06-25T08:00:39Z

Reviewer's Guide by Sourcery

This pull request introduces a new GitHub Actions workflow to automate the testing of all DRS-Filer API endpoints. The workflow is triggered on push and pull request events, and includes steps to build and run Docker Compose, install necessary tools, and execute a series of API endpoint tests to ensure the functionality of the DRS-Filer service. Additionally, the Travis CI configuration has been removed in favor of the new GitHub Actions workflows.

File-Level Changes

Files	Changes
`.github/workflows/docker-build-publish-drs-filer.yml` `.github/workflows/lint.yml` `.github/workflows/test.yml`	Added new GitHub Actions workflows for building and publishing Docker images, linting and running unit tests, and testing DRS-Filer API endpoints. These workflows replace the previous Travis CI configuration.

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
Continue your discussion with Sourcery by replying directly to review comments.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

Hey @psankhe28 - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 5 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

.github/workflows/test.yml

sourcery-ai · 2024-06-25T08:01:57Z

.github/workflows/test.yml

+
+    - name: Test POST /service-info
+      run: |
+        RESPONSE=$(curl -X POST http://localhost:8080/ga4gh/drs/v1/service-info -H 'Content-Type: application/json' -d '{"contactUrl": "mailto:[email protected]","createdAt": "2024-06-12T12:58:19Z","description": "This service provides...","documentationUrl": "https://docs.myservice.example.com","environment": "test","id": "org.ga4gh.myservice","name": "My project","organization": {"name": "My organization","url": "https://example.com"},"type": {"artifact": "beacon","group": "org.ga4gh","version": "1.0.0"},"updatedAt": "2024-06-12T12:58:19Z","version": "1.0.0"}')


suggestion: Consider breaking down long JSON payloads

The JSON payload in this POST request is quite long and can be hard to read. Consider breaking it down into multiple lines or using a JSON file to improve readability.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Signed-off-by: Prati28 <[email protected]>

.github/workflows/test.yml

Signed-off-by: Prati28 <[email protected]>

.github/workflows/lint.yml

Signed-off-by: Prati28 <[email protected]>

uniqueg

This looks good - thanks a lot. However, we should test whether these workflows actually do what they are supposed to do - without having to merge them first.

For that, you need to ensure that there are no conditions that stop the workflows from running, like:

restrictions on the conditions under which workflows are triggered
creating the PR from a feature branch and not a fork (which imposes restrictions on the use of secrets)

uniqueg · 2024-07-22T10:50:18Z

Also, please address the Sourcery AI comments - they make a lot of sense 🙏

psankhe28 · 2024-07-22T13:44:45Z

@sourcery-ai review

sourcery-ai

Hey @psankhe28 - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding some high-level comments in the test.py file to explain the purpose of each test function and any complex logic.
The Python versions in the linting workflow (3.6, 3.7, 3.8) are quite old. Consider updating to more recent versions for better support and features.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟡 Security: 1 issue found
🟡 Testing: 13 issues found
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

.github/workflows/docker-build-publish-drs-filer.yml

.github/workflows/test.yml

tests/test.py

uniqueg · 2024-07-22T14:01:06Z

Couple more good Sourcery comments :)

added github actions

bad64a2

Signed-off-by: Prati28 <[email protected]>

sourcery-ai bot reviewed Jun 25, 2024

View reviewed changes

psankhe28 and others added 3 commits June 25, 2024 13:33

checking curl installation

a8de884

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

checking http response

0083614

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

check for service

f645820

Signed-off-by: Prati28 <[email protected]>

psankhe28 requested a review from uniqueg June 25, 2024 08:08

uniqueg changed the title ~~feat: add github actions~~ ci: replace Travis CI with GH Actions Jul 1, 2024

uniqueg requested changes Jul 1, 2024

View reviewed changes

.github/workflows/test.yml Outdated Show resolved Hide resolved

.github/workflows/test.yml Outdated Show resolved Hide resolved

.github/workflows/test.yml Show resolved Hide resolved

replaced travis ci with github actions

8474357

Signed-off-by: Prati28 <[email protected]>

psankhe28 requested a review from uniqueg July 3, 2024 11:35

psankhe28 added 3 commits July 3, 2024 18:10

added python file for testing endpoints

3b071d4

removed docker service

beae023

Signed-off-by: Prati28 <[email protected]>

added api test file

2978f86

psankhe28 marked this pull request as draft July 3, 2024 13:08

uniqueg requested changes Jul 3, 2024

View reviewed changes

.github/workflows/lint.yml Outdated Show resolved Hide resolved

added all endpoints with status codes

be9ff74

psankhe28 marked this pull request as ready for review July 3, 2024 14:34

psankhe28 added 2 commits July 3, 2024 20:26

added helper function for common errors

7644ba5

fixed the pytest error

a78e9c4

Signed-off-by: Prati28 <[email protected]>

uniqueg reviewed Jul 22, 2024

View reviewed changes

sourcery-ai bot reviewed Jul 22, 2024

View reviewed changes

Merge branch 'elixir-cloud-aai:dev' into github-actions

4a45fec

psankhe28 closed this Jul 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: replace Travis CI with GH Actions #60

ci: replace Travis CI with GH Actions #60

psankhe28 commented Jun 25, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jun 25, 2024 •

edited

Loading

sourcery-ai bot left a comment

sourcery-ai bot Jun 25, 2024

uniqueg left a comment

uniqueg commented Jul 22, 2024

psankhe28 commented Jul 22, 2024

sourcery-ai bot left a comment

uniqueg commented Jul 22, 2024

ci: replace Travis CI with GH Actions #60

ci: replace Travis CI with GH Actions #60

Conversation

psankhe28 commented Jun 25, 2024 • edited by sourcery-ai bot Loading

Description

Type of change

Checklist:

Summary by Sourcery

sourcery-ai bot commented Jun 25, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Jun 25, 2024

Choose a reason for hiding this comment

uniqueg left a comment

Choose a reason for hiding this comment

uniqueg commented Jul 22, 2024

psankhe28 commented Jul 22, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

uniqueg commented Jul 22, 2024

psankhe28 commented Jun 25, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jun 25, 2024 •

edited

Loading