sweeping changes to make the github actions work

Author: Jibola

README.md

@@ -101,7 +101,7 @@ See notes:
 - Replaced Backend native connection of PostgreSQL/SQLAlchemy with MongoDB Motor/Beanie ODM
 - Removed Neo4j plugin
 - Removed Alembic Usage
-- Introduced new cookiecutter environment variables `mongo_host`, `mongo_user`, `mongo_password`, and `mongo_database`
+- Introduced new cookiecutter environment variables `mongodb_uri`, and `mongo_database`
 - Introduced support for Pydantic 2
 
 [Historic changes from whythawk](https://github.com/whythawk/full-stack-fastapi-postgresql/releases)

cookiecutter.json

@@ -23,9 +23,7 @@
     "smtp_emails_from_name": "Symona Adaro",
     "smtp_emails_to_email": "info@{{cookiecutter.domain_main}}",
 
-    "mongo_host": "changethis",
-    "mongo_user": "changethis",
-    "mongodb_password": "changethis",
+    "mongodb_uri": "changethis",
     "mongodb_database": "changethis",
 
     "traefik_constraint_tag": "{{cookiecutter.domain_main}}",

docs/development-guide.md

@@ -61,9 +61,7 @@ The input variables, with their default values (some auto generated) are:
 - `smtp_emails_from_email`: The email account to use as the sender in the notification emails, it could be something like `info@your-custom-domain.com`.
 - `smtp_emails_from_name`: The email account name to use as the sender in the notification emails, it could be something like `Symona Adaro`.
 - `smtp_emails_to_email`: The email account to use as the recipient for `contact us` emails, it could be something like `requests@your-custom-domain.com`.
-- `mongo_host`: MongoDB host cluster URI password
-- `mongo_user`: MongoDB User account to access the cluster
-- `mongodb_password`: MongoDB password for access to the cluster
+- `mongodb_uri`: MongoDB URI for access to the cluster
 - `mongodb_database`: MongoDB database to have the application operate within
 - `traefik_constraint_tag`: The tag to be used by the internal Traefik load balancer (for example, to divide requests between backend and frontend) for production. Used to separate this stack from any other stack you might have. This should identify each stack in each environment (production, staging, etc).
 - `traefik_constraint_tag_staging`: The Traefik tag to be used while on staging.

docs/getting-started.md

@@ -83,7 +83,7 @@ Running Cookiecutter to customise the deployment with your settings, and then bu
 
 ### Setting up a Mongo Connection
 
-A Mongo connection can be set up one of two ways: At the cookiecutter generation step, provide the `mongo_host`, `mongo_user`, `mongo_password`, and `mongo_database` to inform the generator on how to connect to an Atlas cloud instance. Additionally, in the generated file, you can manually set the .env.MONGO_DATABASE_URI and it will connect to the Atlas cluster made locally.
+A Mongo connection can be set up one of two ways: At the cookiecutter generation step, provide the `mongodb_uri`, and `mongo_database` to inform the generator on how to connect to an Atlas cloud instance. Additionally, in the generated file, you can manually set the .env.MONGO_DATABASE_URI and it will connect to the Atlas cluster made locally.
 
 Additionally, developers could configure a local mongo instance, but it would either have to be spun up in docker, or generated separately and also allow for non-localhost connections to be made.
 

{{cookiecutter.project_slug}}/.env

@@ -39,9 +39,5 @@ SENTRY_DSN={{cookiecutter.sentry_dsn}}
 FLOWER_BASIC_AUTH={{cookiecutter.flower_auth}}
 
 # Mongo
-MONGO_HOST={{cookiecutter.mongo_host}}
-MONGO_USER={{cookiecutter.mongo_user}}
-MONGO_PASSWORD={{cookiecutter.mongodb_password}}
-MONGO_DATABASE={{cookiecutter.mongodb_database}}
-# To override the mongo URI, override with this setting
-# MONGO_DATABASE_URI=
+MONGO_DATABASE_URI={{cookiecutter.mongodb_uri}}
+MONGO_DATABASE={{cookiecutter.mongodb_database}}

{{cookiecutter.project_slug}}/.github/workflows/actions.yml

@@ -0,0 +1,105 @@
+name: build and deploy template
+on:
+  push:
+    branches:
+      - main
+      - production
+
+env:
+  TRAEFIK_PUBLIC_NETWORK: traefik-public
+  STACK_NAME: {{cookiecutter.docker_swarm_stack_name_main}}
+  DOCKER_IMAGE_CELERYWORKER: {{cookiecutter.docker_image_celeryworker}}
+  TRAEFIK_TAG: {{cookiecutter.traefik_constraint_tag}}
+  TRAEFIK_PUBLIC_TAG: {{cookiecutter.traefik_public_constraint_tag}}
+  DOCKER_IMAGE_BACKEND: {{cookiecutter.docker_image_backend}}
+  DOCKER_IMAGE_FRONTEND: {{cookiecutter.docker_image_frontend}}
+  PROJECT_NAME: {{cookiecutter.project_name}}
+  DOMAIN: localhost
+  SMTP_HOST:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Run Tests
+        run: sh ./scripts/test.sh
+
+  deploy-staging:
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+{% raw %}
+      - name: Log in to Docker Registry
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+{% endraw %}
+
+      - name: Install docker-auto-labels
+        run: pip install docker-auto-labels
+
+      - name: Build Staging 
+        run: |
+          DOMAIN={{cookiecutter.domain_staging}}
+          TRAEFIK_TAG={{cookiecutter.traefik_constraint_tag_staging}}
+          STACK_NAME={{cookiecutter.docker_swarm_stack_name_staging}}
+          TAG=staging
+          FRONTEND_ENV=staging
+          sh ./scripts/build-push.sh
+
+      - name: Deploy Staging
+        run: |
+          DOMAIN={{cookiecutter.domain_staging}}
+          TRAEFIK_TAG={{cookiecutter.traefik_constraint_tag_staging}}
+          STACK_NAME={{cookiecutter.docker_swarm_stack_name_staging}}
+          TAG=staging
+          sh ./scripts/deploy.sh
+    needs: tests
+
+  deploy-prod:
+    if: github.ref == 'refs/heads/production'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+{% raw %}
+      - name: Log in to Docker Registry
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+{% endraw %}
+      
+      - name: Install docker-auto-labels
+        run: pip install docker-auto-labels
+      
+      - name: Build Production
+        run: |
+          DOMAIN={{cookiecutter.domain_main}}
+          TRAEFIK_TAG={{cookiecutter.traefik_constraint_tag}}
+          STACK_NAME={{cookiecutter.docker_swarm_stack_name_main}}
+          TAG=prod
+          FRONTEND_ENV=production
+          sh ./scripts/build-push.sh
+
+      - name: Deploy Production
+        run: |
+          DOMAIN={{cookiecutter.domain_main}}
+          TRAEFIK_TAG={{cookiecutter.traefik_constraint_tag}}
+          STACK_NAME={{cookiecutter.docker_swarm_stack_name_main}}
+          TAG=prod
+          sh ./scripts/deploy.sh
+    needs: tests
+   
+
+  
+  
+    

{{cookiecutter.project_slug}}/backend/app/app/api/api_v1/endpoints/users.py

@@ -22,7 +22,7 @@ async def create_user_profile(
     db: AgnosticDatabase = Depends(deps.get_db),
     password: str = Body(...),
     email: EmailStr = Body(...),
-    full_name: str = Body(None),
+    full_name: str = Body(""),
 ) -> Any:
     """
     Create new user without the need to be logged in.
@@ -50,9 +50,13 @@ async def update_user(
     Update user.
     """
     if current_user.hashed_password:
-        user = await crud.user.authenticate(db, email=current_user.email, password=obj_in.original)
+        user = await crud.user.authenticate(
+            db, email=current_user.email, password=obj_in.original
+        )
         if not obj_in.original or not user:
-            raise HTTPException(status_code=400, detail="Unable to authenticate this update.")
+            raise HTTPException(
+                status_code=400, detail="Unable to authenticate this update."
+            )
     current_user_data = jsonable_encoder(current_user)
     user_in = schemas.UserUpdate(**current_user_data)
     if obj_in.password is not None:
@@ -146,7 +150,9 @@ async def create_user(
         )
     user = await crud.user.create(db, obj_in=user_in)
     if settings.EMAILS_ENABLED and user_in.email:
-        send_new_account_email(email_to=user_in.email, username=user_in.email, password=user_in.password)
+        send_new_account_email(
+            email_to=user_in.email, username=user_in.email, password=user_in.password
+        )
     return user
 
 

{{cookiecutter.project_slug}}/backend/app/app/core/config.py

@@ -1,7 +1,8 @@
 import secrets
 from typing import Any, Dict, List, Optional, Union
 
-from pydantic import AnyHttpUrl, EmailStr, HttpUrl, validator
+from pydantic import AnyHttpUrl, EmailStr, HttpUrl, field_validator
+from pydantic_core.core_schema import ValidationInfo
 from pydantic_settings import BaseSettings
 
 
@@ -22,7 +23,7 @@ class Settings(BaseSettings):
     # "http://localhost:8080", "http://local.dockertoolbox.tiangolo.com"]'
     BACKEND_CORS_ORIGINS: List[AnyHttpUrl] = []
 
-    @validator("BACKEND_CORS_ORIGINS", pre=True)
+    @field_validator("BACKEND_CORS_ORIGINS", mode="before")
     def assemble_cors_origins(cls, v: Union[str, List[str]]) -> Union[List[str], str]:
         if isinstance(v, str) and not v.startswith("["):
             return [i.strip() for i in v.split(",")]
@@ -33,9 +34,9 @@ def assemble_cors_origins(cls, v: Union[str, List[str]]) -> Union[List[str], str
     PROJECT_NAME: str
     SENTRY_DSN: Optional[HttpUrl] = None
 
-    @validator("SENTRY_DSN", pre=True)
+    @field_validator("SENTRY_DSN", mode="before")
     def sentry_dsn_can_be_blank(cls, v: str) -> Optional[str]:
-        if len(v) == 0:
+        if isinstance(v, str) and len(v) == 0:
             return None
         return v
 
@@ -44,27 +45,8 @@ def sentry_dsn_can_be_blank(cls, v: str) -> Optional[str]:
     MULTI_MAX: int = 20
 
     # COMPONENT SETTINGS
-
-    MONGO_HOST: str
-    MONGO_USER: str
-    MONGO_PASSWORD: str
     MONGO_DATABASE: str
-    MONGO_URI_OPTIONS: str = "retryWrites=true&w=majority"
-    MONGO_DATABASE_URI: Optional[str] = None
-
-    @validator("MONGO_DATABASE_URI", pre=True)
-    def assemble_db_connection(cls, v: Optional[str], values: Dict[str, Any]) -> Any:
-        if isinstance(v, str):
-            return v
-        mongo_user, mongo_password, mongo_host, mongo_options = (
-            values.get("MONGO_USER"),
-            values.get("MONGO_PASSWORD"),
-            values.get("MONGO_HOST"),
-            values.get("MONGO_URI_OPTIONS"),
-        )
-        return (
-            f"mongodb+srv://{mongo_user}:{mongo_password}@{mongo_host}/?{mongo_options}"
-        )
+    MONGO_DATABASE_URI: str = ""
 
     SMTP_TLS: bool = True
     SMTP_PORT: Optional[int] = None
@@ -75,22 +57,22 @@ def assemble_db_connection(cls, v: Optional[str], values: Dict[str, Any]) -> Any
     EMAILS_FROM_NAME: Optional[str] = None
     EMAILS_TO_EMAIL: Optional[EmailStr] = None
 
-    @validator("EMAILS_FROM_NAME")
-    def get_project_name(cls, v: Optional[str], values: Dict[str, Any]) -> str:
+    @field_validator("EMAILS_FROM_NAME")
+    def get_project_name(cls, v: Optional[str], info: ValidationInfo) -> str:
         if not v:
-            return values["PROJECT_NAME"]
+            return info.data["PROJECT_NAME"]
         return v
 
     EMAIL_RESET_TOKEN_EXPIRE_HOURS: int = 48
     EMAIL_TEMPLATES_DIR: str = "/app/app/email-templates/build"
     EMAILS_ENABLED: bool = False
 
-    @validator("EMAILS_ENABLED", pre=True)
-    def get_emails_enabled(cls, v: bool, values: Dict[str, Any]) -> bool:
+    @field_validator("EMAILS_ENABLED", mode="before")
+    def get_emails_enabled(cls, v: bool, info: ValidationInfo) -> bool:
         return bool(
-            values.get("SMTP_HOST")
-            and values.get("SMTP_PORT")
-            and values.get("EMAILS_FROM_EMAIL")
+            info.data.get("SMTP_HOST")
+            and info.data.get("SMTP_PORT")
+            and info.data.get("EMAILS_FROM_EMAIL")
         )
 
     EMAIL_TEST_USER: EmailStr = "test@example.com"  # type: ignore

{{cookiecutter.project_slug}}/backend/app/app/db/session.py

@@ -8,11 +8,13 @@ class _MongoClientSingleton:
     def __new__(cls):
         if not hasattr(cls, "instance"):
             cls.instance = super(_MongoClientSingleton, cls).__new__(cls)
-            cls.instance.mongo_client = motor_asyncio.AsyncIOMotorClient(settings.MONGO_DATABASE_URI)
+            cls.instance.mongo_client = motor_asyncio.AsyncIOMotorClient(
+                settings.MONGO_DATABASE_URI
+            )
         return cls.instance
 
 
-def MongoDatabase() -> core.AgnosticDatabase:
+def MongoDatabase(test=False) -> core.AgnosticDatabase:
     return _MongoClientSingleton().mongo_client[settings.MONGO_DATABASE]
 
 

{{cookiecutter.project_slug}}/backend/app/app/models/user.py

@@ -10,9 +10,13 @@
     from . import Token  # noqa: F401
 
 
+def datetime_now_sec():
+    return datetime.now().replace(microsecond=0)
+
+
 class User(Base):
-    created: datetime = Field(default_factory=datetime.now)
-    modified: datetime = Field(default_factory=datetime.now)
+    created: datetime = Field(default_factory=datetime_now_sec)
+    modified: datetime = Field(default_factory=datetime_now_sec)
     full_name: str = Field(default="")
     email: EmailStr
     hashed_password: Optional[str]
@@ -21,4 +25,4 @@ class User(Base):
     email_validated: bool = Field(default=False)
     is_active: bool = Field(default=False)
     is_superuser: bool = Field(default=False)
-    refresh_tokens: list[Link["Token"]] = Field(default_factory=list)
+    refresh_tokens: list[Link["Token"]] = Field(default_factory=list)

{{cookiecutter.project_slug}}/backend/app/app/schemas/user.py

@@ -1,5 +1,5 @@
 from typing import Optional
-from pydantic import BaseModel, Field, EmailStr, constr, validator
+from pydantic import BaseModel, Field, EmailStr, constr, field_validator
 from beanie import PydanticObjectId
 
 
@@ -44,13 +44,13 @@ class User(UserInDBBase):
     class Config:
         populate_by_name = True
 
-    @validator("hashed_password", pre=True)
+    @field_validator("hashed_password", mode="before")
     def evaluate_hashed_password(cls, hashed_password):
         if hashed_password:
             return True
         return False
 
-    @validator("totp_secret", pre=True)
+    @field_validator("totp_secret", mode="before")
     def evaluate_totp_secret(cls, totp_secret):
         if totp_secret:
             return True