Unified logging approach for api and ingestion server

[ashiramin]

Fixes

Fixes #2031 by @dhruvkb

Description

Unified logging approach between api and ingestion server by logging container logs in ci/cd instead of inside python code. Now both test-api and test-ing follow a similar pattern of storing test logs.

1. .github/workflows/ci_cd.yml:

   • Added a step to store the ingestion-server test logs an

2. ingestion_server/justfile:

   • Added a new command to display integration test logs.

3. ingestion_server/test/integration_test.py:

   • Docker compose stack is only removed when running tests locally. CI does this separately after storing logs
   • Test logs are no longer saved when running locally.

Testing Instructions

• Since most of the changes are made in the CI, testing it locally is hard. Running tests locally removes the docker compose stack so newly added test-logs command won't return anything since test containers are destroyed
• To verify this in the CI. Go to the latest summary page for this PR where artifacts are listed and make sure ing_logs exists and has ingestion server test logs. This can be verified by downloading ing_logs.zip file

Checklist

• My pull request has a descriptive title (not a vague title likeUpdate index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.
• I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[sarayourfriend]

@ashiramin Can you add testing instructions for this change? It makes it much easier for maintainers to review the changes leading to reviews coming in sooner 🙂

[ashiramin]

@ashiramin Can you add testing instructions for this change? It makes it much easier for maintainers to review the changes leading to reviews coming in sooner 🙂

@sarayourfriend Thank you for letting me know. I updated the testing instruction section in the PR description :)

[sarayourfriend]

Looks good to me! I'll be happy to approve once @dhruvkb confirms whether the if condition is needed on "Cleanup ingestion-server test".

[sarayourfriend]

Apologies for not noticing this before, but I'd like to request that this change does not affect the local development experience by making the logs inaccessible locally. Before this change the logs would output to a file before the stack is torn down. I believe the easiest way to preserve this is to remove tearing down the stack from the Python script entirely. Instead, we can add test-logs test-clean-dc to test-local.

It would look something like this:

test-local:
    pipenv run pytest {{ args }}
    if [ -z "$CI" ]; then just test-logs && just test-clean-dc; fi

Please also update the test-clean-dc doc-comment as it'll now be regularly used.

[openverse-bot]

Based on the low urgency of this PR, the following reviewers are being gently reminded to review this PR:

@krysal
@dhruvkb
@stacimc
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend¹ days, this PR was ready for review 9 day(s) ago. PRs labelled with low urgency are expected to be reviewed within 5 weekday(s)².

@ashiramin, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

1. Specifically, Saturday and Sunday. ↩

2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range. ↩

[ashiramin]

Apologies for not noticing this before, but I'd like to request that this change does not affect the local development experience by making the logs inaccessible locally. Before this change the logs would output to a file before the stack is torn down. I believe the easiest way to preserve this is to remove tearing down the stack from the Python script entirely. Instead, we can add test-logs test-clean-dc to test-local.

It would look something like this:

test-local:
    pipenv run pytest {{ args }}
    if [ -z "$CI" ]; then just test-logs && just test-clean-dc; fi

Please also update the test-clean-dc doc-comment as it'll now be regularly used.

@sarayourfriend made the change :) sorry it took me a bit longer. Please take a look

[sarayourfriend]

Fantastic, thanks very much for your patience in the review process. I've tested this locally by running just ingestion_server/test-local with and without CI=1 and the behaviour is exactly as expected.

Thanks again very much for your contribution @ashiramin 🙏

[stacimc]

Thanks for your contribution and especially for your patience @ashiramin :)

Pinging @dhruvkb again for awareness, but I was able to test this locally and this looks good to me.