Merge pull request #68 from gmbrax/test/database-unit-test

Change the import to avoid importing by the folder

tests/conftest.py

@@ -26,3 +26,11 @@ def populated_db_session(db_session):
     db_session.add(travel_diary)
     db_session.commit()
     return db_session
+
+@pytest.fixture
+def session_with_one_diary(db_session):
+    diary = TravelDiary(name="Diário de Teste", directory_name="diario_de_teste")
+    db_session.add(diary)
+    db_session.commit()
+    db_session.refresh(diary)
+    return db_session, diary

tests/service/test_entry_service.py

@@ -0,0 +1,269 @@
+from re import search
+
+import pytest
+from datetime import datetime
+from unittest.mock import Mock
+from sqlalchemy import create_engine
+from sqlalchemy.exc import IntegrityError
+from sqlalchemy.orm import sessionmaker
+
+from pilgrim.database import Base
+from pilgrim.models.travel_diary import TravelDiary
+from pilgrim.models.entry import Entry
+from pilgrim.models.photo import Photo
+
+from pilgrim.service.entry_service import EntryService
+
+
+
+@pytest.fixture
+def session_with_an_entry(populated_db_session):
+    session = populated_db_session
+    initial_entry = Entry(
+        title="Título Original",
+        text="Texto original.",
+        date=datetime(2025, 1, 1),
+        travel_diary_id=1
+    )
+    session.add(initial_entry)
+    session.commit()
+    return session, initial_entry.id
+
+@pytest.fixture
+def session_with_multiple_entries(populated_db_session):
+    """Fixture que cria um diário e duas entradas para ele."""
+    session = populated_db_session
+
+    entry1 = Entry(title="Entrada 1", text="Texto 1", date=datetime(2025, 1, 1), travel_diary_id=1)
+    entry2 = Entry(title="Entrada 2", text="Texto 2", date=datetime(2025, 1, 2), travel_diary_id=1)
+
+    session.add_all([entry1, entry2])
+    session.commit()
+
+    return session
+
+def test_create_entry_successfully(populated_db_session):
+    session = populated_db_session
+    service = EntryService(session)
+    diary_id = 1  # Sabemos que o ID é 1 por causa da nossa fixture
+    title = "Primeiro Dia na Praia"
+    text = "O dia foi ensolarado e o mar estava ótimo."
+    date = datetime(2025, 7, 20)
+    photos = [Photo(filepath="/path/to/photo1.jpg",name="Photo 1",photo_hash="hash_12345678",fk_travel_diary_id=diary_id), Photo(filepath="/path/to/photo2.jpg",name="Photo 1",photo_hash="hash_87654321",fk_travel_diary_id=diary_id)]
+    created_entry = service.create(
+        travel_diary_id=diary_id,
+        title=title,
+        text=text,
+        date=date,
+        photos=photos
+    )
+    assert created_entry is not None
+    assert created_entry.id is not None  # Garante que foi salvo no BD e tem um ID
+    assert created_entry.title == title
+    assert created_entry.text == text
+    assert len(created_entry.photos) == 2
+    assert created_entry.photos[0].filepath == "/path/to/photo1.jpg"
+
+    entry_in_db = session.query(Entry).filter_by(id=created_entry.id).one()
+    assert entry_in_db.title == "Primeiro Dia na Praia"
+
+def test_create_entry_fails_when_diary_id_is_invalid(db_session):
+    session = db_session
+    service = EntryService(session)
+    invalid_id = 666
+
+    result = service.create(
+        travel_diary_id=invalid_id,
+        title="Título de Teste",
+        text="Texto de Teste",
+        date=datetime(2025, 7, 20),
+        photos=[]
+    )
+
+    assert result is None
+
+def test_create_entry_successfully_without_photo(populated_db_session):
+    session = populated_db_session
+    service = EntryService(session)
+    diary_id = 1  # Sabemos que o ID é 1 por causa da nossa fixture
+    title = "Primeiro Dia na Praia"
+    text = "O dia foi ensolarado e o mar estava ótimo."
+    date = datetime(2025, 7, 20)
+    photos = []
+    created_entry = service.create(
+        travel_diary_id=diary_id,
+        title=title,
+        text=text,
+        date=date,
+        photos=photos
+    )
+    assert created_entry is not None
+    assert created_entry.id is not None  # Garante que foi salvo no BD e tem um ID
+    assert created_entry.title == title
+    assert created_entry.text == text
+    assert len(created_entry.photos) == 0
+    entry_in_db = session.query(Entry).filter_by(id=created_entry.id).one()
+    assert entry_in_db.title == "Primeiro Dia na Praia"
+
+def test_create_entry_fails_with_null_title(populated_db_session):
+    session = populated_db_session
+    service = EntryService(session)
+    diary_id = 1
+    with pytest.raises(IntegrityError):
+        service.create(
+            travel_diary_id=diary_id,
+            title=None,
+            text="Um texto qualquer.",
+            date=datetime.now(),
+            photos=[]
+        )
+
+def test_create_entry_fails_with_null_date(populated_db_session):
+    session = populated_db_session
+    service = EntryService(session)
+    diary_id = 1
+    with pytest.raises(IntegrityError):
+        service.create(
+            travel_diary_id=diary_id,
+            title="Sabado de sol",
+            text="Um texto qualquer.",
+            date=None,
+            photos=[]
+        )
+
+def test_create_entry_fails_with_null_diary_id(populated_db_session):
+    session = populated_db_session
+    service = EntryService(session)
+    diary_id = 1
+    result = service.create(
+            travel_diary_id=None,
+            title="Sabado de sol",
+            text="Um texto qualquer.",
+            date=datetime.now(),
+            photos=[]
+        )
+    assert result is None
+def test_ready_by_id_successfully(session_with_an_entry):
+    session,_ = session_with_an_entry
+    service = EntryService(session)
+    search_id = 1
+    result = service.read_by_id(search_id)
+    assert result is not None
+def test_ready_by_id_fails_when_id_is_invalid(db_session):
+    session = db_session
+    service = EntryService(session)
+    invalid_id = 666
+    result = service.read_by_id(invalid_id)
+    assert result is None
+
+def test_read_all_returns_all_entries(session_with_multiple_entries):
+    session = session_with_multiple_entries
+    service = EntryService(session)
+    all_entries = service.read_all()
+    assert isinstance(all_entries, list)
+    assert len(all_entries) == 2
+    assert all_entries[0].title == "Entrada 1"
+    assert all_entries[1].title == "Entrada 2"
+
+def test_read_all_returns_empty_list_on_empty_db(db_session):
+    session = db_session
+    service = EntryService(session)
+    all_entries = service.read_all()
+    assert isinstance(all_entries, list)
+    assert len(all_entries) == 0
+
+def test_update_entry_successfully(session_with_an_entry):
+    session, entry_id = session_with_an_entry
+    service = EntryService(session)
+    entry_src = session.query(Entry).filter_by(id=entry_id).one()
+    new_date = datetime(2025, 1, 2)
+    entry_dst = Entry(
+        title="Título Atualizado",
+        text="Texto atualizado.",
+        date=new_date,
+        travel_diary_id=1,  # Mantemos o mesmo travel_diary_id
+        photos=[]
+    )
+    updated_entry = service.update(entry_src, entry_dst)
+    assert updated_entry is not None
+    assert updated_entry.id == entry_id
+    assert updated_entry.title == "Título Atualizado"
+    assert updated_entry.text == "Texto atualizado."
+    entry_in_db = session.query(Entry).filter_by(id=entry_id).one()
+    assert entry_in_db.title == "Título Atualizado"
+
+def test_update_entry_fails_if_entry_does_not_exist(db_session):
+    service = EntryService(db_session)
+    non_existent_entry = Entry(
+        title="dummy",
+        text="dummy",
+        date=datetime.now(),
+        travel_diary_id=1)
+    non_existent_entry.id = 999
+    entry_with_new_data = Entry(title="Novo Título", text="Novo Texto", date=datetime.now(), travel_diary_id=1)
+    result = service.update(non_existent_entry, entry_with_new_data)
+    assert result is None
+
+def test_update_fails_with_null_title(session_with_an_entry):
+    session, entry_id = session_with_an_entry
+    service = EntryService(session)
+    entry_src = session.query(Entry).filter_by(id=entry_id).one()
+    entry_dst = Entry(
+        title=None,
+        text="Texto atualizado.",
+        date=datetime.now(),
+        travel_diary_id=1,
+        photos=[]
+    )
+    with pytest.raises(IntegrityError):
+        service.update(entry_src, entry_dst)
+
+def test_update_fails_with_null_date(session_with_an_entry):
+    session, entry_id = session_with_an_entry
+    service = EntryService(session)
+    entry_src = session.query(Entry).filter_by(id=entry_id).one()
+    entry_dst = Entry(
+        title=entry_src.title,
+        text="Texto atualizado.",
+        date=None,
+        travel_diary_id=1,
+        photos=[]
+    )
+    with pytest.raises(IntegrityError):
+        service.update(entry_src, entry_dst)
+
+def test_update_fails_with_null_diary_id(session_with_an_entry):
+    session, entry_id = session_with_an_entry
+    service = EntryService(session)
+    entry_src = session.query(Entry).filter_by(id=entry_id).one()
+    entry_dst = Entry(
+        title=entry_src.title,
+        text="Texto atualizado.",
+        date=datetime.now(),
+        travel_diary_id=None,
+        photos=[]
+    )
+    with pytest.raises(IntegrityError):
+        service.update(entry_src, entry_dst)
+
+def test_delete_successfully_removes_entry(session_with_an_entry):
+    session, entry_id = session_with_an_entry
+    service = EntryService(session)
+    entry_to_delete = service.read_by_id(entry_id)
+    assert entry_to_delete is not None
+    deleted_entry = service.delete(entry_to_delete)
+    assert deleted_entry is not None
+    assert deleted_entry.id == entry_id
+    entry_in_db = service.read_by_id(entry_id)
+    assert entry_in_db is None
+
+def test_delete_returns_none_if_entry_does_not_exist(db_session):
+    service = EntryService(db_session)
+    non_existent_entry = Entry(
+        title="dummy",
+        text="dummy",
+        date=datetime.now(),
+        travel_diary_id=1)
+    non_existent_entry.id = 999
+    result = service.delete(non_existent_entry)
+    assert result is None

