Added shop listing logic + startup event, tests, added update user roles/shops endpoint + me versions

Author: Michael Oliver

docker-compose.yml

@@ -52,3 +52,8 @@ services:
     image: mailhog/mailhog:v1.0.0
     ports:
       - "8025:8025"
+
+  splash-browser:
+    image: scrapinghub/splash
+    ports:
+    - "8050:8050"

server/alembic/versions/daff23253894_adding_user_shops_relationship.py

@@ -0,0 +1,27 @@
+"""Adding user shops relationship
+
+Revision ID: daff23253894
+Revises: fab2a86c8b63
+Create Date: 2020-04-11 08:46:05.071956
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "daff23253894"
+down_revision = "fab2a86c8b63"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###

server/alembic/versions/fab2a86c8b63_adding_user_shops.py

@@ -0,0 +1,66 @@
+"""Adding user shops
+
+Revision ID: fab2a86c8b63
+Revises: e7ff97c10b8f
+Create Date: 2020-04-11 08:44:40.315632
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "fab2a86c8b63"
+down_revision = "e7ff97c10b8f"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "shop",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column(
+            "created_at",
+            sa.TIMESTAMP(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=True,
+        ),
+        sa.Column("updated_at", sa.TIMESTAMP(timezone=True), nullable=True),
+        sa.Column("name", sa.String(), nullable=False),
+        sa.Column("url", sa.String(), nullable=False),
+        sa.Column("query_url", sa.String(), nullable=False),
+        sa.Column("render_javascript", sa.Boolean(), nullable=False),
+        sa.Column("listing_page_selector", sa.JSON(), nullable=True),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("name"),
+        sa.UniqueConstraint("url"),
+    )
+    op.create_table(
+        "user_shops",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column(
+            "created_at",
+            sa.TIMESTAMP(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=True,
+        ),
+        sa.Column("updated_at", sa.TIMESTAMP(timezone=True), nullable=True),
+        sa.Column("user_id", sa.Integer(), nullable=True),
+        sa.Column("shop_id", sa.Integer(), nullable=True),
+        sa.ForeignKeyConstraint(
+            ["shop_id"], ["shop.id"], onupdate="CASCADE", ondelete="CASCADE"
+        ),
+        sa.ForeignKeyConstraint(
+            ["user_id"], ["user.id"], onupdate="CASCADE", ondelete="CASCADE"
+        ),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("user_shops")
+    op.drop_table("shop")
+    # ### end Alembic commands ###

server/app/api/v1/dependencies/or_404.py

@@ -2,8 +2,8 @@
 from sqlalchemy import orm
 
 from app.db.session import get_db
-from app.models import rolemodels, usermodels
-from app.service import roleservice, userservice
+from app.models import rolemodels, shopmodels, usermodels
+from app.service import roleservice, shopservice, userservice
 
 
 def get_role_by_id_or_404(
@@ -51,3 +51,19 @@ def get_user_or_404(
             detail="Specified user was not found.",
         )
     return user
+
+
+def get_shop_or_404(
+    db_session: orm.Session = Depends(get_db),
+    shop_id: int = Path(..., alias="id", ge=1),
+) -> shopmodels.Shop:
+    """
+    Route dependency that retrieves a shop by id or raises 404.
+    """
+    shop = shopservice.get(db_session=db_session, id_=shop_id)
+    if not shop:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="Specified shop was not found.",
+        )
+    return shop

server/app/api/v1/routes/me.py

@@ -1,11 +1,11 @@
 from typing import List
 
-from fastapi import APIRouter, Depends, HTTPException, Path, status
+from fastapi import APIRouter, Body, Depends, HTTPException, Path, status
 from sqlalchemy.orm import Session
 
 from app.db.session import get_db
-from app.models import rolemodels, usermodels
-from app.service import userservice
+from app.models import rolemodels, shopmodels, usermodels
+from app.service import shopservice, userservice
 
 from ..dependencies.auth import get_current_active_user
 
@@ -44,3 +44,41 @@ def read_current_user_roles(
 ):
     """Read the currently logged in user roles"""
     return current_user.roles
+
+
+@router.get(
+    "/me/shops", response_model=List[shopmodels.ShopRead],
+)
+def read_current_user_shops(
+    current_user: usermodels.User = Depends(get_current_active_user),
+):
+    """
+    Retrieve a list of shops assigned to the currently logged in user.
+    """
+    return current_user.shops
+
+
+@router.put(
+    "/me/shops", response_model=List[shopmodels.ShopRead],
+)
+def update_user_shops(
+    *,
+    db_session: Session = Depends(get_db),
+    current_user: usermodels.User = Depends(get_current_active_user),
+    shops_ids: List[int] = Body(...),
+):
+    """
+    Update the assigned shops of the currently logged in user.
+    """
+
+    shop_objs = shopservice.get_multiple_by_ids(db_session=db_session, ids_=shops_ids)
+
+    if len(shop_objs) != len(shops_ids):
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="One of the specified shops was not found man.",
+        )
+
+    current_user.shops = shop_objs
+    db_session.commit()
+    return shop_objs

server/app/api/v1/routes/shops.py

@@ -0,0 +1,106 @@
+from typing import List, Set
+
+from fastapi import APIRouter, Depends, HTTPException, Query, status
+from sqlalchemy import orm
+
+from app.db.session import get_db
+from app.models import shopmodels
+from app.service import scraperservice, shopservice
+
+from ..dependencies.auth import admin_role, user_role
+from ..dependencies.or_404 import get_shop_or_404
+
+router = APIRouter()
+
+
+# Populate the scrapers into memory
+@router.on_event("startup")
+def populate_scrapers():
+    from tests.common import SessionLocal
+
+    scraperservice.populate_scrapers(db_session=SessionLocal())
+
+
+@router.get(
+    "/", response_model=List[shopmodels.ShopRead], dependencies=[Depends(user_role)]
+)
+def get_shops(*, db_session: orm.Session = Depends(get_db)):
+    """
+    Retrieve a list of shops.
+    """
+    return shopservice.get_multiple(db_session=db_session)
+
+
+@router.get("/{id}", response_model=shopmodels.ShopRead)
+def get_single_shop(shop: shopmodels.ShopRead = Depends(get_shop_or_404),):
+    """
+    Retrieve details about a specific shop.
+    """
+    return shop
+
+
+@router.post(
+    "/",
+    status_code=status.HTTP_201_CREATED,
+    response_model=shopmodels.ShopRead,
+    dependencies=[Depends(admin_role)],
+)
+def create_shop(
+    *, db_session: orm.Session = Depends(get_db), shop_in: shopmodels.ShopCreate
+):
+    """
+    Create a new shop.
+    """
+
+    if shopservice.get_by_name(db_session=db_session, name=shop_in.name):
+        raise HTTPException(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            detail="Shop with that name already exists",
+        )
+    return shopservice.create(db_session=db_session, shop_in=shop_in)
+
+
+@router.put(
+    "/{id}", response_model=shopmodels.ShopRead, dependencies=[Depends(admin_role)]
+)
+def update_shop(
+    *,
+    db_session: orm.Session = Depends(get_db),
+    shop_in: shopmodels.ShopUpdate,
+    shop: shopmodels.Shop = Depends(get_shop_or_404),
+):
+    """
+    Update an individual shop.
+    """
+
+    return shopservice.update(db_session=db_session, shop=shop, shop_in=shop_in)
+
+
+@router.delete(
+    "/{id}", response_model=shopmodels.ShopRead, dependencies=[Depends(admin_role)]
+)
+def delete_shop(
+    *,
+    db_session: orm.Session = Depends(get_db),
+    shop: shopmodels.Shop = Depends(get_shop_or_404),
+):
+    """
+    Delete an individual shop.
+    """
+
+    return shopservice.delete(db_session=db_session, id_=shop.id)
+
+
+@router.get("/listings/", dependencies=[Depends(admin_role)])
+async def read_multiple_shops_listings(
+    query: str = Query(..., description="The search term to query by."),
+    limit: int = Query(10, description="The number of results to return.", ge=1, le=40),
+    include: Set[int] = Query(..., description="Shop IDs to query for listings."),
+):
+    """
+    Scrape multiple shops for listings in real time.
+    """
+
+    return await scraperservice.query_scrapers(
+        query=query, limit=limit, include=include
+    )

server/app/api/v1/routes/users.py

@@ -4,8 +4,8 @@
 from sqlalchemy.orm import Session
 
 from app.db.session import get_db
-from app.models import rolemodels, usermodels
-from app.service import roleservice, userservice
+from app.models import rolemodels, shopmodels, usermodels
+from app.service import roleservice, shopservice, userservice
 
 from ..dependencies.or_404 import get_user_or_404
 
@@ -110,5 +110,39 @@ def update_user_roles(
             detail="One of the specified roles was not found man. I don't know which one yet.",
         )
 
-    user.roles = [role_objs]
+    user.roles = role_objs
+    db_session.commit()
+
+
+@router.get(
+    "/{id}/shops", response_model=List[shopmodels.ShopRead],
+)
+def read_user_shops(user: usermodels.User = Depends(get_user_or_404),):
+    """
+    Retrieve a list of shops assigned to an individual user.
+    """
+    return user.shops
+
+
+@router.put(
+    "/{id}/shops", response_model=List[shopmodels.ShopRead],
+)
+def update_user_shops(
+    *,
+    db_session: Session = Depends(get_db),
+    user: usermodels.User = Depends(get_user_or_404),
+    shops_ids: List[int] = Body(...),
+):
+    """
+    Update the assigned shops of an individual user.
+    """
+
+    shop_objs = shopservice.get_multiple_by_ids(db_session=db_session, ids_=shops_ids)
+    if len(shops_ids) != len(shops_ids):
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail="One of the specified shops was not found man.",
+        )
+
+    user.roles = [shop_objs]
     db_session.commit()

