You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: TESTING.md
+6-5
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,15 @@ To run **only** public endpoint tests, you only need `SPOTIFY_CLIENT_ID` and `SP
9
9
To additionally run **all** private (client) endpoint tests, you need a valid Spotify application, redirect uri, and token string.
10
10
The additional environment variables you will need to add are `SPOTIFY_REDIRECT_URI` and `SPOTIFY_TOKEN_STRING`.
11
11
12
+
To specifically run player tests, you must include the `SPOTIFY_ENABLE_PLAYER_TESTS`=true environment variable.
13
+
12
14
Some tests may fail if you do not allow access to all required scopes. To mitigate this, you can individually grant
13
15
each scope or use the following code snippet to print out the Spotify token string (given a generated authorization code).
14
-
However, you can painlessly generate a valid token by using the [spotify-web-api-token-helper](https://github.com/adamint/spotify-web-api-token-helper)
15
-
library.
16
-
16
+
However, you can painlessly generate a valid token by using this site: https://adamratzman.com/projects/spotify/generate-token
17
17
18
-
To run tests, run `gradle check`
18
+
To run tests, run `gradle jvmTest`, `gradle macosX64Test`, `gradle testDebugUnitTest`, or any other target.
19
19
20
+
To output all http requests to the console, set the `SPOTIFY_LOG_HTTP`=true environment variable.
20
21
21
22
To build the maven artifact locally, you will need to follow these steps:
22
23
- Create `gradle.properties` if it doesn't exist already.
@@ -25,5 +26,5 @@ To build the maven artifact locally, you will need to follow these steps:
25
26
26
27
You can use this artifact to test locally by adding the `mavenLocal()` repository in any local gradle project.
27
28
28
-
To build docs, run `gradle dokkaHtml`. They will be located under the docs directory in the repostiory root, and
29
+
To build docs, run `gradle dokka`. They will be located under the docs directory in the repostiory root, and
29
30
are ignored. This is how we generate release docs.
* @param additionalTypes A list of types to return in addition to [CurrentlyPlayingType.TRACK]. Ad type not allowed.
81
+
* @param market If a country code is specified, only shows and episodes that are available in that market will be returned.
82
+
* If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.
83
+
* Note: If neither market or user country are provided, the content is considered unavailable for the client.
84
+
* Users can view the country that is associated with their account in the account settings. Required for [SpotifyAppApi], but **you may use [Market.FROM_TOKEN] to get the user market**
* @param additionalTypes A list of types to return in addition to [CurrentlyPlayingType.TRACK]. Ad type not allowed.
115
+
* @param market If a country code is specified, only shows and episodes that are available in that market will be returned.
116
+
* If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.
117
+
* Note: If neither market or user country are provided, the content is considered unavailable for the client.
118
+
* Users can view the country that is associated with their account in the account settings. Required for [SpotifyAppApi], but **you may use [Market.FROM_TOKEN] to get the user market**
* @param additionalTypes A list of types to return in addition to [CurrentlyPlayingType.TRACK]. Ad type not allowed.
181
+
* @param market If a country code is specified, only shows and episodes that are available in that market will be returned.
182
+
* If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.
183
+
* Note: If neither market or user country are provided, the content is considered unavailable for the client.
184
+
* Users can view the country that is associated with their account in the account settings. Required for [SpotifyAppApi], but **you may use [Market.FROM_TOKEN] to get the user market**
* @param additionalTypes A list of types to return in addition to [CurrentlyPlayingType.TRACK]. Ad type not allowed.
221
+
* @param market If a country code is specified, only shows and episodes that are available in that market will be returned.
222
+
* If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.
223
+
* Note: If neither market or user country are provided, the content is considered unavailable for the client.
224
+
* Users can view the country that is associated with their account in the account settings. Required for [SpotifyAppApi], but **you may use [Market.FROM_TOKEN] to get the user market**
0 commit comments