Add backend users (Buuntu#16)

* add users router and a basic fetch all users test

* add helper script for testing and get alembic migrations working with get_users test

* add ability to create users and add hashed passwords

* fix being able to see the user list

* add link to admin page and some more readme docs

Author: Buuntu

CONTRIBUTING.md

@@ -2,6 +2,7 @@
 
 ## Development
 
+### Helper Scripts
 You can use the helper script `scripts/dev-project.sh` to create a cookiecutter
 project to test locally.  Do this from outside of the root directory to avoid
 accidentally commiting test builds.  For example:
@@ -15,6 +16,11 @@ cd dev-fastapi-react
 docker-compose up -d
 ```
 
+When developing locally, there is also a helper script that will create a cookiecutter directory, build containers, and run tests all from within the root project directory.  This can be kind of a tedious process with cookiecutter so this makes it somewhat less painful.  From the root `fastapi-react` directory, simply run:
+```bash
+./scripts/test_local.sh
+```
+
 ## Pull Requests
 
 Use the general [feature branch
@@ -26,4 +32,8 @@ Try to keep PRs as small and focused as possible. If you are making a big
 breaking change in production and don't want to expose half finished
 functionality to users, you can use [feature
 flags](https://www.martinfowler.com/articles/feature-toggles.html) to work on
-this incrementally.  A big PR is much less likely to be approved
+this incrementally.  A big PR is much less likely to be approved
+
+## Which issues to start with?
+
+Start by browsing through the [list of issues](https://github.com/Buuntu/fastapi-react/issues), particularly those flagged as [help wanted](https://github.com/Buuntu/fastapi-react/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)

README.md

@@ -3,17 +3,18 @@
 This project serves as a template for bootstrapping a FastAPI project using the
 following tools:
 
-1. **FastAPI** (Python 3.8)
-2. **React** (with Typescript)
+1. **[FastAPI](https://fastapi.tiangolo.com/)** (Python 3.8)
+2. **[React](https://reactjs.org/)** (with Typescript)
 3. **Postgres**
-4. **SqlAlchemy**
-5. **Alembic**
-6. **Pytest**
-7. **Prettier**/**ESLint** (Airbnb style guide)
+4. **[SqlAlchemy](https://www.sqlalchemy.org/)**
+5. **[Alembic](https://alembic.sqlalchemy.org/en/latest/)**
+6. **[Pytest](https://docs.pytest.org/en/latest/)**
+7. **[Prettier](https://prettier.io/)**/**[ESLint](https://eslint.org/)**
+   (Airbnb style guide)
 8. **Docker**
 9. **Nginx** as a reverse proxy to allow backend/frontend on the same port
-10. [MaterialUI](https://material-ui.com/) for styling
-11. [react-admin](https://github.com/marmelab/react-admin) for the admin
+10. [**MaterialUI**](https://material-ui.com/) for styling
+11. [**react-admin**](https://github.com/marmelab/react-admin) for the admin
     dashboard
 
 It is meant as a lightweight/React alternative to [FastAPI's official fullstack
@@ -26,7 +27,7 @@ FastAPI.
 This does not have any opinions on production settings and leaves that up to the
 user.
 
-## Project Setup
+## Quick Start
 
 First, install cookiecutter:
 
@@ -54,14 +55,21 @@ and will create a directory called whatever you set for `project_slug`.
 
 Change into your project directory and then run:
 
-```
+```bash
 docker-compose up -d
+docker-compose run --rm backend alembic upgrade head
 ```
 
 This will take a little while to build the first time it's run.
 
 Once this finishes you can navigate to the port set during setup (default is
-`localhost:8000`), you should see the default create-react-app.
+`localhost:8000`), you should see the default create-react-app:
+
+![default create-react-app](assets/create-react-app.png)
+
+*Note: If you see an Nginx error at first with a `502: Bad Gateway` page, you
+may  have to wait for webpack to build the development server (the nginx
+container builds much more quickly).*
 
 The backend docs will be at http://localhost:8000/api/docs by default.
 
@@ -74,8 +82,14 @@ configurable admin dashboard.
 
 After starting the project, navigate to `http://localhost:8000/admin`.  By
 default you should see a list of users, which you can edit, add, and delete.
+These are all based off of the `users` routes.
 
 ![React Admin Dashboard](assets/admin-dashboard.png)
 
