1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
|
// Copyright 2009 The GoMPD Authors. All rights reserved.
// Use of this source code is governed by the MIT
// license that can be found in the LICENSE file.
package mpd
import (
"os"
"reflect"
"testing"
"github.com/fhs/gompd/v2/mpd/internal/server"
)
// Tests we want to run
var quoteTests = &[...]*struct {
source, expected string
}{
{`test.ogg`, `"test.ogg"`},
{`test "song".ogg`, `"test \"song\".ogg"`},
{`test with 'single' and "double" quotes`, `"test with \'single\' and \"double\" quotes"`},
{`escape \"escaped\"`, `"escape \\\"escaped\\\""`},
{`just a \`, `"just a \\"`},
{`04 - ILL - DECAYED LOVE feat.℃iel.ogg`, `"04 - ILL - DECAYED LOVE feat.℃iel.ogg"`},
// Test case provided at https://www.musicpd.org/doc/html/protocol.html#escaping-string-values.
// NB: we don't support quoting in the "protocol level" mode, hence single quotes get the same treatment as
// double quotes and there are 3 backslashes before the single quote, too.
{`(Artist == "foo\'bar\"")`, `"(Artist == \"foo\\\'bar\\\"\")"`},
}
func TestQuote(t *testing.T) {
// Run tests
for _, test := range quoteTests {
if q := quote(test.source); q != test.expected {
t.Errorf("quote(%s) returned %s; expected %s", test.source, q, test.expected)
}
}
}
var (
benchmarkQuoteInput = quoteTests[len(quoteTests)-1].source
benchmarkQuoteOutput = ""
)
func BenchmarkQuote(b *testing.B) {
for i := 0; i < b.N; i++ {
benchmarkQuoteOutput = quote(benchmarkQuoteInput)
}
}
func TestQuoteArgs(t *testing.T) {
quoteArgsTest := []string{`Artist`, `Nightingale`, `Title`, `"Don't Go Away"`}
expected := `"Artist" "Nightingale" "Title" "\"Don\'t Go Away\""`
if got := quoteArgs(quoteArgsTest); got != expected {
t.Errorf("quoteArgs(%v) returned %s; expected %s", quoteArgsTest, got, expected)
}
}
var (
serverRunning = false
useGoMPDServer = true
)
func localAddr() (net, addr string) {
if useGoMPDServer {
// Don't clash with standard MPD port 6600
return "tcp", "127.0.0.1:6603"
}
net = "unix"
addr = os.Getenv("MPD_HOST")
if len(addr) > 0 && addr[0] == '/' {
return
}
net = "tcp"
if len(addr) == 0 {
addr = "127.0.0.1"
}
port := os.Getenv("MPD_PORT")
if len(port) == 0 {
port = "6600"
}
return net, addr + ":" + port
}
func localDial(t *testing.T) *Client {
net, addr := localAddr()
if useGoMPDServer && !serverRunning {
running := make(chan bool)
go server.Listen(net, addr, running)
serverRunning = true
<-running
}
cli, err := Dial(net, addr)
if err != nil {
t.Fatalf("Dial(%q) = %v, %s want PTR, nil", addr, cli, err)
}
return cli
}
func teardown(cli *Client, t *testing.T) {
if err := cli.Close(); err != nil {
t.Errorf("Client.Close() = %s need nil", err)
}
}
func attrsEqual(left, right Attrs) bool {
if len(left) != len(right) {
return false
}
for key, lval := range left {
if rval, ok := right[key]; !ok || lval != rval {
return false
}
}
return true
}
func TestPlaylistInfo(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
// Add songs to the current playlist.
all := 4
files, err := cli.GetFiles()
if err != nil {
t.Fatalf("Client.GetFiles failed: %s\n", err)
}
if len(files) < all {
t.Fatalf("Add more then %d audio file to your MPD to run this test.", all)
}
for i := 0; i < all; i++ {
if err = cli.Add(files[i]); err != nil {
t.Fatalf("Client.Add failed: %s\n", err)
}
}
pls, err := cli.PlaylistInfo(-1, -1)
if err != nil {
t.Fatalf("Client.PlaylistInfo(-1, -1) = %v, %s need _, nil", pls, err)
}
if len(pls) != all {
t.Fatalf("Client.PlaylistInfo(-1, -1) len = %d need %d", len(pls), all)
}
for i, song := range pls {
if _, ok := song["file"]; !ok {
t.Errorf(`PlaylistInfo: song %d has no "file" attribute`, i)
}
pls1, err := cli.PlaylistInfo(i, -1)
if err != nil {
t.Errorf("Client.PlaylistInfo(%d, -1) = %v, %s need _, nil", i, pls1, err)
}
if !attrsEqual(pls[i], pls1[0]) {
t.Errorf("song at position %d is %v; want %v", i, pls[i], pls1[0])
}
}
pls, err = cli.PlaylistInfo(2, 4)
if err != nil {
t.Fatalf("Client.PlaylistInfo(2, 4) = %v, %s need _, nil", pls, err)
}
if len(pls) != 2 {
t.Fatalf("Client.PlaylistInfo(2, 4) len = %d need 2", len(pls))
}
}
func TestListInfo(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
fileCount, dirCount, plsCount := 0, 0, 0
ls, err := cli.ListInfo("foo")
if err != nil {
t.Fatalf(`Client.ListInfo("") = %v, %s need _, nil`, ls, err)
}
for i, item := range ls {
if _, ok := item["file"]; ok {
fileCount++
for _, field := range []string{"last-modified", "artist", "title", "track"} {
if _, ok := item[field]; !ok {
t.Errorf(`ListInfo: file item %d has no "%s" field`, i, field)
}
}
} else if _, ok := item["directory"]; ok {
dirCount++
} else if _, ok := item["playlist"]; ok {
plsCount++
} else {
t.Errorf("ListInfo: item %d has no file/directory/playlist attribute", i)
}
}
if expected := 100; fileCount != expected {
t.Errorf(`ListInfo: expected %d files, got %d`, expected, fileCount)
}
if expected := 2; dirCount != expected {
t.Errorf(`ListInfo: expected %d directories, got %d`, expected, dirCount)
}
if expected := 1; plsCount != expected {
t.Errorf(`ListInfo: expected %d playlists, got %d`, expected, plsCount)
}
}
func TestSticker(t *testing.T) {
testCases := []struct {
Song, Name, Value string
}{
{"song0000.ogg", "rating", "superb"},
{"song0000.ogg", "num_rating", "10"},
}
cli := localDial(t)
defer teardown(cli, t)
t.Run("Set", func(t *testing.T) {
for _, tc := range testCases {
if err := cli.StickerSet(tc.Song, tc.Name, tc.Value); err != nil {
t.Fatalf("Client.StickerSet of %v failed: %v", tc, err)
}
}
})
t.Run("Get", func(t *testing.T) {
for _, tc := range testCases {
s, err := cli.StickerGet(tc.Song, tc.Name)
if err != nil {
t.Fatalf("Client.StickerGet of %v failed: %v", tc, err)
}
if s.Value != tc.Value {
t.Errorf("Client.StickerGet of %v is %v; want %v", tc, s.Value, tc.Value)
}
}
})
t.Run("List", func(t *testing.T) {
stks, err := cli.StickerList(testCases[0].Song)
if err != nil {
t.Fatalf("Client.StickerList failed: %v", err)
}
if len(stks) != len(testCases) {
t.Errorf("Client.StickerList returned %v stickers; want %v", len(stks), len(testCases))
}
})
t.Run("Find", func(t *testing.T) {
for _, tc := range testCases {
files, stks, err := cli.StickerFind("", tc.Name)
if err != nil {
t.Fatalf("Client.StickerFind(%q) failed: %v", tc.Name, err)
}
if len(files) != len(stks) {
t.Errorf("Client.StickerFind(%q) returned %v files and %v stickers", tc.Name, len(files), len(stks))
}
if len(files) != 1 {
t.Errorf("Client.StickerFind(%q) returned %v file; need 1", tc.Name, len(files))
}
}
})
t.Run("Delete", func(t *testing.T) {
for i, tc := range testCases {
if err := cli.StickerDelete(tc.Song, tc.Name); err != nil {
t.Fatalf("Client.StickerDelete of %v failed: %v", tc, err)
}
stks, err := cli.StickerList(testCases[0].Song)
if err != nil {
t.Fatalf("Client.StickerList failed: %v", err)
}
if len(stks) != len(testCases)-i-1 {
t.Fatalf("Client.StickerList returned %v stickers; want %v", len(stks), len(testCases)-i-1)
}
}
})
}
func TestCurrentSong(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
attrs, err := cli.CurrentSong()
if err != nil {
t.Fatalf("Client.CurrentSong() = %v, %s need _, nil", attrs, err)
}
if len(attrs) == 0 {
return // no current song
}
if _, ok := attrs["file"]; !ok {
t.Fatalf("current song (attrs=%v) has no file attribute", attrs)
}
}
func TestReadComments(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
attrs, err := cli.ReadComments("foo.mp3")
if err != nil {
t.Fatalf(`Client.ReadComments("foo.mp3") = %v, %s need _, nil`, attrs, err)
}
if _, ok := attrs["TITLE"]; !ok {
t.Fatalf("comments (attrs=%v) has no ARTIST attribute", attrs)
}
}
func TestVersion(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
if cli.Version() != "gompd0.1" {
t.Errorf("Client.Version failed: %s != gompd0.1", cli.Version())
}
}
func TestPing(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
if err := cli.Ping(); err != nil {
t.Errorf("Client.Ping failed: %s", err)
}
}
func TestUpdate(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
id, err := cli.Update("foo")
if err != nil {
t.Fatalf("Client.Update failed: %s\n", err)
}
if id < 1 {
t.Errorf("job id is too small: %d", id)
}
}
func TestRescan(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
id, err := cli.Rescan("foo")
if err != nil {
t.Fatalf("Client.Rescan failed: %s\n", err)
}
if id < 1 {
t.Errorf("job id is too small: %d", id)
}
}
func TestListOutputs(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
outputs, err := cli.ListOutputs()
if err != nil {
t.Fatalf(`Client.ListOutputs() = %v, %s need _, nil`, outputs, err)
}
expected := []Attrs{{
"outputid": "0",
"outputname": "downstairs",
"outputenabled": "1",
}, {
"outputid": "1",
"outputname": "upstairs",
"outputenabled": "0",
}}
if len(outputs) != 2 {
t.Errorf(`Listed %d outputs, expected %d`, len(outputs), 2)
}
for i, o := range outputs {
if len(o) != 3 {
t.Errorf(`Output should contain 3 keys, got %d`, len(o))
}
for k, v := range expected[i] {
if outputs[i][k] != v {
t.Errorf(`Expected property %s for key "%s", got %s`, v, k, outputs[i][k])
}
}
}
}
func TestEnableOutput(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
if err := cli.EnableOutput(1); err != nil {
t.Fatalf("Client.EnableOutput failed: %s\n", err)
}
}
func TestDisableOutput(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
if err := cli.DisableOutput(1); err != nil {
t.Fatalf("Client.DisableOutput failed: %s\n", err)
}
}
func TestPlaylistFunctions(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
files, err := cli.GetFiles()
if err != nil {
t.Fatalf("Client.GetFiles failed: %s\n", err)
}
if len(files) < 2 {
t.Log("Add more then 1 audio file to your MPD to run this test.")
return
}
for i := 0; i < 2; i++ {
if err = cli.PlaylistAdd("Test Playlist", files[i]); err != nil {
t.Fatalf("Client.PlaylistAdd failed: %s\n", err)
}
}
attrs, err := cli.ListPlaylists()
if err != nil {
t.Fatalf("Client.ListPlaylists failed: %s\n", err)
}
if i := attrsListIndex(attrs, "playlist", "Test Playlist"); i < 0 {
t.Fatalf("Couldn't find playlist \"Test Playlist\" in %v\n", attrs)
}
attrs, err = cli.PlaylistContents("Test Playlist")
if err != nil {
t.Fatalf("Client.PlaylistContents failed: %s\n", err)
}
if i := attrsListIndex(attrs, "file", files[0]); i < 0 {
t.Fatalf("Couldn't find song %q in %v", files[0], attrs)
}
if err = cli.PlaylistDelete("Test Playlist", 0); err != nil {
t.Fatalf("Client.PlaylistDelete failed: %s\n", err)
}
playlist, err := cli.PlaylistContents("Test Playlist")
if err != nil {
t.Fatalf("Client.PlaylistContents failed: %s\n", err)
}
if !attrsListEqual(playlist, attrs[1:]) {
t.Fatalf("PlaylistContents returned %v; want %v", playlist, attrs[1:])
}
cli.PlaylistRemove("Test Playlist 2")
if err = cli.PlaylistRename("Test Playlist", "Test Playlist 2"); err != nil {
t.Fatalf("Client.PlaylistRename failed: %s\n", err)
}
if err = cli.Clear(); err != nil {
t.Fatalf("Client.Clear failed: %s\n", err)
}
if err = cli.PlaylistLoad("Test Playlist 2", -1, -1); err != nil {
t.Fatalf("Client.Load failed: %s\n", err)
}
attrs, err = cli.PlaylistInfo(-1, -1)
if err != nil {
t.Fatalf("Client.PlaylistInfo failed: %s\n", err)
}
if !attrsListEqualKey(playlist, attrs, "file") {
t.Fatalf("Unexpected playlist: %v != %v\n", attrs, playlist)
}
if err = cli.PlaylistClear("Test Playlist 2"); err != nil {
t.Fatalf("Client.PlaylistClear failed: %s\n", err)
}
attrs, err = cli.PlaylistContents("Test Playlist 2")
if err != nil {
t.Fatalf("Client.PlaylistContents failed: %s\n", err)
}
if len(attrs) != 0 {
t.Fatalf("Unexpected number of songs: %d != 0\n", len(attrs))
}
if err = cli.PlaylistRemove("Test Playlist 2"); err != nil {
t.Fatalf("Client.PlaylistRemove failed: %s\n", err)
}
attrs, err = cli.ListPlaylists()
if err != nil {
t.Fatalf("Client.ListPlaylists failed: %s\n", err)
}
if i := attrsListIndex(attrs, "playlist", "Test Playlist 2"); i > -1 {
t.Fatalf("Found playlist \"Test Playlist 2\" in %v\n", attrs)
}
if err = cli.PlaylistSave("Test Playlist"); err != nil {
t.Fatalf("Client.PlaylistSave failed: %s\n", err)
}
attrs, err = cli.PlaylistContents("Test Playlist")
if err != nil {
t.Fatalf("Client.PlaylistContents failed: %s\n", err)
}
if !attrsListEqual(playlist, attrs) {
t.Fatalf("Unexpected playlist: %v != %v\n", attrs, playlist)
}
}
func attrsListIndex(attrs []Attrs, key, value string) int {
for i, attr := range attrs {
if attr[key] == value {
return i
}
}
return -1
}
func attrsListEqual(a, b []Attrs) bool {
if len(a) != len(b) {
return false
}
for i := range a {
if !attrsEqual(a[i], b[i]) {
return false
}
}
return true
}
func attrsListEqualKey(a, b []Attrs, key string) bool {
if len(a) != len(b) {
return false
}
for i := range a {
if a[i][key] != b[i][key] {
return false
}
}
return true
}
func TestPriority(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
for _, tc := range []struct {
priority, start, end int
ok bool
}{
{255, 1, 1, true},
{255, 1, 1, true},
{256, 1, -1, false},
{-1, 1, 1, false},
} {
// if tc.ok is true,, err should be nil
err := cli.SetPriority(tc.priority, tc.start, tc.end)
if err != nil && tc.ok {
t.Errorf("Client.SetPriority failed: %s", err)
}
if err == nil && !tc.ok {
t.Errorf("Client.SetPriority succeeded when it should fail")
}
}
}
func TestPriorityID(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
for _, tc := range []struct {
priority, id int
ok bool
}{
{255, 1, true},
{255, 1, true},
{256, 1, false},
{-1, 1, false},
{1, -1, false},
} {
// if tc.ok is true,, err should be nil
err := cli.SetPriorityID(tc.priority, tc.id)
if err != nil && tc.ok {
t.Errorf("Client.SetPriorityID failed: %s", err)
}
if err == nil && !tc.ok {
t.Errorf("Client.SetPriorityID succeeded when it should fail")
}
}
}
// TODO test adding at position
// TODO test “addid” failures
// - invalid position
// - unexpected result (not an ID)
// - invalid song
func TestAddIDAndDeleteID(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
id1, err := cli.AddID("song0042.ogg", -1)
if err != nil {
t.Fatalf("Client.AddID failed: %s\n", err)
}
id2, err := cli.AddID("song0042.ogg", -1)
if err != nil {
t.Fatalf("Client.AddID failed: %s\n", err)
}
if id1 == id2 {
t.Fatalf("Client.AddID returned the same ID twice\n")
}
if err := cli.DeleteID(id1); err != nil {
t.Fatalf("Client.DeleteID failed: %s\n", err)
}
err = cli.DeleteID(id1)
if err == nil {
t.Fatalf("Client.DeleteID did not fail on second delete of an ID\n")
}
mpdErr, ok := err.(Error)
if !ok {
t.Fatalf("Client.DeleteID did not fail with an mpd.Error\n")
}
if mpdErr.Code != ErrorNoExist {
t.Fatalf("Unexpected error code: expected %d, got %d\n", ErrorNoExist, mpdErr.Code)
}
if err := cli.DeleteID(id2); err != nil {
t.Fatalf("Client.DeleteID failed: %s\n", err)
}
}
func TestResponseErrorHandling(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
for name, fn := range map[string]func() error{
// “list” requires an argument
"in readList": func() error { _, err := cli.Command("list").Strings("file"); return err },
"in readAttrsList": func() error { _, err := cli.PlaylistContents("does_not_exist"); return err },
"in readAttrs": func() error { _, err := cli.ReadComments(""); return err },
"in readOKLine": func() error { return cli.DeleteID(123) },
"in Update": func() error { _, err := cli.Update(""); return err },
"in ListAllInfo": func() error { _, err := cli.ListAllInfo(""); return err },
"in ListInfo": func() error { _, err := cli.ListInfo(""); return err },
"in List": func() error { _, err := cli.List(""); return err },
} {
t.Run(name, func(t *testing.T) {
if err := fn(); err == nil {
t.Errorf("did not fail on MPD error response")
} else if _, ok := err.(Error); !ok {
t.Errorf("did not fail with an mpd.Error")
}
})
}
}
func TestAlbumArt(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
tests := []struct {
name string
uri string
want []byte
wantErr bool
}{
{"artwork as a whole", "/file/with/small-artwork", []byte{0x01, 0x02, 0x03, 0x04, 0x05}, false},
{"artwork in chunks", "/file/with/huge-artwork", []byte{0x01, 0x02, 0x03, 0x04, 0x05}, false},
{"nonexistent artwork", "some_wrong_file", nil, true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := cli.AlbumArt(tt.uri)
if (err != nil) != tt.wantErr {
t.Errorf("AlbumArt() error = %v, wantErr %v", err, tt.wantErr)
} else if !reflect.DeepEqual(got, tt.want) {
t.Errorf("AlbumArt() got = %v, want %v", got, tt.want)
}
})
}
}
func TestReadPicture(t *testing.T) {
cli := localDial(t)
defer teardown(cli, t)
tests := []struct {
name string
uri string
want []byte
wantErr bool
}{
{"artwork as a whole", "/file/with/small-artwork", []byte{0x01, 0x02, 0x03, 0x04, 0x05}, false},
{"artwork in chunks", "/file/with/huge-artwork", []byte{0x01, 0x02, 0x03, 0x04, 0x05}, false},
{"nonexistent artwork", "some_wrong_file", nil, true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := cli.ReadPicture(tt.uri)
if (err != nil) != tt.wantErr {
t.Errorf("ReadPicture() error = %v, wantErr %v", err, tt.wantErr)
} else if !reflect.DeepEqual(got, tt.want) {
t.Errorf("ReadPicture() got = %v, want %v", got, tt.want)
}
})
}
}
|