server/app/api/v1/v1_router.py

@@ -1,20 +1,26 @@
 from fastapi import APIRouter, Depends
 
 from .dependencies.auth import admin_role
-from .routes import auth, me, roles, users
+from .routes import auth, me, roles, shops, users
 
 router = APIRouter()
+
 router.include_router(router=auth.router, prefix="/auth", tags=["auth"])
+
 router.include_router(router=me.router, tags=["self"])
+
 router.include_router(
     router=users.router,
     prefix="/users",
     tags=["users"],
     dependencies=[Depends(admin_role)],
 )
+
 router.include_router(
     router=roles.router,
     prefix="/roles",
     tags=["roles"],
     dependencies=[Depends(admin_role)],
 )
+
+router.include_router(router=shops.router, prefix="/shops", tags=["shops"])

server/app/db/initdb.py

@@ -3,8 +3,8 @@
 import yaml
 from sqlalchemy import engine, orm
 
-from app.models import rolemodels, usermodels
-from app.service import roleservice, userservice
+from app.models import rolemodels, shopmodels, usermodels
+from app.service import roleservice, shopservice, userservice
 from app.settings import settings
 
 INITDB_PATH = settings.APP_DIR / "db" / "initdb.yaml"
@@ -14,6 +14,7 @@
 
 def initdb(db_session: orm.Session):
     init_roles(db_session=db_session)
