Skip to content

Commit

Permalink
improve error handling #4529
Browse files Browse the repository at this point in the history 
Return UNAUTHORIZED instead of BAD_REQUEST and detailed error messages.
  • Loading branch information
@pdurbin
pdurbin committed Jul 28, 2020
1 parent 4da877b commit fc7df59
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 21 deletions.
8 changes: 4 additions & 4 deletions src/main/java/edu/harvard/iq/dataverse/api/Access.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -559,8 +559,8 @@ public Response downloadAllFromLatest(@PathParam("id") String datasetIdOrPersist
final DatasetVersion latest = execCommand(new GetLatestAccessibleDatasetVersionCommand(req, retrieved));
String fileIds = getFileIdsAsCommaSeparated(latest.getFileMetadatas());
return downloadDatafiles(fileIds, gbrecs, apiTokenParam, uriInfo, headers, response);
} catch (WrappedResponse ex) {
return error(BAD_REQUEST, ex.getLocalizedMessage());
} catch (WrappedResponse wr) {
return wr.getResponse();
}
}

Expand Down Expand Up @@ -598,8 +598,8 @@ public Command<DatasetVersion> handleLatestPublished() {
}
String fileIds = getFileIdsAsCommaSeparated(dsv.getFileMetadatas());
return downloadDatafiles(fileIds, gbrecs, apiTokenParam, uriInfo, headers, response);
} catch (WrappedResponse ex) {
return error(BAD_REQUEST, ex.getLocalizedMessage());
} catch (WrappedResponse wr) {
return wr.getResponse();
}
}

