koel/tests/Unit/ArtistTest.php

<?php

namespace Tests\Unit;

use App\Models\Artist;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Lastfm;
use org\bovigo\vfs\vfsStream;
use Tests\TestCase;

class ArtistTest extends TestCase
{
    use DatabaseTransactions;

    /** @test */
    public function it_can_be_instantiated()
    {
        $this->assertInstanceOf(Artist::class, new Artist());
    }

    /** @test */
    public function various_artist_can_be_retrieved()
    {
        // When I retrieve the Various Artist
        $artist = Artist::getVariousArtist();

        // Then I received the Various Artist
        $this->assertTrue($artist->is_various);
    }

    /** @test */
    public function existing_artist_can_be_retrieved_using_name()
    {
        // Given an existing artist with a name
        /** @var Artist $artist */
        $artist = factory(Artist::class)->create(['name' => 'Foo']);

        // When I get the artist by name
        $gottenArtist = Artist::get('Foo');

        // Then I get the artist
        $this->assertEquals($artist->id, $gottenArtist->id);
    }

    /** @test */
    public function new_artist_can_be_created_using_name()
    {
        // Given an artist name
        $name = 'Foo';

        // And an artist with such a name doesn't exist yet
        $this->assertNull(Artist::whereName($name)->first());

        // When I get the artist by name
        $artist = Artist::get($name);

        // Then I get the newly created artist
        $this->assertInstanceOf(Artist::class, $artist);
    }

    /** @test */
    public function getting_artist_with_empty_name_returns_unknown_artist()
    {
        // Given an empty name
        $name = '';

        // When I get the artist by the empty name
        $artist = Artist::get($name);

        // Then I get the artist as Unknown Artist
        $this->assertTrue($artist->is_unknown);
    }

    /** @test */
    public function it_can_write_an_image_file_and_update_itself_with_the_image()
    {
        // Given there's an artist and an image file content
        /** @var Artist $artist */
        $artist = factory(Artist::class)->create();
        $imageContent = 'dummy';
        $root = vfsStream::setup('home');
        $imagePath = vfsStream::url('home/foo.jpg');

        // When I call the method to write the image file
        $artist->writeImageFile($imageContent, 'jpg', $imagePath);

        // Then I see the image file is generated
        $this->assertTrue($root->hasChild('foo.jpg'));

        // And the artist's image attribute is updated
        $this->assertEquals('http://localhost/public/img/artists/foo.jpg', Artist::find($artist->id)->image);
    }

    /** @test */
    public function extra_info_can_be_retrieved_for_an_artist()
    {
        // Given there's an artist
        /** @var Artist $artist */
        $artist = factory(Artist::class)->create();

        // When I get the extra info
        Lastfm::shouldReceive('getArtistInfo')
            ->once()
            ->with($artist->name)
            ->andReturn(['foo' => 'bar']);

        $info = $artist->getInfo();

        // Then I receive the extra info
        $this->assertEquals(['foo' => 'bar'], $info);
    }

    /** @test */
    public function artists_with_name_in_utf16_encoding_are_retrieved_correctly()
    {
        // Given there's an artist with name in UTF-16 encoding
        $name = file_get_contents(__DIR__.'../../blobs/utf16');
        $artist = Artist::get($name);

        // When I get the artist using the name
        $retrieved = Artist::get($name);

        // Then I receive the artist
        $this->assertEquals($artist->id, $retrieved->id);

    }
}