{}
""".format( - ''.join(['{}: {}'.format(k, v) for k, v in hashes.items()]) + ''.join([f'{k}: {v}' for k, v in hashes.items()]) ) if hashes else '', # TODO: Format better for UI msg ] diff --git a/addons/base/views.py b/addons/base/views.py index 2e061f4f665..e3605206b0b 100644 --- a/addons/base/views.py +++ b/addons/base/views.py @@ -2,12 +2,12 @@ import os import uuid import markupsafe -from future.moves.urllib.parse import quote +from urllib.parse import quote from django.utils import timezone from flask import make_response from flask import request -import furl +from furl import furl import jwe import jwt import waffle @@ -66,7 +66,7 @@ # import so that associated listener is instantiated and gets emails from website.notifications.events.files import FileEvent # noqa -ERROR_MESSAGES = {'FILE_GONE': u""" +ERROR_MESSAGES = {'FILE_GONE': """ @@ -77,7 +77,7 @@It was deleted by {deleted_by} on {deleted_on}.
""", - 'FILE_GONE_ACTOR_UNKNOWN': u""" + 'FILE_GONE_ACTOR_UNKNOWN': """ @@ -88,7 +88,7 @@It was deleted on {deleted_on}.
""", - 'DONT_KNOW': u""" + 'DONT_KNOW': """ @@ -96,7 +96,7 @@File not found at {provider}.
""", - 'BLAME_PROVIDER': u""" + 'BLAME_PROVIDER': """ @@ -108,7 +108,7 @@You may wish to verify this through {provider}'s website.
""", - 'FILE_SUSPENDED': u""" + 'FILE_SUSPENDED': """ @@ -167,11 +167,26 @@ def get_addon_user_config(**kwargs): return addon.to_json(user) +def _download_is_from_mfr(waterbutler_data): + metrics_data = waterbutler_data['metrics'] + uri = metrics_data['uri'] + is_render_uri = furl(uri or '').query.params.get('mode') == 'render' + return ( + # This header is sent for download requests that + # originate from MFR, e.g. for the code pygments renderer + request.headers.get('X-Cos-Mfr-Render-Request', None) or + # Need to check the URI in order to account + # for renderers that send XHRs from the + # rendered content, e.g. PDFs + is_render_uri + ) + + def make_auth(user): if user is not None: return { 'id': user._id, - 'email': '{}@osf.io'.format(user._id), + 'email': f'{user._id}@osf.io', 'name': user.fullname, } return {} @@ -221,7 +236,13 @@ def get_auth(auth, **kwargs): resource=resource, provider_name=provider_name, file_version=file_version, ) - _enqueue_metrics(file_version=file_version, file_node=file_node, action=action, auth=auth) + _enqueue_metrics( + file_version=file_version, + file_node=file_node, + action=action, + auth=auth, + from_mfr=_download_is_from_mfr(waterbutler_data), + ) # Construct the response payload including the JWT return _construct_payload( @@ -374,13 +395,13 @@ def _get_osfstorage_file_version_and_node( return file_version, file_node -def _enqueue_metrics(file_version, file_node, action, auth): +def _enqueue_metrics(file_version, file_node, action, auth, from_mfr=False): if not file_version: return if action == 'render': file_signals.file_viewed.send(auth=auth, fileversion=file_version, file_node=file_node) - elif action == 'download': + elif action == 'download' and not from_mfr: file_signals.file_downloaded.send(auth=auth, fileversion=file_version, file_node=file_node) return @@ -420,7 +441,7 @@ def _construct_payload(auth, resource, credentials, waterbutler_settings): # Encrypt the encoded JWT with JWE decoded_encrypted_jwt = jwe.encrypt( - encoded_jwt, + encoded_jwt.encode(), WATERBUTLER_JWE_KEY ).decode() @@ -437,10 +458,10 @@ def _construct_payload(auth, resource, credentials, waterbutler_settings): 'create_folder': NodeLog.FOLDER_CREATED, } -DOWNLOAD_ACTIONS = set([ +DOWNLOAD_ACTIONS = { 'download_file', 'download_zip', -]) +} @must_be_signed @no_auto_transaction @@ -817,19 +838,19 @@ def addon_view_or_download_file(auth, path, provider, **kwargs): object_text = markupsafe.escape(getattr(target, 'project_or_component', 'this object')) raise HTTPError(http_status.HTTP_400_BAD_REQUEST, data={ 'message_short': 'Bad Request', - 'message_long': 'The {} add-on containing {} is no longer connected to {}.'.format(provider_safe, path_safe, object_text) + 'message_long': f'The {provider_safe} add-on containing {path_safe} is no longer connected to {object_text}.' }) if not node_addon.has_auth: raise HTTPError(http_status.HTTP_401_UNAUTHORIZED, data={ 'message_short': 'Unauthorized', - 'message_long': 'The {} add-on containing {} is no longer authorized.'.format(provider_safe, path_safe) + 'message_long': f'The {provider_safe} add-on containing {path_safe} is no longer authorized.' }) if not node_addon.complete: raise HTTPError(http_status.HTTP_400_BAD_REQUEST, data={ 'message_short': 'Bad Request', - 'message_long': 'The {} add-on containing {} is no longer configured.'.format(provider_safe, path_safe) + 'message_long': f'The {provider_safe} add-on containing {path_safe} is no longer configured.' }) savepoint_id = transaction.savepoint() @@ -915,7 +936,7 @@ def addon_view_or_download_file(auth, path, provider, **kwargs): format = extras.get('format') _, extension = os.path.splitext(file_node.name) # avoid rendering files with the same format type. - if format and '.{}'.format(format.lower()) != extension.lower(): + if format and f'.{format.lower()}' != extension.lower(): return redirect('{}/export?format={}&url={}'.format(get_mfr_url(target, provider), format, quote(file_node.generate_waterbutler_url( **dict(extras, direct=None, version=version.identifier, _internal=extras.get('mode') == 'render') )))) @@ -935,10 +956,11 @@ def addon_view_or_download_file(auth, path, provider, **kwargs): if len(request.path.strip('/').split('/')) > 1: guid = file_node.get_guid(create=True) - return redirect(furl.furl('/{}/'.format(guid._id)).set(args=extras).url) + # NOTE: furl encoding to be verified later + return redirect(furl(f'/{guid._id}/', args=extras).url) if isinstance(target, Preprint): # Redirecting preprint file guids to the preprint detail page - return redirect('/{}/'.format(target._id)) + return redirect(f'/{target._id}/') return addon_view_file(auth, target, file_node, version) @@ -983,7 +1005,7 @@ def addon_view_or_download_quickfile(**kwargs): 'message_short': 'File Not Found', 'message_long': 'The requested file could not be found.' }) - return proxy_url('/project/{}/files/osfstorage/{}/'.format(file_.target._id, fid)) + return proxy_url(f'/project/{file_.target._id}/files/osfstorage/{fid}/') def addon_view_file(auth, node, file_node, version): # TODO: resolve circular import issue @@ -1006,8 +1028,9 @@ def addon_view_file(auth, node, file_node, version): else: sharejs_uuid = None - internal_furl = furl.furl(settings.INTERNAL_DOMAIN) - download_url = furl.furl(request.url).set( + internal_furl = furl(settings.INTERNAL_DOMAIN) + download_url = furl( + request.url, netloc=internal_furl.netloc, args=dict(request.args, **{ 'direct': None, @@ -1018,7 +1041,9 @@ def addon_view_file(auth, node, file_node, version): ) mfr_url = get_mfr_url(node, file_node.provider) - render_url = furl.furl(mfr_url).set( + # NOTE: furl encoding to be verified later + render_url = furl( + mfr_url, path=['render'], args={'url': download_url.url} ) diff --git a/addons/bitbucket/__init__.py b/addons/bitbucket/__init__.py index 5563ac92f53..e69de29bb2d 100644 --- a/addons/bitbucket/__init__.py +++ b/addons/bitbucket/__init__.py @@ -1 +0,0 @@ -default_app_config = 'addons.bitbucket.apps.BitbucketAddonConfig' diff --git a/addons/bitbucket/api.py b/addons/bitbucket/api.py index e7176b6395b..4f1176d9a9d 100644 --- a/addons/bitbucket/api.py +++ b/addons/bitbucket/api.py @@ -1,4 +1,4 @@ -from future.moves.urllib.parse import urlencode +from urllib.parse import urlencode from addons.bitbucket import settings @@ -15,7 +15,7 @@ def __init__(self, access_token=None): @property def _default_headers(self): if self.access_token: - return {'Authorization': 'Bearer {}'.format(self.access_token)} + return {'Authorization': f'Bearer {self.access_token}'} return {} @property diff --git a/addons/bitbucket/apps.py b/addons/bitbucket/apps.py index 12ed98d9222..b03cce6f32e 100644 --- a/addons/bitbucket/apps.py +++ b/addons/bitbucket/apps.py @@ -54,7 +54,7 @@ def bitbucket_hgrid_data(node_settings, auth, **kwargs): 'fetch': node_settings.owner.api_url + 'bitbucket/hgrid/' + (ref or ''), 'branch': node_settings.owner.api_url + 'bitbucket/hgrid/root/', 'zip': node_settings.owner.api_url + 'bitbucket/zipball/' + (ref or ''), - 'repo': 'https://bitbucket.com/{0}/{1}/branch/'.format(node_settings.user, node_settings.repo) + 'repo': f'https://bitbucket.com/{node_settings.user}/{node_settings.repo}/branch/' } branch_names = [each['name'] for each in branches] @@ -80,6 +80,7 @@ def bitbucket_hgrid_data(node_settings, auth, **kwargs): class BitbucketAddonConfig(BaseAddonAppConfig): + default = True name = 'addons.bitbucket' label = 'addons_bitbucket' full_name = 'Bitbucket' diff --git a/addons/bitbucket/migrations/0001_initial.py b/addons/bitbucket/migrations/0001_initial.py index dfde90f1fe5..e15bde518bd 100644 --- a/addons/bitbucket/migrations/0001_initial.py +++ b/addons/bitbucket/migrations/0001_initial.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- # Generated by Django 1.11.29 on 2022-08-17 19:15 -from __future__ import unicode_literals import addons.base.models from django.db import migrations, models diff --git a/addons/bitbucket/migrations/0002_auto_20220817_1915.py b/addons/bitbucket/migrations/0002_auto_20220817_1915.py index 6646f72e6c5..d443615930b 100644 --- a/addons/bitbucket/migrations/0002_auto_20220817_1915.py +++ b/addons/bitbucket/migrations/0002_auto_20220817_1915.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- # Generated by Django 1.11.29 on 2022-08-17 19:15 -from __future__ import unicode_literals from django.conf import settings from django.db import migrations, models diff --git a/addons/bitbucket/migrations/0003_alter_nodesettings_external_account_and_more.py b/addons/bitbucket/migrations/0003_alter_nodesettings_external_account_and_more.py new file mode 100644 index 00000000000..4015fe9da1b --- /dev/null +++ b/addons/bitbucket/migrations/0003_alter_nodesettings_external_account_and_more.py @@ -0,0 +1,32 @@ +# Generated by Django 4.2.13 on 2024-07-15 13:46 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('osf', '0021_preprint_custom_publication_citation'), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('addons_bitbucket', '0002_auto_20220817_1915'), + ] + + operations = [ + migrations.AlterField( + model_name='nodesettings', + name='external_account', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.externalaccount'), + ), + migrations.AlterField( + model_name='nodesettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.abstractnode'), + ), + migrations.AlterField( + model_name='usersettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_user_settings', to=settings.AUTH_USER_MODEL), + ), + ] diff --git a/addons/bitbucket/models.py b/addons/bitbucket/models.py index b9f22b79ce2..50ebc39a2de 100644 --- a/addons/bitbucket/models.py +++ b/addons/bitbucket/models.py @@ -1,13 +1,12 @@ -# -*- coding: utf-8 -*- - import markupsafe from django.db import models from addons.base import exceptions -from addons.base.models import (BaseOAuthNodeSettings, BaseOAuthUserSettings, - BaseStorageAddon) - +from addons.base.models import ( + BaseOAuthNodeSettings, + BaseOAuthUserSettings, + BaseStorageAddon,) from addons.bitbucket.api import BitbucketClient from addons.bitbucket.serializer import BitbucketSerializer from addons.bitbucket import settings as bitbucket_settings @@ -34,7 +33,7 @@ class BitbucketFile(BitbucketFileNode, File): def touch(self, auth_header, revision=None, commitSha=None, branch=None, **kwargs): revision = revision or commitSha or branch - return super(BitbucketFile, self).touch(auth_header, revision=revision, **kwargs) + return super().touch(auth_header, revision=revision, **kwargs) @property def _hashes(self): @@ -133,7 +132,7 @@ def folder_id(self): @property def folder_name(self): if self.complete: - return '{}/{}'.format(self.user, self.repo) + return f'{self.user}/{self.repo}' return None @property @@ -178,7 +177,7 @@ def deauthorize(self, auth=None, log=True): self.clear_auth() def delete(self, save=False): - super(NodeSettings, self).delete(save=False) + super().delete(save=False) self.deauthorize(log=False) if save: self.save() @@ -186,9 +185,7 @@ def delete(self, save=False): @property def repo_url(self): if self.user and self.repo: - return 'https://bitbucket.org/{0}/{1}/'.format( - self.user, self.repo - ) + return f'https://bitbucket.org/{self.user}/{self.repo}/' @property def short_url(self): @@ -211,7 +208,7 @@ def fetch_access_token(self): # TODO: Delete me and replace with serialize_settings / Knockout def to_json(self, user): - ret = super(NodeSettings, self).to_json(user) + ret = super().to_json(user) user_settings = user.get_addon('bitbucket') ret.update({ 'user_has_auth': user_settings and user_settings.has_auth, @@ -238,7 +235,7 @@ def to_json(self, user): 'node_has_auth': True, 'bitbucket_user': self.user or '', 'bitbucket_repo': self.repo or '', - 'bitbucket_repo_full_name': '{0} / {1}'.format(self.user, self.repo) if (self.user and self.repo) else '', + 'bitbucket_repo_full_name': f'{self.user} / {self.repo}' if (self.user and self.repo) else '', 'auth_osf_name': owner.fullname, 'auth_osf_url': owner.url, 'auth_osf_id': owner._id, @@ -274,14 +271,14 @@ def create_waterbutler_log(self, auth, action, metadata): try: sha = metadata['extra']['commitSha'] urls = { - 'view': '{0}?commitSha={1}'.format(url, sha), - 'download': '{0}?action=download&commitSha={1}'.format(url, sha) + 'view': f'{url}?commitSha={sha}', + 'download': f'{url}?action=download&commitSha={sha}' } except KeyError: pass self.owner.add_log( - 'bitbucket_{0}'.format(action), + f'bitbucket_{action}', auth=auth, params={ 'project': self.owner.parent_id, @@ -371,7 +368,7 @@ def before_remove_contributor_message(self, node, removed): """ try: - message = (super(NodeSettings, self).before_remove_contributor_message(node, removed) + + message = (super().before_remove_contributor_message(node, removed) + 'You can download the contents of this repository before removing ' 'this contributor here.'.format( url=node.api_url + 'bitbucket/tarball/' @@ -397,8 +394,8 @@ def after_remove_contributor(self, node, removed, auth=None): self.user_settings = None self.save() message = ( - u'Because the Bitbucket add-on for {category} "{title}" was authenticated ' - u'by {user}, authentication information has been deleted.' + 'Because the Bitbucket add-on for {category} "{title}" was authenticated ' + 'by {user}, authentication information has been deleted.' ).format( category=markupsafe.escape(node.category_display), title=markupsafe.escape(node.title), @@ -408,7 +405,7 @@ def after_remove_contributor(self, node, removed, auth=None): if not auth or auth.user != removed: url = node.web_url_for('node_setting') message += ( - u' You can re-authenticate on the Settings page.' + ' You can re-authenticate on the Settings page.' ).format(url=url) # return message @@ -424,7 +421,7 @@ def after_fork(self, node, fork, user, save=True): :param bool save: Save settings after callback :return tuple: Tuple of cloned settings and alert message """ - clone = super(NodeSettings, self).after_fork( + clone = super().after_fork( node, fork, user, save=False ) diff --git a/addons/bitbucket/requirements.txt b/addons/bitbucket/requirements.txt deleted file mode 100644 index e1eb62f260f..00000000000 --- a/addons/bitbucket/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -# no requirements diff --git a/addons/bitbucket/routes.py b/addons/bitbucket/routes.py index 07a28748446..9deb07f2428 100644 --- a/addons/bitbucket/routes.py +++ b/addons/bitbucket/routes.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- - from framework.routing import Rule, json_renderer from addons.bitbucket import views diff --git a/addons/bitbucket/serializer.py b/addons/bitbucket/serializer.py index 6797ffd5749..65cc76d84b7 100644 --- a/addons/bitbucket/serializer.py +++ b/addons/bitbucket/serializer.py @@ -18,7 +18,7 @@ def credentials_are_valid(self, user_settings, client): def serialized_folder(self, node_settings): return { 'path': node_settings.repo, - 'name': '{0} / {1}'.format(node_settings.user, node_settings.repo), + 'name': f'{node_settings.user} / {node_settings.repo}', } @property diff --git a/addons/bitbucket/settings/__init__.py b/addons/bitbucket/settings/__init__.py index 2b2f98881f6..40f955c5a78 100644 --- a/addons/bitbucket/settings/__init__.py +++ b/addons/bitbucket/settings/__init__.py @@ -7,4 +7,4 @@ try: from .local import * # noqa except ImportError: - logger.warn('No local.py settings file found') + logger.warning('No local.py settings file found') diff --git a/addons/bitbucket/tests/factories.py b/addons/bitbucket/tests/factories.py index d5416c7c938..7220c54cbd7 100644 --- a/addons/bitbucket/tests/factories.py +++ b/addons/bitbucket/tests/factories.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- - from factory import Sequence, SubFactory from factory.django import DjangoModelFactory from osf_tests.factories import ExternalAccountFactory, ProjectFactory, UserFactory @@ -9,8 +7,8 @@ class BitbucketAccountFactory(ExternalAccountFactory): provider = 'bitbucket' - provider_id = Sequence(lambda n: 'id-{0}'.format(n)) - oauth_key = Sequence(lambda n: 'key-{0}'.format(n)) + provider_id = Sequence(lambda n: f'id-{n}') + oauth_key = Sequence(lambda n: f'key-{n}') display_name = 'abc' diff --git a/addons/bitbucket/tests/test_models.py b/addons/bitbucket/tests/test_models.py index b2c38d0cd9f..bfa759e23e5 100644 --- a/addons/bitbucket/tests/test_models.py +++ b/addons/bitbucket/tests/test_models.py @@ -1,9 +1,6 @@ -# -*- coding: utf-8 -*- - -import mock +from unittest import mock import pytest import unittest -from nose.tools import * # noqa from tests.base import OsfTestCase, get_default_metaschema from osf_tests.factories import ( @@ -58,21 +55,21 @@ def test_serialize_settings(self): # common storage addons. settings = self.node_settings.serialize_waterbutler_settings() expected = {'owner': self.node_settings.user, 'repo': self.node_settings.repo} - assert_equal(settings, expected) + assert settings == expected @mock.patch( 'addons.bitbucket.models.UserSettings.revoke_remote_oauth_access', mock.PropertyMock() ) def test_complete_has_auth_not_verified(self): - super(TestNodeSettings, self).test_complete_has_auth_not_verified() + super().test_complete_has_auth_not_verified() @mock.patch('addons.bitbucket.api.BitbucketClient.repos') @mock.patch('addons.bitbucket.api.BitbucketClient.team_repos') def test_to_json(self, mock_repos, mock_team_repos): mock_repos.return_value = [] mock_team_repos.return_value = [] - super(TestNodeSettings, self).test_to_json() + super().test_to_json() @mock.patch('addons.bitbucket.api.BitbucketClient.repos') @mock.patch('addons.bitbucket.api.BitbucketClient.team_repos') @@ -80,11 +77,11 @@ def test_to_json_user_is_owner(self, mock_repos, mock_team_repos): mock_repos.return_value = [] mock_team_repos.return_value = [] result = self.node_settings.to_json(self.user) - assert_true(result['user_has_auth']) - assert_equal(result['bitbucket_user'], 'abc') - assert_true(result['is_owner']) - assert_true(result['valid_credentials']) - assert_equal(result.get('repo_names', None), []) + assert result['user_has_auth'] + assert result['bitbucket_user'] == 'abc' + assert result['is_owner'] + assert result['valid_credentials'] + assert result.get('repo_names', None) == [] @mock.patch('addons.bitbucket.api.BitbucketClient.repos') @mock.patch('addons.bitbucket.api.BitbucketClient.team_repos') @@ -93,11 +90,11 @@ def test_to_json_user_is_not_owner(self, mock_repos, mock_team_repos): mock_team_repos.return_value = [] not_owner = UserFactory() result = self.node_settings.to_json(not_owner) - assert_false(result['user_has_auth']) - assert_equal(result['bitbucket_user'], 'abc') - assert_false(result['is_owner']) - assert_true(result['valid_credentials']) - assert_equal(result.get('repo_names', None), None) + assert not result['user_has_auth'] + assert result['bitbucket_user'] == 'abc' + assert not result['is_owner'] + assert result['valid_credentials'] + assert result.get('repo_names', None) == None class TestUserSettings(models.OAuthAddonUserSettingTestSuiteMixin, unittest.TestCase): @@ -107,14 +104,14 @@ class TestUserSettings(models.OAuthAddonUserSettingTestSuiteMixin, unittest.Test ExternalAccountFactory = BitbucketAccountFactory def test_public_id(self): - assert_equal(self.user.external_accounts.first().display_name, self.user_settings.public_id) + assert self.user.external_accounts.first().display_name == self.user_settings.public_id class TestCallbacks(OsfTestCase): def setUp(self): - super(TestCallbacks, self).setUp() + super().setUp() self.project = ProjectFactory() self.consolidated_auth = Auth(self.project.creator) @@ -144,7 +141,7 @@ def test_before_make_public(self, mock_repo): mock_repo.side_effect = NotFoundError result = self.node_settings.before_make_public(self.project) - assert_is(result, None) + assert result is None @mock.patch('addons.bitbucket.api.BitbucketClient.repo') def test_before_page_load_osf_public_bb_public(self, mock_repo): @@ -156,7 +153,7 @@ def test_before_page_load_osf_public_bb_public(self, mock_repo): user=self.node_settings.user, repo=self.node_settings.repo, ) - assert_false(message) + assert not message @mock.patch('addons.bitbucket.api.BitbucketClient.repo') def test_before_page_load_osf_public_bb_private(self, mock_repo): @@ -168,8 +165,8 @@ def test_before_page_load_osf_public_bb_private(self, mock_repo): user=self.node_settings.user, repo=self.node_settings.repo, ) - assert_true(message) - assert_in('Users can view the contents of this private Bitbucket repository through this public project.', message[0]) + assert message + assert 'Users can view the contents of this private Bitbucket repository through this public project.' in message[0] @mock.patch('addons.bitbucket.api.BitbucketClient.repo') def test_before_page_load_repo_deleted(self, mock_repo): @@ -181,8 +178,8 @@ def test_before_page_load_repo_deleted(self, mock_repo): user=self.node_settings.user, repo=self.node_settings.repo, ) - assert_true(message) - assert_in('has been deleted.', message[0]) + assert message + assert 'has been deleted.' in message[0] @mock.patch('addons.bitbucket.api.BitbucketClient.repo') def test_before_page_load_osf_private_bb_public(self, mock_repo): @@ -192,8 +189,8 @@ def test_before_page_load_osf_private_bb_public(self, mock_repo): user=self.node_settings.user, repo=self.node_settings.repo, ) - assert_true(message) - assert_in('The files in this Bitbucket repo can be viewed on Bitbucket', message[0]) + assert message + assert 'The files in this Bitbucket repo can be viewed on Bitbucket' in message[0] @mock.patch('addons.bitbucket.api.BitbucketClient.repo') def test_before_page_load_osf_private_bb_private(self, mock_repo): @@ -203,85 +200,70 @@ def test_before_page_load_osf_private_bb_private(self, mock_repo): user=self.node_settings.user, repo=self.node_settings.repo, ) - assert_false(message) + assert not message def test_before_page_load_not_contributor(self): message = self.node_settings.before_page_load(self.project, UserFactory()) - assert_false(message) + assert not message def test_before_page_load_not_logged_in(self): message = self.node_settings.before_page_load(self.project, None) - assert_false(message) + assert not message def test_before_remove_contributor_authenticator(self): message = self.node_settings.before_remove_contributor( self.project, self.project.creator ) - assert_true(message) + assert message def test_before_remove_contributor_not_authenticator(self): message = self.node_settings.before_remove_contributor( self.project, self.non_authenticator ) - assert_false(message) + assert not message def test_after_remove_contributor_authenticator_self(self): message = self.node_settings.after_remove_contributor( self.project, self.project.creator, self.consolidated_auth ) - assert_equal( - self.node_settings.user_settings, - None - ) - assert_true(message) - assert_not_in('You can re-authenticate', message) + assert self.node_settings.user_settings is None + assert message + assert 'You can re-authenticate' not in message def test_after_remove_contributor_authenticator_not_self(self): auth = Auth(user=self.non_authenticator) message = self.node_settings.after_remove_contributor( self.project, self.project.creator, auth ) - assert_equal( - self.node_settings.user_settings, - None - ) - assert_true(message) - assert_in('You can re-authenticate', message) + assert self.node_settings.user_settings is None + assert message + assert 'You can re-authenticate' in message def test_after_remove_contributor_not_authenticator(self): self.node_settings.after_remove_contributor( self.project, self.non_authenticator, self.consolidated_auth ) - assert_not_equal( - self.node_settings.user_settings, - None, - ) + assert self.node_settings.user_settings is not None def test_after_fork_authenticator(self): fork = ProjectFactory() clone = self.node_settings.after_fork( self.project, fork, self.project.creator, ) - assert_equal( - self.node_settings.user_settings, - clone.user_settings, - ) + assert self.node_settings.user_settings == clone.user_settings def test_after_fork_not_authenticator(self): fork = ProjectFactory() clone = self.node_settings.after_fork( self.project, fork, self.non_authenticator, ) - assert_equal( - clone.user_settings, - None, - ) + assert clone.user_settings is None def test_after_delete(self): self.project.remove_node(Auth(user=self.project.creator)) # Ensure that changes to node settings have been saved self.node_settings.reload() - assert_true(self.node_settings.user_settings is None) + assert self.node_settings.user_settings is None @mock.patch('website.archiver.tasks.archive') def test_does_not_get_copied_to_registrations(self, mock_archive): @@ -290,4 +272,4 @@ def test_does_not_get_copied_to_registrations(self, mock_archive): auth=Auth(user=self.project.creator), draft_registration=DraftRegistrationFactory(branched_from=self.project), ) - assert_false(registration.has_addon('bitbucket')) + assert not registration.has_addon('bitbucket') diff --git a/addons/bitbucket/tests/test_serializer.py b/addons/bitbucket/tests/test_serializer.py index 2f804ec6980..008625ab909 100644 --- a/addons/bitbucket/tests/test_serializer.py +++ b/addons/bitbucket/tests/test_serializer.py @@ -1,8 +1,6 @@ -# -*- coding: utf-8 -*- """Serializer tests for the Bitbucket addon.""" -import mock -from nose.tools import * # noqa (PEP8 asserts) +from unittest import mock import pytest from tests.base import OsfTestCase diff --git a/addons/bitbucket/tests/test_views.py b/addons/bitbucket/tests/test_views.py index 13725b3f2c0..51cac6012b5 100644 --- a/addons/bitbucket/tests/test_views.py +++ b/addons/bitbucket/tests/test_views.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- from rest_framework import status as http_status -import mock +from unittest import mock import datetime import unittest import pytest -from nose.tools import * # noqa (PEP8 asserts) from tests.base import OsfTestCase, get_default_metaschema from osf_tests.factories import ( ProjectFactory, @@ -38,7 +36,7 @@ class TestBitbucketAuthViews(BitbucketAddonTestCase, OAuthAddonAuthViewsTestCase mock.PropertyMock() ) def test_delete_external_account(self): - super(TestBitbucketAuthViews, self).test_delete_external_account() + super().test_delete_external_account() class TestBitbucketConfigViews(BitbucketAddonTestCase, OAuthAddonConfigViewsTestCaseMixin, OsfTestCase): @@ -49,14 +47,14 @@ class TestBitbucketConfigViews(BitbucketAddonTestCase, OAuthAddonConfigViewsTest ## Overrides ## def setUp(self): - super(TestBitbucketConfigViews, self).setUp() + super().setUp() self.mock_access_token = mock.patch('addons.bitbucket.models.BitbucketProvider.fetch_access_token') self.mock_access_token.return_value = mock.Mock() self.mock_access_token.start() def tearDown(self): self.mock_access_token.stop() - super(TestBitbucketConfigViews, self).tearDown() + super().tearDown() def test_folder_list(self): # BB only lists root folder (repos), this test is superfluous @@ -68,23 +66,20 @@ def test_set_config(self, mock_account, mock_repo): # BB selects repos, not folders, so this needs to be overriden mock_account.return_value = mock.Mock() mock_repo.return_value = 'repo_name' - url = self.project.api_url_for('{0}_set_config'.format(self.ADDON_SHORT_NAME)) - res = self.app.post_json(url, { + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_set_config') + res = self.app.post(url, json={ 'bitbucket_user': 'octocat', 'bitbucket_repo': 'repo_name', }, auth=self.user.auth) - assert_equal(res.status_code, http_status.HTTP_200_OK) + assert res.status_code == http_status.HTTP_200_OK self.project.reload() - assert_equal( - self.project.logs.latest().action, - '{0}_repo_linked'.format(self.ADDON_SHORT_NAME) - ) + assert self.project.logs.latest().action == f'{self.ADDON_SHORT_NAME}_repo_linked' class TestBitbucketViews(OsfTestCase): def setUp(self): - super(TestBitbucketViews, self).setUp() + super().setUp() self.user = AuthUserFactory() self.consolidated_auth = Auth(user=self.user) @@ -140,17 +135,14 @@ def test_get_refs_defaults(self, mock_account, mock_default_branch, mock_repo, m mock_branches.return_value = bitbucket_mock.branches.return_value branch, sha, branches = utils.get_refs(self.node_settings) - assert_equal( - branch, - bitbucket_mock.repo_default_branch.return_value - ) - assert_equal(sha, self._get_sha_for_branch(branch=None)) # Get refs for default branch + assert branch == bitbucket_mock.repo_default_branch.return_value + assert sha == self._get_sha_for_branch(branch=None) # Get refs for default branch expected_branches = [ {'name': x['name'], 'sha': x['target']['hash']} for x in bitbucket_mock.branches.return_value ] - assert_equal(branches, expected_branches) + assert branches == expected_branches @mock.patch('addons.bitbucket.api.BitbucketClient.branches') @mock.patch('addons.bitbucket.api.BitbucketClient.repo') @@ -164,47 +156,47 @@ def test_get_refs_branch(self, mock_account, mock_default_branch, mock_repo, moc mock_branches.return_value = bitbucket_mock.branches.return_value branch, sha, branches = utils.get_refs(self.node_settings, 'master') - assert_equal(branch, 'master') + assert branch == 'master' branch_sha = self._get_sha_for_branch('master') - assert_equal(sha, branch_sha) + assert sha == branch_sha expected_branches = [ {'name': x['name'], 'sha': x['target']['hash']} for x in bitbucket_mock.branches.return_value ] - assert_equal(branches, expected_branches) + assert branches == expected_branches def test_before_fork(self): url = self.project.api_url + 'fork/before/' - res = self.app.get(url, auth=self.user.auth).maybe_follow() - assert_equal(len(res.json['prompts']), 1) + res = self.app.get(url, auth=self.user.auth, follow_redirects=True) + assert len(res.json['prompts']) == 1 def test_before_register(self): url = self.project.api_url + 'beforeregister/' - res = self.app.get(url, auth=self.user.auth).maybe_follow() - assert_true('Bitbucket' in res.json['prompts'][1]) + res = self.app.get(url, auth=self.user.auth, follow_redirects=True) + assert 'Bitbucket' in res.json['prompts'][1] @mock.patch('addons.bitbucket.models.NodeSettings.external_account') def test_get_refs_sha_no_branch(self, mock_account): - with assert_raises(HTTPError): + with pytest.raises(HTTPError): utils.get_refs(self.node_settings, sha='12345') def check_hook_urls(self, urls, node, path, sha): url = node.web_url_for('addon_view_or_download_file', path=path, provider='bitbucket') expected_urls = { - 'view': '{0}?ref={1}'.format(url, sha), - 'download': '{0}?action=download&ref={1}'.format(url, sha) + 'view': f'{url}?ref={sha}', + 'download': f'{url}?action=download&ref={sha}' } - assert_equal(urls['view'], expected_urls['view']) - assert_equal(urls['download'], expected_urls['download']) + assert urls['view'] == expected_urls['view'] + assert urls['download'] == expected_urls['download'] class TestBitbucketSettings(OsfTestCase): def setUp(self): - super(TestBitbucketSettings, self).setUp() + super().setUp() self.bitbucket = create_mock_bitbucket(user='fred', private=False) self.project = ProjectFactory() self.project.save() @@ -228,21 +220,21 @@ def test_link_repo(self, mock_account, mock_repo): mock_repo.return_value = bitbucket_mock.repo.return_value url = self.project.api_url + 'bitbucket/settings/' - self.app.post_json( + self.app.post( url, - { + json={ 'bitbucket_user': 'queen', 'bitbucket_repo': 'night at the opera', }, - auth=self.auth - ).maybe_follow() + auth=self.auth, follow_redirects=True + ) self.project.reload() self.node_settings.reload() - assert_equal(self.node_settings.user, 'queen') - assert_equal(self.node_settings.repo, 'night at the opera') - assert_equal(self.project.logs.latest().action, 'bitbucket_repo_linked') + assert self.node_settings.user == 'queen' + assert self.node_settings.repo == 'night at the opera' + assert self.project.logs.latest().action == 'bitbucket_repo_linked' @mock.patch('addons.bitbucket.api.BitbucketClient.repo') @mock.patch('addons.bitbucket.models.NodeSettings.external_account') @@ -254,19 +246,20 @@ def test_link_repo_no_change(self, mock_account, mock_repo): log_count = self.project.logs.count() url = self.project.api_url + 'bitbucket/settings/' - self.app.post_json( + self.app.post( url, - { + json={ 'bitbucket_user': 'Queen', 'bitbucket_repo': 'Sheer-Heart-Attack', }, - auth=self.auth - ).maybe_follow() + auth=self.auth, + follow_redirects=True + ) self.project.reload() self.node_settings.reload() - assert_equal(self.project.logs.count(), log_count) + assert self.project.logs.count() == log_count @mock.patch('addons.bitbucket.api.BitbucketClient.repo') @mock.patch('addons.bitbucket.models.NodeSettings.external_account') @@ -275,17 +268,17 @@ def test_link_repo_non_existent(self, mock_account, mock_repo): mock_repo.return_value = None url = self.project.api_url + 'bitbucket/settings/' - res = self.app.post_json( + res = self.app.post( url, - { + json={ 'bitbucket_user': 'queen', 'bitbucket_repo': 'night at the opera', }, auth=self.auth, - expect_errors=True - ).maybe_follow() + follow_redirects=True + ) - assert_equal(res.status_code, 400) + assert res.status_code == 400 @mock.patch('addons.bitbucket.api.BitbucketClient.branches') def test_link_repo_registration(self, mock_branches): @@ -299,31 +292,31 @@ def test_link_repo_registration(self, mock_branches): ) url = registration.api_url + 'bitbucket/settings/' - res = self.app.post_json( + res = self.app.post( url, - { + json={ 'bitbucket_user': 'queen', 'bitbucket_repo': 'night at the opera', }, auth=self.auth, - expect_errors=True - ).maybe_follow() + follow_redirects=True + ) - assert_equal(res.status_code, 400) + assert res.status_code == 400 def test_deauthorize(self): url = self.project.api_url + 'bitbucket/user_auth/' - self.app.delete(url, auth=self.auth).maybe_follow() + self.app.delete(url, auth=self.auth, follow_redirects=True) self.project.reload() self.node_settings.reload() - assert_equal(self.node_settings.user, None) - assert_equal(self.node_settings.repo, None) - assert_equal(self.node_settings.user_settings, None) + assert self.node_settings.user == None + assert self.node_settings.repo == None + assert self.node_settings.user_settings == None - assert_equal(self.project.logs.latest().action, 'bitbucket_node_deauthorized') + assert self.project.logs.latest().action == 'bitbucket_node_deauthorized' if __name__ == '__main__': diff --git a/addons/bitbucket/tests/utils.py b/addons/bitbucket/tests/utils.py index 6f1312fae01..bfedc8d0ac6 100644 --- a/addons/bitbucket/tests/utils.py +++ b/addons/bitbucket/tests/utils.py @@ -1,4 +1,4 @@ -import mock +from unittest import mock from addons.bitbucket.api import BitbucketClient @@ -13,7 +13,7 @@ class BitbucketAddonTestCase(OAuthAddonTestCaseMixin, AddonTestCase): Provider = BitbucketProvider def set_node_settings(self, settings): - super(BitbucketAddonTestCase, self).set_node_settings(settings) + super().set_node_settings(settings) settings.repo = 'abc' settings.user = 'octo-cat' @@ -36,9 +36,9 @@ def create_mock_bitbucket(user='octo-cat', private=False): 'owner': {'username': user}, } bitbucket_mock.repos.return_value = [ - {'full_name': '{}/cow-problems-app'.format(user)}, - {'full_name': '{}/duck-problems-app'.format(user)}, - {'full_name': '{}/horse-problems-app'.format(user)}, + {'full_name': f'{user}/cow-problems-app'}, + {'full_name': f'{user}/duck-problems-app'}, + {'full_name': f'{user}/horse-problems-app'}, ] bitbucket_mock.team_repos.return_value = [ {'full_name': 'team-barn-devs/pig-problems-app'}, diff --git a/addons/bitbucket/utils.py b/addons/bitbucket/utils.py index a7f8b213941..d289e056669 100644 --- a/addons/bitbucket/utils.py +++ b/addons/bitbucket/utils.py @@ -1,4 +1,4 @@ -from future.moves.urllib.parse import unquote_plus +from urllib.parse import unquote_plus from rest_framework import status as http_status from framework.exceptions import HTTPError diff --git a/addons/bitbucket/views.py b/addons/bitbucket/views.py index df555703c34..0409595c9e1 100644 --- a/addons/bitbucket/views.py +++ b/addons/bitbucket/views.py @@ -1,5 +1,4 @@ """Views for the node settings page.""" -# -*- coding: utf-8 -*- from rest_framework import status as http_status import logging diff --git a/addons/boa/__init__.py b/addons/boa/__init__.py index b593ad68bd2..e69de29bb2d 100644 --- a/addons/boa/__init__.py +++ b/addons/boa/__init__.py @@ -1 +0,0 @@ -default_app_config = 'addons.boa.apps.BoaAddonAppConfig' diff --git a/addons/boa/apps.py b/addons/boa/apps.py index bd6ac6eea13..bc0e4fa78a5 100644 --- a/addons/boa/apps.py +++ b/addons/boa/apps.py @@ -8,6 +8,7 @@ class BoaAddonAppConfig(BaseAddonAppConfig): + default = True name = 'addons.boa' label = 'addons_boa' full_name = 'Boa' diff --git a/addons/boa/migrations/0002_alter_nodesettings_external_account_and_more.py b/addons/boa/migrations/0002_alter_nodesettings_external_account_and_more.py new file mode 100644 index 00000000000..e3a52c86d27 --- /dev/null +++ b/addons/boa/migrations/0002_alter_nodesettings_external_account_and_more.py @@ -0,0 +1,32 @@ +# Generated by Django 4.2.13 on 2024-07-15 13:46 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('osf', '0021_preprint_custom_publication_citation'), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('addons_boa', '0001_initial'), + ] + + operations = [ + migrations.AlterField( + model_name='nodesettings', + name='external_account', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.externalaccount'), + ), + migrations.AlterField( + model_name='nodesettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.abstractnode'), + ), + migrations.AlterField( + model_name='usersettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_user_settings', to=settings.AUTH_USER_MODEL), + ), + ] diff --git a/addons/boa/models.py b/addons/boa/models.py index bde51f59b2a..01578a89bdc 100644 --- a/addons/boa/models.py +++ b/addons/boa/models.py @@ -17,7 +17,7 @@ class BoaProvider(BasicAuthProviderMixin): def __init__(self, account=None, host=None, username=None, password=None): if username: username = username.lower() - super(BoaProvider, self).__init__(account=account, host=host, username=username, password=password) + super().__init__(account=account, host=host, username=username, password=password) def __repr__(self): return '<{name}: {status}>'.format( @@ -32,7 +32,7 @@ class UserSettings(BaseOAuthUserSettings): serializer = BoaSerializer def to_json(self, user): - ret = super(UserSettings, self).to_json(user) + ret = super().to_json(user) ret['hosts'] = DEFAULT_HOSTS return ret diff --git a/addons/boa/requirements.txt b/addons/boa/requirements.txt deleted file mode 100644 index 196f2a7d505..00000000000 --- a/addons/boa/requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ -# Requirements for the boa add-on -boa-api==0.1.14 - -# Requirements for running asyncio in celery, using 3.4.1 for Python 3.6 compatibility -asgiref==3.4.1 diff --git a/addons/boa/serializer.py b/addons/boa/serializer.py index 7a3275ff170..42c738e62a8 100644 --- a/addons/boa/serializer.py +++ b/addons/boa/serializer.py @@ -52,19 +52,19 @@ def addon_serialized_urls(self): @property def serialized_node_settings(self): - result = super(BoaSerializer, self).serialized_node_settings + result = super().serialized_node_settings result['hosts'] = DEFAULT_HOSTS return result @property def serialized_user_settings(self): - result = super(BoaSerializer, self).serialized_user_settings + result = super().serialized_user_settings result['hosts'] = DEFAULT_HOSTS return result def serialize_settings(self, node_settings, current_user, client=None): if client is not None: sentry.log_message('Client ignored for Boa Serializer in serialize_settings()') - ret = super(BoaSerializer, self).serialize_settings(node_settings, current_user, client=client) + ret = super().serialize_settings(node_settings, current_user, client=client) ret['hosts'] = DEFAULT_HOSTS return ret diff --git a/addons/boa/settings/__init__.py b/addons/boa/settings/__init__.py index 90f189ec18d..6deafee2808 100644 --- a/addons/boa/settings/__init__.py +++ b/addons/boa/settings/__init__.py @@ -7,4 +7,4 @@ try: from addons.boa.settings.local import * # noqa except ImportError: - logger.warn('No local.py settings file found') + logger.warning('No local.py settings file found') diff --git a/addons/boa/tests/factories.py b/addons/boa/tests/factories.py index c432eea1c24..6be5ccc2f42 100644 --- a/addons/boa/tests/factories.py +++ b/addons/boa/tests/factories.py @@ -1,4 +1,5 @@ -from factory import DjangoModelFactory, Sequence, SubFactory +from factory import Sequence, SubFactory +from factory.django import DjangoModelFactory from addons.boa.models import UserSettings, NodeSettings from osf_tests.factories import UserFactory, ProjectFactory, ExternalAccountFactory @@ -12,9 +13,9 @@ class BoaAccountFactory(ExternalAccountFactory): provider = 'boa' provider_name = 'Fake Boa Provider' - provider_id = Sequence(lambda n: '{0}:{1}-{2}'.format(BOA_HOST, BOA_USERNAME, n)) - profile_url = Sequence(lambda n: 'http://localhost:9999/{0}/boa'.format(n)) - oauth_secret = Sequence(lambda n: 'secret-{0}'.format(n)) + provider_id = Sequence(lambda n: f'{BOA_HOST}:{BOA_USERNAME}-{n}') + profile_url = Sequence(lambda n: f'http://localhost:9999/{n}/boa') + oauth_secret = Sequence(lambda n: f'secret-{n}') oauth_key = BOA_PASSWORD display_name = 'Fake Boa' diff --git a/addons/boa/tests/test_serializer.py b/addons/boa/tests/test_serializer.py index 100c044797f..058ed018533 100644 --- a/addons/boa/tests/test_serializer.py +++ b/addons/boa/tests/test_serializer.py @@ -1,4 +1,4 @@ -import mock +from unittest import mock import pytest from tests.base import OsfTestCase @@ -18,11 +18,11 @@ def setUp(self): self.mock_credentials = mock.patch('addons.boa.serializer.BoaSerializer.credentials_are_valid') self.mock_credentials.return_value = True self.mock_credentials.start() - super(TestBoaSerializer, self).setUp() + super().setUp() def tearDown(self): self.mock_credentials.stop() - super(TestBoaSerializer, self).tearDown() + super().tearDown() def test_serialize_settings_authorized_folder_is_set(self): self.set_provider_id(pid='foo') diff --git a/addons/boa/tests/test_tasks.py b/addons/boa/tests/test_tasks.py index e0807823a9f..a4842d6c417 100644 --- a/addons/boa/tests/test_tasks.py +++ b/addons/boa/tests/test_tasks.py @@ -1,8 +1,7 @@ -from asynctest import TestCase as AsyncTestCase from boaapi.boa_client import BoaException from boaapi.status import CompilerStatus, ExecutionStatus from http.client import HTTPMessage -import mock +from unittest import mock import pytest from unittest.mock import ANY, MagicMock from urllib.error import HTTPError @@ -21,13 +20,13 @@ class AsyncMock(MagicMock): async def __call__(self, *args, **kwargs): - return super(AsyncMock, self).__call__(*args, **kwargs) + return super().__call__(*args, **kwargs) class TestBoaErrorHandling(OsfTestCase): def setUp(self): - super(TestBoaErrorHandling, self).setUp() + super().setUp() self.error_message = 'fake-error-message' self.user_username = 'fake-user-username' self.user_fullname = 'fake-user-fullname' @@ -40,7 +39,7 @@ def setUp(self): self.job_id = '1a2b3c4d5e6f7g8' def tearDown(self): - super(TestBoaErrorHandling, self).tearDown() + super().tearDown() def test_boa_error_code(self): assert BoaErrorCode.NO_ERROR == -1 @@ -95,7 +94,7 @@ def test_handle_boa_error(self): class TestSubmitToBoa(OsfTestCase): def setUp(self): - super(TestSubmitToBoa, self).setUp() + super().setUp() self.host = 'http://locahost:9999/boa/?q=boa/api' self.username = 'fake-boa-username' self.password = 'fake-boa-password' @@ -109,7 +108,7 @@ def setUp(self): self.output_upload_url = f'http://localhost:7777/v1/resources/{self.project_guid}/providers/osfstorage/?kind=file' def tearDown(self): - super(TestSubmitToBoa, self).tearDown() + super().tearDown() def test_submit_to_boa_async_called(self): with mock.patch( @@ -135,10 +134,11 @@ def test_submit_to_boa_async_called(self): @pytest.mark.django_db -class TestSubmitToBoaAsync(OsfTestCase, AsyncTestCase): +@pytest.mark.asyncio +class TestSubmitToBoaAsync(OsfTestCase): def setUp(self): - super(TestSubmitToBoaAsync, self).setUp() + super().setUp() self.host = 'http://locahost:9999/boa/?q=boa/api' self.username = 'fake-boa-username' self.password = 'fake-boa-password' @@ -168,7 +168,7 @@ def setUp(self): boa_settings.MAX_JOB_WAITING_TIME = DEFAULT_MAX_JOB_WAITING_TIME def tearDown(self): - super(TestSubmitToBoaAsync, self).tearDown() + super().tearDown() async def test_submit_success(self): with mock.patch('osf.models.user.OSFUser.objects.get', return_value=self.user), \ diff --git a/addons/boa/tests/test_views.py b/addons/boa/tests/test_views.py index 1cd4516cf86..3989386f739 100644 --- a/addons/boa/tests/test_views.py +++ b/addons/boa/tests/test_views.py @@ -1,4 +1,4 @@ -import mock +from unittest import mock import pytest from rest_framework import status as http_status @@ -29,7 +29,7 @@ def test_oauth_finish(self): class TestConfigViews(BoaBasicAuthAddonTestCase, OAuthAddonConfigViewsTestCaseMixin, OsfTestCase): def setUp(self): - super(TestConfigViews, self).setUp() + super().setUp() self.mock_boa_client_login = mock.patch('boaapi.boa_client.BoaClient.login') self.mock_boa_client_close = mock.patch('boaapi.boa_client.BoaClient.close') self.mock_boa_client_login.start() @@ -38,7 +38,7 @@ def setUp(self): def tearDown(self): self.mock_boa_client_close.stop() self.mock_boa_client_login.stop() - super(TestConfigViews, self).tearDown() + super().tearDown() def test_folder_list(self): """Not applicable to remote computing add-ons.""" @@ -77,7 +77,7 @@ def test_get_config_owner_with_external_account(self): assert self.node_settings.external_account is not None assert serialized['validCredentials'] is True - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') res = self.app.get(url, auth=self.user.auth) assert res.status_code == http_status.HTTP_200_OK assert 'result' in res.json @@ -93,7 +93,7 @@ def test_get_config_owner_without_external_account(self): assert self.node_settings.external_account is None assert serialized['validCredentials'] is False - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') res = self.app.get(url, auth=self.user.auth) assert res.status_code == http_status.HTTP_200_OK assert 'result' in res.json @@ -112,7 +112,7 @@ def test_get_config_write_contrib_with_external_account(self): assert self.node_settings.external_account is not None assert serialized['validCredentials'] is True - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') res = self.app.get(url, auth=user_write.auth) assert res.status_code == http_status.HTTP_200_OK assert 'result' in res.json @@ -130,7 +130,7 @@ def test_get_config_write_contrib_without_external_account(self): assert self.node_settings.external_account is None assert serialized['validCredentials'] is False - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') res = self.app.get(url, auth=user_write.auth) assert res.status_code == http_status.HTTP_200_OK assert 'result' in res.json @@ -149,7 +149,7 @@ def test_get_config_admin_contrib_with_external_account(self): assert self.node_settings.external_account is not None assert serialized['validCredentials'] is True - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') res = self.app.get(url, auth=user_admin.auth) assert res.status_code == http_status.HTTP_200_OK assert 'result' in res.json @@ -167,7 +167,7 @@ def test_get_config_admin_contrib_without_external_account(self): assert self.node_settings.external_account is None assert serialized['validCredentials'] is False - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') res = self.app.get(url, auth=user_admin.auth) assert res.status_code == http_status.HTTP_200_OK assert 'result' in res.json @@ -178,9 +178,9 @@ def test_get_config_read_contrib_with_valid_credentials(self): user_read_only = AuthUserFactory() self.project.add_contributor(user_read_only, permissions=permissions.READ, auth=self.auth, save=True) - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') with mock.patch.object(type(self.Serializer()), 'credentials_are_valid', return_value=True): - res = self.app.get(url, auth=user_read_only.auth, expect_errors=True) + res = self.app.get(url, auth=user_read_only.auth) assert res.status_code == http_status.HTTP_403_FORBIDDEN def test_get_config_read_contrib_without_valid_credentials(self): @@ -188,16 +188,16 @@ def test_get_config_read_contrib_without_valid_credentials(self): user_read_only = AuthUserFactory() self.project.add_contributor(user_read_only, permissions=permissions.READ, auth=self.auth, save=True) - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') with mock.patch.object(type(self.Serializer()), 'credentials_are_valid', return_value=False): - res = self.app.get(url, auth=user_read_only.auth, expect_errors=True) + res = self.app.get(url, auth=user_read_only.auth) assert res.status_code == http_status.HTTP_403_FORBIDDEN class TestBoaSubmitViews(BoaBasicAuthAddonTestCase, OsfTestCase): def setUp(self): - super(TestBoaSubmitViews, self).setUp() + super().setUp() self.folder_name = 'fake_boa_folder' self.file_name = 'fake_boa_file.boa' self.file_size = 255 @@ -238,7 +238,7 @@ def setUp(self): } def tearDown(self): - super(TestBoaSubmitViews, self).tearDown() + super().tearDown() def test_boa_submit_job_from_addon_root(self): with mock.patch('addons.boa.tasks.submit_to_boa.s', return_value=BoaErrorCode.NO_ERROR) as mock_submit_s: @@ -247,7 +247,7 @@ def test_boa_submit_job_from_addon_root(self): addon_root_url = waterbutler_api_url_for(self.project._id, 'osfstorage', _internal=True, base_url=base_url) upload_url_root = f'{addon_root_url}?kind=file' url = self.project.api_url_for('boa_submit_job') - res = self.app.post_json(url, self.payload_addon_root, auth=self.user.auth) + res = self.app.post(url, json=self.payload_addon_root, auth=self.user.auth) assert res.status_code == http_status.HTTP_200_OK mock_submit_s.assert_called_with( BOA_HOST, @@ -267,7 +267,7 @@ def test_boa_submit_job_from_sub_folder(self): with mock.patch('addons.boa.tasks.submit_to_boa.s', return_value=BoaErrorCode.NO_ERROR) as mock_submit_s: self.node_settings.set_auth(self.external_account, self.user) url = self.project.api_url_for('boa_submit_job') - res = self.app.post_json(url, self.payload_sub_folder, auth=self.user.auth) + res = self.app.post(url, json=self.payload_sub_folder, auth=self.user.auth) assert res.status_code == http_status.HTTP_200_OK mock_submit_s.assert_called_with( BOA_HOST, @@ -289,7 +289,7 @@ def test_boa_submit_job_admin_contrib(self): user_admin = AuthUserFactory() self.project.add_contributor(user_admin, permissions=permissions.ADMIN, auth=self.auth, save=True) url = self.project.api_url_for('boa_submit_job') - res = self.app.post_json(url, self.payload_sub_folder, auth=user_admin.auth) + res = self.app.post(url, json=self.payload_sub_folder, auth=user_admin.auth) assert res.status_code == http_status.HTTP_200_OK mock_submit_s.assert_called_with( BOA_HOST, @@ -311,7 +311,7 @@ def test_boa_submit_job_write_contrib(self): user_write = AuthUserFactory() self.project.add_contributor(user_write, permissions=permissions.WRITE, auth=self.auth, save=True) url = self.project.api_url_for('boa_submit_job') - res = self.app.post_json(url, self.payload_sub_folder, auth=user_write.auth) + res = self.app.post(url, json=self.payload_sub_folder, auth=user_write.auth) assert res.status_code == http_status.HTTP_200_OK mock_submit_s.assert_called_with( BOA_HOST, @@ -333,6 +333,6 @@ def test_boa_submit_job_read_contrib(self): user_read_only = AuthUserFactory() self.project.add_contributor(user_read_only, permissions=permissions.READ, auth=self.auth, save=True) url = self.project.api_url_for('boa_submit_job') - res = self.app.post_json(url, self.payload_sub_folder, auth=user_read_only.auth, expect_errors=True) + res = self.app.post(url, json=self.payload_sub_folder, auth=user_read_only.auth) assert res.status_code == http_status.HTTP_403_FORBIDDEN mock_submit_s.assert_not_called() diff --git a/addons/boa/tests/utils.py b/addons/boa/tests/utils.py index b03e9d803c9..c5ad1f474b0 100644 --- a/addons/boa/tests/utils.py +++ b/addons/boa/tests/utils.py @@ -3,7 +3,7 @@ from addons.boa.tests.factories import BoaAccountFactory, BoaNodeSettingsFactory, BoaUserSettingsFactory -class BoaAddonTestCaseBaseMixin(object): +class BoaAddonTestCaseBaseMixin: short_name = 'boa' full_name = 'Boa' @@ -22,12 +22,12 @@ class BoaAddonTestCaseBaseMixin(object): class BoaBasicAuthAddonTestCase(BoaAddonTestCaseBaseMixin, OAuthAddonTestCaseMixin, AddonTestCase): def __init__(self, *args, **kwargs): - super(BoaBasicAuthAddonTestCase, self).__init__(*args, **kwargs) + super().__init__(*args, **kwargs) self.auth = None self.external_account = None def set_user_settings(self, settings): - super(BoaBasicAuthAddonTestCase, self).set_user_settings(settings) + super().set_user_settings(settings) def set_node_settings(self, settings): - super(BoaBasicAuthAddonTestCase, self).set_node_settings(settings) + super().set_node_settings(settings) diff --git a/addons/boa/views.py b/addons/boa/views.py index 2b82d4c91bd..05cf37729c5 100644 --- a/addons/boa/views.py +++ b/addons/boa/views.py @@ -50,7 +50,7 @@ def boa_add_user_account(auth, **kwargs): except ValidationError: provider.account = ExternalAccount.objects.get( provider=provider.short_name, - provider_id='{}:{}'.format(BOA_API_ENDPOINT, username).lower() + provider_id=f'{BOA_API_ENDPOINT}:{username}'.lower() ) if provider.account.oauth_key != password: provider.account.oauth_key = password diff --git a/addons/box/__init__.py b/addons/box/__init__.py index 305007bec08..e69de29bb2d 100644 --- a/addons/box/__init__.py +++ b/addons/box/__init__.py @@ -1 +0,0 @@ -default_app_config = 'addons.box.apps.BoxAddonAppConfig' diff --git a/addons/box/apps.py b/addons/box/apps.py index 0637591fa66..d7563b94fca 100644 --- a/addons/box/apps.py +++ b/addons/box/apps.py @@ -6,6 +6,7 @@ class BoxAddonAppConfig(BaseAddonAppConfig): + default = True name = 'addons.box' label = 'addons_box' full_name = 'Box' diff --git a/addons/box/migrations/0001_initial.py b/addons/box/migrations/0001_initial.py index f2053798e95..0b9a6c40caf 100644 --- a/addons/box/migrations/0001_initial.py +++ b/addons/box/migrations/0001_initial.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- # Generated by Django 1.11.29 on 2022-08-17 19:15 -from __future__ import unicode_literals import addons.base.models from django.db import migrations, models diff --git a/addons/box/migrations/0002_auto_20220817_1915.py b/addons/box/migrations/0002_auto_20220817_1915.py index 58be50b8bea..3805ee039bc 100644 --- a/addons/box/migrations/0002_auto_20220817_1915.py +++ b/addons/box/migrations/0002_auto_20220817_1915.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- # Generated by Django 1.11.29 on 2022-08-17 19:15 -from __future__ import unicode_literals from django.conf import settings from django.db import migrations, models diff --git a/addons/box/migrations/0003_alter_nodesettings_external_account_and_more.py b/addons/box/migrations/0003_alter_nodesettings_external_account_and_more.py new file mode 100644 index 00000000000..0db0015ea20 --- /dev/null +++ b/addons/box/migrations/0003_alter_nodesettings_external_account_and_more.py @@ -0,0 +1,32 @@ +# Generated by Django 4.2.13 on 2024-07-15 13:46 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('osf', '0021_preprint_custom_publication_citation'), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('addons_box', '0002_auto_20220817_1915'), + ] + + operations = [ + migrations.AlterField( + model_name='nodesettings', + name='external_account', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.externalaccount'), + ), + migrations.AlterField( + model_name='nodesettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.abstractnode'), + ), + migrations.AlterField( + model_name='usersettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_user_settings', to=settings.AUTH_USER_MODEL), + ), + ] diff --git a/addons/box/models.py b/addons/box/models.py index 88108a78bc1..78002b122df 100644 --- a/addons/box/models.py +++ b/addons/box/models.py @@ -71,7 +71,7 @@ def handle_callback(self, response): return { 'provider_id': about['id'], 'display_name': about['name'], - 'profile_url': 'https://app.box.com/profile/{0}'.format(about['id']) + 'profile_url': f'https://app.box.com/profile/{about["id"]}' } @@ -118,7 +118,7 @@ def api(self): @property def display_name(self): - return '{0}: {1}'.format(self.config.full_name, self.folder_id) + return f'{self.config.full_name}: {self.folder_id}' def fetch_full_folder_path(self): return self.folder_path @@ -134,7 +134,7 @@ def get_folders(self, **kwargs): 'name': '/ (Full Box)', 'urls': { # 'folders': node.api_url_for('box_folder_list', folderId=0), - 'folders': api_v2_url('nodes/{}/addons/box/folders/'.format(self.owner._id), + 'folders': api_v2_url(f'nodes/{self.owner._id}/addons/box/folders/', params={'id': '0'} ) } @@ -169,7 +169,7 @@ def get_folders(self, **kwargs): 'name': item['name'], 'path': os.path.join(folder_path, item['name']).replace('All Files', ''), 'urls': { - 'folders': api_v2_url('nodes/{}/addons/box/folders/'.format(self.owner._id), + 'folders': api_v2_url(f'nodes/{self.owner._id}/addons/box/folders/', params={'id': item['id']} ) } @@ -237,7 +237,7 @@ def serialize_waterbutler_settings(self): def create_waterbutler_log(self, auth, action, metadata): self.owner.add_log( - 'box_{0}'.format(action), + f'box_{action}', auth=auth, params={ 'path': metadata['materialized'], diff --git a/addons/box/requirements.txt b/addons/box/requirements.txt deleted file mode 100644 index c1b869fddf2..00000000000 --- a/addons/box/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -boxsdk==1.5.5 diff --git a/addons/box/routes.py b/addons/box/routes.py index a73302bd638..b29d650902d 100644 --- a/addons/box/routes.py +++ b/addons/box/routes.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Box addon routes.""" from framework.routing import Rule, json_renderer diff --git a/addons/box/settings/__init__.py b/addons/box/settings/__init__.py index bce98689d3b..eb5d40c3725 100644 --- a/addons/box/settings/__init__.py +++ b/addons/box/settings/__init__.py @@ -6,4 +6,4 @@ try: from .local import * # noqa except ImportError: - logger.warn('No local.py settings file found') + logger.warning('No local.py settings file found') diff --git a/addons/box/settings/local-dist.py b/addons/box/settings/local-dist.py index 492ed19ff45..38d245c2df6 100644 --- a/addons/box/settings/local-dist.py +++ b/addons/box/settings/local-dist.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Example Box local settings file. Copy this file to local.py and change these settings. """ diff --git a/addons/box/tests/factories.py b/addons/box/tests/factories.py index bada66e3a54..17b1898e49d 100644 --- a/addons/box/tests/factories.py +++ b/addons/box/tests/factories.py @@ -14,8 +14,8 @@ class BoxAccountFactory(ExternalAccountFactory): provider = 'box' - provider_id = Sequence(lambda n: 'id-{0}'.format(n)) - oauth_key = Sequence(lambda n: 'key-{0}'.format(n)) + provider_id = Sequence(lambda n: f'id-{n}') + oauth_key = Sequence(lambda n: f'key-{n}') expires_at = timezone.now() + relativedelta(seconds=3600) diff --git a/addons/box/tests/test_client.py b/addons/box/tests/test_client.py index 97db6293bd4..e6051137ed5 100644 --- a/addons/box/tests/test_client.py +++ b/addons/box/tests/test_client.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- -from nose.tools import assert_true import pytest import unittest @@ -13,7 +11,7 @@ class TestCore(unittest.TestCase): def setUp(self): - super(TestCore, self).setUp() + super().setUp() self.user = UserFactory() self.user.add_addon('box') @@ -24,4 +22,4 @@ def setUp(self): def test_get_addon_returns_box_user_settings(self): result = self.user.get_addon('box') - assert_true(isinstance(result, UserSettings)) + assert isinstance(result, UserSettings) diff --git a/addons/box/tests/test_models.py b/addons/box/tests/test_models.py index c3a9a78c903..6829b754d23 100644 --- a/addons/box/tests/test_models.py +++ b/addons/box/tests/test_models.py @@ -1,4 +1,4 @@ -import mock +from unittest import mock import unittest import pytest @@ -28,11 +28,11 @@ def setUp(self): return_value=('12235', '/Foo') ) self.mock_data.start() - super(TestBoxNodeSettings, self).setUp() + super().setUp() def tearDown(self): self.mock_data.stop() - super(TestBoxNodeSettings, self).tearDown() + super().tearDown() def test_folder_defaults_to_none(self): node_settings = NodeSettings(user_settings=self.user_settings, owner=factories.ProjectFactory()) @@ -42,11 +42,11 @@ def test_folder_defaults_to_none(self): @mock.patch('addons.box.models.Provider.refresh_oauth_key') def test_serialize_credentials(self, mock_refresh): mock_refresh.return_value = True - super(TestBoxNodeSettings, self).test_serialize_credentials() + super().test_serialize_credentials() @mock.patch('addons.box.models.UserSettings.revoke_remote_oauth_access', mock.PropertyMock()) def test_complete_has_auth_not_verified(self): - super(TestBoxNodeSettings, self).test_complete_has_auth_not_verified() + super().test_complete_has_auth_not_verified() class TestBoxUserSettings(OAuthAddonUserSettingTestSuiteMixin, unittest.TestCase): diff --git a/addons/box/tests/test_serializer.py b/addons/box/tests/test_serializer.py index 1ee4537d4ba..e32adec4faf 100644 --- a/addons/box/tests/test_serializer.py +++ b/addons/box/tests/test_serializer.py @@ -1,6 +1,5 @@ -# -*- coding: utf-8 -*- """Serializer tests for the Box addon.""" -import mock +from unittest import mock import pytest from addons.base.tests.serializers import StorageAddonSerializerTestSuiteMixin @@ -27,11 +26,11 @@ def setUp(self): return_value=True ) self.mock_valid.start() - super(TestBoxSerializer, self).setUp() + super().setUp() def tearDown(self): self.mock_valid.stop() - super(TestBoxSerializer, self).tearDown() + super().tearDown() def set_provider_id(self, pid): self.node_settings.folder_id = pid diff --git a/addons/box/tests/test_views.py b/addons/box/tests/test_views.py index af7d646ae77..f8da949c5bf 100644 --- a/addons/box/tests/test_views.py +++ b/addons/box/tests/test_views.py @@ -1,9 +1,7 @@ -# -*- coding: utf-8 -*- """Views tests for the Box addon.""" from django.utils import timezone from rest_framework import status as http_status -from nose.tools import * # noqa (PEP8 asserts) -import mock +from unittest import mock import pytest from urllib3.exceptions import MaxRetryError @@ -32,18 +30,18 @@ def setUp(self): self.mock_refresh = mock.patch('addons.box.models.Provider.refresh_oauth_key') self.mock_refresh.return_value = True self.mock_refresh.start() - super(TestAuthViews, self).setUp() + super().setUp() def tearDown(self): self.mock_refresh.stop() - super(TestAuthViews, self).tearDown() + super().tearDown() @mock.patch( 'addons.box.models.UserSettings.revoke_remote_oauth_access', mock.PropertyMock() ) def test_delete_external_account(self): - super(TestAuthViews, self).test_delete_external_account() + super().test_delete_external_account() class TestConfigViews(BoxAddonTestCase, views_testing.OAuthAddonConfigViewsTestCaseMixin, OsfTestCase): @@ -62,20 +60,20 @@ def setUp(self): return_value=(self.folder['id'], self.folder['path']) ) self.mock_data.start() - super(TestConfigViews, self).setUp() + super().setUp() def tearDown(self): self.mock_data.stop() - super(TestConfigViews, self).tearDown() + super().tearDown() @mock.patch.object(BoxSerializer, 'credentials_are_valid', return_value=True) def test_import_auth(self, *args): - super(TestConfigViews, self).test_import_auth() + super().test_import_auth() class TestFilebrowserViews(BoxAddonTestCase, OsfTestCase): def setUp(self): - super(TestFilebrowserViews, self).setUp() + super().setUp() self.user.add_addon('box') self.node_settings.external_account = self.user_settings.external_accounts[0] self.node_settings.save() @@ -93,10 +91,10 @@ def test_box_list_folders(self): res = self.app.get(url, auth=self.user.auth) contents = mock_client.folder('', list=True)['item_collection']['entries'] expected = [each for each in contents if each['type'] == 'folder'] - assert_equal(len(res.json), len(expected)) + assert len(res.json) == len(expected) first = res.json[0] - assert_in('kind', first) - assert_equal(first['name'], contents[0]['name']) + assert 'kind' in first + assert first['name'] == contents[0]['name'] @mock.patch('addons.box.models.NodeSettings.folder_id') def test_box_list_folders_if_folder_is_none(self, mock_folder): @@ -104,7 +102,7 @@ def test_box_list_folders_if_folder_is_none(self, mock_folder): mock_folder.__get__ = mock.Mock(return_value=None) url = self.project.api_url_for('box_folder_list') res = self.app.get(url, auth=self.user.auth) - assert_equal(len(res.json), 1) + assert len(res.json) == 1 def test_box_list_folders_if_folder_is_none_and_folders_only(self): with patch_client('addons.box.models.Client'): @@ -115,7 +113,7 @@ def test_box_list_folders_if_folder_is_none_and_folders_only(self): res = self.app.get(url, auth=self.user.auth) contents = mock_client.folder('', list=True)['item_collection']['entries'] expected = [each for each in contents if each['type'] == 'folder'] - assert_equal(len(res.json), len(expected)) + assert len(res.json) == len(expected) def test_box_list_folders_folders_only(self): with patch_client('addons.box.models.Client'): @@ -123,7 +121,7 @@ def test_box_list_folders_folders_only(self): res = self.app.get(url, auth=self.user.auth) contents = mock_client.folder('', list=True)['item_collection']['entries'] expected = [each for each in contents if each['type'] == 'folder'] - assert_equal(len(res.json), len(expected)) + assert len(res.json) == len(expected) def test_box_list_folders_doesnt_include_root(self): with mock.patch('addons.box.models.Client.folder') as folder_mock: @@ -133,22 +131,22 @@ def test_box_list_folders_doesnt_include_root(self): contents = mock_client.folder('', list=True)['item_collection']['entries'] expected = [each for each in contents if each['type'] == 'folder'] - assert_equal(len(res.json), len(expected)) + assert len(res.json) == len(expected) @mock.patch('addons.box.models.Client.folder') def test_box_list_folders_returns_error_if_invalid_path(self, mock_metadata): mock_metadata.side_effect = BoxAPIException(status=404, message='File not found') url = self.project.api_url_for('box_folder_list', folder_id='lolwut') - res = self.app.get(url, auth=self.user.auth, expect_errors=True) - assert_equal(res.status_code, http_status.HTTP_404_NOT_FOUND) + res = self.app.get(url, auth=self.user.auth) + assert res.status_code == http_status.HTTP_404_NOT_FOUND @mock.patch('addons.box.models.Client.folder') def test_box_list_folders_handles_max_retry_error(self, mock_metadata): mock_response = mock.Mock() url = self.project.api_url_for('box_folder_list', folder_id='fo') mock_metadata.side_effect = MaxRetryError(mock_response, url) - res = self.app.get(url, auth=self.user.auth, expect_errors=True) - assert_equal(res.status_code, http_status.HTTP_400_BAD_REQUEST) + res = self.app.get(url, auth=self.user.auth) + assert res.status_code == http_status.HTTP_400_BAD_REQUEST class TestRestrictions(BoxAddonTestCase, OsfTestCase): @@ -179,14 +177,14 @@ def test_restricted_hgrid_data_contents(self, mock_auth): # tries to access a parent folder url = self.project.api_url_for('box_folder_list', path='foo bar') - res = self.app.get(url, auth=self.contrib.auth, expect_errors=True) - assert_equal(res.status_code, http_status.HTTP_403_FORBIDDEN) + res = self.app.get(url, auth=self.contrib.auth) + assert res.status_code == http_status.HTTP_403_FORBIDDEN def test_restricted_config_contrib_no_addon(self): url = api_url_for('box_set_config', pid=self.project._primary_key) - res = self.app.put_json(url, {'selected': {'path': 'foo'}}, - auth=self.contrib.auth, expect_errors=True) - assert_equal(res.status_code, http_status.HTTP_400_BAD_REQUEST) + res = self.app.put(url, json={'selected': {'path': 'foo'}}, + auth=self.contrib.auth) + assert res.status_code == http_status.HTTP_400_BAD_REQUEST def test_restricted_config_contrib_not_owner(self): # Contributor has box auth, but is not the node authorizer @@ -194,6 +192,6 @@ def test_restricted_config_contrib_not_owner(self): self.contrib.save() url = api_url_for('box_set_config', pid=self.project._primary_key) - res = self.app.put_json(url, {'selected': {'path': 'foo'}}, - auth=self.contrib.auth, expect_errors=True) - assert_equal(res.status_code, http_status.HTTP_403_FORBIDDEN) + res = self.app.put(url, json={'selected': {'path': 'foo'}}, + auth=self.contrib.auth) + assert res.status_code == http_status.HTTP_403_FORBIDDEN diff --git a/addons/box/tests/utils.py b/addons/box/tests/utils.py index 793d16c5b1f..7b4c942258e 100644 --- a/addons/box/tests/utils.py +++ b/addons/box/tests/utils.py @@ -1,5 +1,4 @@ -# -*- coding: utf-8 -*- -import mock +from unittest import mock from contextlib import contextmanager from addons.base.tests.base import OAuthAddonTestCaseMixin, AddonTestCase @@ -14,7 +13,7 @@ class BoxAddonTestCase(OAuthAddonTestCaseMixin, AddonTestCase): Provider = Provider def set_node_settings(self, settings): - super(BoxAddonTestCase, self).set_node_settings(settings) + super().set_node_settings(settings) settings.folder_id = '1234567890' settings.folder_name = 'Foo' @@ -88,64 +87,64 @@ def set_node_settings(self, settings): 'revision': 220191 }, { - u'bytes': 0, - u'icon': u'folder', - u'is_dir': True, - u'modified': u'Sat, 22 Mar 2014 05:40:29 +0000', - u'path': u'/datasets/New Folder', - u'rev': u'3fed51f002c12fc', - u'revision': 67032351, - u'root': u'box', - u'size': u'0 bytes', - u'thumb_exists': False + 'bytes': 0, + 'icon': 'folder', + 'is_dir': True, + 'modified': 'Sat, 22 Mar 2014 05:40:29 +0000', + 'path': '/datasets/New Folder', + 'rev': '3fed51f002c12fc', + 'revision': 67032351, + 'root': 'box', + 'size': '0 bytes', + 'thumb_exists': False } ], 'revision': 29007 }, 'metadata_single': { - u'id': 'id', - u'bytes': 74, - u'client_mtime': u'Mon, 13 Jan 2014 20:24:15 +0000', - u'icon': u'page_white', - u'is_dir': False, - u'mime_type': u'text/csv', - u'modified': u'Fri, 21 Mar 2014 05:46:36 +0000', - u'path': '/datasets/foo.txt', - u'rev': u'a2149fb64', - u'revision': 10, - u'root': u'app_folder', - u'size': u'74 bytes', - u'thumb_exists': False + 'id': 'id', + 'bytes': 74, + 'client_mtime': 'Mon, 13 Jan 2014 20:24:15 +0000', + 'icon': 'page_white', + 'is_dir': False, + 'mime_type': 'text/csv', + 'modified': 'Fri, 21 Mar 2014 05:46:36 +0000', + 'path': '/datasets/foo.txt', + 'rev': 'a2149fb64', + 'revision': 10, + 'root': 'app_folder', + 'size': '74 bytes', + 'thumb_exists': False }, - 'revisions': [{u'bytes': 0, - u'client_mtime': u'Wed, 31 Dec 1969 23:59:59 +0000', - u'icon': u'page_white_picture', - u'is_deleted': True, - u'is_dir': False, - u'mime_type': u'image/png', - u'modified': u'Tue, 25 Mar 2014 03:39:13 +0000', - u'path': u'/svs-v-barks.png', - u'rev': u'3fed741002c12fc', - u'revision': 67032897, - u'root': u'box', - u'size': u'0 bytes', - u'thumb_exists': True}, - {u'bytes': 151164, - u'client_mtime': u'Sat, 13 Apr 2013 21:56:36 +0000', - u'icon': u'page_white_picture', - u'is_dir': False, - u'mime_type': u'image/png', - u'modified': u'Tue, 25 Mar 2014 01:45:51 +0000', - u'path': u'/svs-v-barks.png', - u'rev': u'3fed61a002c12fc', - u'revision': 67032602, - u'root': u'box', - u'size': u'147.6 KB', - u'thumb_exists': True}] + 'revisions': [{'bytes': 0, + 'client_mtime': 'Wed, 31 Dec 1969 23:59:59 +0000', + 'icon': 'page_white_picture', + 'is_deleted': True, + 'is_dir': False, + 'mime_type': 'image/png', + 'modified': 'Tue, 25 Mar 2014 03:39:13 +0000', + 'path': '/svs-v-barks.png', + 'rev': '3fed741002c12fc', + 'revision': 67032897, + 'root': 'box', + 'size': '0 bytes', + 'thumb_exists': True}, + {'bytes': 151164, + 'client_mtime': 'Sat, 13 Apr 2013 21:56:36 +0000', + 'icon': 'page_white_picture', + 'is_dir': False, + 'mime_type': 'image/png', + 'modified': 'Tue, 25 Mar 2014 01:45:51 +0000', + 'path': '/svs-v-barks.png', + 'rev': '3fed61a002c12fc', + 'revision': 67032602, + 'root': 'box', + 'size': '147.6 KB', + 'thumb_exists': True}] } -class MockBox(object): +class MockBox: def put_file(self, full_path, file_obj, overwrite=False, parent_rev=None): return mock_responses['put_file'] diff --git a/addons/box/views.py b/addons/box/views.py index e808b079536..7e3694f75ae 100644 --- a/addons/box/views.py +++ b/addons/box/views.py @@ -1,5 +1,4 @@ """Views for the node settings page.""" -# -*- coding: utf-8 -*- from flask import request from addons.base import generic_views diff --git a/addons/dataverse/__init__.py b/addons/dataverse/__init__.py index 3041d2b08d3..e69de29bb2d 100644 --- a/addons/dataverse/__init__.py +++ b/addons/dataverse/__init__.py @@ -1 +0,0 @@ -default_app_config = 'addons.dataverse.apps.DataverseAddonAppConfig' diff --git a/addons/dataverse/apps.py b/addons/dataverse/apps.py index 1221a979139..15b04f40f15 100644 --- a/addons/dataverse/apps.py +++ b/addons/dataverse/apps.py @@ -11,6 +11,7 @@ class DataverseAddonAppConfig(BaseAddonAppConfig): + default = True name = 'addons.dataverse' label = 'addons_dataverse' full_name = 'Dataverse' diff --git a/addons/dataverse/migrations/0001_initial.py b/addons/dataverse/migrations/0001_initial.py index 8f0bdbe9345..d3a1ec3a73c 100644 --- a/addons/dataverse/migrations/0001_initial.py +++ b/addons/dataverse/migrations/0001_initial.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- # Generated by Django 1.11.29 on 2022-08-17 19:15 -from __future__ import unicode_literals import addons.base.models from django.db import migrations, models diff --git a/addons/dataverse/migrations/0002_auto_20220817_1915.py b/addons/dataverse/migrations/0002_auto_20220817_1915.py index bb10ee76ec4..1ba459bd7a6 100644 --- a/addons/dataverse/migrations/0002_auto_20220817_1915.py +++ b/addons/dataverse/migrations/0002_auto_20220817_1915.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- # Generated by Django 1.11.29 on 2022-08-17 19:15 -from __future__ import unicode_literals from django.conf import settings from django.db import migrations, models diff --git a/addons/dataverse/migrations/0003_alter_nodesettings_external_account_and_more.py b/addons/dataverse/migrations/0003_alter_nodesettings_external_account_and_more.py new file mode 100644 index 00000000000..d792caf1d49 --- /dev/null +++ b/addons/dataverse/migrations/0003_alter_nodesettings_external_account_and_more.py @@ -0,0 +1,32 @@ +# Generated by Django 4.2.13 on 2024-07-15 13:46 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('osf', '0021_preprint_custom_publication_citation'), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('addons_dataverse', '0002_auto_20220817_1915'), + ] + + operations = [ + migrations.AlterField( + model_name='nodesettings', + name='external_account', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.externalaccount'), + ), + migrations.AlterField( + model_name='nodesettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.abstractnode'), + ), + migrations.AlterField( + model_name='usersettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_user_settings', to=settings.AUTH_USER_MODEL), + ), + ] diff --git a/addons/dataverse/models.py b/addons/dataverse/models.py index f586a99a958..1b4753d7cfa 100644 --- a/addons/dataverse/models.py +++ b/addons/dataverse/models.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- from rest_framework import status as http_status from addons.base import exceptions as addon_errors @@ -71,14 +70,14 @@ def update(self, revision, data, save=True, user=None): return version -class DataverseProvider(object): +class DataverseProvider: """An alternative to `ExternalProvider` not tied to OAuth""" name = 'Dataverse' short_name = 'dataverse' serializer = DataverseSerializer def __init__(self, account=None): - super(DataverseProvider, self).__init__() # this does exactly nothing... + super().__init__() # this does exactly nothing... # provide an unauthenticated session by default self.account = account @@ -165,7 +164,7 @@ def set_folder(self, dataverse, dataset, auth=None): def _get_fileobj_child_metadata(self, filenode, user, cookie=None, version=None): try: - return super(NodeSettings, self)._get_fileobj_child_metadata(filenode, user, cookie=cookie, version=version) + return super()._get_fileobj_child_metadata(filenode, user, cookie=cookie, version=version) except HTTPError as e: # The Dataverse API returns a 404 if the dataset has no published files if e.code == http_status.HTTP_404_NOT_FOUND and version == 'latest-published': @@ -215,7 +214,7 @@ def serialize_waterbutler_settings(self): def create_waterbutler_log(self, auth, action, metadata): url = self.owner.web_url_for('addon_view_or_download_file', path=metadata['path'], provider='dataverse') self.owner.add_log( - 'dataverse_{0}'.format(action), + f'dataverse_{action}', auth=auth, params={ 'project': self.owner.parent_id, diff --git a/addons/dataverse/requirements.txt b/addons/dataverse/requirements.txt deleted file mode 100644 index 5bf59c7dae2..00000000000 --- a/addons/dataverse/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -# Allow for optional timeout parameter. -# https://github.com/IQSS/dataverse-client-python/pull/27 -#-e git+https://github.com/IQSS/dataverse-client-python.git@b6aec5bc3fd1cc3199e3c97ac9c71705b54c3d11#egg=dataverse --e git+https://github.com/CenterForOpenScience/dataverse-client-python.git@5a9a8cabc9a521bd86efc0105075c5a4816a2ca5#egg=dataverse diff --git a/addons/dataverse/serializer.py b/addons/dataverse/serializer.py index 0535580827f..0b8d66abceb 100644 --- a/addons/dataverse/serializer.py +++ b/addons/dataverse/serializer.py @@ -12,11 +12,11 @@ class DataverseSerializer(OAuthAddonSerializer): # Include host information with more informative labels / formatting def serialize_account(self, external_account): - ret = super(DataverseSerializer, self).serialize_account(external_account) + ret = super().serialize_account(external_account) host = external_account.oauth_key ret.update({ 'host': host, - 'host_url': 'https://{0}'.format(host), + 'host_url': f'https://{host}', }) return ret @@ -38,7 +38,7 @@ def serialized_urls(self): addon_urls = self.addon_serialized_urls # Make sure developer returns set of needed urls for url in self.REQUIRED_URLS: - assert url in addon_urls, "addon_serilized_urls must include key '{0}'".format(url) + assert url in addon_urls, f"addon_serilized_urls must include key '{url}'" ret.update(addon_urls) return ret @@ -55,13 +55,13 @@ def addon_serialized_urls(self): 'deauthorize': node.api_url_for('dataverse_deauthorize_node'), 'getDatasets': node.api_url_for('dataverse_get_datasets'), 'datasetPrefix': 'https://doi.org/', - 'dataversePrefix': 'http://{0}/dataverse/'.format(host), + 'dataversePrefix': f'http://{host}/dataverse/', 'accounts': api_url_for('dataverse_account_list'), } @property def serialized_node_settings(self): - result = super(DataverseSerializer, self).serialized_node_settings + result = super().serialized_node_settings result['hosts'] = DEFAULT_HOSTS # Update with Dataverse specific fields diff --git a/addons/dataverse/settings/__init__.py b/addons/dataverse/settings/__init__.py index bce98689d3b..eb5d40c3725 100644 --- a/addons/dataverse/settings/__init__.py +++ b/addons/dataverse/settings/__init__.py @@ -6,4 +6,4 @@ try: from .local import * # noqa except ImportError: - logger.warn('No local.py settings file found') + logger.warning('No local.py settings file found') diff --git a/addons/dataverse/tests/factories.py b/addons/dataverse/tests/factories.py index 2d13177d5fe..6a67eb8fd5c 100644 --- a/addons/dataverse/tests/factories.py +++ b/addons/dataverse/tests/factories.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """Factory boy factories for the Dataverse addon.""" import factory from factory.django import DjangoModelFactory @@ -10,8 +9,8 @@ class DataverseAccountFactory(ExternalAccountFactory): provider = 'dataverse' provider_name = 'Dataverse' - provider_id = factory.Sequence(lambda n: 'id-{0}'.format(n)) - oauth_key = factory.Sequence(lambda n: 'key-{0}'.format(n)) + provider_id = factory.Sequence(lambda n: f'id-{n}') + oauth_key = factory.Sequence(lambda n: f'key-{n}') display_name = 'foo.bar.baz' oauth_secret = 'doremi-abc-123' diff --git a/addons/dataverse/tests/test_client.py b/addons/dataverse/tests/test_client.py index 37835869435..19812d1c8b3 100644 --- a/addons/dataverse/tests/test_client.py +++ b/addons/dataverse/tests/test_client.py @@ -1,8 +1,4 @@ -import mock -from nose.tools import ( - assert_equal, assert_raises, assert_true, - assert_false, assert_in, assert_is, assert_is_none -) +from unittest import mock import pytest import unittest @@ -25,7 +21,7 @@ class TestClient(DataverseAddonTestCase, unittest.TestCase): def setUp(self): - super(TestClient, self).setUp() + super().setUp() self.host = 'some.host.url' self.token = 'some-fancy-api-token-which-is-long' @@ -45,12 +41,12 @@ def test_connect(self, mock_connection): c = _connect(self.host, self.token) mock_connection.assert_called_once_with(self.host, self.token) - assert_true(c) + assert c @mock.patch('addons.dataverse.client.Connection') def test_connect_fail(self, mock_connection): mock_connection.side_effect = UnauthorizedError() - with assert_raises(UnauthorizedError): + with pytest.raises(UnauthorizedError): _connect(self.host, self.token) mock_connection.assert_called_once_with(self.host, self.token) @@ -61,16 +57,16 @@ def test_connect_or_error(self, mock_connection): c = connect_or_error(self.host, self.token) mock_connection.assert_called_once_with(self.host, self.token) - assert_true(c) + assert c @mock.patch('addons.dataverse.client.Connection') def test_connect_or_error_returns_401_when_client_raises_unauthorized_error(self, mock_connection): mock_connection.side_effect = UnauthorizedError() - with assert_raises(HTTPError) as cm: + with pytest.raises(HTTPError) as cm: connect_or_error(self.host, self.token) mock_connection.assert_called_once_with(self.host, self.token) - assert_equal(cm.exception.code, 401) + assert cm.value.code == 401 @mock.patch('addons.dataverse.client._connect') def test_connect_from_settings(self, mock_connect): @@ -80,12 +76,12 @@ def test_connect_from_settings(self, mock_connect): ) connection = connect_from_settings(node_settings) - assert_true(connection) + assert connection mock_connect.assert_called_once_with(self.host, self.token) def test_connect_from_settings_none(self): connection = connect_from_settings(None) - assert_is_none(connection) + assert connection is None @mock.patch('addons.dataverse.client._connect') def test_connect_from_settings_or_401(self, mock_connect): @@ -95,12 +91,12 @@ def test_connect_from_settings_or_401(self, mock_connect): ) connection = connect_from_settings_or_401(node_settings) - assert_true(connection) + assert connection mock_connect.assert_called_once_with(self.host, self.token) def test_connect_from_settings_or_401_none(self): connection = connect_from_settings_or_401(None) - assert_is_none(connection) + assert connection is None @mock.patch('addons.dataverse.client.Connection') def test_connect_from_settings_or_401_forbidden(self, mock_connection): @@ -110,11 +106,11 @@ def test_connect_from_settings_or_401_forbidden(self, mock_connection): self.host, self.token, ) - with assert_raises(HTTPError) as e: + with pytest.raises(HTTPError) as e: connect_from_settings_or_401(node_settings) mock_connection.assert_called_once_with(self.host, self.token) - assert_equal(e.exception.code, 401) + assert e.value.code == 401 def test_get_files(self): published = False @@ -132,11 +128,11 @@ def test_publish_dataset(self): def test_publish_dataset_unpublished_dataverse(self): type(self.mock_dataverse).is_published = mock.PropertyMock(return_value=False) - with assert_raises(HTTPError) as e: + with pytest.raises(HTTPError) as e: publish_dataset(self.mock_dataset) - assert_false(self.mock_dataset.publish.called) - assert_equal(e.exception.code, 405) + assert not self.mock_dataset.publish.called + assert e.value.code == 405 def test_get_datasets(self): mock_dataset1 = mock.create_autospec(Dataset) @@ -150,23 +146,23 @@ def test_get_datasets(self): ] datasets = get_datasets(self.mock_dataverse) - assert_is(self.mock_dataverse.get_datasets.assert_called_once_with(timeout=settings.REQUEST_TIMEOUT), None) - assert_in(mock_dataset1, datasets) - assert_in(mock_dataset2, datasets) - assert_in(mock_dataset3, datasets) + assert self.mock_dataverse.get_datasets.assert_called_once_with(timeout=settings.REQUEST_TIMEOUT) is None + assert mock_dataset1 in datasets + assert mock_dataset2 in datasets + assert mock_dataset3 in datasets def test_get_datasets_no_dataverse(self): datasets = get_datasets(None) - assert_equal(datasets, []) + assert datasets == [] def test_get_dataset(self): self.mock_dataset.get_state.return_value = 'DRAFT' self.mock_dataverse.get_dataset_by_doi.return_value = self.mock_dataset s = get_dataset(self.mock_dataverse, 'My hdl') - assert_is(self.mock_dataverse.get_dataset_by_doi.assert_called_once_with('My hdl', timeout=settings.REQUEST_TIMEOUT), None) + assert self.mock_dataverse.get_dataset_by_doi.assert_called_once_with('My hdl', timeout=settings.REQUEST_TIMEOUT) is None - assert_equal(s, self.mock_dataset) + assert s == self.mock_dataset @mock.patch('dataverse.dataverse.requests') def test_get_dataset_calls_patched_timeout_method(self, mock_requests): @@ -177,30 +173,30 @@ def test_get_dataset_calls_patched_timeout_method(self, mock_requests): dataverse.collection.get.return_value = '123' mock_requests.get.side_effect = Exception('Done Testing') - with assert_raises(Exception) as e: + with pytest.raises(Exception) as e: get_dataset(dataverse, 'My hdl') - assert_is(mock_requests.get.assert_called_once_with('123', auth='me', timeout=settings.REQUEST_TIMEOUT), None) - assert_equal(str(e.exception), 'Done Testing') + assert mock_requests.get.assert_called_once_with('123', auth='me', timeout=settings.REQUEST_TIMEOUT) is None + assert str(e.value) == 'Done Testing' def test_get_deaccessioned_dataset(self): self.mock_dataset.get_state.return_value = 'DEACCESSIONED' self.mock_dataverse.get_dataset_by_doi.return_value = self.mock_dataset - with assert_raises(HTTPError) as e: + with pytest.raises(HTTPError) as e: get_dataset(self.mock_dataverse, 'My hdl') - assert_is(self.mock_dataverse.get_dataset_by_doi.assert_called_once_with('My hdl', timeout=settings.REQUEST_TIMEOUT), None) - assert_equal(e.exception.code, 410) + assert self.mock_dataverse.get_dataset_by_doi.assert_called_once_with('My hdl', timeout=settings.REQUEST_TIMEOUT) is None + assert e.value.code == 410 def test_get_bad_dataset(self): error = UnicodeDecodeError('utf-8', b'', 1, 2, 'jeepers') self.mock_dataset.get_state.side_effect = error self.mock_dataverse.get_dataset_by_doi.return_value = self.mock_dataset - with assert_raises(HTTPError) as e: + with pytest.raises(HTTPError) as e: get_dataset(self.mock_dataverse, 'My hdl') - assert_is(self.mock_dataverse.get_dataset_by_doi.assert_called_once_with('My hdl', timeout=settings.REQUEST_TIMEOUT), None) - assert_equal(e.exception.code, 406) + assert self.mock_dataverse.get_dataset_by_doi.assert_called_once_with('My hdl', timeout=settings.REQUEST_TIMEOUT) is None + assert e.value.code == 406 def test_get_dataverses(self): published_dv = mock.create_autospec(Dataverse) @@ -214,9 +210,9 @@ def test_get_dataverses(self): dvs = get_dataverses(self.mock_connection) self.mock_connection.get_dataverses.assert_called_once_with() - assert_in(published_dv, dvs) - assert_in(unpublished_dv, dvs) - assert_equal(len(dvs), 2) + assert published_dv in dvs + assert unpublished_dv in dvs + assert len(dvs) == 2 def test_get_dataverse(self): type(self.mock_dataverse).is_published = mock.PropertyMock(return_value=True) @@ -225,7 +221,7 @@ def test_get_dataverse(self): d = get_dataverse(self.mock_connection, 'ALIAS') self.mock_connection.get_dataverse.assert_called_once_with('ALIAS') - assert_equal(d, self.mock_dataverse) + assert d == self.mock_dataverse def test_get_unpublished_dataverse(self): type(self.mock_dataverse).is_published = mock.PropertyMock(return_value=False) @@ -234,4 +230,4 @@ def test_get_unpublished_dataverse(self): d = get_dataverse(self.mock_connection, 'ALIAS') self.mock_connection.get_dataverse.assert_called_once_with('ALIAS') - assert_equal(d, self.mock_dataverse) + assert d == self.mock_dataverse diff --git a/addons/dataverse/tests/test_logger.py b/addons/dataverse/tests/test_logger.py index 032ca9c0878..6ff9670e41e 100644 --- a/addons/dataverse/tests/test_logger.py +++ b/addons/dataverse/tests/test_logger.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """NodeLogger tests for the Dataverse addon.""" import pytest @@ -16,10 +15,10 @@ class TestDataverseNodeLogger(StorageAddonNodeLoggerTestSuiteMixin, OsfTestCase) NodeLogger = DataverseNodeLogger def setUp(self): - super(TestDataverseNodeLogger, self).setUp() + super().setUp() node_settings = self.node.get_addon(self.addon_short_name) node_settings.dataset = 'fake dataset' node_settings.save() def tearDown(self): - super(TestDataverseNodeLogger, self).tearDown() + super().tearDown() diff --git a/addons/dataverse/tests/test_model.py b/addons/dataverse/tests/test_model.py index 1c53b57ff5c..6054ea40dac 100644 --- a/addons/dataverse/tests/test_model.py +++ b/addons/dataverse/tests/test_model.py @@ -1,5 +1,4 @@ -from nose.tools import * # noqa -import mock +from unittest import mock import pytest import unittest @@ -45,7 +44,7 @@ def test_does_not_get_copied_to_registrations(self, mock_archive): auth=Auth(user=self.node.creator), draft_registration=DraftRegistrationFactory(branched_from=self.node), ) - assert_false(registration.has_addon('dataverse')) + assert not registration.has_addon('dataverse') ## Overrides ## @@ -59,32 +58,28 @@ def test_create_log(self): metadata={'path': filename, 'materialized': filename}, ) self.node.reload() - assert_equal(self.node.logs.count(), nlog + 1) - assert_equal( - self.node.logs.latest().action, - '{0}_{1}'.format(self.short_name, action), - ) - assert_equal( - self.node.logs.latest().params['filename'], + assert self.node.logs.count() == nlog + 1 + assert self.node.logs.latest().action == \ + f'{self.short_name}_{action}' + assert self.node.logs.latest().params['filename'] == \ filename - ) def test_set_folder(self): dataverse = utils.create_mock_dataverse() dataset = utils.create_mock_dataset() self.node_settings.set_folder(dataverse, dataset, auth=Auth(self.user)) # Folder was set - assert_equal(self.node_settings.folder_id, dataset.id) + assert self.node_settings.folder_id == dataset.id # Log was saved last_log = self.node.logs.latest() - assert_equal(last_log.action, '{0}_dataset_linked'.format(self.short_name)) + assert last_log.action == f'{self.short_name}_dataset_linked' def test_serialize_credentials(self): credentials = self.node_settings.serialize_waterbutler_credentials() - assert_is_not_none(self.node_settings.external_account.oauth_secret) + assert self.node_settings.external_account.oauth_secret is not None expected = {'token': self.node_settings.external_account.oauth_secret} - assert_equal(credentials, expected) + assert credentials == expected def test_serialize_settings(self): settings = self.node_settings.serialize_waterbutler_settings() @@ -94,7 +89,7 @@ def test_serialize_settings(self): 'id': self.node_settings.dataset_id, 'name': self.node_settings.dataset, } - assert_equal(settings, expected) + assert settings == expected class TestUserSettings(OAuthAddonUserSettingTestSuiteMixin, unittest.TestCase): diff --git a/addons/dataverse/tests/test_serializer.py b/addons/dataverse/tests/test_serializer.py index a6b47bb5c13..fa781d6b81f 100644 --- a/addons/dataverse/tests/test_serializer.py +++ b/addons/dataverse/tests/test_serializer.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- -from nose.tools import * # noqa -import mock +from unittest import mock import pytest @@ -25,7 +23,7 @@ class TestDataverseSerializer(OAuthAddonSerializerTestSuiteMixin, OsfTestCase): required_settings_authorized = ('ownerName', ) def setUp(self): - super(TestDataverseSerializer, self).setUp() + super().setUp() self.ser = self.Serializer( user_settings=self.user_settings, node_settings=self.node_settings @@ -36,7 +34,7 @@ def setUp(self): def tearDown(self): self.mock_api.stop() - super(TestDataverseSerializer, self).tearDown() + super().tearDown() def test_serialize_acccount(self): ea = self.ExternalAccountFactory() @@ -49,6 +47,6 @@ def test_serialize_acccount(self): 'profile_url': ea.profile_url, 'nodes': [], 'host': ea.oauth_key, - 'host_url': 'https://{0}'.format(ea.oauth_key), + 'host_url': f'https://{ea.oauth_key}', } - assert_equal(self.ser.serialize_account(ea), expected) + assert self.ser.serialize_account(ea) == expected diff --git a/addons/dataverse/tests/test_utils.py b/addons/dataverse/tests/test_utils.py index 35f47278b18..2e230c9dffa 100644 --- a/addons/dataverse/tests/test_utils.py +++ b/addons/dataverse/tests/test_utils.py @@ -1,13 +1,13 @@ -from nose.tools import ( - assert_equal, assert_true, assert_false, assert_is_instance -) import pytest from dataverse import Dataverse, Dataset, DataverseFile from addons.dataverse.tests.utils import ( - create_mock_dataverse, create_mock_dataset, create_mock_draft_file, - create_mock_connection, DataverseAddonTestCase, + create_mock_dataverse, + create_mock_dataset, + create_mock_draft_file, + create_mock_connection, + DataverseAddonTestCase, ) pytestmark = pytest.mark.django_db @@ -17,45 +17,43 @@ class TestUtils(DataverseAddonTestCase): def test_mock_connection(self): mock_connection = create_mock_connection() - assert_equal(mock_connection.token, 'snowman-frosty') - assert_equal(len(mock_connection.get_dataverses()), 3) - assert_is_instance(mock_connection.get_dataverses()[0], Dataverse) - assert_equal( - mock_connection.get_dataverse(mock_connection.get_dataverses()[1].alias), - mock_connection.get_dataverses()[1], + assert mock_connection.token == 'snowman-frosty' + assert len(mock_connection.get_dataverses()) == 3 + assert isinstance(mock_connection.get_dataverses()[0], Dataverse) + assert ( + mock_connection.get_dataverse(mock_connection.get_dataverses()[1].alias) + == mock_connection.get_dataverses()[1] ) def test_mock_dataverse(self): mock_dv = create_mock_dataverse('Example 1') - assert_equal(mock_dv.title, 'Example 1') - assert_true(mock_dv.is_published) - assert_equal(mock_dv.alias, 'ALIAS1') - assert_equal(len(mock_dv.get_datasets()), 3) - assert_is_instance(mock_dv.get_datasets()[0], Dataset) - assert_equal(mock_dv.get_dataset_by_doi(mock_dv.get_datasets()[1].doi), - mock_dv.get_datasets()[1]) + assert mock_dv.title == 'Example 1' + assert mock_dv.is_published + assert mock_dv.alias == 'ALIAS1' + assert len(mock_dv.get_datasets()) == 3 + assert isinstance(mock_dv.get_datasets()[0], Dataset) + assert mock_dv.get_dataset_by_doi(mock_dv.get_datasets()[1].doi) == mock_dv.get_datasets()[1] def test_mock_dataset(self): dataset_id = 'DVN/23456' - doi = 'doi:12.3456/{0}'.format(dataset_id) + doi = f'doi:12.3456/{dataset_id}' mock_dataset = create_mock_dataset(dataset_id) - assert_equal(mock_dataset.doi, doi) - assert_equal(mock_dataset.citation, - 'Example Citation for {0}'.format(dataset_id)) - assert_equal(mock_dataset.title, 'Example ({0})'.format(dataset_id)) - assert_equal(mock_dataset.doi, doi) - assert_equal(mock_dataset.get_state(), 'DRAFT') - assert_equal(len(mock_dataset.get_files()), 1) - assert_false(mock_dataset.get_files()[0].is_published) - assert_true(mock_dataset.get_files(published=True)[0].is_published) - assert_false(mock_dataset.get_file('name.txt').is_published) - assert_true(mock_dataset.get_file('name.txt', published=True).is_published) - assert_false(mock_dataset.get_file_by_id('123').is_published) - assert_true(mock_dataset.get_file_by_id('123', published=True).is_published) + assert mock_dataset.doi == doi + assert mock_dataset.citation == f'Example Citation for {dataset_id}' + assert mock_dataset.title == f'Example ({dataset_id})' + assert mock_dataset.doi == doi + assert mock_dataset.get_state() == 'DRAFT' + assert len(mock_dataset.get_files()) == 1 + assert not mock_dataset.get_files()[0].is_published + assert mock_dataset.get_files(published=True)[0].is_published + assert not mock_dataset.get_file('name.txt').is_published + assert mock_dataset.get_file('name.txt', published=True).is_published + assert not mock_dataset.get_file_by_id('123').is_published + assert mock_dataset.get_file_by_id('123', published=True).is_published def test_mock_dvn_file(self): fid = '65432' mock_file = create_mock_draft_file(fid) - assert_equal(mock_file.name, 'file.txt') - assert_equal(mock_file.id, fid) - assert_is_instance(mock_file, DataverseFile) + assert mock_file.name == 'file.txt' + assert mock_file.id == fid + assert isinstance(mock_file, DataverseFile) diff --git a/addons/dataverse/tests/test_views.py b/addons/dataverse/tests/test_views.py index bcf7e6ef1ca..e6c1faabf4d 100644 --- a/addons/dataverse/tests/test_views.py +++ b/addons/dataverse/tests/test_views.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- -from nose.tools import (assert_false, assert_equal, assert_in, assert_true) -import mock +from unittest import mock import pytest import unittest @@ -28,19 +26,19 @@ def test_deauthorize(self): self.app.delete(url, auth=self.user.auth) self.node_settings.reload() - assert_false(self.node_settings.dataverse_alias) - assert_false(self.node_settings.dataverse) - assert_false(self.node_settings.dataset_doi) - assert_false(self.node_settings.dataset) - assert_false(self.node_settings.user_settings) + assert not self.node_settings.dataverse_alias + assert not self.node_settings.dataverse + assert not self.node_settings.dataset_doi + assert not self.node_settings.dataset + assert not self.node_settings.user_settings # Log states that node was deauthorized self.project.reload() last_log = self.project.logs.latest() - assert_equal(last_log.action, 'dataverse_node_deauthorized') + assert last_log.action == 'dataverse_node_deauthorized' log_params = last_log.params - assert_equal(log_params['node'], self.project._primary_key) - assert_equal(log_params['project'], None) + assert log_params['node'] == self.project._primary_key + assert log_params['project'] is None def test_user_config_get(self): url = api_url_for('dataverse_user_config_get') @@ -48,9 +46,9 @@ def test_user_config_get(self): res = self.app.get(url, auth=new_user.auth) result = res.json.get('result') - assert_false(result['userHasAuth']) - assert_in('hosts', result) - assert_in('create', result['urls']) + assert not result['userHasAuth'] + assert 'hosts' in result + assert 'create' in result['urls'] # userHasAuth is true with external accounts new_user.external_accounts.add(create_external_account()) @@ -58,7 +56,7 @@ def test_user_config_get(self): res = self.app.get(url, auth=self.user.auth) result = res.json.get('result') - assert_true(result['userHasAuth']) + assert result['userHasAuth'] class TestConfigViews(DataverseAddonTestCase, OAuthAddonConfigViewsTestCaseMixin, OsfTestCase): connection = create_mock_connection() @@ -66,14 +64,14 @@ class TestConfigViews(DataverseAddonTestCase, OAuthAddonConfigViewsTestCaseMixin client = DataverseProvider def setUp(self): - super(TestConfigViews, self).setUp() + super().setUp() self.mock_ser_api = mock.patch('addons.dataverse.serializer.client.connect_from_settings') self.mock_ser_api.return_value = create_mock_connection() self.mock_ser_api.start() def tearDown(self): self.mock_ser_api.stop() - super(TestConfigViews, self).tearDown() + super().tearDown() @mock.patch('addons.dataverse.views.client.connect_from_settings') def test_folder_list(self, mock_connection): @@ -82,42 +80,40 @@ def test_folder_list(self, mock_connection): url = api_url_for('dataverse_get_datasets', pid=self.project._primary_key) params = {'alias': 'ALIAS1'} - res = self.app.post_json(url, params, auth=self.user.auth) + res = self.app.post(url, json=params, auth=self.user.auth) - assert_equal(len(res.json['datasets']), 3) + assert len(res.json['datasets']) == 3 first = res.json['datasets'][0] - assert_equal(first['title'], 'Example (DVN/00001)') - assert_equal(first['doi'], 'doi:12.3456/DVN/00001') + assert first['title'] == 'Example (DVN/00001)' + assert first['doi'] == 'doi:12.3456/DVN/00001' @mock.patch('addons.dataverse.views.client.connect_from_settings') def test_set_config(self, mock_connection): mock_connection.return_value = self.connection - url = self.project.api_url_for('{0}_set_config'.format(self.ADDON_SHORT_NAME)) - res = self.app.post_json(url, { + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_set_config') + res = self.app.post(url, json={ 'dataverse': {'alias': 'ALIAS3'}, 'dataset': {'doi': 'doi:12.3456/DVN/00003'}, }, auth=self.user.auth) - assert_equal(res.status_code, http_status.HTTP_200_OK) + assert res.status_code == http_status.HTTP_200_OK self.project.reload() - assert_equal( - self.project.logs.latest().action, - '{0}_dataset_linked'.format(self.ADDON_SHORT_NAME) - ) - assert_equal(res.json['dataverse'], self.connection.get_dataverse('ALIAS3').title) - assert_equal(res.json['dataset'], - self.connection.get_dataverse('ALIAS3').get_dataset_by_doi('doi:12.3456/DVN/00003').title) + assert self.project.logs.latest().action == \ + f'{self.ADDON_SHORT_NAME}_dataset_linked' + assert res.json['dataverse'] == self.connection.get_dataverse('ALIAS3').title + assert res.json['dataset'] == \ + self.connection.get_dataverse('ALIAS3').get_dataset_by_doi('doi:12.3456/DVN/00003').title def test_get_config(self): - url = self.project.api_url_for('{0}_get_config'.format(self.ADDON_SHORT_NAME)) + url = self.project.api_url_for(f'{self.ADDON_SHORT_NAME}_get_config') res = self.app.get(url, auth=self.user.auth) - assert_equal(res.status_code, http_status.HTTP_200_OK) - assert_in('result', res.json) + assert res.status_code == http_status.HTTP_200_OK + assert 'result' in res.json serialized = self.Serializer().serialize_settings( self.node_settings, self.user, ) - assert_equal(serialized, res.json['result']) + assert serialized == res.json['result'] @mock.patch('addons.dataverse.views.client.connect_from_settings') def test_set_config_no_dataset(self, mock_connection): @@ -132,19 +128,18 @@ def test_set_config_no_dataset(self, mock_connection): } # Select a different dataset - res = self.app.post_json(url, params, auth=self.user.auth, - expect_errors=True) + res = self.app.post(url, json=params, auth=self.user.auth) self.node_settings.reload() # Old settings did not change - assert_equal(res.status_code, http_status.HTTP_400_BAD_REQUEST) - assert_equal(self.node_settings.dataverse_alias, 'ALIAS2') - assert_equal(self.node_settings.dataset, 'Example (DVN/00001)') - assert_equal(self.node_settings.dataset_doi, 'doi:12.3456/DVN/00001') + assert res.status_code == http_status.HTTP_400_BAD_REQUEST + assert self.node_settings.dataverse_alias == 'ALIAS2' + assert self.node_settings.dataset == 'Example (DVN/00001)' + assert self.node_settings.dataset_doi == 'doi:12.3456/DVN/00001' # Nothing was logged self.project.reload() - assert_equal(self.project.logs.count(), num_old_logs) + assert self.project.logs.count() == num_old_logs class TestHgridViews(DataverseAddonTestCase, OsfTestCase, unittest.TestCase): @@ -175,16 +170,16 @@ def test_dataverse_root_published(self, mock_files, mock_connection, mock_text): # Contributor can select between states, current state is correct res = self.app.get(url, auth=self.user.auth) - assert_true(res.json[0]['permissions']['edit']) - assert_true(res.json[0]['hasPublishedFiles']) - assert_equal(res.json[0]['version'], 'latest-published') + assert res.json[0]['permissions']['edit'] + assert res.json[0]['hasPublishedFiles'] + assert res.json[0]['version'] == 'latest-published' # Non-contributor gets published version, no options user2 = AuthUserFactory() res = self.app.get(url, auth=user2.auth) - assert_false(res.json[0]['permissions']['edit']) - assert_true(res.json[0]['hasPublishedFiles']) - assert_equal(res.json[0]['version'], 'latest-published') + assert not res.json[0]['permissions']['edit'] + assert res.json[0]['hasPublishedFiles'] + assert res.json[0]['version'] == 'latest-published' @mock.patch('addons.dataverse.views.client.get_custom_publish_text') @mock.patch('addons.dataverse.views.client.connect_from_settings') @@ -212,14 +207,14 @@ def test_dataverse_root_not_published(self, mock_files, mock_connection, mock_te # Contributor gets draft, no options res = self.app.get(url, auth=self.user.auth) - assert_true(res.json[0]['permissions']['edit']) - assert_false(res.json[0]['hasPublishedFiles']) - assert_equal(res.json[0]['version'], 'latest') + assert res.json[0]['permissions']['edit'] + assert not res.json[0]['hasPublishedFiles'] + assert res.json[0]['version'] == 'latest' # Non-contributor gets nothing user2 = AuthUserFactory() res = self.app.get(url, auth=user2.auth) - assert_equal(res.json, []) + assert res.json == [] @mock.patch('addons.dataverse.views.client.connect_from_settings') @mock.patch('addons.dataverse.views.client.get_files') @@ -232,7 +227,7 @@ def test_dataverse_root_no_connection(self, mock_files, mock_connection): mock_connection.return_value = None res = self.app.get(url, auth=self.user.auth) - assert_equal(res.json, []) + assert res.json == [] def test_dataverse_root_incomplete(self): self.node_settings.dataset_doi = None @@ -242,7 +237,7 @@ def test_dataverse_root_incomplete(self): pid=self.project._primary_key) res = self.app.get(url, auth=self.user.auth) - assert_equal(res.json, []) + assert res.json == [] class TestCrudViews(DataverseAddonTestCase, OsfTestCase, unittest.TestCase): @@ -255,11 +250,11 @@ def test_dataverse_publish_dataset(self, mock_publish_dv, mock_publish_ds, mock_ url = api_url_for('dataverse_publish_dataset', pid=self.project._primary_key) - self.app.put_json(url, params={'publish_both': False}, auth=self.user.auth) + self.app.put(url, json={'publish_both': False}, auth=self.user.auth) # Only dataset was published - assert_false(mock_publish_dv.called) - assert_true(mock_publish_ds.called) + assert not mock_publish_dv.called + assert mock_publish_ds.called @mock.patch('addons.dataverse.views.client.connect_from_settings_or_401') @mock.patch('addons.dataverse.views.client.publish_dataset') @@ -269,11 +264,11 @@ def test_dataverse_publish_both(self, mock_publish_dv, mock_publish_ds, mock_con url = api_url_for('dataverse_publish_dataset', pid=self.project._primary_key) - self.app.put_json(url, params={'publish_both': True}, auth=self.user.auth) + self.app.put(url, json={'publish_both': True}, auth=self.user.auth) # Both Dataverse and dataset were published - assert_true(mock_publish_dv.called) - assert_true(mock_publish_ds.called) + assert mock_publish_dv.called + assert mock_publish_ds.called class TestDataverseRestrictions(DataverseAddonTestCase, OsfTestCase): @@ -301,6 +296,5 @@ def test_restricted_set_dataset_not_owner(self, mock_connection): 'dataverse': {'alias': 'ALIAS1'}, 'dataset': {'doi': 'doi:12.3456/DVN/00002'}, } - res = self.app.post_json(url, params, auth=self.contrib.auth, - expect_errors=True) - assert_equal(res.status_code, http_status.HTTP_403_FORBIDDEN) + res = self.app.post(url, json=params, auth=self.contrib.auth) + assert res.status_code == http_status.HTTP_403_FORBIDDEN diff --git a/addons/dataverse/tests/utils.py b/addons/dataverse/tests/utils.py index af64882cc2f..349fdc25a57 100644 --- a/addons/dataverse/tests/utils.py +++ b/addons/dataverse/tests/utils.py @@ -1,4 +1,4 @@ -import mock +from unittest import mock from dataverse import Connection, Dataverse, Dataset, DataverseFile @@ -14,7 +14,7 @@ class DataverseAddonTestCase(OAuthAddonTestCaseMixin, AddonTestCase): Provider = DataverseProvider def set_node_settings(self, settings): - super(DataverseAddonTestCase, self).set_node_settings(settings) + super().set_node_settings(settings) settings.dataverse_alias = 'ALIAS2' settings.dataverse = 'Example 2' settings.dataset_doi = 'doi:12.3456/DVN/00001' @@ -85,7 +85,7 @@ def create_mock_dataverse(title='Example Dataverse 0'): type(mock_dataverse).title = mock.PropertyMock(return_value=title) type(mock_dataverse).is_published = mock.PropertyMock(return_value=True) type(mock_dataverse).alias = mock.PropertyMock( - return_value='ALIAS{}'.format(title[-1]) + return_value=f'ALIAS{title[-1]}' ) mock_dataverse.get_datasets.return_value = [ @@ -110,9 +110,9 @@ def _get_dataset_by_doi(doi, timeout=None): def create_mock_dataset(id='DVN/12345'): mock_dataset = mock.create_autospec(Dataset) - mock_dataset.citation = 'Example Citation for {0}'.format(id) - mock_dataset.title = 'Example ({0})'.format(id) - mock_dataset.doi = 'doi:12.3456/{0}'.format(id) + mock_dataset.citation = f'Example Citation for {id}' + mock_dataset.title = f'Example ({id})' + mock_dataset.doi = f'doi:12.3456/{id}' mock_dataset.id = '18' mock_dataset.get_state.return_value = 'DRAFT' @@ -150,16 +150,16 @@ def create_mock_published_file(id='54321'): mock_responses = { 'contents': { - u'kind': u'item', - u'name': u'file.txt', - u'ext': u'.txt', - u'file_id': u'54321', - u'urls': {u'download': u'/project/xxxxx/dataverse/file/54321/download/', - u'delete': u'/api/v1/project/xxxxx/dataverse/file/54321/', - u'view': u'/project/xxxxx/dataverse/file/54321/'}, - u'permissions': {u'edit': False, u'view': True}, - u'addon': u'dataverse', - u'hasPublishedFiles': True, - u'state': 'published', + 'kind': 'item', + 'name': 'file.txt', + 'ext': '.txt', + 'file_id': '54321', + 'urls': {'download': '/project/xxxxx/dataverse/file/54321/download/', + 'delete': '/api/v1/project/xxxxx/dataverse/file/54321/', + 'view': '/project/xxxxx/dataverse/file/54321/'}, + 'permissions': {'edit': False, 'view': True}, + 'addon': 'dataverse', + 'hasPublishedFiles': True, + 'state': 'published', } } diff --git a/addons/dataverse/views.py b/addons/dataverse/views.py index a3d5e24834f..9b549e6de9b 100644 --- a/addons/dataverse/views.py +++ b/addons/dataverse/views.py @@ -1,5 +1,4 @@ """Views for the node settings page.""" -# -*- coding: utf-8 -*- from rest_framework import status as http_status from django.utils import timezone @@ -312,7 +311,7 @@ def dataverse_get_widget_contents(node_addon, **kwargs): return {'data': data}, http_status.HTTP_400_BAD_REQUEST dataverse_host = node_addon.external_account.oauth_key - dataverse_url = 'http://{0}/dataverse/{1}'.format(dataverse_host, alias) + dataverse_url = f'http://{dataverse_host}/dataverse/{alias}' dataset_url = 'https://doi.org/' + doi data.update({ diff --git a/addons/dropbox/__init__.py b/addons/dropbox/__init__.py index a8685d3c977..e69de29bb2d 100644 --- a/addons/dropbox/__init__.py +++ b/addons/dropbox/__init__.py @@ -1 +0,0 @@ -default_app_config = 'addons.dropbox.apps.DropboxAddonAppConfig' diff --git a/addons/dropbox/apps.py b/addons/dropbox/apps.py index 9b8c26bafe8..07ec04355d2 100644 --- a/addons/dropbox/apps.py +++ b/addons/dropbox/apps.py @@ -4,8 +4,10 @@ dropbox_root_folder = generic_root_folder('dropbox') + class DropboxAddonAppConfig(BaseAddonAppConfig): + default = True name = 'addons.dropbox' label = 'addons_dropbox' full_name = 'Dropbox' diff --git a/addons/dropbox/migrations/0001_initial.py b/addons/dropbox/migrations/0001_initial.py index f62db239046..43f59b49b24 100644 --- a/addons/dropbox/migrations/0001_initial.py +++ b/addons/dropbox/migrations/0001_initial.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- # Generated by Django 1.11.29 on 2022-08-17 19:15 -from __future__ import unicode_literals import addons.base.models from django.db import migrations, models diff --git a/addons/dropbox/migrations/0002_auto_20220817_1915.py b/addons/dropbox/migrations/0002_auto_20220817_1915.py index 1de073e684c..bd2981d90e8 100644 --- a/addons/dropbox/migrations/0002_auto_20220817_1915.py +++ b/addons/dropbox/migrations/0002_auto_20220817_1915.py @@ -1,6 +1,4 @@ -# -*- coding: utf-8 -*- # Generated by Django 1.11.29 on 2022-08-17 19:15 -from __future__ import unicode_literals from django.conf import settings from django.db import migrations, models diff --git a/addons/dropbox/migrations/0003_alter_nodesettings_external_account_and_more.py b/addons/dropbox/migrations/0003_alter_nodesettings_external_account_and_more.py new file mode 100644 index 00000000000..e1ed18415e5 --- /dev/null +++ b/addons/dropbox/migrations/0003_alter_nodesettings_external_account_and_more.py @@ -0,0 +1,32 @@ +# Generated by Django 4.2.13 on 2024-07-15 13:46 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('osf', '0021_preprint_custom_publication_citation'), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('addons_dropbox', '0002_auto_20220817_1915'), + ] + + operations = [ + migrations.AlterField( + model_name='nodesettings', + name='external_account', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.externalaccount'), + ), + migrations.AlterField( + model_name='nodesettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_node_settings', to='osf.abstractnode'), + ), + migrations.AlterField( + model_name='usersettings', + name='owner', + field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='%(app_label)s_user_settings', to=settings.AUTH_USER_MODEL), + ), + ] diff --git a/addons/dropbox/models.py b/addons/dropbox/models.py index 05a7e6797ad..d28d761dcd9 100644 --- a/addons/dropbox/models.py +++ b/addons/dropbox/models.py @@ -5,7 +5,7 @@ from addons.base.models import (BaseOAuthNodeSettings, BaseOAuthUserSettings, BaseStorageAddon) from django.db import models -from dropbox.dropbox import Dropbox +from dropbox import Dropbox from dropbox.exceptions import ApiError, DropboxException from dropbox.files import FolderMetadata from furl import furl @@ -55,7 +55,7 @@ class Provider(ExternalProvider): def auth_url(self): # Dropbox requires explicitly requesting refresh_tokens via `token_access_type` # https://developers.dropbox.com/oauth-guide#implementing-oauth - url = super(Provider, self).auth_url + url = super().auth_url return furl(url).add({'token_access_type': 'offline'}).url def handle_callback(self, response): @@ -122,7 +122,7 @@ def folder_path(self): @property def display_name(self): - return '{0}: {1}'.format(self.config.full_name, self.folder) + return f'{self.config.full_name}: {self.folder}' def fetch_access_token(self): return self.api.fetch_access_token() @@ -140,9 +140,7 @@ def get_folders(self, **kwargs): 'kind': 'folder', 'name': '/ (Full Dropbox)', 'urls': { - 'folders': api_v2_url('nodes/{}/addons/dropbox/folders/'.format(self.owner._id), - params={'id': '/'} - ) + 'folders': api_v2_url(f'nodes/{self.owner._id}/addons/dropbox/folders/', params={'id': '/'}) } }] @@ -171,8 +169,8 @@ def get_folders(self, **kwargs): 'name': item.path_display.split('/')[-1], 'path': item.path_display, 'urls': { - 'folders': api_v2_url('nodes/{}/addons/dropbox/folders/'.format(self.owner._id), - params={'id': item.path_display} + 'folders': api_v2_url( + f'nodes/{self.owner._id}/addons/dropbox/folders/', params={'id': item.path_display} ) } } @@ -207,12 +205,13 @@ def serialize_waterbutler_settings(self): return {'folder': self.folder} def create_waterbutler_log(self, auth, action, metadata): - url = self.owner.web_url_for('addon_view_or_download_file', + url = self.owner.web_url_for( + 'addon_view_or_download_file', path=metadata['path'].strip('/'), provider='dropbox' ) self.owner.add_log( - 'dropbox_{0}'.format(action), + f'dropbox_{action}', auth=auth, params={ 'project': self.owner.parent_id, @@ -227,7 +226,7 @@ def create_waterbutler_log(self, auth, action, metadata): ) def __repr__(self): - return u'