documenting how to run integration tests locally #380

edublancas · 2023-04-06T04:02:27Z

Describe your changes

Updates developer guide to document how to run integration tests locally.

Issue number

Closes #309

Checklist before requesting a review

Performed a self-review of my code
Formatted my code with pkgmt format
Added tests (when necessary).
Added documentation in the docstring and changelog (when needed)

📚 Documentation preview 📚: https://jupysql--380.org.readthedocs.build/en/380/

yafimvo

Added 2 notes, besides that lgtm.

Some notes on the execution itself:

After executing pytest src/test/integration on Windows 11, the execution got stuck at this point:

Can't stop it/abort it (need to restart the command prompt)

This is the docker status

doc/community/developer-guide.md

tonykploomber

LGTM

idomic

Couldn't move beyond installation.

doc/community/developer-guide.md

idomic · 2023-04-07T18:58:54Z

@edublancas nice job!

alextongme · 2023-04-11T20:03:11Z

The links in the checklist are all dead

Checklist before requesting a review
 Performed a self-review of my code
 Formatted my code with [pkgmt format](https://github.com/ploomber/contributing/blob/main/CONTRIBUTING.md#lintingformatting)
 Added [tests](https://github.com/ploomber/contributing/blob/main/CONTRIBUTING.md#testing) (when necessary).
 Added documentation in the [docstring](https://github.com/ploomber/contributing/blob/main/CONTRIBUTING.md#documenting-changes-and-new-features) and [changelog](https://github.com/ploomber/contributing/blob/main/CONTRIBUTING.md#changelog) (when needed)

alextongme · 2023-04-12T21:02:55Z

hey team, while trying to run the integration tests, i got multiple failures all saying that each container was not ready fast enough.

Container postgres not ready fast enough.

is there any other setup i need to perform on docker besides downloading docker desktop?

edublancas · 2023-04-12T21:16:21Z

@alextongme: unfortunately, we're still improving the installation process to be more compatible with several OSs. I suggest using the CI to test your PRs

alextongme · 2023-04-12T21:27:56Z

ah gotcha, ok sounds good. im not sure i will have much feedback to give on this PR then since i cant walk through the installation

alextongme · 2023-04-11T20:05:38Z

doc/community/developer-guide.md

+```sh
+pytest src/tests/TEST_FILE_NAME.py
+```
+


I think it is also helpful to include how to run a specific test in a file likeso:

pytest src/tests/test_magic.py::test_save_with_trailing_semicolon

alextongme · 2023-04-12T19:50:47Z

doc/community/developer-guide.md

+the required Docker images):
+
+```sh
+pytest src/tests/integration


When I get to this step, I received the error:

_____________ ERROR collecting src/tests/integration/test_mssql.py _____________ ImportError while importing test module '/Users/alextong/Documents/coding/jupysql/src/tests/integration/test_mssql.py'. Hint: make sure your test modules/packages have valid Python names. Traceback: ../../../opt/anaconda3/envs/jupysql/lib/python3.10/importlib/__init__.py:126: in import_module return _bootstrap._gcd_import(name[level:], package, level) src/tests/integration/test_mssql.py:1: in <module> import pyodbc E ImportError: dlopen(/Users/alextong/opt/anaconda3/envs/jupysql/lib/python3.10/site-packages/pyodbc.cpython-310-darwin.so, 2): Library not loaded: /usr/local/opt/unixodbc/lib/libodbc.2.dylib E Referenced from: /Users/alextong/opt/anaconda3/envs/jupysql/lib/python3.10/site-packages/pyodbc.cpython-310-darwin.so E Reason: image not found

Running brew install unixodbc seems to have fixed it as per the instructions on https://pypi.org/project/pyodbc/. I think this step should be added in before line 180 for users on Macs/Unix.

alextongme · 2023-04-14T17:16:35Z

doc/community/developer-guide.md

@@ -19,10 +19,28 @@ myst:

 # Developer guide

+Before continuing, ensure you have a working [development environment.](https://ploomber-contributing.readthedocs.io/en/latest/contributing/setup.html)


I think that this entire developer-guide.md file should be renamed and moved into a "Testing" -> "JupySQL" section within the contributing portal

I also found it a bit difficult to navigate to the contribution docs from the main website, and would suggest just making the "Developer guide" link pictured below directly go to Contributing since that covers all development instructions for all of your projects

alextongme · 2023-04-14T17:19:59Z

doc/community/developer-guide.md

+each PR; however, you might need to run them locally.
+
+```{note}
+Setting up the development environment for running integration tests locally


Perhaps, consider adding another note here to push developers to rely on the CI to test PRs since integration tests are not yet supported on all OSes

It might also be helpful to include which OSes are supported

alextongme · 2023-04-14T17:27:57Z

doc/community/developer-guide.md

+To run all integration tests (the tests are pre-configured to start and shut down
+the required Docker images):
+
+```sh
+pytest src/tests/integration
+```
+
+```{important}
+If you're using **Windows**, the command above might get stuck. Send us a [message on Slack](https://ploomber.io/community) if it happens.
+```
+
+To run some of the tests:
+
+```sh
+pytest src/tests/integration/test_generic_db_operations.py::test_profile_query
+```


For consistency with the unit testing section, I would recommend this:

Integration tests are pre-configured to start and shut down the required Docker images. To run all integration tests: ```sh pytest src/tests/integration ``` ```{important} If you're using **Windows**, the command above might get stuck. Send us a [message on Slack](https://ploomber.io/community) if it happens. ``` To run a specific file: ```sh pytest src/tests/integration/test_generic_db_operations.py ``` To run a specific test: ```sh pytest src/tests/integration/test_generic_db_operations.py::test_profile_query ```

alextongme · 2023-04-14T19:30:27Z

doc/community/developer-guide.md

+
+Unit tests are executed on each PR; however, you might need to run them locally.
+
+To run all unit tests:


i believe that with my added tests on the #319 change, running all unit tests locally started to fail due to a Too many open files error. i was able to bypass it by temporarily increasing my ulimit

ulimit -n 2048

another environment issue specific only to my mac, but having instructions published here in case other users encounter it might be worth writing since 256 is the default for macs.

documenting how to run integration tests locally

f5d9725

edublancas marked this pull request as ready for review April 6, 2023 04:13

edublancas requested review from yafimvo and tonykploomber April 6, 2023 04:13

yafimvo requested changes Apr 6, 2023

View reviewed changes

doc/community/developer-guide.md Outdated Show resolved Hide resolved

doc/community/developer-guide.md Outdated Show resolved Hide resolved

fixes

7e5de19

edublancas mentioned this pull request Apr 6, 2023

integration tests getting stuck on windows #382

Closed

edublancas requested a review from yafimvo April 6, 2023 14:16

tonykploomber approved these changes Apr 6, 2023

View reviewed changes

idomic reviewed Apr 6, 2023

View reviewed changes

doc/community/developer-guide.md Show resolved Hide resolved

idomic merged commit 0158a2a into master Apr 7, 2023

idomic deleted the dev-doc branch April 7, 2023 18:58

edublancas requested review from alextongme and removed request for alextongme April 7, 2023 21:32

alextongme reviewed Apr 14, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

documenting how to run integration tests locally #380

documenting how to run integration tests locally #380

edublancas commented Apr 6, 2023 •

edited by github-actions bot

Loading

yafimvo left a comment •

edited

Loading

tonykploomber left a comment

idomic left a comment

idomic commented Apr 7, 2023

alextongme commented Apr 11, 2023

alextongme commented Apr 12, 2023

edublancas commented Apr 12, 2023

alextongme commented Apr 12, 2023

alextongme Apr 11, 2023

alextongme Apr 12, 2023

alextongme Apr 14, 2023

alextongme Apr 14, 2023

alextongme Apr 14, 2023

alextongme Apr 14, 2023

alextongme Apr 14, 2023

alextongme Apr 14, 2023

		@@ -19,10 +19,28 @@ myst:

		# Developer guide

		Before continuing, ensure you have a working [development environment.](https://ploomber-contributing.readthedocs.io/en/latest/contributing/setup.html)


		Unit tests are executed on each PR; however, you might need to run them locally.

		To run all unit tests:

documenting how to run integration tests locally #380

documenting how to run integration tests locally #380

Conversation

edublancas commented Apr 6, 2023 • edited by github-actions bot Loading

Describe your changes

Issue number

Checklist before requesting a review

yafimvo left a comment • edited Loading

Choose a reason for hiding this comment

tonykploomber left a comment

Choose a reason for hiding this comment

idomic left a comment

Choose a reason for hiding this comment

idomic commented Apr 7, 2023

alextongme commented Apr 11, 2023

alextongme commented Apr 12, 2023

edublancas commented Apr 12, 2023

alextongme commented Apr 12, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

edublancas commented Apr 6, 2023 •

edited by github-actions bot

Loading

yafimvo left a comment •

edited

Loading