+    init_shops(db_session=db_session)
 
 
 def init_roles(db_session: orm.Session):
@@ -24,6 +25,12 @@ def init_roles(db_session: orm.Session):
     roleservice.create_multiple(db_session=db_session, roles_in=roles_in)
 
 
+def init_shops(db_session: orm.Session):
+    for shop in config["shops"]:
+        shop_in = shopmodels.ShopCreate(**shop)
+        shopservice.create(db_session=db_session, shop_in=shop_in)
+
+
 def setup_guids_postgresql(engine: engine.Engine) -> None:  # pragma: no cover
     """
     Set up UUID generation using the pgcrypto extension for postgres

server/app/db/initdb.yaml

@@ -3,3 +3,196 @@ roles:
     description: Permits administrator privileges.
   - name: user
     description: Normal user privileges.
+
+shops:
+
+  - url: www.aldi.co.uk
+    name: aldi
+    query_url: /search?category=ALL&text={query}
+    render_javascript: false
+    listing_page_selector:
+      items:
+        css: 'div.hover-item:nth-of-type(n+6)'
+        multiple: true
+        type: Text
+        children:
+          url:
+            css: a.category-item__wrapper-link
+            type: Link
+          name:
+            css: 'ul.category-item__meta li.category-item__title'
+            type: Text
+          price:
+            css: 'ul.category-item__meta.list-unstyled > a > li'
+            type: Text
+          price_per_unit:
+            css: a.category-item__wrapper-link
+            type: Attribute
+            attribute: category-item__pricePerUnit
+          image_url:
+            css: 'a.category-item__link picture.category-item__image source:first-of-type'
+            type: Attribute
+            attribute: srcset
+
+  - url: www.amazon.co.uk
+    name: amazon_pantry
+    query_url: /s?k={query}&i=pantry
+    render_javascript: false
+    listing_page_selector:
+      items:
+        css: '#search div.s-result-item'
+        multiple: true
+        type: Text
+        children:
+          price:
+            css: span.a-offscreen
+            type: Text
+          name:
+            css: h2
+            type: Text
+          url:
+            css: a
+            type: Link
+          image_url:
+            css: img.s-image
+            type: Attribute
+            attribute: src
+          price_per_unit:
+            css: span.a-size-base.a-color-secondary
+            type: Text
+
+  - url: groceries.asda.com
+    name: asda
+    query_url: /search/{query}
+    render_javascript: true
+    listing_page_selector:
+      items:
+        css: 'section.products-tab li.co-item'
+        multiple: true
+        type: Text
+        children:
+          price:
+            css: strong.co-product__price
+            type: Text
+          price_per_unit:
+            css: span.co-product__price-per-uom
+            type: Text
+          name:
+            css: a.co-product__anchor
+            type: Text
+          url:
+            css: a.co-product__anchor
+            type: Link
+          image_url:
+            css: img.co-product__image
+            type: Attribute
+            attribute: src
+
+  - url: www.iceland.co.uk
+    name: iceland
+    query_url: /search?q={query}
+    render_javascript: false
+    listing_page_selector:
+      items:
+        css: 'ul.search-result-items div.product-tile'
+        multiple: true
+        type: Text
+        children:
+          name:
+            css: 'a.name-link span'
+            type: Text
+          price:
+            css: 'span.product-sales-price span'
+            type: Text
+          price_per_unit:
+            css: div.product-pricing-info
+            type: Text
+          image_url:
+            css: img.thumb-link
+            type: Attribute
+            attribute: src
+          url:
+            css: 'div.product-image a.thumb-link'
+            type: Attribute
+            attribute: href
+
+  - url: groceries.morrisons.com
+    name: morrisons
+    query_url: /search?entry={query}
+    render_javascript: false
+    listing_page_selector:
+      items:
+        css: 'ul.fops.fops-regular li.fops-item:nth-of-type(n+1)'
+        multiple: true
+        type: Text
+        children:
+          price:
+            css: span.fop-price
+            type: Text
+          name:
+            css: h4.fop-title
+            type: Text
+          price_per_unit:
+            css: span.fop-unit-price
+            type: Text
+          image_url:
+            css: img.fop-img
+            type: Attribute
+            attribute: src
+          url:
+            css: div.fop-contentWrapper
+            type: Link
+
+  - url: www.sainsburys.co.uk
+    name: sainsburys
+    query_url: /webapp/wcs/stores/servlet/SearchDisplayView?storeId=10151&orderBy=RELEVANCE&searchTerm={query}
+    render_javascript: false
+    listing_page_selector:
+      items:
+        css: 'div.section li.gridItem'
+        multiple: true
+        type: Text
+        children:
+          url:
+            css: 'h3 a'
+            type: Link
+          name:
+            css: h3
+            type: Text
+          price:
+            css: p.pricePerUnit
+            type: Text
+          price_per_unit:
+            css: p.pricePerMeasure
+            type: Text
+          image_url:
+            css: 'h3 img'
+            type: Attribute
+            attribute: src
+
+  - url: www.tesco.com
+    name: tesco
+    query_url: /groceries/en-GB/search?query={query}
+    render_javascript: false
+    listing_page_selector:
+      items:
+        css: li.product-list--list-item
+        multiple: true
+        type: Text
+        children:
+          url:
+            css: a.sc-kAzzGY
+            type: Link
+          name:
+            css: div.product-details--content
+            type: Text
+          price:
+            css: 'div.price-per-sellable-unit div'
+            type: Text
+          price_per_unit:
+            css: div.price-per-quantity-weight
+            type: Text
+          image_url:
+            css: img.product-image
+            type: Attribute
+            attribute: src

server/app/models/__init__.py

@@ -3,5 +3,5 @@
 """
 
 from .rolemodels import *
