Set up Docker and edited Readme

Author: user-of-github

.github/workflows/run-unittests.yml

@@ -1,19 +1,12 @@
-FROM python:3.10-alpine
+FROM python:3.9.5-slim
 
+# set env variables
 ENV PYTHONDONTWRITEBYTECODE 1
 ENV PYTHONUNBUFFERED 1
 
-RUN apk update \
-    && apk add postgresql-dev gcc python3-dev musl-dev
-
-
-RUN mkdir /code
-
-WORKDIR /code
-
-COPY . /code/
-RUN python -m pip install --upgrade pip
-
+# install dependencies
+COPY requirements.txt .
 RUN pip install -r requirements.txt
 
-ENTRYPOINT ["/usr/src/app/entrypoint.sh"]
+# copy project
+COPY . .

Dockerfile

@@ -9,38 +9,61 @@
 * _PyTest_     
 
 
-## Some commands for comfortable run:  
-
-#### To run tests (pytest)  
+## _Some commands for comfortable run:_  
+### • To test:  
+#### To run tests [pytest]:  
 1. Activate venv
 2. `pip install -r requirements.txt`  
 3. `coverage run -m pytest`  
 4. `coverage report` or `coverage html` (for generating report in HTML)
-5. Remove `coverage-badge.svg` file and run `coverage-badge -o coverage.svg`
-    
+5. Remove `coverage-badge.svg` file and run `coverage-badge -o coverage.svg`  
+
+#### To run tests [unittest from task-source]:   
+1. `pip install -r requirements.txt` 
+2. Run server in Docker (see below how to run in docker) or in usual way ()
+3. `python unit_test.py`
 
-#### To run application locally (you must have PostgreSQL installed and set up):  
+### • To launch:
+#### To run application locally [no Docker] (you must have PostgreSQL installed and set up):  
 1. Activate venv
 2. `pip install -r requirements.txt`
 3. Change `DOCKER` field in `config.json` to `false`  
 4. `python manage.py makemigrations`  
 5. `python manage.py migrate`  
-6. `python manage.py runserver localhost:80` (or other port)  
-
-#### To set up remote machine:  
-1. Connect to remote machine (via SSH)
-2. `sudo git clone <this_repo_url>`  
-3. `cd rest-api-test-task`  
-4. `sudo python3 -m venv venv`  
-5. `source venv/bin/activate`  
-6. `sudo pip3 install -r requirements.txt`  
-7. [Auto running:](https://winitpro.ru/index.php/2019/10/11/avtozagruzka-servisov-i-skriptov-v-linux/)  
-8. `sudo touch /etc/systemd/system/test-script.service` 
-9. `sudo chmod 664 /etc/systemd/system/test-script.service`
-10. `sudo nano /etc/systemd/system/test-script.service`
-11. Write file 
-12. Write entry-point SH executor  
-13. `sudo systemctl enable test-script.service`
+6. `python manage.py runserver 0.0.0.0:80` (or other port, for example)  
+
+#### To run application locally [with Docker] (build & run)
+1. `docker-compose up -d --build`
+2. `docker-compose exec web python manage.py makemigrations --noinput`  
+3. `docker-compose exec web python manage.py migrate --noinput`  
+4. [optional] `docker-compose exec web python manage.py createsuperuser`
+5. `docker-compose up`
+
+### • To deploy:
+#### To set up remote machine:
+1. Set `docker` field to `true`/`false` (depending on if you're going to run in Docker)
+2. Push changes to GitHub repository `git add <...>`, `git commit -m <...>`, `git push`
+3. Connect to remote machine (via SSH) `ssh login@ip`. Following actions are done from remote machine
+4. `git clone <this_repo_url>`  
+5. `cd rest-api-test-task` 
+6. For non-Docker run:
+   1. `python3 -m venv venv`  
+   2. `source venv/bin/activate`  
+   3. `pip3 install -r requirements.txt`  
+   4. `python3 manage.py makemigrations`  
+   5. `python3 manage.py migrate`
+7. For Docker-run:
+   1. `docker-compose up -d --build`
+   2. `docker-compose exec web python manage.py makemigrations --noinput`  
+   3. `docker-compose exec web python manage.py migrate --noinput`  
+   4. [optional] `docker-compose exec web python manage.py createsuperuser`
+8. [Auto running:](https://winitpro.ru/index.php/2019/10/11/avtozagruzka-servisov-i-skriptov-v-linux/)  
+9. `sudo touch /etc/systemd/system/test-script.service` 
+10. `sudo chmod 664 /etc/systemd/system/test-script.service`
+11. `sudo nano /etc/systemd/system/test-script.service`
+12. Write file 
+13. Write entry-point SH executor  (for running with or without Docker)
+14. `sudo systemctl enable test-script.service`
 &nbsp;  
 
 

Readme.md

@@ -1,4 +1,4 @@
 {
-  "DOCKER": false,
+  "DOCKER": true,
   "DEBUG": true
 }

config.json

@@ -1,21 +1,20 @@
-version: '3.7'
+version: '3.8'
 services:
   web:
-    restart: always
     build: .
-    command: python manage.py runserver 0.0.0.0:80
-    volumes:
-      - ./:/usr/src/app/
+    command: bash -c 'while !</dev/tcp/db/5432; do sleep 1; done; python manage.py runserver 0.0.0.0:80'
     ports:
-      - "80:80"
-    env_file:
-      - ./.env.dev
+      - 80:80
+    environment:
+      - DEBUG=1
     depends_on:
       - db
   db:
-    image: postgres:13-alpine
+    image: postgres:12-alpine
     volumes:
       - postgres_data:/var/lib/postgresql/data/
+    expose:
+      - 5432
     environment:
       - POSTGRES_USER=onlineserviceuser
       - POSTGRES_PASSWORD=onlineservicepassword

docker-compose.yml

@@ -6,7 +6,7 @@
 import urllib.parse
 import urllib.request
 
-API_BASEURL = 'https://responses-1920.usr.yandex-academy.ru'
+API_BASEURL = 'http://localhost:80'
 
 
 ROOT_ID = "069cb8d7-bbdd-47d3-ad8f-82ef4c269df1"
@@ -239,8 +239,8 @@ def test_nodes():
 
 def test_sales():
     status, response = request(f'/sales?date=2022-02-04T00:00:00.000Z')
-    print(response)
-    print(status)
+    # print(response)
+    # print(status)
     assert status == 200, f"Expected HTTP status code 200, got {status}"
     print("Test sales passed.")
 
@@ -270,7 +270,7 @@ def test_delete():
 def test_all():
     test_import()
     test_nodes()
-    #test_sales() # I have sales, but sometimes DEPLOYED app responses with 500
+    test_sales() # I have sales, but sometimes DEPLOYED app responses with 500
     #test_stats()
     test_delete()