Compare commits

..
Author SHA1 Message Date
Gustavo Henrique Santos Souza de Miranda bf64255fe2 Add the tests for the service manager 2025-07-21 16:58:27 -03:00
Gustavo Henrique Miranda 9d0bc50350 Merge pull request #69 from gmbrax/fix/traveldiary-model-back-relantioship
Fix the photo and travel diary relationship to properly work
2025-07-21 15:44:24 -03:00
Gustavo Henrique Santos Souza de Miranda 83e7db9ce1 Fix the photo and travel diary relationship to properly work 2025-07-21 15:27:51 -03:00
Gustavo Henrique Miranda d840299398 Merge pull request #68 from gmbrax/test/database-unit-test
Change the import to avoid importing by the folder
2025-07-21 01:23:10 -03:00
Gustavo Henrique Santos Souza de Miranda ca0b8c554c Change the import to avoid importing by the folder 2025-07-21 01:22:05 -03:00
Gustavo Henrique Miranda ed2dbee1a3 Merge pull request #67 from gmbrax/test/traveldiaryservice-unit-test
Test/traveldiaryservice unit test
2025-07-21 01:18:08 -03:00
Gustavo Henrique Miranda 6e17064ce6 Merge pull request #66 from gmbrax/test/entryservice-unit-test
Test/entryservice unit test
2025-07-21 01:08:46 -03:00
Gustavo Henrique Santos Souza de Miranda a18c621d5c Add the tests for delete the entries method 2025-07-21 01:07:11 -03:00
Gustavo Henrique Miranda 998fa3ce2f Merge pull request #65 from gmbrax/test/database-unit-test
Create the test for the database class
2025-07-21 00:58:04 -03:00
Gustavo Henrique Santos Souza de Miranda 66879b5a7d Add the tests for update the entries method 2025-07-21 00:53:04 -03:00
Gustavo Henrique Santos Souza de Miranda 240e4ae6c7 fix the sanitization directory method to remove accents and diacritics 2025-07-21 00:53:04 -03:00
Gustavo Henrique Santos Souza de Miranda df9101ccac Add unidecode dependency on pyproject.toml 2025-07-21 00:53:04 -03:00
Gustavo Henrique Miranda 2454f929c9 Merge pull request #64 from gmbrax/fix/sanitize-accent-bug
Fix/sanitize accent bug
2025-07-21 00:23:35 -03:00
Gustavo Henrique Santos Souza de Miranda 736c0f160f fix the sanitization directory method to remove accents and diacritics 2025-07-21 00:14:17 -03:00
Gustavo Henrique Santos Souza de Miranda de27485c98 Add unidecode dependency on pyproject.toml 2025-07-21 00:13:26 -03:00
Gustavo Henrique Santos Souza de Miranda 152bff85e5 Add the read entries unit tests 2025-07-20 23:53:53 -03:00
Gustavo Henrique Santos Souza de Miranda f374285e2a Add the fixture for the read entry tests 2025-07-20 23:52:45 -03:00
Gustavo Henrique Santos Souza de Miranda b020f8500b Add The tests for the filename sanitization function and the create travel diary 2025-07-20 23:38:36 -03:00
Gustavo Henrique Santos Souza de Miranda 8119ae74f6 Create the test for the database class 2025-07-20 01:50:12 -03:00
8 changed files with 233 additions and 4 deletions
+2 -1
View File
@@ -20,7 +20,8 @@ dependencies = [
"sqlalchemy", "sqlalchemy",
"textual", "textual",
"tomli", "tomli",
"tomli_w" "tomli_w",
"unidecode"
] ]
[project.urls] [project.urls]
+2 -1
View File
@@ -25,7 +25,8 @@ class Photo(Base):
back_populates="photos" back_populates="photos"
) )
fk_travel_diary_id = Column(Integer, ForeignKey("travel_diaries.id"),nullable=False) fk_travel_diary_id = Column(Integer, ForeignKey("travel_diaries.id"), nullable=False)
travel_diary = relationship("TravelDiary", back_populates="photos")
__table_args__ = ( __table_args__ = (
Index('idx_photo_hash_diary', 'hash', 'fk_travel_diary_id'), Index('idx_photo_hash_diary', 'hash', 'fk_travel_diary_id'),
) )
+1
View File
@@ -13,6 +13,7 @@ class TravelDiary(Base):
name = Column(String, nullable=False) name = Column(String, nullable=False)
directory_name = Column(String, nullable=False, unique=True) directory_name = Column(String, nullable=False, unique=True)
entries = relationship("Entry", back_populates="travel_diary", cascade="all, delete-orphan") entries = relationship("Entry", back_populates="travel_diary", cascade="all, delete-orphan")
photos = relationship("Photo", back_populates="travel_diary", cascade="all, delete-orphan")
__table_args__ = ( __table_args__ = (
UniqueConstraint('directory_name', name='uq_travel_diary_directory_name'), UniqueConstraint('directory_name', name='uq_travel_diary_directory_name'),
+4 -2
View File
@@ -7,7 +7,7 @@ from pilgrim.utils import DirectoryManager
from sqlalchemy.exc import IntegrityError from sqlalchemy.exc import IntegrityError
from pilgrim.models.travel_diary import TravelDiary from pilgrim.models.travel_diary import TravelDiary
from unidecode import unidecode
class TravelDiaryService: class TravelDiaryService:
def __init__(self, session): def __init__(self, session):
@@ -20,8 +20,10 @@ class TravelDiaryService:
- Replaces spaces with underscores - Replaces spaces with underscores
- Ensures name is unique by adding a suffix if needed - Ensures name is unique by adding a suffix if needed
""" """
transliterated_name = unidecode(name)
# Remove special characters and replace spaces # Remove special characters and replace spaces
safe_name = re.sub(r'[^\w\s-]', '', name) safe_name = re.sub(r'[^\w\s-]', '', transliterated_name)
safe_name = safe_name.strip().replace(' ', '_').lower() safe_name = safe_name.strip().replace(' ', '_').lower()
# Ensure we have a valid name # Ensure we have a valid name
+8
View File
@@ -26,3 +26,11 @@ def populated_db_session(db_session):
db_session.add(travel_diary) db_session.add(travel_diary)
db_session.commit() db_session.commit()
return db_session 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
+33
View File
@@ -0,0 +1,33 @@
from pilgrim.service.servicemanager import ServiceManager
from unittest.mock import patch, MagicMock
def test_initial_state_is_none():
manager = ServiceManager()
assert manager.get_session() is None
assert manager.get_entry_service() is None
assert manager.get_photo_service() is None
assert manager.get_travel_diary_service() is None
@patch('pilgrim.service.servicemanager.TravelDiaryService')
@patch('pilgrim.service.servicemanager.PhotoService')
@patch('pilgrim.service.servicemanager.EntryService')
def test_get_services_instantiates_with_correct_session(
mock_entry_service, mock_photo_service, mock_travel_diary_service
):
manager = ServiceManager()
mock_session = MagicMock()
manager.set_session(mock_session)
entry_service_instance = manager.get_entry_service()
photo_service_instance = manager.get_photo_service()
travel_diary_service_instance = manager.get_travel_diary_service()
mock_entry_service.assert_called_once()
mock_photo_service.assert_called_once()
mock_travel_diary_service.assert_called_once()
mock_entry_service.assert_called_once_with(mock_session)
mock_photo_service.assert_called_once_with(mock_session)
mock_travel_diary_service.assert_called_once_with(mock_session)
assert entry_service_instance == mock_entry_service.return_value
assert photo_service_instance == mock_photo_service.return_value
assert travel_diary_service_instance == mock_travel_diary_service.return_value
+143
View File
@@ -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"
+40
View File
@@ -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()