-from .usermodels import *
 from .shopmodels import *
+from .usermodels import *

server/app/models/shopmodels.py

@@ -42,7 +42,7 @@ class ShopCreate(PydanticBase):
 class ShopRead(PydanticTS, ShopCreate):
     """Attributes to return via API"""
 
-    pass
+    id: int
 
 
 class ShopUpdate(PydanticBase):

server/app/models/usermodels.py

@@ -23,7 +23,7 @@ class User(SQLAlchemyTS, SQLAlchemyIntPK, SQLAlchemyBase):
 
     # Relationships
     roles = relationship("Role", secondary="user_roles")
-    # shops = relationship("Shop", secondary="user_shops")
+    shops = relationship("Shop", secondary="user_shops")
 
     @property
     def role_names(self) -> List[str]:

server/app/service/scraperservice.py

@@ -3,53 +3,49 @@
 from typing import Set
 
 import httpx
-import pyppeteer
 import selectorlib
-from app.core.settings import settings
-from app.crud import shop_crud
-from app.schemas.shop import ShopConfigurationDB
+from sqlalchemy import orm
+
+from app.models import shopmodels
+from app.service import shopservice
+from app.settings import settings
 
 logger = logging.getLogger(__name__)
 
 
 class Scraper:
-    def __init__(self, config: ShopConfigurationDB) -> None:
+    def __init__(self, shop: shopmodels.ShopRead) -> None:
         self.protocol = "https"
