Merge pull request buildingSMART#85 from buildingSMART/main

Sync main back to development

.dockerignore

@@ -1,5 +1,4 @@
 # .dockerignore file for docker compose
-**/.env
 **/.dev
 **/.ssh
 **/.DS_Store

.env

@@ -1,15 +1,15 @@
 # variables in Docker Compose
-VERSION = v0.6.4
+VERSION = 0.6.5
 DEBUG = True
 ENV = Development
-PUBLIC_URL = https://dev.validate.buildingsmart.org
+PUBLIC_URL = http://localhost
 
 # Django
 MEDIA_ROOT = /files_storage
 DJANGO_DB = postgresql
 DJANGO_SECRET_KEY = django-insecure-um7-^+&jbk_=80*xcc9uf4nh$4koida7)ja&6!vb*$8@n288jk
-DJANGO_ALLOWED_HOSTS = dev.validate.buildingsmart.org
-DJANGO_TRUSTED_ORIGINS = https://dev.validate.buildingsmart.org https://authentication.buildingsmart.org
+DJANGO_ALLOWED_HOSTS = localhost
+DJANGO_TRUSTED_ORIGINS = http://localhost:3000 http://localhost http://localhost:8000
 DJANGO_LOG_LEVEL = INFO
 DJANGO_GUNICORN_WORKERS = 3
 DJANGO_GUNICORN_THREADS_PER_WORKER = 4
@@ -31,15 +31,16 @@ DJANGO_DB_USER_CONTEXT = SYSTEM
 CELERY_CONCURRENCY = 4
 
 # Email
-MAILGUN_API_URL = https://api.eu.mailgun.net/v3/validate.buildingsmart.org/messages
-MAILGUN_API_KEY = <API_KEY>
+MAILGUN_API_URL = <MG_API_URL>
+MAILGUN_API_KEY = <MG_API_KEY>
 MAILGUN_FROM_NAME = Validation Service
-MAILGUN_FROM_EMAIL = noreply@validate.buildingsmart.org
+MAILGUN_FROM_EMAIL = noreply@localhost
 ADMIN_EMAIL = noreply@localhost
 CONTACT_EMAIL = noreply@localhost
 
 # IAM
 B2C_CLIENT_ID = <B2C_CLIENT_ID>
 B2C_CLIENT_SECRET = <B2C_CLIENT_SECRET>
 B2C_AUTHORITY = <B2C_AUTHORITY>
-B2C_USER_FLOW = <B2C_USER_FLOW>
+B2C_USER_FLOW = <B2C_USER_FLOW>
+USE_WHITELIST = False

Makefile

@@ -1,5 +1,3 @@
-VERSION=v0.6.4
-
 none:
 	@echo ERROR: Enter at least one target (start, start-load-balanced, start-full, start-infra-only, stop, build, rebuild, clean, fetch-modules)
 
@@ -36,18 +34,22 @@ rebuild: clean
 
 rebuild-frontend:
 	docker stop frontend || true
-	docker rmi --force buildingsmart/validationsvc-frontend:${VERSION}
+	docker rmi --force $$(docker images -q 'buildingsmart/validationsvc-frontend' | uniq) || true
 	docker compose build
 
 rebuild-backend:
 	docker stop backend || true
 	docker stop worker || true
-	docker rmi --force buildingsmart/validationsvc-backend:${VERSION}
+	docker rmi --force $$(docker images -q 'buildingsmart/validationsvc-backend' | uniq) || true
 	docker compose build
 
 clean:
-	docker compose down
-	docker image prune --force
+	docker stop backend || true
+	docker stop worker || true
+	docker stop frontend || true
+	docker rmi --force $$(docker images -q 'buildingsmart/validationsvc-frontend' | uniq) || true
+	docker rmi --force $$(docker images -q 'buildingsmart/validationsvc-backend' | uniq) || true
+	docker image prune --all --force --filter=label=org.opencontainers.image.vendor="buildingSMART.org"	
 	docker system prune --all --force --volumes --filter=label=org.opencontainers.image.vendor="buildingSMART.org"	
 
 fetch-modules:

README.md

@@ -99,7 +99,7 @@ exit
 6. Navigate to different services:
 
 - Validation Service - React UI: http://localhost
-- Django Admin UI: http://localhost/admin (or http://localhost:8000/admin) - default user/password: root/root
+- Django Admin UI: http://localhost/admin - default user/password per step 5.
 - Django API - Swagger: http://localhost/api/swagger-ui
 - Django API - Redoc: http://localhost/api/redoc
 
