generated from datalad/datalad-extension-template
-
Notifications
You must be signed in to change notification settings - Fork 15
/
test_pydataverse.py
189 lines (161 loc) · 6.12 KB
/
test_pydataverse.py
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
"""Tests all essential pydataverse behavior"""
import datetime
import json
from requests import delete
from requests.auth import HTTPBasicAuth
from datalad_next.tests.utils import md5sum
from .utils import (
list_dataset_files,
get_dvfile_with_md5,
)
#
# functionality tested here is all candidate for a dedicated pydataverse
# abstraction for use in datalad-dataverse. however, first all functionality
# has to be cataloged and the required features confirmed
#
def test_file_handling(
tmp_path,
dataverse_admin_api,
dataverse_dataaccess_api,
dataverse_dataset,
):
# the starting point of `dataverse_dataset` is a freshly
# created, non-published dataset in draft mode, with no prior
# version
fcontent = 'some_content'
fpath = tmp_path / 'dummy.txt'
fpath.write_text(fcontent)
src_md5 = md5sum(fpath)
check_duplicate_file_deposition(
dataverse_admin_api,
dataverse_dataset,
tmp_path)
fileid = check_upload(
dataverse_admin_api,
dataverse_dataset, fcontent, fpath, src_md5)
check_download(
dataverse_dataaccess_api, fileid,
dataverse_dataset, tmp_path / 'downloaded.txt', src_md5)
# TODO replace_datafile
# custom request to remove a file via `data-deposit` API
def check_download(api, fileid, dsid, fpath, src_md5):
# TODO there is no standalone implementation of the following
# reimplementing DataverseRemote._download_file
# recent pydataverse requires saying `is_pid=False` for a file-id
response = api.get_datafile(fileid, is_pid=False)
# TODO this could also just be a download via HttpUrlOperations
# avoiding any custom code
assert response.status_code == 200
with fpath.open("wb") as f:
# accommodate old and newer pydataverse version
try:
it = response.iter_content
except AttributeError:
it = response.iter_bytes
# use a stupdily small chunksize to actual get chunking on
# our tiny test file
for chunk in it(chunk_size=1):
f.write(chunk)
# confirm identity
assert md5sum(fpath) == src_md5
def check_duplicate_file_deposition(api, dsid, tmp_path):
content = 'identical'
content_md5 = 'ee0cbdbacdada19376449799774976e8'
for fname in ('nonunique1.txt', 'nonunique2.txt'):
(tmp_path / fname).write_text(content)
response = api.upload_datafile(
identifier=dsid,
filename=tmp_path / 'nonunique1.txt'
)
# we do not expect issues here
response.raise_for_status()
# now upload the second file with the same content
response = api.upload_datafile(
identifier=dsid,
filename=tmp_path / 'nonunique2.txt'
)
response.raise_for_status()
# check both files are available under their respective names
flist = list_dataset_files(api, dsid)
identicals = get_dvfile_with_md5(flist, content_md5, all_matching=True)
assert len(identicals) == 2
assert any(f['label'] == 'nonunique1.txt' and f['dataFile']['md5'] == content_md5
for f in identicals)
assert any(f['label'] == 'nonunique2.txt' and f['dataFile']['md5'] == content_md5
for f in identicals)
def check_upload(api, dsid, fcontent, fpath, src_md5):
# the simplest possible upload, just a source file name
response = api.upload_datafile(
identifier=dsid,
filename=fpath,
)
# worked
assert response.status_code == 200
# verify structure of response
rj = response.json()
assert rj['status'] == 'OK'
rfiles = rj['data']['files']
# one file uploaded, one report
assert len(rfiles) == 1
rfile = rfiles[0]
# for a fresh upload a bunch of things should be true
assert rfile['description'] == ''
assert rfile['label'] == fpath.name
assert rfile['restricted'] is False
assert rfile['version'] == 1
assert rfile['datasetVersionId'] # we are not testing for identity
# most info is in a 'dataFile' dict
df = rfile['dataFile']
assert df['contentType'] == 'text/plain'
assert df['creationDate'] == datetime.datetime.today().strftime('%Y-%m-%d')
# unclear if this is always a copy of the prop above
assert df['description'] == rfile['description']
assert df['filename'] == fpath.name
assert df['filesize'] == len(fcontent)
assert df['id']
assert df['checksum']['type'] == 'MD5'
assert df['md5'] == df['checksum']['value'] == src_md5
assert df['persistentId'] == ''
# TODO: seemingly discontinued between Dataverse 5.13 and 6.0?
#assert df['pidURL'] == ''
assert df['rootDataFileId'] == -1
assert df['storageIdentifier'].startswith('s3://demo-dataverse')
# report the file ID for external use
return df['id']
def test_file_removal(
tmp_path,
dataverse_admin_api,
dataverse_dataset,
):
# the starting point of `dataverse_dataset` is a freshly
# created, non-published dataset in draft mode, with no prior
# version
fcontent = 'some_content'
fpath = tmp_path / 'dummy.txt'
fpath.write_text(fcontent)
response = dataverse_admin_api.upload_datafile(
identifier=dataverse_dataset,
filename=fpath,
)
# worked
assert response.status_code == 200, \
f"failed to upload file {response.status_code}: {response.json()}"
# No further assertion on upload response - this is tested in
# test_file_handling.
fid = response.json()['data']['files'][0]['dataFile']['id']
# This should be removable:
status = delete(
f'{dataverse_admin_api.base_url}/dvn/api/data-deposit/v1.1/swordv2/'
f'edit-media/file/{fid}',
auth=HTTPBasicAuth(dataverse_admin_api.api_token, ''))
# TODO: Not sure, whether that is always a 204. Or why it would be at all
# for that matter.
assert status.status_code == 204, \
f"failed to delete file {status.status_code}: {status.json()}"
# Re-upload
response = dataverse_admin_api.upload_datafile(
identifier=dataverse_dataset,
filename=fpath,
)
assert response.status_code == 200, \
f"failed to upload file {response.status_code}: {response.json()}"