Add testing support #88

Hidorikun · 2024-04-28T17:44:17Z

Added a way to run all tests.
Added tests for the remove punctuation utility as well as refactored it.
Moved constants in separate folder because they caused a circular dependency between ts_core and library.

Loran425

Glad to see someone interested in the testing side of thing, many new projects (or newly open source projects) suffer due to lack of testing, and having robust tests makes everyone's lives easier.

A few other changes that would be needed before this could be considered for a merge.
The following files all reference ts_core.py looking for items now in the src.core.constants file.

tagstudio\src\qt\modals\build_tag.py
tagstudio\src\qt\widgets\collage_icon.py
tagstudio\src\qt\widgets\item_thumb.py
tagstudio\src\qt\widgets\preview_panel.py
tagstudio\src\qt\widgets\thumb_renderer.py

Loran425 · 2024-04-30T05:14:16Z

tagstudio/src/core/library.py

+from tagstudio.src.core.json_typing import JsonCollation, JsonEntry, JsonLibary, JsonTag
+from tagstudio.src.core.constants import TS_FOLDER_NAME, BACKUP_FOLDER_NAME, COLLAGE_FOLDER_NAME, VERSION, TEXT_FIELDS
+from tagstudio.src.core.utils.str import strip_punctuation
+from tagstudio.src.core.utils.web import strip_web_protocol


Tagstudio.src... import format breaks at runtime for vscode and when running from the terminal

Suggested change

from tagstudio.src.core.json_typing import JsonCollation, JsonEntry, JsonLibary, JsonTag

from tagstudio.src.core.constants import TS_FOLDER_NAME, BACKUP_FOLDER_NAME, COLLAGE_FOLDER_NAME, VERSION, TEXT_FIELDS

from tagstudio.src.core.utils.str import strip_punctuation

from tagstudio.src.core.utils.web import strip_web_protocol

from src.core.json_typing import JsonCollation, JsonEntry, JsonLibary, JsonTag

from src.core.constants import TS_FOLDER_NAME, BACKUP_FOLDER_NAME, COLLAGE_FOLDER_NAME, VERSION, TEXT_FIELDS

from src.core.utils.str import strip_punctuation

from src.core.utils.web import strip_web_protocol

Thank you for the feedback! I have made the changes.

Loran425 · 2024-04-30T05:15:06Z

tagstudio/src/core/ts_core.py

+from tagstudio.src.core.constants import TEXT_FIELDS
+from tagstudio.src.core.library import Entry, Library


Tagstudio.src... import format breaks at runtime for vscode and when running from the terminal

Suggested change

from tagstudio.src.core.constants import TEXT_FIELDS

from tagstudio.src.core.library import Entry, Library

from src.core.constants import TEXT_FIELDS

from src.core.library import Entry, Library

Thank you for the feedback! I have made the changes.

Loran425 · 2024-04-30T05:16:04Z

tagstudio/src/qt/ts_qt.py

+from tagstudio.src.core.utils.web import strip_web_protocol
+from tagstudio.src.qt.flowlayout import FlowLayout, FlowWidget
+from tagstudio.src.qt.main_window import Ui_MainWindow


Tagstudio.src... import format breaks at runtime for vscode and when running from the terminal

Thank you for the feedback! I have made the changes.

Loran425 · 2024-04-30T05:22:21Z

tagstudio/tests/main.py

I'm having luck getting python.exe -m unittest discover tagstudio.tests -t "tagstudio" to run from the <local_repo> directory but this file is throwing a fit working between all the different use cases.
Something like unittest.TestSuite() or unittest load test protocol might be more appropriate for the longer term and avoid needing to change the import format in the src library.

I have added pytest instead of unittest and I found that running python -m pytest tests/ from the tagstudio folder works. Does not seem to work any other way though.

Loran425 · 2024-04-30T05:32:24Z

requirements.txt

@@ -7,3 +7,4 @@ PySide6_Addons>=6.5.1.1,<=6.6.3.1
 PySide6_Essentials>=6.5.1.1,<=6.6.3.1
 typing_extensions>=3.10.0.0,<=4.11.0
 ujson>=5.8.0,<=5.9.0
+parametrized==0.9.0


Suggested change

parametrized==0.9.0

parameterized==0.9.0

Thank you for the feedback! I have added a requirements-dev.txt as discussed in this MR with pytest.

Loran425 · 2024-04-30T05:36:13Z

tagstudio/src/qt/ts_qt.py

 						   FixDupeFilesModal, FoldersToTagsModal)
-import src.qt.resources_rc
+import tagstudio.src.qt.resources_rc


Tagstudio.src... import format breaks at runtime for vscode and when running from the terminal