-Routes are kept in the `frontend/src/admin` by default to
-keep them separate from regular frontend routes.
+Routes are kept in the `frontend/src/admin` by default to keep them separate
+from regular frontend routes.
+
+## Contributing
+
+Contributing to this project is encouraged.  Please read the [Contributing
+doc](CONTRIBUTING.md) first.

assets/create-react-app.png

@@ -4,6 +4,6 @@
   "port": "8000",
   "postgres_user": "postgres",
   "postgres_password": "password",
-  "postgres_server": "db",
+  "postgres_server": "postgres",
   "postgres_database": "app"
 }

cookiecutter.json

@@ -11,7 +11,13 @@ cd testing-project
 docker-compose build
 docker-compose down -v --remove-orphans
 docker-compose up -d
+# Run migrations first
+docker-compose run --rm backend alembic upgrade head
+
+# Backend/frontend tests
 ./scripts/test.sh
+
+# Cleanup
 docker-compose down -v --remove-orphans
 
 # only remove directory if running locally

scripts/test.sh

@@ -0,0 +1,7 @@
+cd ..
+./fastapi-react/scripts/dev-project.sh
+cd dev-fastapi-react
+docker-compose down -v --remove-orphans
+docker-compose up -d
+docker-compose run --rm backend alembic upgrade head
+./scripts/test.sh

scripts/test_local.sh

@@ -21,12 +21,19 @@ The only dependencies for this project should be docker and docker-compose.
 Starting the project with hot-reloading enabled
 (the first time it will take a while):
 
