Creating an integration test to make sure nominatim calls work properly. The tests call various classes from Nominatim.py and ensures that the format of the responses are as expected with the current calling format.

save_ground_truth.py: added parser argument line so that ground truth can be saved successfully using "diary" argument.

Generated a ground truth file while testing save_ground_truth.py.

Modified nominatim.py to remove all google based functionality.

Created new docker-compose.yml, Dockerfile, and a few shell scripts in emission/integrationTests to run the integration tests while starting Nominatim server through docker container.

nominatim-docker-test.yml sets up the servers in GH actions and runs docker-compose.

runIntegrationTests.sh uses the discover method to run all tests in emission/integrationTests.

TestNominatimBeta.py compares the result of a reverse geocoding call to nominatim with an expected output.
removed ports from docker-compose.tests.yml per Shankari's instruction.

Moved nominatim-docker-test.yml to github workflows directory and set path to docker compose.

Edited docker-compose.yml to reflect rhode island data instead of norcal; updated ports.

Added environment variable to dockerfile (not quite polished yet) so that nominatim query can be run with localhost when appropriate.

Trying to get nominatim-docker-test.yml to run in GH actions with small syntax changes. Also changing the repo from which docker builds to current directory.

Removed unused imports.

Added a line that temporarily sets the query URL in eco to that of the environment variable, just for the purpose of testing. This way, nominatim.json can stay the same, while the testing environment variable can still be used and modified easily.

Also resolved hardcoding of nominatim URL per Shankari's request.

Added os import, removed print statement.

Changed file to run on PR (temporarily) to see if it will run.

- Added nominatim network in docker-compose so that db and nominatim are separated. This should allow them to run on different ports, while communicating with the web server.
- Testing to see where pythonpath is set in GH actions/if we need to specify in the runner specs.

Dockerfile: updated query url to access the nominatim container while running on web server.

start_integration_tests: moved a commented out section.

Nominatim.py: Added environment variable to replace nominatim.json file. added multiple prints to (hopefully) see what's going on with the tests.

…atimBeta.

Nominatim.py: removing prints

TestNominatimBeta: removed and combined with testnominatim.py

runIntegrationTests.sh: modified to only call TestNominatim.py, since the other integration tests don't work yet.

TestNominatim.py: updated environment variable functionality to work with both AWS and the testing environment.  Modified test_geocode to only call geocode function once. Changed test query for test_get_json_geo so that it would return a list.

Directly testing two different potential solutions to the URL query issue in GH actions. Will change the environment variable for NOMINATIM_QUERY_URL when I find the right way to call the container in the GH actions network.

TestNominatim.py: commented out irrelevant tests that won't help with troubleshooting

Nominatim.py: Added port to nominatim call. Trying out calling by image name instead of name of container.

runIntegrationTests.sh: Added command to list out processes on 8080

Did not recognize this command; trying again.

Specifying nominatim-network is separated from the service name, nominatim. It is possible that this was causing an issue with accessing the network.

Trying to remove universal network at the bottom of the file, and removing http.

Modifying network to add a bridge driver, specifying network names, adding link to nominatim network from web server, and assigning web server its own ports. All of these changes are in an attempt to allow web server to access the nominatim container and make an API call.

Since my network was working properly locally, I'm now thinking that the issue has to do with timing. I don't think the rhodeisland-nominatim container had enough time to setup and wait/listen, which caused the connection to be refused. Changes:

start_integration_tests: removing echoes

dockerfile: reverting to old environment variable

compose: removing version(hopefully this is allowed) and reverting everything except adding condition check. This should cause web-server to wait for the nominatim service to be up and running before trying to connect. We will see!

docker-compose: Added healthcheck to nominatim service, in tandem with restart policy for web server. Hopefully, this gives nominatim enough time to initialize. Also added environment variable for query url.

Dockerfile: removed environment variable, and added to compose.

Added --wait to docker-compose command, which supposedly will cause the other containers to wait for my nominatim service to pass its health check. Removed restart on failure, which isn't necessary with wait.

start_integration_tests: Added sleep command to directly delay starting the tests, since docker methods weren't working. This worked locally, and I could see where the health checks were taking place. Will be helpful to, at the very least, see how long nominatim needs to get started up.

nominatim-docker-test.yml: Reverted to old command.

TestNominatim.py: Un-commented other tests.

Giving nominatim twice as long to initialize. I cannot get my local container to not build with old image data, despite deleting the old images.

A small change while I'm working on implementing dockerize. Mock should bypass the issue with the place_id, which should get the tests to work!! :)