Suggested change

import tagstudio.src.qt.resources_rc

import src.qt.resources_rc

Thank you for the feedback! I have made the changes.

Loran425 · 2024-04-30T05:36:59Z

tagstudio/tests/src/core/test_tags.py


+from tagstudio.src.core.library import Tag


Tagstudio.src... import format breaks at runtime for vscode and when running from the terminal

Suggested change

from tagstudio.src.core.library import Tag

from src.core.library import Tag

Thank you for the feedback! I have made the changes.

Loran425 · 2024-04-30T05:37:53Z

tagstudio/tests/src/utils/test_str.py

+
+from parameterized import parameterized
+
+from tagstudio.src.core.utils.str import strip_punctuation


Tagstudio.src... import format breaks at runtime for vscode and when running from the terminal

Suggested change

from tagstudio.src.core.utils.str import strip_punctuation

from src.core.utils.str import strip_punctuation

Thank you for the feedback! I have made the changes.

Loran425 · 2024-04-30T05:47:01Z

tagstudio/src/qt/ts_qt.py

-from src.core.library import ItemType
-from src.core.ts_core import (PLAINTEXT_TYPES, TagStudioCore, TAG_COLORS, DATE_FIELDS, TEXT_FIELDS, BOX_FIELDS, ALL_FILE_TYPES,
+from tagstudio.src.core.library import Collation, Entry, ItemType, Library, Tag
+from tagstudio.src.core.palette import ColorType, get_tag_color


This line was removed in a previous commit and is no longer used in ts_qt.py

Thank you for the feedback! I have made the changes.

Loran425 · 2024-04-30T05:47:32Z

tagstudio/src/qt/ts_qt.py

-
-from src.core.library import ItemType
-from src.core.ts_core import (PLAINTEXT_TYPES, TagStudioCore, TAG_COLORS, DATE_FIELDS, TEXT_FIELDS, BOX_FIELDS, ALL_FILE_TYPES,
+from tagstudio.src.core.library import Collation, Entry, ItemType, Library, Tag


This line was previously reduced to only import ItemType as it is the only item used in ts_qt.py

Thank you for the feedback! I have made the changes.

yedpodtrzitko · 2024-04-30T07:18:37Z

requirements.txt

@@ -7,3 +7,4 @@ PySide6_Addons>=6.5.1.1,<=6.6.3.1
 PySide6_Essentials>=6.5.1.1,<=6.6.3.1
 typing_extensions>=3.10.0.0,<=4.11.0
 ujson>=5.8.0,<=5.9.0
+parametrized==0.9.0


this shouldnt be a production depedency, I'd suggest to create requirements-dev.txt or similar and put it there instead.

That's a good point. By the way, do you guys manually add those dependencies to the requirements.txt or can pip do that automtically like npm can?

There's pip freeze which lists all currently installed packages, so you can do pip freeze > requirements.txt but it lists even the transitional dependencies which is suboptimal.

Ideally the project should use some advanced dep. management tool like Poetry or pdm, but seems like that isnt/wasnt a priority yet

Fair point,
I don't think there's currently a plan to switchover to a more robust dependency manager, not saying a switch shouldn't happen but I believe the energy is more focused on swapping the backend from a JSON file to a database.

Are there any recommendations aside from something like a requirements-dev.txt file to be a stopgap on this kind of thing?

Example

-r requirements.txt parameterized==0.9.0

I'd go with requirements-dev.txt and requirements-dev.txt without referencing each other, any dev will know how to deal with it. But I dont have strong opinion about it.

What do you guys think about the latest changes? 😄

I'd keep the original name requirements.txt instead of adding the -prod suffix there, as that's the most common name everyone looks for by default. Other than that it looks good to me, nice job.

Done, thank you for the review 😄

yedpodtrzitko · 2024-04-30T07:28:48Z

just out of curiosity - why unittest instead of pytest? The latter is considered defacto the go-to testing library. It has fixtures and parametrization support out of the box, and it's less verbose, eg. no need to wrap every single test into a class, and you can use plain assert instead of writing self.assertEqual etc. everywhere.

Hidorikun · 2024-04-30T11:15:10Z

@yedpodtrzitko I was looking for some native support for testing in Python and came across unittest.

My thinking was that I would want to avoid adding extra dependencies if I can.
Saying that, to create a parameterized test I also needed to add a dependency, so if pytest can do that and much more, I agree that it would be a better alternative.

Thank you for pointing it out. I am not accustomed with the defacto conventions in python projects so far, and I appreciate the input.

Loran425

Great work, I'm only seeing these two comments that should be addressed.

tagstudio/src/core/ts_core.py

Loran425 · 2024-04-30T18:50:45Z

tagstudio/src/qt/ts_qt.py

@@ -323,7 +323,7 @@ def start(self):
 		# self.entry_panel.setWindowIcon(icon)

 		if os.name == 'nt':
-			appid = "cyanvoxel.tagstudio.9"
+			appid = "cyanvoxel.9"


not sure if this was intentional or a replace all gone wrong.

It was a replace gone wrong, good catch. I reverted it.

Co-authored-by: Andrew Arneson <Loran425@gmail.com>

yedpodtrzitko · 2024-05-01T10:10:48Z

requirements-dev.txt

+humanfriendly==10.0
+opencv_python>=4.8.0.74,<=4.9.0.80
+Pillow==10.3.0
+pillow_avif_plugin>=1.3.1,<=1.4.3
+PySide6>=6.5.1.1,<=6.6.3.1
+PySide6_Addons>=6.5.1.1,<=6.6.3.1
+PySide6_Essentials>=6.5.1.1,<=6.6.3.1
+typing_extensions>=3.10.0.0,<=4.11.0
+ujson>=5.8.0,<=5.9.0


Suggested change

humanfriendly==10.0

opencv_python>=4.8.0.74,<=4.9.0.80

Pillow==10.3.0

pillow_avif_plugin>=1.3.1,<=1.4.3

PySide6>=6.5.1.1,<=6.6.3.1

PySide6_Addons>=6.5.1.1,<=6.6.3.1

PySide6_Essentials>=6.5.1.1,<=6.6.3.1

typing_extensions>=3.10.0.0,<=4.11.0

ujson>=5.8.0,<=5.9.0

There was probably some misunderstanding, but these dependencies should remain only in requirements.txt, otherwise these files will get out of sync sooner or later and it will cause problems.

If you really want to have everything installed via a single dependency file, put here -r requirements.txt isntead. Otherwise I think both these files should be independent from each other. Ie. requirements.txt for installing production dependencies, requirements-dev.txt for developers' dependencies.

gabrieljreed · 2024-05-04T06:30:07Z

Just wanted to add my 2 cents here - this looks great! One small thing I might change is that I usually see the tests folder live outside the source code directory (in this case, the tagstudio folder.) Everything inside the source code folder should be code for the package, since tests are not actual application code, they can be separate. This is actually recommended in the pytest documentation as well.

Hidorikun added 3 commits April 28, 2024 20:37

Add testing support

a5ffada

Merge branch 'main' into test-support

55775c2

Add parametrized dependency

3fb442c

Loran425 suggested changes Apr 30, 2024

View reviewed changes

yedpodtrzitko reviewed Apr 30, 2024

View reviewed changes

Hidorikun added 3 commits April 30, 2024 18:16

Fix imports to work with Visual Studio and with Terminal

11a357f

Add PyTest dependency and update the documentation

f4c2e8e

Rename requirements-prod.txt to requirements.txt

e1ba7e2

Loran425 suggested changes Apr 30, 2024

View reviewed changes

Loran425 mentioned this pull request May 1, 2024

Add "Delete Tag" menu option to tags in the Tag Database and tag box #105

Closed

Loran425 added the Type: Enhancement New feature or request label May 1, 2024

Hidorikun and others added 2 commits May 1, 2024 11:11

Update ts_core.py

80ec766

Co-authored-by: Andrew Arneson <Loran425@gmail.com>

Restore appid

d583916

yedpodtrzitko reviewed May 1, 2024

View reviewed changes

Hidorikun and others added 2 commits May 1, 2024 14:32

Leave only dev requirements in the requirements-dev file

87d535b

Merge branch 'main' into test-support

c9423fe

Hidorikun mentioned this pull request May 6, 2024

Add pytest support #142

Merged

Hidorikun closed this May 7, 2024

Hidorikun deleted the test-support branch May 7, 2024 07:49

CyanVoxel mentioned this pull request May 17, 2024

Replace use of os.path with pathlib #156

Merged

		from tagstudio.src.core.constants import TEXT_FIELDS
		from tagstudio.src.core.library import Entry, Library

	import tagstudio.src.qt.resources_rc
	import src.qt.resources_rc

	from tagstudio.src.core.library import Tag
	from src.core.library import Tag


		from parameterized import parameterized

		from tagstudio.src.core.utils.str import strip_punctuation

	from tagstudio.src.core.utils.str import strip_punctuation
	from src.core.utils.str import strip_punctuation

Add testing support #88

Add testing support #88

Conversation

Hidorikun commented Apr 28, 2024

Loran425 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yedpodtrzitko commented Apr 30, 2024

Hidorikun commented Apr 30, 2024

Loran425 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabrieljreed commented May 4, 2024