-        self._config = config
-        self.base_url = f"{self.protocol}://{self._config.url}"
-        self.name = self._config.name
+        self._shop = shop
+        self.base_url = f"{self.protocol}://{self._shop.url}"
+        self.name = self._shop.name
 
         # Create Extractor for listing page
         self._listing_page_extractor = selectorlib.Extractor(
-            self._config.listing_page_selector
+            self._shop.listing_page_selector
         )
 
     def __repr__(self) -> str:
         return f"Scraper(name={self.name}, base_url={self.base_url})"
 
     def _build_query_url(self, q: str) -> str:
-        return self.base_url + self._config.query_url.format(query=q)
+        return self.base_url + self._shop.query_url.format(query=q)
 
     async def query_listings(
         self, client: httpx.AsyncClient, query: str, limit: int = 10
     ) -> dict:
 
         url = self._build_query_url(query)
-
-        # Render page with `pyppeteer` if needed
-        if self._config.render_javascript:
-            html = await render_page(url=url)
-        else:
-            html = await fetch_page(url=url, client=client)
+        html = await fetch_page(url=url, client=client)
 
         results = self._listing_page_extractor.extract(
             html, base_url=self.base_url
         ).get("items")
         if results:
             results = results[:limit]
         response_object = {
-            "id": self._config.id,
-            "name": self._config.name,
+            "id": self._shop.id,
+            "name": self._shop.name,
             "listings": results,
         }
         return response_object
