Add unit tests for rating tracks, albums and artists

Author: ironsmile

src/library/local_favourites_test.go

@@ -13,7 +13,7 @@ import (
 // favourites works.
 func TestFavouritesTracks(t *testing.T) {
 	ctx := context.Background()
-	lib := setUpLibForFavoutites(t)
+	lib := setUpLibForFavRatingsTesting(t)
 	defer func() { _ = lib.Truncate() }()
 
 	classicalSearch := SearchArgs{Query: "Classical Bugs", Count: 10}
@@ -93,7 +93,7 @@ func TestFavouritesTracks(t *testing.T) {
 // TestFavouritesAlbums checks that adding albums to favourites work.
 func TestFavouritesAlbums(t *testing.T) {
 	ctx := context.Background()
-	lib := setUpLibForFavoutites(t)
+	lib := setUpLibForFavRatingsTesting(t)
 	defer func() { _ = lib.Truncate() }()
 
 	classicalSearch := SearchArgs{Query: "Classical Bugs", Count: 10}
@@ -170,7 +170,7 @@ func TestFavouritesAlbums(t *testing.T) {
 // TestFavouritesArtists checks that adding artists to the favourites works.
 func TestFavouritesArtists(t *testing.T) {
 	ctx := context.Background()
-	lib := setUpLibForFavoutites(t)
+	lib := setUpLibForFavRatingsTesting(t)
 	defer func() { _ = lib.Truncate() }()
 
 	stackSearchArgs := SearchArgs{Query: "Stack Overflow", Count: 10}
@@ -241,7 +241,9 @@ func TestFavouritesArtists(t *testing.T) {
 	}
 }
 
-func setUpLibForFavoutites(t *testing.T) *LocalLibrary {
+// setUpLibForFavRatingsTesting returns a library which already has some media files
+// included. It is suitable for testing of the favourites and ratings.
+func setUpLibForFavRatingsTesting(t *testing.T) *LocalLibrary {
 	ctx := context.Background()
 	lib, err := NewLocalLibrary(ctx, SQLiteMemoryFile, getTestMigrationFiles())
 	if err != nil {

src/library/local_ratings_test.go

@@ -0,0 +1,152 @@
+package library
+
+import (
+	"context"
+	"testing"
+
+	"github.com/ironsmile/euterpe/src/assert"
+)
+
+// TestRatingOutOfBounds checks that setting ratings outside of the [0-5] interval causes
+// an error.
+func TestRatingOutOfBounds(t *testing.T) {
+	ctx := context.Background()
+	lib := setUpLibForFavRatingsTesting(t)
+	defer func() { _ = lib.Truncate() }()
+
+	tracks := lib.Search(ctx, SearchArgs{
+		Count: 1,
+	})
+	if len(tracks) < 1 {
+		t.Errorf("expected at least one track to be returned")
+	}
+
+	err := lib.SetTrackRating(ctx, tracks[0].ID, 12)
+	if err == nil {
+		t.Errorf("expected error when setting out of bounds track rating")
+	}
+
+	err = lib.SetAlbumRating(ctx, tracks[0].AlbumID, 12)
+	if err == nil {
+		t.Errorf("expected error when setting out of bounds album rating")
+	}
+
+	err = lib.SetArtistRating(ctx, tracks[0].ArtistID, 12)
+	if err == nil {
+		t.Errorf("expected error when setting out of bounds artist rating")
+	}
+}
+
+// TestRatingTracks checks that setting and removing ratings for tracks does work.
+func TestRatingTracks(t *testing.T) {
+	ctx := context.Background()
+	lib := setUpLibForFavRatingsTesting(t)
+	defer func() { _ = lib.Truncate() }()
+
+	tracks := lib.Search(ctx, SearchArgs{
+		Count: 1,
+	})
+	if len(tracks) < 1 {
+		t.Errorf("expected at least one track to be returned")
+	}
+
+	track := tracks[0]
+	if err := lib.SetTrackRating(ctx, track.ID, 3); err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+
+	found, err := lib.GetTrack(ctx, track.ID)
+	if err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+
+	assert.Equal(t, track.ID, found.ID)
+	assert.Equal(t, 3, found.Rating, "wrong track rating")
+
+	if err := lib.SetTrackRating(ctx, track.ID, 0); err != nil {
+		t.Errorf("error removing track rating: %s", err)
+	}
+
+	found, err = lib.GetTrack(ctx, track.ID)
+	if err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+	assert.Equal(t, track.ID, found.ID)
+	assert.Equal(t, 0, found.Rating, "wrong track rating after removal")
+}
+
+// TestRatingsAlbums checks that setting and removing ratings from albums work.
+func TestRatingsAlbums(t *testing.T) {
+	ctx := context.Background()
+	lib := setUpLibForFavRatingsTesting(t)
+	defer func() { _ = lib.Truncate() }()
+
+	albums := lib.SearchAlbums(ctx, SearchArgs{
+		Count: 1,
+	})
+	if len(albums) < 1 {
+		t.Errorf("expected at least one album to be returned")
+	}
+
+	album := albums[0]
+	if err := lib.SetAlbumRating(ctx, album.ID, 4); err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+
+	found, err := lib.GetAlbum(ctx, album.ID)
+	if err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+
+	assert.Equal(t, album.ID, found.ID)
+	assert.Equal(t, 4, found.Rating, "wrong album rating")
+
+	if err := lib.SetAlbumRating(ctx, album.ID, 0); err != nil {
+		t.Errorf("error removing album rating: %s", err)
+	}
+
+	found, err = lib.GetAlbum(ctx, album.ID)
+	if err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+	assert.Equal(t, album.ID, found.ID)
+	assert.Equal(t, 0, found.Rating, "wrong album rating after removal")
+}
+
+// TestRatingsArtists checks that setting and removing ratings for artists work.
+func TestRatingsArtists(t *testing.T) {
+	ctx := context.Background()
+	lib := setUpLibForFavRatingsTesting(t)
+	defer func() { _ = lib.Truncate() }()
+
+	artists := lib.SearchArtists(ctx, SearchArgs{
+		Count: 1,
+	})
+	if len(artists) < 1 {
+		t.Errorf("expected at least one artist to be returned")
+	}
+
+	artist := artists[0]
+	if err := lib.SetArtistRating(ctx, artist.ID, 4); err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+
+	found, err := lib.GetArtist(ctx, artist.ID)
+	if err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+
+	assert.Equal(t, artist.ID, found.ID)
+	assert.Equal(t, 4, found.Rating, "wrong artist rating")
+
+	if err := lib.SetArtistRating(ctx, artist.ID, 0); err != nil {
+		t.Errorf("error removing artist rating: %s", err)
+	}
+
+	found, err = lib.GetArtist(ctx, artist.ID)
+	if err != nil {
+		t.Errorf("unexpected error: %s", err)
+	}
+	assert.Equal(t, artist.ID, found.ID)
+	assert.Equal(t, 0, found.Rating, "wrong artist rating after removal")
+}