spotify-cli 0.5.0

A command-line interface for Spotify
Documentation
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
//! RPC integration tests
//!
//! Tests for the JSON-RPC server and protocol implementation.
//!
//! These tests only run on Unix systems since Unix sockets are not available on Windows.

#![cfg(unix)]

use spotify_cli::rpc::protocol::{RpcNotification, RpcRequest, RpcResponse, error_codes};
use spotify_cli::rpc::{Server, ServerConfig};
use std::path::PathBuf;
use std::time::Duration;
use tempfile::{TempDir, tempdir};
use tokio::io::{AsyncBufReadExt, AsyncWriteExt, BufReader};
use tokio::net::UnixStream;

/// Helper to create a test server with a temporary socket
/// Returns TempDir to keep it alive for the duration of the test
async fn setup_test_server() -> (Server, PathBuf, TempDir) {
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("test.sock");

    let config = ServerConfig {
        socket_path: socket_path.clone(),
    };

    let server = Server::new(config);
    (server, socket_path, temp_dir)
}

/// Helper to send a JSON-RPC request and get response
async fn send_request(socket_path: &PathBuf, request: &str) -> String {
    let stream = UnixStream::connect(socket_path)
        .await
        .expect("Failed to connect");
    let (reader, mut writer) = stream.into_split();
    let mut reader = BufReader::new(reader);

    writer
        .write_all(request.as_bytes())
        .await
        .expect("Failed to write");
    writer
        .write_all(b"\n")
        .await
        .expect("Failed to write newline");
    writer.flush().await.expect("Failed to flush");

    let mut response = String::new();
    reader
        .read_line(&mut response)
        .await
        .expect("Failed to read");
    response
}

// ============================================================
// Protocol Tests
// ============================================================

#[test]
fn test_rpc_request_parsing() {
    let json = r#"{"jsonrpc":"2.0","method":"ping","id":1}"#;
    let req: RpcRequest = serde_json::from_str(json).expect("Failed to parse request");

    assert_eq!(req.jsonrpc, "2.0");
    assert_eq!(req.method, "ping");
    assert!(!req.is_notification());
}

#[test]
fn test_rpc_request_with_params() {
    let json =
        r#"{"jsonrpc":"2.0","method":"player.play","params":{"uri":"spotify:track:123"},"id":2}"#;
    let req: RpcRequest = serde_json::from_str(json).expect("Failed to parse request");

    assert_eq!(req.method, "player.play");
    assert!(req.params.is_some());
    let params = req.params.unwrap();
    assert_eq!(params["uri"], "spotify:track:123");
}

#[test]
fn test_rpc_notification_no_id() {
    let json = r#"{"jsonrpc":"2.0","method":"player.next"}"#;
    let req: RpcRequest = serde_json::from_str(json).expect("Failed to parse notification");

    assert!(req.is_notification());
    assert!(req.id.is_none());
}