@@ -62,32 +58,11 @@ async def fetch_page(url: str, client: httpx.AsyncClient):
     return html
 
 
-async def render_page(url: str) -> str:
-    """
-    Using ``pyppeteer`` load a web page and return HTML content.
-    """
-    options = {
-        "timeout": int(settings.scraper.PYPPETEER_TIMEOUT * 1000),
-        "waitUntil": "domcontentloaded",
-    }
-    browser = await pyppeteer.launch(
-        executablePath=settings.CHROME_BIN, ignoreHTTPSErrors=True, headless=True
-    )
-    page = await browser.newPage()
-    await page.goto(url, options=options)
-    await asyncio.sleep(settings.scraper.PYPPETEER_SLEEP)
-    html = await page.content()
-    await browser.close()
-    return html
-
-
 async def query_scrapers(query: str, limit: int, include: Set[int]):
     """Query scrapers entry point."""
 
     # Only use one client for all requests
-    async with httpx.AsyncClient(
-        verify=False, timeout=settings.scraper.HTTPCLIENT_TIMEOUT
-    ) as client:
+    async with httpx.AsyncClient(verify=False,) as client:
         tasks = [
             scrapers[i].query_listings(client=client, query=query, limit=limit)
             for i in include
@@ -99,31 +74,13 @@ async def query_scrapers(query: str, limit: int, include: Set[int]):
 scrapers = {}
 
 
-async def initialise():
+def populate_scrapers(db_session: orm.Session):
     """
-    Reads all shop configurations from database and using each config initialise's a `Scraper` instance.
-    Local scraper dict is then used for quick lookup. Key is scraper id and value is `Scraper` instance.
-    Should be called every time new configurations are added to db.
+    Populate scraper configuration into memory for fast lookup.
     """
     global scrapers
     scrapers = {}
-    shops = await shop_crud.read_all()
-    for s in shops:
-        scrapers[s["id"]] = Scraper(config=ShopConfigurationDB(**s))
-
-
-# async def initialise():
-#     global scrapers
-#     """Reads scraper information from /etc and populates the database with shop configs."""
-#
-#     with open(settings.SHOPS_YAML_PATH) as fileobj:
-#         shopsconfig = yaml.safe_load_all(fileobj.read())
-#
-#     global scrapers
-#     for config in shopsconfig:
-#         shop = await shop_crud.read_by_name(config["name"])
-#         if not shop:
-#             logger.info(f"Shop not found adding: {config['name']}")
-#             shop = await shop_crud.create(ShopConfigurationSchema(**config))
-#
-#         scrapers[shop["id"]] = Scraper(config=ShopConfigurationDB(**shop))
+    shops = shopservice.get_multiple(db_session=db_session)
+    for shop in shops:
+        shop_model = shopmodels.ShopRead.from_orm(shop)
+        scrapers[shop.id] = Scraper(shop_model)

server/manage.py

@@ -5,7 +5,7 @@
 import typer
 from tabulate import tabulate
 
-from app.db.initdb import initdb
+from app.db.initdb import init_shops
 from app.enums import logenums, userenums
 from app.main import app
 from app.models import rolemodels, usermodels
@@ -311,6 +311,8 @@ def seeddb():
                 role=admin_role,
             )
 
+            init_shops(db_session=db_session)
+
     typer.echo(Messages.success)
 
 

server/tests/api/v1/test_me.py

@@ -1,6 +1,8 @@
 import pytest
 from fastapi.testclient import TestClient
 
+from tests import factories
+
 
 def test_read_me(user_role_client: TestClient):
     url = "/api/v1/me"
@@ -53,3 +55,13 @@ def test_read_me_roles(user_role_client: TestClient):
 
     roles = resp.json()
     assert roles[0]["name"] == "user"
+
+
+def test_update_me_shops(user_role_client: TestClient):
+    shops = [factories.ShopFactory(), factories.ShopFactory()]
+    shop_ids = [shop.id for shop in shops]
+
+    url = "/api/v1/me/shops"
+
+    resp = user_role_client.put(url=url, json=shop_ids)
+    assert resp.status_code == 200, resp.text

