Changes to Project structure (#4269)

* structure

* fix docker compose

* Changes to project structure and Docker image building
- Project installs as packaget on dist image
- Rebuild dockerfile structure
- removed unused file
- addjusted entrypoint and manage.py

* fix code style

* selenium test fixes

* changed settings

---------

Co-authored-by: Domenico DiNicola <[email protected]>

.github/helpers/docker-compose.selenium.yml

@@ -8,7 +8,7 @@ services:
       - ../src/report/:/code/report/
       - type: volume
         source: backend-web-app
-        target: /code/hct_mis_api/apps/web
+        target: /code/src/hct_mis_api/apps/web
         volume:
           nocopy: false
     depends_on:
@@ -31,7 +31,7 @@ services:
       - backend-web-app:/tmp/
     command: |
       sh -c "
-        cp -r ./hct_mis_api/apps/web/* /tmp/
+        cp -r /packages/__pypackages__/3.11/lib/hct_mis_api/apps/web/* /tmp/
       "
     restart: "no"
 

.gitignore

@@ -101,6 +101,8 @@ ENV/
 env.bak/
 venv.bak/
 
+.pdm-python
+
 # Spyder project settings
 .spyderproject
 .spyproject

development_tools/compose.yml

@@ -25,11 +25,14 @@ services:
     ports:
       - "8080:8000"
     volumes:
-      - ../src:/code/
+      - ../src:/code/src/
+      - ../manage.py:/code/manage.py
+      - ../pyproject.toml:/code/pyproject.toml
+      - ../pdm.lock:/code/pdm.lock
       - ../tests:/tests/
       - backend-data:/data
-      - ../src/pyproject.toml:/packages/pyproject.toml
-      - ../src/pdm.lock:/packages/pdm.lock
+      - ../pyproject.toml:/packages/pyproject.toml
+      - ../pdm.lock:/packages/pdm.lock
       - ipython_data_local:/root/.ipython
     command: "dev"
     depends_on:

docker/Dockerfile

@@ -41,11 +41,10 @@ RUN apt-get update \
 
 ENV PDM_PACKAGES=/packages
 ENV CODE=/code
-ENV PDM_NO_SELF=True
 ENV PDM_PROJECT=$PDM_PACKAGES
 ENV PYPACKAGES=$PDM_PACKAGES/__pypackages__/3.11
 ENV PYTHONPYCACHEPREFIX=/tmp/pycache \
-    PYTHONPATH=$PYPACKAGES/lib:$CODE:$PYTHONPATH \
+    PYTHONPATH=$PYPACKAGES/lib:$PYTHONPATH \
     PATH=$PYPACKAGES/bin:$PATH \
     XDG_RUNTIME_DIR=/run/user/"${UID}"
 
@@ -54,22 +53,22 @@ WORKDIR $CODE
 COPY --from=waitforit /data/waitforit /usr/local/bin/waitforit
 
 # Dist builder image
-FROM base as builder
-
+FROM base as pdm
 RUN pip install --upgrade pip &&\
     pip install pdm==2.15.2 &&\
     pip install setuptools==71.1.0 &&\
     pdm config cache_dir /var/cache/pdm &&\
     pdm config python.use_venv false &&\
     pdm config venv.in_project true &&\
     pdm config check_update false
-
 WORKDIR $PDM_PACKAGES
-COPY src/pyproject.toml src/pdm.lock ./
-RUN pdm sync --prod --no-editable --no-self --no-isolation
+COPY README.md LICENSE pyproject.toml pdm.lock ./
+
+
+
 
 # Dev image
-FROM builder AS dev
+FROM pdm AS dev
 
 RUN apt-get update \
   && apt-get install -y --no-install-recommends \
@@ -83,26 +82,14 @@ RUN apt-get update \
   && apt-get clean \
   && rm -rf /var/lib/apt/lists/*
 
+ENV PYTHONPATH=$CODE/src:/test/:$PYTHONPATH
 RUN pdm sync --no-editable --no-self --no-isolation
 
 WORKDIR $CODE
-COPY ./src/ ./
+COPY ./src/ ./src/
 COPY ./tests /tests
-
-
-
-COPY ./docker/entrypoint.sh /bin/
-ENTRYPOINT ["entrypoint.sh"]
-
-## Dist (backend only) image
-FROM base AS be-dist
-
-COPY ./src/ ./
-COPY --chown=hope:hope --from=builder $PDM_PACKAGES $PDM_PACKAGES
-COPY --chown=hope:hope --from=certs /data/psql-cert.crt /code/psql-cert.crt
-
-USER hope
-
+COPY ./manage.py ./manage.py
+COPY .flake8 pyproject.toml pdm.lock ./
 COPY ./docker/entrypoint.sh /bin/
 ENTRYPOINT ["entrypoint.sh"]
 
@@ -117,7 +104,22 @@ RUN yarn install --frozen-lockfile --network-timeout 600000
 COPY ./src/frontend ./
 RUN NODE_ENV="production" NODE_OPTIONS="--max-old-space-size=4096" yarn build
 
+# Dist builder image
+FROM pdm as dist-builder
+COPY ./src/ ./src/
+COPY --chown=hope:hope --from=frontend-builder /fe-build/build $PDM_PACKAGES/src/hct_mis_api/apps/web/static/web
+RUN pdm sync --prod --no-editable --no-isolation
+
+
+## Dist (backend only) image
+FROM base AS dist
+
+
+COPY ./src/gunicorn_config.py /conf/gunicorn_config.py
+COPY --chown=hope:hope --from=dist-builder $PDM_PACKAGES $PDM_PACKAGES
+COPY --chown=hope:hope --from=certs /data/psql-cert.crt /certs/psql-cert.crt
 
-FROM be-dist AS dist
+USER hope
 
-COPY --chown=hope:hope --from=frontend-builder /fe-build/build ./hct_mis_api/apps/web/static/web
+COPY ./docker/entrypoint.sh /bin/
+ENTRYPOINT ["entrypoint.sh"]

docker/entrypoint.sh

@@ -7,7 +7,7 @@ wait_for_db() {
 }
 
 if [ $# -eq 0 ]; then
-    exec gunicorn hct_mis_api.wsgi -c /code/gunicorn_config.py
+    exec gunicorn hct_mis_api.wsgi -c /conf/gunicorn_config.py
 else
   case "$1" in
     "dev")