Use poetry for python dependency management (#1766)

.github/workflows/ci.yml

@@ -45,28 +45,27 @@ jobs:
       - name: Apt install
         run: cat Aptfile | sudo xargs apt-get install
 
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.5.1
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
           python-version: "3.9.6"
 
-      - id: cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt', '**/test_requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
       - name: Install dependencies
-        run: pip install -r requirements.txt -r test_requirements.txt
+        run: poetry install --no-interaction
 
       # disabled for now because it's broken for some reason
       # - name: Lint
       #   run: pylint ./**/*.py
 
       - name: Code Formatting (Black)
-        run: black --check .
+        run: poetry run black --check .
 
       # Configurations required for elasticsearch.
       - name: Configure sysctl limits

Dockerfile

@@ -17,16 +17,36 @@ RUN mkdir /app
 RUN adduser --disabled-password --gecos "" mitodl
 RUN mkdir /var/media && chown -R mitodl:mitodl /var/media
 
+# Poetry env configuration
+ENV  \
+  # poetry:
+  POETRY_VERSION=1.5.1 \
+  POETRY_VIRTUALENVS_CREATE=false \
+  POETRY_CACHE_DIR='/tmp/cache/poetry' \
+  POETRY_HOME='/home/mitodl/.local' \
+  VIRTUAL_ENV="/opt/venv"
+ENV PATH="$VIRTUAL_ENV/bin:$POETRY_HOME/bin:$PATH"
+
 # Install project packages
-COPY requirements.txt /tmp/requirements.txt
-COPY test_requirements.txt /tmp/test_requirements.txt
-RUN pip install -r requirements.txt -r test_requirements.txt
+COPY pyproject.toml /app
+COPY poetry.lock /app
+RUN chown -R mitodl:mitodl /app
+RUN mkdir ${VIRTUAL_ENV} && chown -R mitodl:mitodl ${VIRTUAL_ENV}
+
+USER mitodl
+RUN curl -sSL https://install.python-poetry.org \
+  | \
+  POETRY_VERSION=${POETRY_VERSION} \
+  POETRY_HOME=${POETRY_HOME} \
+  python3 -q
+WORKDIR /app
+RUN python3 -m venv $VIRTUAL_ENV
+RUN poetry install
 
 # Add project
 COPY . /app
-WORKDIR /app
-RUN chown -R mitodl:mitodl /app
 
+USER root
 RUN apt-get clean && apt-get purge
 
 # Set pip cache folder, as it is breaking pip when it is on a shared volume

RELEASE.rst

@@ -1681,4 +1681,3 @@ Version 0.1.0 (Released August 04, 2021)
 - Fix flaky util test
 - Add courses app
 - Added Wagtail and initial model definitions
-

app.base.json

@@ -11,6 +11,9 @@
     {
       "url": "https://github.com/heroku/heroku-buildpack-nodejs"
     },
+    {
+      "url": "https://github.com/moneymeets/python-poetry-buildpack"
+    },
     {
       "url": "https://github.com/heroku/heroku-buildpack-python"
     },

app.json

@@ -11,6 +11,9 @@
     {
       "url": "https://github.com/heroku/heroku-buildpack-nodejs"
     },
+    {
+      "url": "https://github.com/moneymeets/python-poetry-buildpack"
+    },
     {
       "url": "https://github.com/heroku/heroku-buildpack-python"
     },
@@ -579,4 +582,4 @@
   },
   "success_url": "/",
   "website": "https://github.com/mitodl/mitx-online"
-}
+}

authentication/middleware_test.py

@@ -20,7 +20,6 @@ def test_process_exception_no_strategy(rf, settings):
 def test_process_exception(rf, settings):
     """Tests that a process_exception handles auth exceptions correctly"""
     settings.DEBUG = False
-    msg = "error message"
     request = rf.get(reverse("social:complete", args=("email",)))
     # social_django depends on request.sesssion, so use the middleware to set that
     SessionMiddleware().process_request(request)
@@ -30,10 +29,11 @@ def test_process_exception(rf, settings):
     request.backend = backend
 
     middleware = SocialAuthExceptionRedirectMiddleware()
-    result = middleware.process_exception(request, AuthAlreadyAssociated(backend, msg))
+    error = AuthAlreadyAssociated(backend)
+    result = middleware.process_exception(request, error)
     assert result.status_code == status.HTTP_302_FOUND
     assert result.url == "{}?message={}&backend={}".format(
-        reverse("login"), urlquote(msg), backend.name
+        reverse("login"), urlquote(error.__str__()), backend.name
     )