@@ -168,6 +168,8 @@ npm run start
 ```shell
 cd backend
 
+. .dev/venv/bin/activate
+
 DJANGO_SUPERUSER_USERNAME=root DJANGO_SUPERUSER_PASSWORD=root DJANGO_SUPERUSER_EMAIL=root@localhost python3 manage.py createsuperuser --noinput
 
 DJANGO_SUPERUSER_USERNAME=SYSTEM DJANGO_SUPERUSER_PASSWORD=system DJANGO_SUPERUSER_EMAIL=system@localhost python3 manage.py createsuperuser --noinput
@@ -176,7 +178,7 @@ DJANGO_SUPERUSER_USERNAME=SYSTEM DJANGO_SUPERUSER_PASSWORD=system DJANGO_SUPERUS
 9. Navigate to different services:
 
 - Validation Service - React UI: http://localhost:3000
-- Django Admin UI: http://localhost:8000/admin - default user/password: root/root
+- Django Admin UI: http://localhost:8000/admin - default user/password per step 8
 - Django API - Swagger: http://localhost:8000/api/swagger-ui
 - Django API - Redoc: http://localhost:8000/api/redoc
 - Celery Flower UI: http://localhost:5555

backend/.env

@@ -7,7 +7,7 @@
 #    4) host environment variables
 #    5) default value in code
 
-VERSION = 0.6.4
+VERSION = 0.6.5
 DEBUG = True
 ENV = Development
 PUBLIC_URL = http://localhost:3000
@@ -37,9 +37,16 @@ TASK_TIMEOUT_LIMIT = 3600
 DJANGO_DB_USER_CONTEXT = SYSTEM
 
 # Email
-MAILGUN_API_URL = https://api.eu.mailgun.net/v3/validate.buildingsmart.org/messages
-MAILGUN_API_KEY = <API_KEY>
+MAILGUN_API_URL = <MG_API_URL>
+MAILGUN_API_KEY = <MG_API_KEY>
 MAILGUN_FROM_NAME = Validation Service
-MAILGUN_FROM_EMAIL = noreply@validate.buildingsmart.org
+MAILGUN_FROM_EMAIL = noreply@localhost
 ADMIN_EMAIL = noreply@localhost
-CONTACT_EMAIL = noreply@localhost
+CONTACT_EMAIL = noreply@localhost
+
+# IAM
+B2C_CLIENT_ID = <B2C_CLIENT_ID>
+B2C_CLIENT_SECRET = <B2C_CLIENT_SECRET>
+B2C_AUTHORITY = <B2C_AUTHORITY>
+B2C_USER_FLOW = <B2C_USER_FLOW>
+USE_WHITELIST = False

backend/apps/ifc_validation/admin.py

@@ -4,6 +4,7 @@
 from django.contrib import admin
 from django.contrib import messages
 from django.contrib.auth import get_permission_codename
+from django.contrib.auth.admin import UserAdmin
 from django.contrib.auth.models import User
 from django.http import HttpResponseRedirect
 from django.shortcuts import render
@@ -315,7 +316,7 @@ class AuthoringToolAdmin(BaseAdmin):
     list_filter = ["company", "created", "updated"]
 
 
-class UserAdmin(BaseAdmin):
+class CustomUserAdmin(UserAdmin):
 
     list_display = ["id", "username", "email", "first_name", "last_name", "is_active", "is_staff", "is_superuser", "last_login", "date_joined"]
     list_filter = ['is_staff', 'is_superuser', 'is_active']
@@ -348,4 +349,4 @@ def deactivate(self, request, queryset):
 admin.site.register(AuthoringTool, AuthoringToolAdmin)
 
 admin.site.unregister(User)
-admin.site.register(User, UserAdmin)
+admin.site.register(User, CustomUserAdmin)

backend/apps/ifc_validation_bff/views_legacy.py

@@ -20,7 +20,8 @@
 
 from apps.ifc_validation.tasks import ifc_file_validation_task
 
-from core.settings import MEDIA_ROOT, DEVELOPMENT, LOGIN_URL, MAX_FILES_PER_UPLOAD
+from core.settings import MEDIA_ROOT, MAX_FILES_PER_UPLOAD
+from core.settings import DEVELOPMENT, LOGIN_URL, USE_WHITELIST 
 
 logger = logging.getLogger(__name__)
 
@@ -41,8 +42,9 @@ def get_current_user(request):
 
         logger.info(f"Authenticated user with username = '{username}' via OAuth, user.id = {user.id}")
         return user
-
-    elif DEVELOPMENT:
+
+    # only used for local development
+    elif DEVELOPMENT and not USE_WHITELIST:
 
         username = 'development'
         user = User.objects.all().filter(username=username).first()

backend/core/settings.py

@@ -359,6 +359,9 @@
 LOGIN_CALLBACK_URL = os.environ.get("CALLBACK_URL", f"{PUBLIC_URL}/callback")
 POST_LOGIN_REDIRECT_URL = os.environ.get("POST_LOGIN_REDIRECT_URL", f"{PUBLIC_URL}/dashboard")
 
+# whitelisting of users
+USE_WHITELIST = os.environ.get("USE_WHITELIST", False)
+
 AUTHLIB_OAUTH_CLIENTS = {
     'b2c': {
         'client_id': B2C_CLIENT_ID,

backend/core/views_auth.py

@@ -11,7 +11,8 @@
 from authlib.integrations.django_client import OAuth
 
 from .email_tasks import send_user_registered_admin_email_task
-from .settings import LOGIN_CALLBACK_URL, POST_LOGIN_REDIRECT_URL, LOGOUT_URL, LOGIN_URL, PRODUCTION
+from .settings import LOGIN_CALLBACK_URL, POST_LOGIN_REDIRECT_URL, LOGOUT_URL, LOGIN_URL 
+from .settings import USE_WHITELIST
 
 oauth = OAuth()
 oauth.register(name="b2c")
@@ -51,7 +52,7 @@ def callback(request):
                 username = username,
                 password = username,
                 email = userinfo['email'],
-                is_active = True if PRODUCTION else False, 
+                is_active = not USE_WHITELIST, # whitelisting of users
                 is_superuser = False,
                 is_staff = False,
                 first_name = userinfo['given_name'],

docker-compose.full.yml

@@ -33,7 +33,8 @@ services:
         expose:
             - 8000
         environment:
-            PUBLIC_URL: ${PUBLIC_URL}
+            PUBLIC_URL: ${PUBLIC_URL} # for IAM links
+            ENV: ${ENV}
             DEBUG: ${DEBUG}
             CELERY_BROKER_URL: ${CELERY_BROKER_URL}
             CELERY_RESULT_BACKEND: "django-db"
@@ -52,7 +53,8 @@ services:
             B2C_CLIENT_ID: ${B2C_CLIENT_ID}
             B2C_CLIENT_SECRET: ${B2C_CLIENT_SECRET}
             B2C_AUTHORITY: ${B2C_AUTHORITY}
-            B2C_USER_FLOW: ${B2C_USER_FLOW}            
+            B2C_USER_FLOW: ${B2C_USER_FLOW}
+            USE_WHITELIST: ${USE_WHITELIST}
         deploy: # example only
             mode: replicated
             replicas: 2 
@@ -69,7 +71,8 @@ services:
         volumes:
             - files_data:/files_storage
         environment:
-            PUBLIC_URL: ${PUBLIC_URL}
+            PUBLIC_URL: ${PUBLIC_URL} # for email links
+            ENV: ${ENV}
             DEBUG: ${DEBUG}
             CELERY_BROKER_URL: ${CELERY_BROKER_URL}
             CELERY_RESULT_BACKEND: "django-db"

docker-compose.load_balanced.yml

@@ -33,7 +33,8 @@ services:
         expose:
             - 8000
         environment:
-            PUBLIC_URL: ${PUBLIC_URL}
+            PUBLIC_URL: ${PUBLIC_URL} # for IAM links
+            ENV: ${ENV}
             DEBUG: ${DEBUG}
             CELERY_BROKER_URL: ${CELERY_BROKER_URL}
             CELERY_RESULT_BACKEND: "django-db"
@@ -52,7 +53,8 @@ services:
             B2C_CLIENT_ID: ${B2C_CLIENT_ID}
             B2C_CLIENT_SECRET: ${B2C_CLIENT_SECRET}
             B2C_AUTHORITY: ${B2C_AUTHORITY}
-            B2C_USER_FLOW: ${B2C_USER_FLOW}           
+            B2C_USER_FLOW: ${B2C_USER_FLOW}
+            USE_WHITELIST: ${USE_WHITELIST}
         deploy: # example only
             mode: replicated
             replicas: 2 
@@ -73,7 +75,8 @@ services:
         volumes:
             - files_data:/files_storage
         environment:
-            PUBLIC_URL: ${PUBLIC_URL}
+            PUBLIC_URL: ${PUBLIC_URL} # for email links
+            ENV: ${ENV}
             DEBUG: ${DEBUG}
             CELERY_BROKER_URL: ${CELERY_BROKER_URL}
             CELERY_RESULT_BACKEND: "django-db"

docker-compose.nodb.yml

@@ -34,7 +34,8 @@ services:
         ports:
             - 8000:8000
         environment:
-            PUBLIC_URL: ${PUBLIC_URL}
+            PUBLIC_URL: ${PUBLIC_URL} # for IAM links
+            ENV: ${ENV}
             DEBUG: ${DEBUG}
             CELERY_BROKER_URL: ${CELERY_BROKER_URL}
             CELERY_RESULT_BACKEND: "django-db"
@@ -54,6 +55,7 @@ services:
             B2C_CLIENT_SECRET: ${B2C_CLIENT_SECRET}
             B2C_AUTHORITY: ${B2C_AUTHORITY}
             B2C_USER_FLOW: ${B2C_USER_FLOW}
+            USE_WHITELIST: ${USE_WHITELIST}
         depends_on:
             - redis
 
@@ -66,7 +68,8 @@ services:
         volumes:
             - files_data:/files_storage
         environment:
-            PUBLIC_URL: ${PUBLIC_URL}
+            PUBLIC_URL: ${PUBLIC_URL} # for email links
+            ENV: ${ENV}
             DEBUG: ${DEBUG}
             CELERY_BROKER_URL: ${CELERY_BROKER_URL}
             CELERY_RESULT_BACKEND: "django-db"

docker-compose.yml

@@ -34,7 +34,8 @@ services:
         ports:
             - 8000:8000
         environment:
-            PUBLIC_URL: ${PUBLIC_URL}
+            PUBLIC_URL: ${PUBLIC_URL} # for IAM links
+            ENV: ${ENV}
             DEBUG: ${DEBUG}
             CELERY_BROKER_URL: ${CELERY_BROKER_URL}
             CELERY_RESULT_BACKEND: "django-db"
@@ -54,6 +55,7 @@ services:
             B2C_CLIENT_SECRET: ${B2C_CLIENT_SECRET}
             B2C_AUTHORITY: ${B2C_AUTHORITY}
             B2C_USER_FLOW: ${B2C_USER_FLOW}
+            USE_WHITELIST: ${USE_WHITELIST}
         depends_on:
             - db
             - redis
@@ -67,7 +69,8 @@ services:
         volumes:
             - files_data:/files_storage
         environment:
-            PUBLIC_URL: ${PUBLIC_URL}
+            PUBLIC_URL: ${PUBLIC_URL} # for email links
+            ENV: ${ENV}
             DEBUG: ${DEBUG}
             CELERY_BROKER_URL: ${CELERY_BROKER_URL}
             CELERY_RESULT_BACKEND: "django-db"

docker/backend/Dockerfile

@@ -50,6 +50,7 @@ RUN --mount=type=cache,target=/root/.cache \
 
 # copy code
 ADD ./backend /app/backend
+RUN rm -f /app/backend/.env
 
 # remove and download git submodules
 RUN set -ex && \

docker/frontend/.dockerignore

@@ -9,6 +9,4 @@ README.md
 
 dist
 node_modules
-build
-
-.env
+build

docker/frontend/Dockerfile

@@ -14,6 +14,7 @@ COPY ./frontend/src ./src
 COPY ./frontend/public ./public
 COPY ./frontend/package* ./
 COPY ./frontend/.env.* ./
+COPY ./frontend/.env ./
 
 # build React app
 RUN npm install && \
@@ -47,6 +48,4 @@ LABEL org.opencontainers.image.title="IFC Validation Service - Frontend" \
       org.opencontainers.image.url="https://github.com/buildingSMART/validate" \
       org.opencontainers.image.licenses="MIT"
       #org.opencontainers.image.version="{$VERSION}" TODO
-      #org.opencontainers.image.created="TODO"
-
-#CMD "certbot --nginx -d dev.validate.buildingsmart.org -n && ./docker-entrypoint.sh"
+      #org.opencontainers.image.created="TODO"

docker/frontend/nginx/default.conf

@@ -1,6 +1,6 @@
 server {
     listen 80;
-    server_name dev.validate.buildingsmart.org;
+    server_name _;
     server_tokens off;
 
     # turn off buffering, enable streaming to backend

frontend/.env

@@ -0,0 +1 @@
+REACT_APP_VERSION=$npm_package_version

frontend/.env.production

@@ -1,2 +1,2 @@
-PUBLIC_URL=https://dev.validate.buildingsmart.org
-REACT_APP_FETCH_PATH=https://dev.validate.buildingsmart.org/bff
+PUBLIC_URL=/
+REACT_APP_FETCH_PATH=/bff