Create tox environment for running tests by dgorelik · Pull Request #144 · google/python-spanner-orm · GitHub

When running python setup.py test in the past, we've gotten the following message WARNING: Testing via this command is deprecated and will be removed in a future version. Users looking for a generic test entry point independent of test runner are encouraged to use tox.. This PR listens to that advice and creates a tox environment for running tests :)

The nice thing about using tox for tests is we can integrate the setup of Spanner emulator into the tox command.

After a couple people confirm that tox runs for them successfully (i.e. by running tox -e py38), I will update the README to point users to run tests with tox.

Tested: ran tests successfully.

Is there any way to keep this in sync with other places? E.g. could we put this in a requirements.txt or something, and reference that here?

While these can be put in a requirements.txt file, I don't think setup.py should be referencing that file, so there still would be duplication
https://stackoverflow.com/a/33685899

I ended up adding the below in a different PR because of the same issue with setup.py not referencing requirements.txt. Would it make sense to add requirements.txt here, and use it both for tox and the github workflow? Or would the github workflow use tox and not need to reference the dependencies explicitly anymore?

The PR description mentions a warning about doing this. Should this be something else?

I think doing that in a tox env is still OK, but just to be safe, I switched to pytest. It has a cleaner test output too!

Is this going to run every time we run tests? Is there any way to cache it? (Feel free to push this off to another PR.)

Yeah, I'm inclined to push this off for now. In practice (on my admittedly fast internet connection) this steps only takes a couple of seconds.

(nit) add / at the beginning of the line, so it only matches in this directory.

Mind updating https://github.com/google/python-spanner-orm/blob/main/.github/workflows/test.yaml to use tox too?

I ended up adding the below in a different PR because of the same issue with setup.py not referencing requirements.txt. Would it make sense to add requirements.txt here, and use it both for tox and the github workflow? Or would the github workflow use tox and not need to reference the dependencies explicitly anymore?

(nit) This is out of date.

(nit) This doesn't match the other places, but I don't know what it should be.

(nit) Remove 3.6, add 3.9.

dgorelik added 2 commits February 10, 2021 22:15

Finalize tox environment

be39430

Add missing newline

a699c7e

google-cla Bot added the cla: yes label Feb 11, 2021

dgorelik added 3 commits February 10, 2021 22:17

Make indententions consistent

2591ea4

Revert unrelated change

a69b7b8

Revert unrelated change

b16cfd8

dgorelik requested review from dseomn and supersam654 February 11, 2021 13:43

dseomn reviewed Feb 11, 2021

View reviewed changes

dgorelik added 3 commits February 11, 2021 22:26

Address PR comments

f3b9b6c

Add widlcard

7ef478e

Add wildcard

f06217f

dgorelik requested a review from dseomn February 12, 2021 03:29

dseomn approved these changes Feb 12, 2021

View reviewed changes

supersam654 removed their request for review February 17, 2021 14:22

dseomn approved these changes Sep 3, 2021

View reviewed changes

+              deps =
+                absl-py
+                google-api-core
+                google-cloud-spanner >= 1.17.1
+                frozendict
+                portpicker

+                  wget https://storage.googleapis.com/cloud-spanner-emulator/releases/{env:VERSION}/cloud-spanner-emulator_linux_amd64-{env:VERSION}.tar.gz -P /tmp/spanner_emulator/
+                  tar zxvf /tmp/cloud-spanner-emulator_linux_amd64-{env:VERSION}.tar.gz -C /tmp/spanner_emulator/
+                  chmod u+x /tmp/spanner_emulator/gateway_main /tmp/spanner_emulator/emulator_main
+                  python setup.py test

               cloud-spanner-emulator*
               emulator_main
               gateway_main
+              .spanner_emulator/**

+              deps =
+                absl-py
+                google-api-core
+                google-cloud-spanner >= 1.17.1
+                frozendict
+                portpicker

+                absl-py
+                google-api-core
+                google-cloud-spanner >= 1.17.1
+                frozendict

+              # and then run "tox" from this directory.
+              [tox]
+              envlist = py36, py37, py38

Create tox environment for running tests by dgorelik · Pull Request #144 · google/python-spanner-orm · GitHub

Create tox environment for running tests - #144

Create tox environment for running tests#144dgorelik wants to merge 8 commits intomaingoogle/python-spanner-orm:mainfrom tox_testgoogle/python-spanner-orm:tox_testCopy head branch name to clipboard

Conversation

dgorelik commented Feb 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dseomn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Create tox environment for running tests#144
dgorelik wants to merge 8 commits into
mainfrom
tox_test

dgorelik commented Feb 11, 2021 •
edited
Loading