2019-12-04 13:52:23 +08:00
|
|
|
# coding=utf-8
|
|
|
|
# Copyright 2019-present, the HuggingFace Inc. team.
|
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
2019-12-22 23:20:32 +08:00
|
|
|
|
2019-12-04 13:52:23 +08:00
|
|
|
|
|
|
|
import os
|
|
|
|
import time
|
|
|
|
import unittest
|
|
|
|
|
2019-12-14 11:43:15 +08:00
|
|
|
import requests
|
2019-12-22 05:13:14 +08:00
|
|
|
from requests.exceptions import HTTPError
|
2020-03-05 12:33:09 +08:00
|
|
|
from transformers.hf_api import HfApi, HfFolder, ModelInfo, PresignedUrl, S3Obj
|
2019-12-04 13:52:23 +08:00
|
|
|
|
2019-12-21 22:57:32 +08:00
|
|
|
|
2019-12-04 13:52:23 +08:00
|
|
|
USER = "__DUMMY_TRANSFORMERS_USER__"
|
|
|
|
PASS = "__DUMMY_TRANSFORMERS_PASS__"
|
2019-12-14 11:43:15 +08:00
|
|
|
FILES = [
|
|
|
|
(
|
2020-05-01 00:06:01 +08:00
|
|
|
"nested/Test-{}.txt".format(int(time.time())),
|
2019-12-21 22:46:46 +08:00
|
|
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), "fixtures/input.txt"),
|
2019-12-14 11:43:15 +08:00
|
|
|
),
|
|
|
|
(
|
2020-05-01 00:06:01 +08:00
|
|
|
"nested/yoyo {}.txt".format(int(time.time())), # space is intentional
|
2019-12-21 22:46:46 +08:00
|
|
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), "fixtures/empty.txt"),
|
2019-12-14 11:43:15 +08:00
|
|
|
),
|
|
|
|
]
|
2020-03-05 12:33:09 +08:00
|
|
|
ENDPOINT_STAGING = "https://moon-staging.huggingface.co"
|
2019-12-04 13:52:23 +08:00
|
|
|
|
|
|
|
|
|
|
|
class HfApiCommonTest(unittest.TestCase):
|
2020-03-05 12:33:09 +08:00
|
|
|
_api = HfApi(endpoint=ENDPOINT_STAGING)
|
2019-12-04 13:52:23 +08:00
|
|
|
|
|
|
|
|
|
|
|
class HfApiLoginTest(HfApiCommonTest):
|
|
|
|
def test_login_invalid(self):
|
|
|
|
with self.assertRaises(HTTPError):
|
|
|
|
self._api.login(username=USER, password="fake")
|
|
|
|
|
|
|
|
def test_login_valid(self):
|
|
|
|
token = self._api.login(username=USER, password=PASS)
|
2019-12-23 00:56:09 +08:00
|
|
|
self.assertIsInstance(token, str)
|
2019-12-04 13:52:23 +08:00
|
|
|
|
|
|
|
|
|
|
|
class HfApiEndpointsTest(HfApiCommonTest):
|
|
|
|
@classmethod
|
|
|
|
def setUpClass(cls):
|
|
|
|
"""
|
|
|
|
Share this valid token in all tests below.
|
|
|
|
"""
|
|
|
|
cls._token = cls._api.login(username=USER, password=PASS)
|
|
|
|
|
2019-12-28 11:53:49 +08:00
|
|
|
@classmethod
|
|
|
|
def tearDownClass(cls):
|
|
|
|
for FILE_KEY, FILE_PATH in FILES:
|
|
|
|
cls._api.delete_obj(token=cls._token, filename=FILE_KEY)
|
|
|
|
|
2019-12-04 13:52:23 +08:00
|
|
|
def test_whoami(self):
|
2020-03-10 05:29:49 +08:00
|
|
|
user, orgs = self._api.whoami(token=self._token)
|
2019-12-04 13:52:23 +08:00
|
|
|
self.assertEqual(user, USER)
|
2020-03-10 05:29:49 +08:00
|
|
|
self.assertIsInstance(orgs, list)
|
|
|
|
|
|
|
|
def test_presign_invalid_org(self):
|
|
|
|
with self.assertRaises(HTTPError):
|
2020-05-01 00:06:01 +08:00
|
|
|
_ = self._api.presign(token=self._token, filename="nested/fake_org.txt", organization="fake")
|
2020-03-10 05:29:49 +08:00
|
|
|
|
|
|
|
def test_presign_valid_org(self):
|
2020-05-01 00:06:01 +08:00
|
|
|
urls = self._api.presign(token=self._token, filename="nested/valid_org.txt", organization="valid_org")
|
2020-03-10 05:29:49 +08:00
|
|
|
self.assertIsInstance(urls, PresignedUrl)
|
2019-12-04 13:52:23 +08:00
|
|
|
|
2020-05-01 00:51:06 +08:00
|
|
|
def test_presign_invalid(self):
|
|
|
|
try:
|
|
|
|
_ = self._api.presign(token=self._token, filename="non_nested.json")
|
|
|
|
except HTTPError as e:
|
|
|
|
self.assertIsNotNone(e.response.text)
|
|
|
|
self.assertTrue("Filename invalid" in e.response.text)
|
|
|
|
else:
|
|
|
|
self.fail("Expected an exception")
|
|
|
|
|
2019-12-04 13:52:23 +08:00
|
|
|
def test_presign(self):
|
2019-12-14 11:43:15 +08:00
|
|
|
for FILE_KEY, FILE_PATH in FILES:
|
|
|
|
urls = self._api.presign(token=self._token, filename=FILE_KEY)
|
|
|
|
self.assertIsInstance(urls, PresignedUrl)
|
|
|
|
self.assertEqual(urls.type, "text/plain")
|
2019-12-04 13:52:23 +08:00
|
|
|
|
|
|
|
def test_presign_and_upload(self):
|
2019-12-14 11:43:15 +08:00
|
|
|
for FILE_KEY, FILE_PATH in FILES:
|
2019-12-21 22:46:46 +08:00
|
|
|
access_url = self._api.presign_and_upload(token=self._token, filename=FILE_KEY, filepath=FILE_PATH)
|
2019-12-23 00:56:09 +08:00
|
|
|
self.assertIsInstance(access_url, str)
|
2019-12-21 22:46:46 +08:00
|
|
|
with open(FILE_PATH, "r") as f:
|
2019-12-14 11:43:15 +08:00
|
|
|
body = f.read()
|
|
|
|
r = requests.get(access_url)
|
|
|
|
self.assertEqual(r.text, body)
|
2019-12-04 13:52:23 +08:00
|
|
|
|
|
|
|
def test_list_objs(self):
|
|
|
|
objs = self._api.list_objs(token=self._token)
|
2019-12-05 06:22:50 +08:00
|
|
|
self.assertIsInstance(objs, list)
|
|
|
|
if len(objs) > 0:
|
|
|
|
o = objs[-1]
|
|
|
|
self.assertIsInstance(o, S3Obj)
|
2019-12-04 13:52:23 +08:00
|
|
|
|
|
|
|
|
2020-03-05 12:33:09 +08:00
|
|
|
class HfApiPublicTest(unittest.TestCase):
|
|
|
|
def test_staging_model_list(self):
|
|
|
|
_api = HfApi(endpoint=ENDPOINT_STAGING)
|
|
|
|
_ = _api.model_list()
|
|
|
|
|
|
|
|
def test_model_list(self):
|
|
|
|
_api = HfApi()
|
|
|
|
models = _api.model_list()
|
|
|
|
self.assertGreater(len(models), 100)
|
|
|
|
self.assertIsInstance(models[0], ModelInfo)
|
|
|
|
|
|
|
|
|
2019-12-04 13:52:23 +08:00
|
|
|
class HfFolderTest(unittest.TestCase):
|
|
|
|
def test_token_workflow(self):
|
|
|
|
"""
|
|
|
|
Test the whole token save/get/delete workflow,
|
|
|
|
with the desired behavior with respect to non-existent tokens.
|
|
|
|
"""
|
|
|
|
token = "token-{}".format(int(time.time()))
|
|
|
|
HfFolder.save_token(token)
|
2019-12-21 22:46:46 +08:00
|
|
|
self.assertEqual(HfFolder.get_token(), token)
|
2019-12-04 13:52:23 +08:00
|
|
|
HfFolder.delete_token()
|
|
|
|
HfFolder.delete_token()
|
|
|
|
# ^^ not an error, we test that the
|
|
|
|
# second call does not fail.
|
2019-12-21 22:46:46 +08:00
|
|
|
self.assertEqual(HfFolder.get_token(), None)
|