feat: set EDXAPP_TEST_MONGO_HOST=mongodb in openedx-dev
#1083
Conversation
| @@ -275,6 +275,9 @@ RUN pip install -e "/mnt/{{ name }}" | |||
| # Add ipdb as default PYTHONBREAKPOINT | |||
| ENV PYTHONBREAKPOINT=ipdb.set_trace | |||
|
|
|||
| # Point unit tests at the MongoDB container | |||
| ENV EDXAPP_TEST_MONGO_HOST=mongodb | |||
There was a problem hiding this comment.
I think we want to point to {{ MONGODB_HOST }}, and not "mongodb", in case MongoDB runs outside of Tutor. Same for MONGO_PORT_NUM = {{ MONGODB_PORT }}. But then, we don't want to make the image build depend on user configuration, so we should not store these settings here...
I don't have a better alternative to offer that does not break compatibility with devstack... I think that test settings should be overridable, and that xmodule/modulestore/tests/mongo_connection.py should not read EDXAPP_TEST_MONGO_HOST. But that would break the current behaviour.
There was a problem hiding this comment.
But then, we don't want to make the image build depend on user configuration, so we should not store these settings here...
I'm not sure I follow. There are several other points in the Dockerfile that depend on user configuration. As long as the setting has a reasonable default value that most people will use (i.e., mongodb), it seems fine to me to build that into the image, no?
I don't have a better alternative to offer that does not break compatibility with devstack... I think that test settings should be overridable, and that xmodule/modulestore/tests/mongo_connection.py should not read EDXAPP_TEST_MONGO_HOST. But that would break the current behaviour.
Agreed, the tests ought to use the MONGO_HOST and MONGO_PORT_NUM Django settings. The way that they currently ignore the settings and look up the env vars directly is so very wrong.
Devstack is deprecated, and starting right after that Sumac cut, we are no longer obligated to avoid breaking it. Regardless of whether you accept this PR, let's make the upstream fix this October.
There was a problem hiding this comment.
Régis has already added his comment/context. Once those are resolved, this will be good to go.
There was a problem hiding this comment.
@kdmccormick Hi, what's plan for this PR?
There was a problem hiding this comment.
I think we want to point to {{ MONGODB_HOST }}, and not "mongodb", in case MongoDB runs outside of Tutor. Same for MONGO_PORT_NUM = {{ MONGODB_PORT }}.
Done 👍🏻
I don't have a better alternative to offer that does not break compatibility with devstack... I think that test settings should be overridable, and that xmodule/modulestore/tests/mongo_connection.py should not read EDXAPP_TEST_MONGO_HOST. But that would break the current behaviour.
I poked around at simplifying this. I think that the only proper fix is to drop the EDXAPP_TEST_MONGO_* env vars and get rid of the MONGO_* Django settings, as they are all only used in tests. What prod uses is DOC_STORE_CONFIG -- test settings should override pieces of that. Unfortunately that's too much for me to bite off right now, but I'm hoping I can address this (and other bad config patterns) in openedx/edx-platform#35146
In the meantime, I still think this simplification would be valuable to Tutor users. Can you re-review @regisb ?
| @@ -0,0 +1 @@ | |||
| [Improvement] Set `EDXAPP_TEST_MONGO_HOST` env var in the openedx-dev image so that it no longer needs to be set by hand when running edx-platform unit tests (by @kdmccormick). | |||
There was a problem hiding this comment.
do we need a changelog entry for this, considering this is only meant for dev/testing and wont impact the operators as such?
There was a problem hiding this comment.
Since Tutor is both an operator tool and a developer tool, I think it is good to make not of the improvements we make for developers too.
Currently, we are asking devs to set this env var manually before they run tests.
Why not just set it in the development image for them?