Merge pull request #91 from Xpirix/dev_environment

Dev environment updated instructions

Author: Xpirix

INSTALL.md

@@ -7,16 +7,28 @@
 - Path to your repo should be `<your current directory>/QGIS-Plugins-Website `
 - Go to dockerize directory `cd QGIS-Plugins-Website/dockerize`
 
+- Create .env file
+```bash
+$ cp .env.template .env
+```
+
+- Edit .env file and set your environment variables
+- Enable debug mode by setting `DEBUG=True`.
+- Uncomment RABBITMQ_IMAGE if you want to use a different image version. 
+Default is `rabbitmq:3.7-alpine`. This is useful if you encounter any issues 
+with the default image (can be also use to change the image without editing the code). 
+Please also see [this discussion](https://github.com/qgis/QGIS-Plugins-Website/issues/80).
+
 - Build and spin container
 ```bash
 $ make build
-$ make web
 $ make devweb
 ```
 
-- Run migrate
+- Run migrate and seed db
 ```bash
-$ make migrate
+$ make devweb-migrate
+$ make dbseed
 ```
 
 If you have a backup, you can restore it:
@@ -25,16 +37,47 @@ If you have a backup, you can restore it:
 make dbrestore
 ```
 
-otherwise, you can seed initial data from fixtures:
+- Set up python interpreter in PyCharm or just runserver from devweb container:
+```bash
+$ make devweb-runserver
 ```
-make dbseed
+and now, you can see your site at `http://localhost:62202` `http://0.0.0.0:62202`.
+
+- Run unit tests
+```bash
+$ make devweb-runtests
 ```
 
-- Set up python interpreter in PyCharm or just runserver from devweb container:
+- You can use the following credentials to log in if you ran the `make dbseed` command:
+```
+Admin account:
+username: admin
+password: admin
+
+Staff account:
+username: staff
+password: staff
+
+Plugin author account:
+username: creator
+password: creator
+```
+
+- Update migrations:
 ```bash
-$ make devweb-runserver
+$ make devweb-makemigrations app='plugins'
+```
+
+- Run a django command from the devweb container
+```bash
+$ make devweb-exec c='python manage.py createsuperuser'
+$ make devweb-exec c='pip freeze'
+```
+
+- Enter the devweb container shell
+```bash
+$ make devweb-shell
 ```
-and now, you can see your site at `http://0.0.0.0:62202` (skip this step if you are using PyCharm interpreter)
 
 - If 'None' appears in the search results, it indicates a misalignment between the search index and the database. This discrepancy often arises when a plugin is deleted from the model but persists in the search index. To rectify this issue, it is essential to synchronize the search index with the database by rebuilding it. Execute the following command to initiate the rebuilding process:
 

dockerize/.env.template

@@ -45,4 +45,7 @@ SENTRY_RATE=1.0
 METABASE_DOWNLOAD_STATS_URL='https://plugins.qgis.org/metabase/public/dashboard/<dashboard_id>'
 
 # Uwsgi Docker image
-UWSGI_DOCKER_IMAGE='qgis/qgis-plugins-uwsgi:latest'
+UWSGI_DOCKER_IMAGE='qgis/qgis-plugins-uwsgi:latest'
+
+# Rabbitmq docker image
+# RABBITMQ_IMAGE='rabbitmq:3.13.7-alpine'

dockerize/Makefile

@@ -199,13 +199,6 @@ exec:
 	@echo "------------------------------------------------------------------"
 	@docker compose -p $(PROJECT_ID) $(c)
 
-loadmenu:
-	@echo
-	@echo "------------------------------------------------------------------"
-	@echo "Delete all simplemenu entries and load from fixtures/all_menu.json"
-	@echo "------------------------------------------------------------------"
-	@docker compose -p $(PROJECT_ID) exec uwsgi python manage.py clear_simplemenu
-	@docker compose -p $(PROJECT_ID) exec uwsgi python manage.py loaddata fixtures/all_menu.json
 # ----------------------------------------------------------------------------
 #    D E V E L O P M E N T    C O M M A N D S
 # ----------------------------------------------------------------------------
@@ -231,6 +224,34 @@ devweb: db
 	@echo "------------------------------------------------------------------"
 	@docker compose -p $(PROJECT_ID) up --no-deps -d devweb rabbitmq worker beat webpack
 
+devweb-migrate:
+	@echo
+	@echo "------------------------------------------------------------------"
+	@echo "Migrate in development mode only"
+	@echo "------------------------------------------------------------------"
+	@docker compose -p $(PROJECT_ID) exec devweb python manage.py migrate
+
+devweb-makemigrations:
+	@echo
+	@echo "------------------------------------------------------------------"
+	@echo "Migrate in development mode only"
+	@echo "------------------------------------------------------------------"
+	@docker compose -p $(PROJECT_ID) exec devweb python manage.py makemigrations $(app)
+
+devweb-exec:
+	@echo
+	@echo "------------------------------------------------------------------"
+	@echo "Execute a specific docker command"
+	@echo "------------------------------------------------------------------"
+	@docker compose -p $(PROJECT_ID) exec devweb $(c)
+
+devweb-shell:
+	@echo
+	@echo "------------------------------------------------------------------"
+	@echo "Shelling into the devweb container(s)"
+	@echo "------------------------------------------------------------------"
+	@docker compose -p $(PROJECT_ID) exec devweb bash
+
 devweb-runserver: devweb
 	@echo
 	@echo "------------------------------------------------------------------"
@@ -244,3 +265,11 @@ dbseed:
 	@echo "Seed db with JSON data from /fixtures/*.json"
 	@echo "------------------------------------------------------------------"
 	@docker compose -p $(PROJECT_ID) exec devweb bash -c 'python manage.py loaddata fixtures/*.json'
+
+devweb-runtests:
+	@echo
+	@echo "------------------------------------------------------------------"
+	@echo "Running unit tests in development mode"
+	@echo "------------------------------------------------------------------"
+	@docker compose -p $(PROJECT_ID) exec devweb bash -c 'python manage.py makemigrations'
+	@docker compose -p $(PROJECT_ID) exec devweb bash -c 'python manage.py test'

dockerize/README.md

@@ -37,11 +37,6 @@ make metabase
 make web
 ```
 
-- **dbbackups**: Starts the database backups container.
-```sh
-make dbbackups
-```
-
 - **certbot**: Starts the Certbot container for managing SSL certificates.
 ```sh
 make certbot
@@ -164,11 +159,31 @@ make build-dev
 make devweb-test
 ```
 
-- **devweb:** Starts the `devweb` container for development, along with RabbitMQ, worker, and beat containers.
+- **devweb:** Starts the `devweb` container for development, along with RabbitMQ, worker, beat, and webpack containers.
 ```sh
 make devweb
 ```
 
+- **devweb-migrate:** Runs database migrations in the `devweb` container.
+```sh
+make devweb-migrate
+```
+
+- **devweb-makemigrations:** Creates new migration files based on changes in models in the `devweb` container.
+```sh
+make devweb-makemigrations app=app_name
+```
+
+- **devweb-exec:** Executes a specific Docker command in the `devweb` container. Specify the command with the `c` variable.
+```sh
+make devweb-exec c="command"
+```
+
+- **devweb-shell:** Opens a shell in the `devweb` container.
+```sh
+make devweb-shell
+```
+
 - **devweb-runserver:** Runs the Django development server inside the `devweb` container.
 ```sh
 make devweb-runserver
@@ -177,9 +192,4 @@ make devweb-runserver
 - **dbseed:** Seeds the database with initial data from JSON files in the `fixtures` directory.
 ```sh
 make dbseed
-```
-
-- **loadmenu:** Clear all menu entries and load menu from JSON file at `fixtures/simplemenu.json`.
-```sh
-make loadmenu
 ```

dockerize/docker-compose.yml

@@ -104,7 +104,7 @@ services:
       - ${QGISPLUGINS_MEDIA_VOLUME}:/home/web/media:rw
 
   rabbitmq:
-    image: rabbitmq:3.7-alpine
+    image: ${RABBITMQ_IMAGE:-rabbitmq:3.7-alpine}
     hostname: rabbitmq
     volumes:
       - rabbitmq:/var/lib/rabbitmq

qgis-app/base/tests/test_middleware.py

@@ -5,7 +5,6 @@
 from django.urls import reverse
 
 class HandleTemplateDoesNotExistMiddlewareTest(TestCase):
-    fixtures = ["fixtures/simplemenu.json"]
     def setUp(self):
         # Mock get_response function
         self.factory = RequestFactory()