Expand Down
73 changes: 56 additions & 17 deletions src/test/java/edu/harvard/iq/dataverse/api/DownloadFilesIT.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@
import java.util.HashSet;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import static javax.ws.rs.core.Response.Status.BAD_REQUEST;
import static javax.ws.rs.core.Response.Status.CREATED;
import static javax.ws.rs.core.Response.Status.FORBIDDEN;
import static javax.ws.rs.core.Response.Status.OK;
import static javax.ws.rs.core.Response.Status.UNAUTHORIZED;
import static org.hamcrest.CoreMatchers.equalTo;
import org.junit.Assert;
import static org.junit.Assert.assertTrue;
Expand Down Expand Up @@ -91,7 +92,9 @@ public void downloadAllFilesByVersion() throws IOException {
Response downloadFiles2 = UtilIT.downloadFiles(datasetPid, null);
downloadFiles2.prettyPrint();
downloadFiles2.then().assertThat()
.statusCode(BAD_REQUEST.getStatusCode());
.statusCode(UNAUTHORIZED.getStatusCode())
.body("status", equalTo("ERROR"))
.body("message", equalTo("User :guest is not permitted to perform requested action."));

UtilIT.publishDataverseViaNativeApi(dataverseAlias, apiToken)
.then().assertThat().statusCode(OK.getStatusCode());
Expand Down Expand Up @@ -191,11 +194,27 @@ public void downloadAllFilesByVersion() throws IOException {
HashSet<String> expectedFiles7 = new HashSet<>(Arrays.asList("LICENSE.md", "MANIFEST.TXT", "README.md", "CONTRIBUTING.md"));
Assert.assertEquals(expectedFiles7, filenamesFound7);

// Guests cannot download draft versions.
String datasetVersionDraft = ":draft";
Response downloadFiles10 = UtilIT.downloadFiles(datasetPid, datasetVersionDraft, null);
downloadFiles10.prettyPrint();
downloadFiles10.then().assertThat()
.statusCode(UNAUTHORIZED.getStatusCode())
.body("status", equalTo("ERROR"))
.body("message", equalTo("User :guest is not permitted to perform requested action."));

// Users are told about bad API tokens.
Response downloadFiles11 = UtilIT.downloadFiles(datasetPid, "junkToken");
downloadFiles11.prettyPrint();
downloadFiles11.then().assertThat()
.statusCode(UNAUTHORIZED.getStatusCode())
.body("status", equalTo("ERROR"))
.body("message", equalTo("Bad api key "));

}

/**
* This test is focused on downloading all files by their version. All files
* are public.
* This test is focused on downloading all files that are restricted.
*/
@Test
public void downloadAllFilesRestricted() throws IOException {
Expand Down Expand Up @@ -246,35 +265,54 @@ public void downloadAllFilesRestricted() throws IOException {
// The creator can download a restricted file from a draft.
Assert.assertEquals(new HashSet<>(Arrays.asList("secrets.md", "MANIFEST.TXT")), gatherFilenames(downloadFiles1.getBody().asInputStream()));

Path pathToReadme = Paths.get(Files.createTempDirectory(null) + File.separator + "README.md");
Files.write(pathToReadme, "My findings.".getBytes());

Response uploadReadme = UtilIT.uploadFileViaNative(datasetId.toString(), pathToReadme.toString(), apiToken);
uploadReadme.prettyPrint();
uploadReadme.then().assertThat()
.statusCode(OK.getStatusCode())
.body("data.files[0].label", equalTo("README.md"));

Response downloadFiles2 = UtilIT.downloadFiles(datasetPid, apiToken);
downloadFiles2.then().assertThat()
.statusCode(OK.getStatusCode());

// The creator can download a restricted file and an unrestricted file from a draft.
Assert.assertEquals(new HashSet<>(Arrays.asList("secrets.md", "README.md", "MANIFEST.TXT")), gatherFilenames(downloadFiles2.getBody().asInputStream()));
Assert.assertEquals(new HashSet<>(Arrays.asList("secrets.md", "MANIFEST.TXT")), gatherFilenames(downloadFiles2.getBody().asInputStream()));

UtilIT.publishDataverseViaNativeApi(dataverseAlias, apiToken)
.then().assertThat().statusCode(OK.getStatusCode());

UtilIT.publishDatasetViaNativeApi(datasetPid, "major", apiToken)
.then().assertThat().statusCode(OK.getStatusCode());

// Now a guest user can download files (published now)
// A guest user can't download the only file because it's restricted.
Response downloadFiles3 = UtilIT.downloadFiles(datasetPid, null);
downloadFiles3.prettyPrint();
downloadFiles3.then().assertThat()
.statusCode(FORBIDDEN.getStatusCode())
.body("status", equalTo("ERROR"))
.body("message", equalTo("'/api/v1/access/dataset/%3ApersistentId' you are not authorized to access this object via this api endpoint. Please check your code for typos, or consult our API guide at http://guides.dataverse.org."));

// The creator uploads a README that will be public.
Path pathToReadme = Paths.get(Files.createTempDirectory(null) + File.separator + "README.md");
Files.write(pathToReadme, "My findings.".getBytes());

Response uploadReadme = UtilIT.uploadFileViaNative(datasetId.toString(), pathToReadme.toString(), apiToken);
uploadReadme.prettyPrint();
uploadReadme.then().assertThat()
.statusCode(OK.getStatusCode())
.body("data.files[0].label", equalTo("README.md"));

UtilIT.publishDatasetViaNativeApi(datasetPid, "major", apiToken)
.then().assertThat().statusCode(OK.getStatusCode());

// Now a guest user can download files and get the public one.
Response downloadFiles4 = UtilIT.downloadFiles(datasetPid, null);
downloadFiles4.then().assertThat()
.statusCode(OK.getStatusCode());

// The guest can only get the unrestricted file (and the manifest).
Assert.assertEquals(new HashSet<>(Arrays.asList("README.md", "MANIFEST.TXT")), gatherFilenames(downloadFiles3.getBody().asInputStream()));
Assert.assertEquals(new HashSet<>(Arrays.asList("README.md", "MANIFEST.TXT")), gatherFilenames(downloadFiles4.getBody().asInputStream()));

Response downloadFiles5 = UtilIT.downloadFiles(datasetPid, apiToken);
downloadFiles5.then().assertThat()
.statusCode(OK.getStatusCode());

// The creator can download both files (and the manifest).
Assert.assertEquals(new HashSet<>(Arrays.asList("secrets.md", "README.md", "MANIFEST.TXT")), gatherFilenames(downloadFiles5.getBody().asInputStream()));

}

Expand Down Expand Up @@ -315,7 +353,8 @@ public void downloadAllFilesTabular() throws IOException {
.statusCode(OK.getStatusCode())
.body("data.files[0].label", equalTo("50by1000.dta"));

assertTrue("Failed test if Ingest Lock exceeds max duration " + pathToFile, UtilIT.sleepForLock(datasetId.longValue(), "Ingest", apiToken, UtilIT.MAXIMUM_INGEST_LOCK_DURATION));
// UtilIT.MAXIMUM_INGEST_LOCK_DURATION is 3 but not long enough.
assertTrue("Failed test if Ingest Lock exceeds max duration " + pathToFile, UtilIT.sleepForLock(datasetId.longValue(), "Ingest", apiToken, 4));

Response downloadFiles1 = UtilIT.downloadFiles(datasetPid, apiToken);
downloadFiles1.then().assertThat()
Expand Down

0 comments on commit fc7df59

Please sign in to comment.