-```
+```bash
 docker-compose up -d
 ```
 
+To run the alembic migrations (for the users table):
+```bash
+docker-compose run --rm backend alembic upgrade head
+```
+
 And navigate to http://localhost:{{cookiecutter.port}}
 
+*Note: If you see an Nginx error at first with a `502: Bad Gateway` page, you may  have to wait for webpack to build the development server (the nginx container builds much more quickly).*
+
 Auto-generated docs will be at
 http://localhost:{{cookiecutter.port}}/api/docs
 

{{cookiecutter.project_slug}}/README.md

@@ -21,7 +21,7 @@ def upgrade():
         'user',
         sa.Column('id', sa.Integer, primary_key=True),
         sa.Column('email', sa.String(50), nullable=False),
-        sa.Column('hashed_password', sa.String(50), nullable=False),
+        sa.Column('hashed_password', sa.String(100), nullable=False),
         sa.Column('is_active', sa.Boolean),
     )
 

{{cookiecutter.project_slug}}/backend/app/alembic/versions/91979b40eb38_create_users_table.py

@@ -0,0 +1,24 @@
+from fastapi.testclient import TestClient
+from app.main import app
+
+client = TestClient(app)
+
+
+def test_get_users():
+    response = client.get("/api/v1/users")
+    assert response.status_code == 200
+
+
+def test_delete_user():
+    """TODO"""
+    pass
+
+
+def test_edit_user():
+    """TODO"""
+    pass
+
+
+def test_get_user():
+    """TODO: Gets a single user"""
+    pass

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

@@ -0,0 +1,35 @@
+from fastapi import APIRouter, Request, Depends, Response
+
+from app.db.session import get_db
+from app.db.crud import get_users, get_user, create_user, delete_user
+from app.db.schemas import UserCreate
+
+users_router = r = APIRouter()
+
+
+@r.get("/users")
+async def users_list(request: Request, response: Response, db=Depends(get_db)):
+    users = get_users(db)
+    response.headers['Content-Range'] = f'0-9/{len(users)}'
+    return users
+
+
+@r.get("/users/{user_id}")
+async def user_details(request: Request, user_id: str, db=Depends(get_db)):
+    user = get_user(db, user_id)
+    return user
+
+
+@r.post("/users")
+async def user_create(request: Request, user: UserCreate, db=Depends(get_db)):
+    return create_user(db, user)
+
+
+@r.put("/users")
+async def user_edit(request: Request, user: UserCreate, db=Depends(get_db)):
+    return user
+
+
+@r.delete("/users/${user_id}")
+async def user_delete(request: Request, user_id: str, db=Depends(get_db)):
+    return delete_user(db, user_id)

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

@@ -5,5 +5,3 @@
 SQLALCHEMY_DATABASE_URI = os.getenv("DATABASE_URL")
 
 API_V1_STR = '/api/v1'
-
-FRONTEND_SERVER_URL = os.getenv('FRONTEND_SERVER_URL')

{{cookiecutter.project_slug}}/backend/app/api/api_v1/routers/tests/__init__.py

@@ -1,7 +1,18 @@
 from sqlalchemy.orm import Session
+from passlib.context import CryptContext
 
 from . import models, schemas
 
+pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
+
+
+def get_password_hash(password: str) -> str:
+    return pwd_context.hash(password)
+
+
+def verify_password(plain_password: str, hashed_password: str) -> bool:
+    return pwd_context.verify(plain_password, hashed_password)
+
 
 def get_user(db: Session, user_id: int):
     return db.query(models.User).filter(models.User.id == user_id).first()
@@ -16,12 +27,19 @@ def get_users(db: Session, skip: int = 0, limit: int = 100):
 
 
 def create_user(db: Session, user: schemas.UserCreate):
-    fake_hashed_password = user.password + "notreallyhashed"
+    hashed_password = get_password_hash(user.password)
     db_user = models.User(
         email=user.email,
-        hashed_password=fake_hashed_password
+        hashed_password=hashed_password
     )
     db.add(db_user)
     db.commit()
     db.refresh(db_user)
     return db_user
+
+
+def delete_user(db: Session, user_id: int):
+    user = db.query(models.User).get(id)
+    db.delete(user)
+    db.commit()
+    return user

{{cookiecutter.project_slug}}/backend/app/api/api_v1/routers/tests/test_users.py

@@ -4,11 +4,9 @@
 
 
 class User(Base):
-    __tablename__ = "users"
+    __tablename__ = "user"
 
     id = Column(Integer, primary_key=True, index=True)
-    first_name = Column(String)
-    last_name = Column(String)
     email = Column(String, unique=True, index=True)
     hashed_password = Column(String)
     is_active = Column(Boolean, default=True)

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

@@ -10,3 +10,13 @@
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 
 Base = declarative_base()
+
+
+# Dependency
+def get_db():
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()
+

{{cookiecutter.project_slug}}/backend/app/api/dependencies/__init__.py

@@ -2,6 +2,7 @@
 from starlette.requests import Request
 import uvicorn
 
+from app.api.api_v1.routers.users import users_router
 from app.core import config
 from app.db.session import SessionLocal
 
@@ -23,6 +24,8 @@ async def db_session_middleware(request: Request, call_next):
 async def root():
     return {"message": "Hello World"}
 
+# Routers
+app.include_router(users_router, prefix="/api/v1", tags=["users"])
 
 if __name__ == "__main__":
     uvicorn.run(

{{cookiecutter.project_slug}}/backend/app/api/router.py

@@ -10,4 +10,6 @@ pytest==5.3.4
 requests==2.22.0
 SQLAlchemy==1.3.12
 starlette==0.13.4
-uvicorn==0.11.5
+uvicorn==0.11.5
+passlib==1.7.2
+bcrypt==3.1.7

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

@@ -6,9 +6,8 @@ services:
       - ./nginx/nginx.conf:/etc/nginx/conf.d/default.conf
     ports:
       - {{cookiecutter.port}}:80
-    restart: always
 
-  db:
+  postgres:
     image: postgres:12
     restart: always
     environment:
@@ -24,13 +23,13 @@ services:
       context: backend
       dockerfile: Dockerfile
     command: python app/main.py
+    tty: true
     volumes:
-      - ./backend/:/app/:cached
+      - ./backend:/app/:cached
       - ./.docker/.ipython:/root/.ipython:cached
     environment:
       PYTHONPATH: .
-      DATABASE_URL: 'postgresql://{{cookiecutter.postgres_user}}:{{cookiecutter.postgres_password}}@db/{{cookiecutter.postgres_user}}'
-      FRONTEND_SERVER_URL: 'http://localhost:{{cookiecutter.port}}'
+      DATABASE_URL: 'postgresql://{{cookiecutter.postgres_user}}:{{cookiecutter.postgres_password}}@{{cookiecutter.postgres_server}}:5432/{{cookiecutter.postgres_user}}'
   frontend:
     build:
       context: frontend

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

@@ -12,6 +12,7 @@
     "@types/react-redux": "^7.1.7",
     "@types/react-router-dom": "^5.1.3",
     "ra-data-json-server": "^3.5.2",
+    "ra-data-simple-rest": "^3.3.2",
     "react": "^16.13.1",
     "react-admin": "^3.5.2",
     "react-dom": "^16.13.1",