tests/service/test_travel_diary_service.py

@@ -0,0 +1,143 @@
+from unittest.mock import patch, MagicMock
+from pathlib import Path
+
+import pytest
+
+from pilgrim import TravelDiary
+from pilgrim.service.travel_diary_service import TravelDiaryService
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+@pytest.mark.asyncio # Marca o teste para rodar código assíncrono
+async def test_create_diary_successfully(mock_ensure_dir, db_session):
+    service = TravelDiaryService(db_session)
+    new_diary = await service.async_create("Viagem para a Serra")
+    assert new_diary is not None
+    assert new_diary.id is not None
+    assert new_diary.name == "Viagem para a Serra"
+    assert new_diary.directory_name == "viagem_para_a_serra"
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+@patch.object(TravelDiaryService, '_sanitize_directory_name', return_value="nome_existente")
+@pytest.mark.asyncio
+async def test_create_diary_handles_integrity_error(mock_sanitize, mock_ensure_dir, db_session):
+    existing_diary = TravelDiary(name="Diário Antigo", directory_name="nome_existente")
+    db_session.add(existing_diary)
+    db_session.commit()
+    service = TravelDiaryService(db_session)
+    with pytest.raises(ValueError, match="Could not create diary"):
+        await service.async_create("Qualquer Nome Novo")
+    mock_ensure_dir.assert_not_called()
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+def test_read_by_id_successfully(mock_ensure_dir, session_with_one_diary):
+    session, diary_to_find = session_with_one_diary
+    service = TravelDiaryService(session)
+    found_diary = service.read_by_id(diary_to_find.id)
+    assert found_diary is not None
+    assert found_diary.id == diary_to_find.id
+    assert found_diary.name == "Diário de Teste"
+    mock_ensure_dir.assert_called_once_with(found_diary)
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+def test_read_by_id_returns_none_for_invalid_id(mock_ensure_dir, db_session):
+    service = TravelDiaryService(db_session)
+    result = service.read_by_id(999)
+    assert result is None
+    mock_ensure_dir.assert_not_called()
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+def test_read_all_returns_all_diaries(mock_ensure_dir, db_session):
+    d1 = TravelDiary(name="Diário 1", directory_name="d1")
+    d2 = TravelDiary(name="Diário 2", directory_name="d2")
+    db_session.add_all([d1, d2])
+    db_session.commit()
+    service = TravelDiaryService(db_session)
+    diaries = service.read_all()
+    assert isinstance(diaries, list)
+    assert len(diaries) == 2
+    assert mock_ensure_dir.call_count == 2
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+def test_read_all_returns_empty_list_for_empty_db(mock_ensure_dir, db_session):
+    service = TravelDiaryService(db_session)
+    diaries = service.read_all()
+    assert isinstance(diaries, list)
+    assert len(diaries) == 0
+    mock_ensure_dir.assert_not_called()
+
+@patch.object(TravelDiaryService, '_ensure_diary_directory')
+@patch('pathlib.Path.rename')
+@patch.object(TravelDiaryService, '_get_diary_directory')
+def test_update_diary_successfully(mock_get_dir, mock_path_rename, mock_ensure, session_with_one_diary):
+    session, diary_to_update = session_with_one_diary
+    service = TravelDiaryService(session)
+    old_path = MagicMock(spec=Path)  # Um mock que se parece com um objeto Path
+    old_path.exists.return_value = True  # Dizemos que o diretório antigo "existe"
+    new_path = Path("/fake/path/diario_atualizado")
+    mock_get_dir.side_effect = [old_path, new_path]
+    updated_diary = service.update(diary_to_update.id, "Diário Atualizado")
+    assert updated_diary is not None
+    assert updated_diary.name == "Diário Atualizado"
+    assert updated_diary.directory_name == "diario_atualizado"
+    old_path.rename.assert_called_once_with(new_path)
+
+def test_update_returns_none_for_invalid_id(db_session):
+    service = TravelDiaryService(db_session)
+    result = service.update(travel_diary_id=999, name="Nome Novo")
+    assert result is None
+
+@patch.object(TravelDiaryService, '_cleanup_diary_directory')
+def test_delete_diary_successfully(mock_cleanup, session_with_one_diary):
+    session, diary_to_delete = session_with_one_diary
+    service = TravelDiaryService(session)
+    result = service.delete(diary_to_delete)
+    assert result is not None
+    assert result.id == diary_to_delete.id
+    mock_cleanup.assert_called_once_with(diary_to_delete)
+    diary_in_db = service.read_by_id(diary_to_delete.id)
+    assert diary_in_db is None
+
+@patch.object(TravelDiaryService, '_cleanup_diary_directory')
+def test_delete_returns_none_for_non_existent_diary(mock_cleanup, db_session):
+    service = TravelDiaryService(db_session)
+    non_existent_diary = TravelDiary(name="dummy", directory_name="dummy")
+    non_existent_diary.id = 999
+    result = service.delete(non_existent_diary)
+    assert result is None
+    mock_cleanup.assert_not_called()
+
+@patch.object(TravelDiaryService, '_sanitize_directory_name')
+def test_update_raises_value_error_on_name_collision(mock_sanitize, db_session):
+
+    d1 = TravelDiary(name="Diário A", directory_name="diario_a")
+    d2 = TravelDiary(name="Diário B", directory_name="diario_b")
+    db_session.add_all([d1, d2])
+    db_session.commit()
+    db_session.refresh(d1)
+    mock_sanitize.return_value = "diario_b"
+    service = TravelDiaryService(db_session)
+    with pytest.raises(ValueError, match="Could not update diary"):
+        service.update(d1.id, "Diário B")
+
+def test_sanitize_directory_name_formats_string_correctly(db_session):
+    service = TravelDiaryService(db_session)
+    name1 = "Minha Primeira Viagem"
+    assert service._sanitize_directory_name(name1) == "minha_primeira_viagem"
+    name2 = "Viagem para o #Rio de Janeiro! @2025"
+    assert service._sanitize_directory_name(name2) == "viagem_para_o_rio_de_janeiro_2025"
+    name3 = "  Mochilão na Europa   "
+    assert service._sanitize_directory_name(name3) == "mochilao_na_europa"
+
+def test_sanitize_directory_name_handles_uniqueness(db_session):
+    existing_diary = TravelDiary(name="Viagem para a Praia", directory_name="viagem_para_a_praia")
+    db_session.add(existing_diary)
+    db_session.commit()
+    service = TravelDiaryService(db_session)
+    new_sanitized_name = service._sanitize_directory_name("Viagem para a Praia")
+    assert new_sanitized_name == "viagem_para_a_praia_1"
+    another_diary = TravelDiary(name="Outra Viagem", directory_name="viagem_para_a_praia_1")
+    db_session.add(another_diary)
+    db_session.commit()
+
+    third_sanitized_name = service._sanitize_directory_name("Viagem para a Praia")
+    assert third_sanitized_name == "viagem_para_a_praia_2"

tests/test_database.py

@@ -0,0 +1,40 @@
+import pytest
+from unittest.mock import Mock  # A ferramenta para criar nosso "dublê"
+from pathlib import Path
+from sqlalchemy import inspect, Column, Integer, String
+from sqlalchemy.orm import Session
+
+from pilgrim.database import Database,Base
+
+class MockUser(Base):
+    __tablename__ = 'mock_users'
+    id = Column(Integer, primary_key=True)
+    name = Column(String)
+
+@pytest.fixture
+def db_instance(tmp_path: Path):
+    fake_db_path = tmp_path / "test_pilgrim.db"
+    mock_config_manager = Mock()
+    mock_config_manager.database_url = str(fake_db_path)
+    db = Database(mock_config_manager)
+    return db, fake_db_path
+
+def test_create_database(db_instance):
+    db, fake_db_path = db_instance
+    db.create()
+    assert fake_db_path.exists()
+
+def test_table_creation(db_instance):
+    db, _ = db_instance
+    db.create()
+    inspector = inspect(db.engine)
+    assert "mock_users" in inspector.get_table_names()
+
+def test_session_returned_corectly(db_instance):
+    db, _ = db_instance
+    session = db.session()
+    assert isinstance(session, Session)
+    session.close()
+
+
+