[tags-report] Add unit tests, fix some issue

* update README

Author: canepan

README.md

@@ -16,6 +16,9 @@ Currently I have these services at home:
 ## id3-checker
 From a directory, finds songs recursively and shows artist, title and album, alerting on discrepancies
 
+## tags-report
+From a directory, finds songs recursively and shows discrepancies or misses in ID3 tags
+
 ## minecraft_ctl
 Script to disable or enable running Minecraft (by changing permissions, closing the firewall and killing processes).  
 Currently supports (Mac only):
@@ -25,6 +28,9 @@ Currently supports (Mac only):
 * Diablo III
 * Docker
 
+## qsm
+Quick service map: reads keepalived conf, report services location based on active IPs
+
 ## service-map
 * show running, active services
 * reads KeepAlived config (basic)

src/tools/bin/music_tags_report.py

@@ -44,27 +44,29 @@ class Song:
 
     def __post_init__(self):
         self.indexes = {"album": -2, "title": -1, "artist": -3}
+        norm_path = "_".join(filter(None, re.split("[-_\s]", self.path)))
         try:
-            self._year, self._album = self.path.split("/")[self.indexes["album"]].split("-", maxsplit=1)
+            self._year, self._album = norm_path.split("/")[self.indexes["album"]].split("_", maxsplit=1)
         except Exception as e:
             # There could be "CDx" sub-dir
             try:
                 self.indexes["album"] -= 1
                 self.indexes["artist"] -= 1
-                self._year, self._album = self.path.split("/")[self.indexes["album"]].split("-", maxsplit=1)
+                self._year, self._album = norm_path.split("/")[self.indexes["album"]].split("_", maxsplit=1)
             except Exception as e_sub:
                 click.echo(f"Error splitting {self.path} for album/year: {e}; {e_sub}")
         self._album = self._album.replace("_", " ")
         try:
-            self._name = re.sub("^[0-9]+([^0-9 ])* (- )?", "", self.path.split("/")[self.indexes["title"]][:-4]).replace("_", " ")
+            # self._name = re.sub("^[0-9]+([^0-9 ])* (- )?", "", norm_path.split("/")[self.indexes["title"]][:-4]).replace("_", " ")
+            self._name = re.sub("^[0-9]+[-_.\s]*", "", self.path.split("/")[self.indexes["title"]][:-4]).replace("_", " ")
         except Exception as e:
             click.echo(f"Error searching name from {self.path}: {e}")
         try:
-            self._track = re.sub("[^0-9].*$", "", self.path.split("/")[self.indexes["title"]])
+            self._track = re.sub("[^0-9].*$", "", norm_path.split("/")[self.indexes["title"]])
         except Exception as e:
             click.echo(f"Error searching track from {self.path}: {e}")
         try:
-            self._artist = self.path.split("/")[self.indexes["artist"]].replace("_", " ")
+            self._artist = norm_path.split("/")[self.indexes["artist"]].replace("_", " ")
         except Exception as e:
             click.echo(f"Error splitting {self.path} for artist: {e}")
 
@@ -81,11 +83,11 @@ def name(self) -> str:
         return self._name
 
     @property
-    def track(self) -> str:
+    def track(self) -> int:
         return int(self._track or "0")
 
     @property
-    def year(self) -> str:
+    def year(self) -> int:
         return int(self._year)
 
 

test/test_music_tags_report.py

@@ -0,0 +1,20 @@
+import pytest
+
+from tools.bin.music_tags_report import Song
+
+
+@pytest.mark.parametrize(
+    "full_path,expected_year,expected_album,expected_artist,expected_n,expected_title",
+    (
+        ("yaddayadda/artist/1974-album/5 - My Title.mp3", 1974, "album", "artist", 5, "My Title"),
+        ("yaddayadda/artist/1974- album/3. My Title, jet-set.mp3", 1974, "album", "artist", 3, "My Title, jet-set"),
+        ("yaddayadda/Artist_Name/1974 - album/disc/01-My title è.mp3", 1974, "album", "Artist Name", 1, "My title è"),
+    ),
+)
+def test_song_class(full_path, expected_year, expected_album, expected_artist, expected_n, expected_title):
+    song = Song(full_path)
+    assert song.year == expected_year
+    assert song.album == expected_album
+    assert song.artist == expected_artist
+    assert song.name == expected_title
+    assert song.track == expected_n