server/tests/api/v1/test_shops.py

@@ -0,0 +1,104 @@
+import pytest
+from fastapi.testclient import TestClient
+
+from tests.factories import ShopFactory
+
+
+def test_read_many(user_role_client: TestClient):
+    """
+    Test reading many shops.
+    """
+
+    # Create some shops in the db first
+    ShopFactory()
+    ShopFactory()
+    ShopFactory()
+
+    url = "/api/v1/shops/"
+    resp = user_role_client.get(url=url)
+    assert resp.status_code == 200, resp.json()
+    data = resp.json()
+    assert isinstance(data, list)
+    assert len(data) >= 1
+
+
+def test_read(admin_role_client: TestClient):
+    """
+    Test getting a shop.
+    """
+
+    # Create a shop to read first
+    db_shop = ShopFactory()
+
+    shop_id = db_shop.id
+    url = f"/api/v1/shops/{shop_id}"
+    resp = admin_role_client.get(url)
+    assert resp.status_code == 200, resp.text
+
+
+@pytest.mark.parametrize("user_id", [999, 0, -1, "g"])
+def test_read_invalid_id(admin_role_client: TestClient, user_id):
+    """
+    Test getting a shop with an invalid id.
+    """
+
+    # Create a user to read first
+    url = f"/api/v1/users/{user_id}"
+    resp = admin_role_client.get(url)
+    assert resp.status_code in [404, 422]
+
+
+def test_create(admin_role_client: TestClient):
+    """
+    Test creating a shop.
+    """
+    url = "/api/v1/shops/"
+    data = {
+        "name": "tesco",
+        "url": "www.tesco.com",
+        "query_url": "/groceries/en-GB/search?query={query}",
+        "render_javascript": False,
+        "listing_page_selector": {},
+    }
+
+    resp = admin_role_client.post(url, json=data)
+    assert resp.status_code == 201, resp.text
+
+
+def test_create_existing_name(admin_role_client: TestClient):
+    """
+    Test creating a shop with an already existing name.
+    """
+    db_shop = ShopFactory()
+    name = db_shop.name
+    url = "/api/v1/shops/"
+    data = {
+        "name": name,
+        "url": "www.tesco.com",
+        "query_url": "/groceries/en-GB/search?query={query}",
+        "render_javascript": False,
+        "listing_page_selector": {},
+    }
+
+    resp = admin_role_client.post(url, json=data)
+    assert resp.status_code == 400, resp.text
+
+
+def test_delete(admin_role_client: TestClient):
+    """
+    Test deleting a user.
+    """
+
+    # Create one to delete first
+    db_shop = ShopFactory()
+
+    id_ = db_shop.id
+
+    # Delete the shop
+    url = f"/api/v1/shops/{id_}"
+    resp = admin_role_client.delete(url)
+    assert resp.status_code == 200
+
+    # Ensure user has been deleted from the database
+    resp = admin_role_client.get(url)
+    assert resp.status_code == 404

server/tests/api/v1/test_users.py

@@ -1,6 +1,8 @@
 import pytest
 from fastapi.testclient import TestClient
 
+from tests import factories
+
 
 @pytest.mark.parametrize(
     "url, method",
@@ -155,3 +157,19 @@ def test_delete(admin_role_client: TestClient):
     # Ensure user has been deleted from the database
     resp = admin_role_client.get(url)
     assert resp.status_code == 404
+
+
+def test_update_user_roles(admin_role_client: TestClient):
+
+    # Create some roles in the db first
+    roles = [factories.RoleFactory(), factories.RoleFactory()]
+    role_ids = [role.id for role in roles]
+
+    # Create a user to assign the roles
+    user = factories.UserFactory()
+    user_id = user.id
+
+    url = f"/api/v1/users/{user_id}/roles"
+
+    resp = admin_role_client.put(url=url, json=role_ids)
+    assert resp.status_code == 200, resp.text