Move all integration tests to pyopencdms or opencdms repo? Ensure containers are ready before tests start executing

[isedwards]

@faysal-ishtiaq we're trying to update the integration tests in opencdms-test-data (#43) - but we're running into problems with the database containers not being ready before the tests start running. We could introduce a simple delay before running the tests or there may be some other approach we could take to check the containers are ready before running tests.

Any suggestions?

[isedwards]

Also, do you agree that it would make sense to run the same pyopencdms integration tests in both the pyopencdms repo and here in the opencdms-test-data repo actions?

When imported and run from the opencdms-test-data repo, the integration test would run against the original SQL DDL production schemas and when running in their own repo (pyopencdms) the integration tests would run against the pyopencdms SQLAlchemy models.

[faysal-ishtiaq]

@faysal-ishtiaq we're trying to update the integration tests in opencdms-test-data (#43) - but we're running into problems with the database containers not being ready before the tests start running. We could introduce a simple delay before running the tests or there may be some other approach we could take to check the containers are ready before running tests.

Any suggestions?

There are some db engine specific commands to check if database is ready, such as mysqladmin ping, pg_isready, but for our use-case we should also consider if the seeding is complete. So, probably we could write some scripts to check if we have everything we want before the tests start. Or simply sleep for about 30 seconds.

[faysal-ishtiaq]

Also, do you agree that it would make sense to run the same pyopencdms integration tests in both the pyopencdms repo and here in the opencdms-test-data repo actions?

When imported and run from the opencdms-test-data repo, the integration test would run against the original SQL DDL production schemas and when running in their own repo (pyopencdms) the integration tests would run against the pyopencdms SQLAlchemy models.

yes, I agree.

[isedwards]

@faysal-ishtiaq - would you be happy to:

• move/combine all integration tests from this repo with the integration tests in pyopencdms
• make the integration tests in pyopencdms run automatically in both repos with (slightly) different schemas depending on repo as discussed above
• resolve Updates readme and integration tests #43 and fixed some routing on the readme file #27 in this repo as part of the refactoring
• propose a solution to ensuring that containers are ready before tests run

@chinedu117 - is your experience that a 30 second pause would not be sufficient to ensure that containers have time to finish initialising? Do you think we need a longer pause - or something more robust?

[faysal-ishtiaq]

Yes, I will be happy to make the changes.

[chinedu117]

@faysal-ishtiaq - would you be happy to:

* [ ]  move/combine all integration tests from this repo with the integration tests in pyopencdms

* [ ]  make the integration tests in pyopencdms run automatically in both repos with (slightly) different schemas depending on repo as discussed above

* [ ]  resolve [Updates readme and integration tests #43](https://github.com/opencdms/opencdms-test-data/pull/43) and [fixed some routing on the readme file #27](https://github.com/opencdms/opencdms-test-data/pull/27) in this repo as part of the refactoring

* [ ]  propose a solution to ensuring that containers are ready before tests run

@chinedu117 - is your experience that a 30 second pause would not be sufficient to ensure that containers have time to finish initialising? Do you think we need a longer pause - or something more robust?

Currently the code sleeps for 300 seconds before running the tests. From my latest tests, 300 seconds (5 minutes) was sufficient to allow the containers to boot up.

Also, i considered that if we would want to make a test container, where we can use the docker-compose's depends rule to wait for the DB containers to be connection-readybefore we run tests , we would lose the advantage of using GitHub Action's matrix strategy to test with different python versions.

The work around would be to make separate containers for each python version we want to test. I would find it cumbersome to maintain multiple Dockerfiles for the same purpose. Another side effect would be long wait times to build multiple python containers for different python version.

I would suggest we find an optimum sleep time instead of building separate images for each python version.