Testing dockerize. Added docker install to dockerfile, and added a line in our start_integration_tests.sh to wait for a 200 from the rhodeisland-nominatim container. Here's what it looks like on my machine:

```
integrationtests-web-server-1  | 2023/08/28 18:27:10 Waiting for: http://rhodeisland-nominatim:8080
integrationtests-web-server-1  | 2023/08/28 18:27:10 Received 200 from http://rhodeisland-nominatim:8080
```

 Additionally, my tests passed locally:
```
integrationtests-web-server-1  | Ran 6 tests in 0.344s
integrationtests-web-server-1  |
integrationtests-web-server-1  | OK
```

Adding a specified timeout that's longer than the default (10s) so that the container has a chance to start up.

Longer timeout test to see if nominatim will have time to initialize.

nominatim-docker-test.yml: added environment variable for the geofabrik query url with GitHub actions secrets. we will see if this works in this commit.

docker-compose.yml: commented out healthcheck because it isn't currently doing anything useful to delay the start. Should remove completely once docker commit is working.

TestNominatim.py: added functionality for geofabrik calls with GH actions secrets.

Added creation of a fake place to use for testing of get_filtered_place.

Added test comparing geofabrik and nominatim hard-coded calls (these may not be possible from within the container so might be removed)

Added test for get_filtered_place in clean_and_resample, which passes in the fake place created above.

Modified test_get_json_reverse to only check the display name for now.

nominatim-docker-test: Updating geofabrik url variable, in hopes that it will be able to be passed into a call in TestNominatim.py. I have looked into it more, and I'm not sure if GH actions allows this.

nominatim.py: Realized that some of my assertion errors might be related to the nominatim url environment variable not getting set properly locally, so comparing local url to the one produced in github actions.

TestNominatim,py: Changing expected result for get_filtered_place. Difference was due to my error.

Correcting small syntax error (oops)

Added multiple tests to see if I can access the fake API key I added to GH actions secrets.

Modified the test for the get_json_geo function to only look for the name of the returned place.

Temporarily reinstating sleep; re-removing wikipedia import

Seeing if this causes the workflow to run in a different area.

Two workflows became stuck with my last change. Trying to revert change and see if they become unstuck.

docker-compose.yml: Adding healthcheck back in because build failed when I removed it.

nominatim-docker-test.yml: changing workflow to trigger only on push to nominatim, since I'm hoping to only run this test on my test branch instead of the main branch.

Trying to see if there's a way for me to get this workflow to only run in my forked repository for now.

Apparently scheduled runs won't run on forked branches, so I'm removing the schedule to see if it will run on my forked branch. This is important, because I need to get the API keys working.

I think I understand what's happening now and why my workflow won't run on my fork. Added a dummy print to see if this triggers anything, since my last change was just to the workflow file (which GH might not recognize as a real push?)

Test still not running properly. Trying:

yml: Just run on nominatim push. Hoping it will work now.

sh: adding some more echoes to see if I can tell where the problem is arising. I've looked through the old commits and I can't see what would've gone wrong.

I scoured through everything and added some prints. It looks like tail -f is messing up the web server's ability to make requests, so I'm commenting it out again. Hopefully this fixes the issue!!

Currently successfully running all of the tests in my repo only, so I can cancel the jobs if need be. Also, I am now able to test out using API keys in the workflow. It looks like the `TEST_ENVVAR = os.environ["TEST_ENVVAR"]` method is unrecognized/invalid, so I'm removing it and trying out the .get method instead.

Verified with last test that the .get method is the preferred way to set the variable. Trying a few ways to print the variables to see how it looks; I'm nervous because the last attempt printed "None". Added a print without any secrets to see if it's setting these variables at all.

Seeing if something as simple as a string gets carried over to other files, or if it's stuck in the workflow file.

Adding spaces to see if that fixes the secret not being set. Also, trying to access the variables directly without using the get method.

Removing prints that caused workflow to fail

Trying a few more things before I give up on GH actions secrets. Moving the environment variables to be after the run command, as that's what I've seen in many examples. If that doesn't work, I'm going to try to move it to the jobs section of the workflow file.

Moved environment variables to jobs section to hopefully make them accessible throughout the workflow.  Added an echo test to see if the variables are carried to the steps. Added a print to TestNominatim.py to see if there are any environment variable keys available.

It's a stretch but this could potentially be a way to pass in the api key. We will see

Trying again.

Passing in the environment variable to the run command for docker compose, and then adding the variable to the environment again in the docker-compose.yml

Removing brackets around test key variable.

Realized I put the test key in the wrong service. Moving to see if it could finally work!

Trying out setting the environment variable just once, in the docker compose line. I have high hopes for this test :)

