Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2232 only newest slugs autocomplete #615

Merged
merged 4 commits into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions backend/app/app/data_models/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,11 +138,11 @@ class RepositoryGetter(GetterDict):
def get(self, key: str, default: Any = None) -> Any:
repository = self._obj
if key == "books":
books = set()
for commit in repository.commits:
for book in commit.books:
books.add(book.slug)
return list(books)
commits = (c for c in repository.commits if len(c.books) > 0)
newest = max(commits, key=lambda c: c.timestamp, default=None)
if newest is None:
return []
return [book.slug for book in newest.books]
else:
try:
return getattr(self._obj, key)
Expand Down
1 change: 1 addition & 0 deletions backend/app/tests/unit/api/endpoints/test_github.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ def test_repositories(
# the correct information
first = payload[0]
assert first == RepositorySummary.from_orm(fake_data.FAKE_REPO)
assert first["books"] == [b.slug for b in fake_data.FAKE_COMMIT2.books]
21 changes: 19 additions & 2 deletions backend/app/tests/unit/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,30 @@ def fake_data():
class FakeData:
AUDIT_DATA = {"created_at": now, "updated_at": now}
FAKE_REPO = Repository(name="osbooks-fake-book", owner="openstax", id=1)
FAKE_COMMIT = Commit(id=1, repository_id=FAKE_REPO.id)
FAKE_COMMIT = Commit(
id=1,
repository_id=FAKE_REPO.id,
timestamp=datetime.fromisoformat("2024-06-05T17:30:24.311Z"),
)
FAKE_COMMIT2 = Commit(
id=2,
repository_id=FAKE_REPO.id,
timestamp=datetime.fromisoformat("2024-06-05T17:30:53.909Z"),
)
FAKE_BOOK = Book(
commit_id=FAKE_COMMIT.id,
slug="test",
uuid="ooooooo",
edition=0,
style="test",
)
FAKE_BOOK2 = Book(
commit_id=FAKE_COMMIT2.id,
slug="test-2",
uuid="ooooooo",
edition=0,
style="test",
)
FAKE_USER = User(id=1, name="Test", avatar_url="/")
FAKE_SESSION = UserSession(
id=cast(int, FAKE_USER.id),
Expand All @@ -103,7 +119,8 @@ class FakeData:
FAKE_BOOK_JOB = BookJob(book_id=FAKE_BOOK.id, job_id=FAKE_JOB.id)
FAKE_BOOK_JOB.book = FAKE_BOOK
FAKE_COMMIT.books = [FAKE_BOOK]
FAKE_REPO.commits = [FAKE_COMMIT]
FAKE_COMMIT2.books = [FAKE_BOOK2]
FAKE_REPO.commits = [FAKE_COMMIT, FAKE_COMMIT2]
FAKE_JOB.books = [FAKE_BOOK_JOB]
FAKE_JOB.status = FAKE_STATUS
FAKE_JOB.user = FAKE_USER
Expand Down
68 changes: 68 additions & 0 deletions backend/app/tests/unit/test_models.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
from datetime import datetime

from app.data_models.models import RepositoryGetter
from app.db.schema import Book, Commit, Repository


def test_repository_getter_zero_commits():
# GIVEN: A repository containing zero commits
repo = Repository(id=1, name="test")
repo.commits = []
# WHEN: The repository getter tries to get books
# THEN: It returns an empty list instead of the default (None)
getter = RepositoryGetter(repo)
books = getter.get("books", None)
assert books == []


def test_repository_getter_zero_books():
# GIVEN: A repository containing one commit containing zero books
repo = Repository(id=1, name="test")
commit = Commit(
id=1, timestamp=datetime.fromisoformat("2024-06-05T18:54:16.031Z")
)
repo.commits = [commit]
commit.books = []
# WHEN: The repository getter tries to get books
# THEN: It returns an empty list instead of the default (None)
getter = RepositoryGetter(repo)
books = getter.get("books", None)
assert books == []


def test_repository_getter_one_book():
# GIVEN: A repository containing one commit containing one book
repo = Repository(id=1, name="test")
commit = Commit(
id=1, timestamp=datetime.fromisoformat("2024-06-05T18:54:16.031Z")
)
book = Book(slug="test-slug")
repo.commits = [commit]
commit.books = [book]
# WHEN: The repository getter tries to get books
# THEN: It returns a list of book slugs
getter = RepositoryGetter(repo)
books = getter.get("books", None)
assert books == [book.slug]


def test_repository_getter_multiple_matches():
# GIVEN: A repository containing two commits containing one or more books each
repo = Repository(id=1, name="test")
commit = Commit(
id=1, timestamp=datetime.fromisoformat("2024-06-05T18:58:16.011Z")
)
commit2 = Commit(
id=2, timestamp=datetime.fromisoformat("2024-06-05T19:03:21.271Z")
)
book = Book(slug="test-slug")
book2 = Book(slug="test-slug-2")
book3 = Book(slug="test-slug-3")
commit2.books = [book2, book3]
commit.books = [book]
repo.commits = [commit, commit2]
# WHEN: The repository getter tries to get books
# THEN: It returns a list of book slugs from the newest commit
getter = RepositoryGetter(repo)
books = getter.get("books", None)
assert books == [b.slug for b in commit2.books]
Loading