#[test]
fn test_rpc_response_success_serialization() {
    let resp = RpcResponse::success(serde_json::json!(1), serde_json::json!({"status": "ok"}));
    let json = serde_json::to_string(&resp).expect("Failed to serialize");

    assert!(json.contains(r#""jsonrpc":"2.0""#));
    assert!(json.contains(r#""result""#));
    assert!(json.contains(r#""id":1"#));
    assert!(!json.contains(r#""error""#));
}

#[test]
fn test_rpc_response_error_serialization() {
    let resp = RpcResponse::error(
        serde_json::json!(1),
        error_codes::METHOD_NOT_FOUND,
        "Method not found",
        None,
    );
    let json = serde_json::to_string(&resp).expect("Failed to serialize");

    assert!(json.contains(r#""error""#));
    assert!(json.contains(r#"-32601"#));
    assert!(!json.contains(r#""result""#));
}

#[test]
fn test_rpc_notification_serialization() {
    let notif = RpcNotification::new(
        "event.trackChanged",
        Some(serde_json::json!({"track_id": "abc123"})),
    );
    let json = serde_json::to_string(&notif).expect("Failed to serialize");

    assert!(json.contains(r#""method":"event.trackChanged""#));
    assert!(json.contains(r#""params""#));
    assert!(!json.contains(r#""id""#));
}

#[test]
fn test_rpc_notification_without_params() {
    let notif = RpcNotification::new("event.playbackPaused", None);
    let json = serde_json::to_string(&notif).expect("Failed to serialize");

    assert!(json.contains(r#""method":"event.playbackPaused""#));
    assert!(!json.contains(r#""params""#));
}

// ============================================================
// Error Code Tests
// ============================================================

#[test]
fn test_error_codes_values() {
    assert_eq!(error_codes::PARSE_ERROR, -32700);
    assert_eq!(error_codes::INVALID_REQUEST, -32600);
    assert_eq!(error_codes::METHOD_NOT_FOUND, -32601);
    assert_eq!(error_codes::INVALID_PARAMS, -32602);
    assert_eq!(error_codes::INTERNAL_ERROR, -32603);
}

// ============================================================
// Server Configuration Tests
// ============================================================

#[test]
fn test_server_config_default() {
    let config = ServerConfig::default();
    assert!(config.socket_path.to_string_lossy().contains("daemon.sock"));
}

#[test]
fn test_server_config_custom_path() {
    let config = ServerConfig {
        socket_path: PathBuf::from("/tmp/custom.sock"),
    };
    assert_eq!(config.socket_path, PathBuf::from("/tmp/custom.sock"));
}

// ============================================================
// Server Tests
// ============================================================

#[tokio::test]
async fn test_server_socket_path() {
    let (server, socket_path, _temp_dir) = setup_test_server().await;
    assert_eq!(server.socket_path(), &socket_path);
}

#[tokio::test]
async fn test_server_event_sender() {
    let (server, _socket_path, _temp_dir) = setup_test_server().await;
    let tx = server.event_sender();

    // Should be able to send notifications
    let notif = RpcNotification::new("test.event", None);
    let result = tx.send(notif);
    // No receivers, so this returns Err, but that's expected
    assert!(result.is_err());
}

// ============================================================
// Integration Tests (require running server)
// ============================================================

#[tokio::test]
async fn test_server_ping_pong() {
    let (server, socket_path, _temp_dir) = setup_test_server().await;

    // Start server in background
    let server_handle = tokio::spawn(async move {
        let _ = server.run().await;
    });

    // Give server time to start
    tokio::time::sleep(Duration::from_millis(100)).await;

    // Send ping request
    let request = r#"{"jsonrpc":"2.0","method":"ping","id":1}"#;
    let response = send_request(&socket_path, request).await;

    // Parse and verify response
    let resp: RpcResponse = serde_json::from_str(&response).expect("Failed to parse response");
    assert!(resp.result.is_some());
    assert!(resp.error.is_none());

    let result = resp.result.unwrap();
    assert_eq!(result["message"], "pong");

    // Cleanup
    server_handle.abort();
}

#[tokio::test]
async fn test_server_version() {
    let (server, socket_path, _temp_dir) = setup_test_server().await;

    let server_handle = tokio::spawn(async move {
        let _ = server.run().await;
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    let request = r#"{"jsonrpc":"2.0","method":"version","id":2}"#;
    let response = send_request(&socket_path, request).await;

    let resp: RpcResponse = serde_json::from_str(&response).expect("Failed to parse response");
    assert!(resp.result.is_some());

    let result = resp.result.unwrap();
    assert!(result["payload"]["version"].is_string());
    assert!(result["payload"]["name"].is_string());

    server_handle.abort();
}

#[tokio::test]
async fn test_server_unknown_method() {
    let (server, socket_path, _temp_dir) = setup_test_server().await;

    let server_handle = tokio::spawn(async move {
        let _ = server.run().await;
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    let request = r#"{"jsonrpc":"2.0","method":"unknown.method","id":3}"#;
    let response = send_request(&socket_path, request).await;

    let resp: RpcResponse = serde_json::from_str(&response).expect("Failed to parse response");
    assert!(resp.error.is_some());
    assert!(resp.result.is_none());

    let error = resp.error.unwrap();
    // Response uses HTTP-style 404 code for "not found"
    assert_eq!(error.code, 404);

    server_handle.abort();
}

#[tokio::test]
async fn test_server_parse_error() {
    let (server, socket_path, _temp_dir) = setup_test_server().await;

    let server_handle = tokio::spawn(async move {
        let _ = server.run().await;
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    // Send malformed JSON
    let request = r#"{"invalid json"#;
    let response = send_request(&socket_path, request).await;

    let resp: RpcResponse = serde_json::from_str(&response).expect("Failed to parse response");
    assert!(resp.error.is_some());

    let error = resp.error.unwrap();
    assert_eq!(error.code, error_codes::PARSE_ERROR);

    server_handle.abort();
}

#[tokio::test]
async fn test_server_multiple_requests() {
    let (server, socket_path, _temp_dir) = setup_test_server().await;

    let server_handle = tokio::spawn(async move {
        let _ = server.run().await;
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    // Send multiple requests on same connection
    let stream = UnixStream::connect(&socket_path)
        .await
        .expect("Failed to connect");
    let (reader, mut writer) = stream.into_split();
    let mut reader = BufReader::new(reader);

    // First request
    writer
        .write_all(b"{\"jsonrpc\":\"2.0\",\"method\":\"ping\",\"id\":1}\n")
        .await
        .unwrap();
    writer.flush().await.unwrap();

    let mut response1 = String::new();
    reader.read_line(&mut response1).await.unwrap();
    let resp1: RpcResponse = serde_json::from_str(&response1).unwrap();
    assert!(resp1.result.is_some());

    // Second request
    writer
        .write_all(b"{\"jsonrpc\":\"2.0\",\"method\":\"version\",\"id\":2}\n")
        .await
        .unwrap();
    writer.flush().await.unwrap();

    let mut response2 = String::new();
    reader.read_line(&mut response2).await.unwrap();
    let resp2: RpcResponse = serde_json::from_str(&response2).unwrap();
    assert!(resp2.result.is_some());

    server_handle.abort();
}

#[tokio::test]
async fn test_server_notification_no_response() {
    let (server, socket_path, _temp_dir) = setup_test_server().await;

    let server_handle = tokio::spawn(async move {
        let _ = server.run().await;
    });

    tokio::time::sleep(Duration::from_millis(100)).await;

    let stream = UnixStream::connect(&socket_path)
        .await
        .expect("Failed to connect");
    let (reader, mut writer) = stream.into_split();
    let mut reader = BufReader::new(reader);

    // Send notification (no id)
    writer
        .write_all(b"{\"jsonrpc\":\"2.0\",\"method\":\"ping\"}\n")
        .await
        .unwrap();
    writer.flush().await.unwrap();

    // Immediately send a regular request
    writer
        .write_all(b"{\"jsonrpc\":\"2.0\",\"method\":\"ping\",\"id\":1}\n")
        .await
        .unwrap();
    writer.flush().await.unwrap();

    // Should only get one response (for the regular request)
    let mut response = String::new();
    reader.read_line(&mut response).await.unwrap();
    let resp: RpcResponse = serde_json::from_str(&response).unwrap();

    // The response should be for id:1, not the notification
    assert_eq!(resp.id, serde_json::json!(1));

    server_handle.abort();
}

// ============================================================
// Response Conversion Tests
// ============================================================

#[test]
fn test_rpc_response_from_success() {
    use spotify_cli::io::output::Response;

    let cli_response = Response::success(200, "Success message");
    let rpc_response = RpcResponse::from_response(serde_json::json!(1), cli_response);

    assert!(rpc_response.result.is_some());
    assert!(rpc_response.error.is_none());

    let result = rpc_response.result.unwrap();
    assert_eq!(result["message"], "Success message");
}

#[test]
fn test_rpc_response_from_success_with_payload() {
    use spotify_cli::io::output::Response;

    let cli_response =
        Response::success_with_payload(200, "Data retrieved", serde_json::json!({"key": "value"}));
    let rpc_response = RpcResponse::from_response(serde_json::json!(2), cli_response);

    assert!(rpc_response.result.is_some());
    let result = rpc_response.result.unwrap();
    assert_eq!(result["payload"]["key"], "value");
}

#[test]
fn test_rpc_response_from_error() {
    use spotify_cli::io::output::{ErrorKind, Response};

    let cli_response = Response::err(404, "Not found", ErrorKind::NotFound);
    let rpc_response = RpcResponse::from_response(serde_json::json!(3), cli_response);

    assert!(rpc_response.error.is_some());
    assert!(rpc_response.result.is_none());

    let error = rpc_response.error.unwrap();
    assert_eq!(error.code, 404);
    assert_eq!(error.message, "Not found");
}