Trying again but actually commenting out the env section!

Using what I learned from the test key and formatting for geofabrik. Also added a print if the key is not formatted properly. Removed a bunch of extra prints and test variables. I am really hopeful that the test_geofabrik_api test will finally get to run!

Modified test substantially to verify that multiple k,v pairs are equal. The raw json results are substantially different, so it is not viable to compare them. Test is passing locally.

Replaced address called with one that I know the container has (since the function is used elsewhere in the container).

Decided to use the same format as I used for test_geofabrik_and_nominatim to compare the results.

Test is passing locally.

Only looking at the first 30 characters of the display name at the moment so that the test will pass

Changing to the first 71 characters + constraining the docker result as well.

Since the tests are passing, I decided to try out docker commit to further optimize test time. Depending on how long it takes to build the container, I might remove the dockerize functionality.

Also added some comments about what the tests do.

Created a new image without the wikipedia info, since this apparently changed how the container was created. I'm not sure if docker commit is actually going to make this faster based on the logs from my last test.

Created a new image using highly controlled container. Seeing what happens when I push this; I might have to change the entrypoint, but I'm hoping not.

Testing out new entrypoint. Also fixed some of the minor changes from Shankari's code review.

Created a new image and added the required file to skip download. Going to see how this one works :)

compose: Removing healthcheck since the new image is running much faster

start tests script: Modified with Shankari's suggestions + removing sleep functionality

nominatim.py: updating URL + adding potentially helpful print statements

workflow file: adding in commented section for schedule; will un-comment out once everything is good!

Removing the ground truth file + fixing a syntax error in my last commit.

Seeing how it runs when I remove the database port.

Changing services per shankari's requests one step at a time. Removing the webserver export now

Let's see what happens!

Test does not work without it!!

docker-compose.tests.yml: removing whitespace (My test doesn't use this file, so it must have been added there on accident)

dockerfile: removing dockerize and extra print

start_integration_tests: removing dockerize wait command and some extra whitespaces

setup_integrationtests.sh: created a new shell script that's separate from setup_tests.sh. essentially the same, but added a line to run createfakeplace.py

createfakeplace.py: creates a fake place to be used in testnominatim.py

testnominatim.py: added functionality for createfakeplace.py.

Removing another whitespace that I didn't see previously :)

Removing the db.conf file and updating a comment in testnominatim.py

I am almost positive I have the URL formatting how it is supposed to be. All of the tests are passing locally. Here's what I've done:

TestNominatim.py:
 - Created a new module that sets the query URL to be used in nominatim.py and reloads nominatim.py. This allows the user to call the various nominatim services anywehre in the code, without modifying nominatim.py.

- added setup function for consistency with other tests

docker-compose: added query URLs as environment variables for the web-server service.

nominatim.py: set the nominatim_query_url as an environment variable in a more simple way.

After last push, now that I know it works, removing some unnecessary things and reinstating the testing schedule.

- Deleting createfakeplace.py and setup_integrationtests.sh

- Reverting to setup_tests.sh in start_integration_tests.sh

- Moving creation of fake place to TestNominatim.py setup  function

- Adding logging for query URL and modifying a print in nominatim.py

Trying out running the test on only one network. Also adding in run on push to nominatim branch so that the test runs again!

Workflow wasn't going on last push due to changes to schedule, so reverting temporarily.

This could be it! Reverting to the scheduled runs.

Committing Shankari's suggestion

Co-authored-by: shankari <[email protected]>

Trying out removal of port 8080 now that all of the services are on the same network. Hopefully, the container can call by just the name of the container and not expose the port.

Also adding to run on push to one of the paths so that the test runs.

…ion-server into nominatim

Despite being on one network, calling the container by name might have messed things up.

Also adding a print for debugging.

Slightly modifying the workflow to see if the API key can be pulled to the workflow successfully.

Replacing the API key with a known working repo secret to see if the problem is GH accessing the repo secrets, or something with the way the secret was put in.

Setting the geofabrik api key as an environment variable prior to running compose. Hopefully, this will pull the secret properly and allow it to be used in the workflow.

Using DOCKER_USER in place of GEOFABRIK_API until the secret is successfully carried through to the test.

echoing the secret to see if it's being pulled at all

Maybe it's because the quotes are not there?

Adding the workflow status badge to the readme

Running the test on my fork again before making further changes.

???? Not sure why it didn't run last push.

Previous run of this test succeeded. Going to see what happens when I remove port 8080 as the only change (again)

final changes (I hope!) to setup module + re-adding the port since the test did not work without it.

Reverting to running test on schedule since (I think) everything else is done.

Done??