Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added file metadata tests #265

Merged
merged 16 commits into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
123 changes: 123 additions & 0 deletions api/osf_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1050,3 +1050,126 @@ def get_project_node_analytics_data(session, node_id=None, timespan='week'):
url = '_/metrics/query/node_analytics/{}/{}/'.format(node_id, timespan)
data = session.get(url)['data']
return data or None


def get_fake_file_guid(session, file_id):

url = '/v2/files' + file_id
data = session.get(url=url)
file_guid = data['data']['attributes']['guid']
return file_guid


def get_existing_file_data(session, node_id=settings.PREFERRED_NODE):
"""Return the id of the first file in OSFStorage on a given node.
Uploads a new file if one does not exist.
"""
node = client.Node(session=session, id=node_id)
node.get()
files_url = node.relationships.files['links']['related']['href']
data = session.get(files_url + 'osfstorage/')
name = data['data'][0]['attributes']['name']
return name, data


def update_custom_project_metadata(session, node_id):
"""Updates project metadata fields resource_type and
resource_language and support funder info with custom values"""
url = 'v2/custom_item_metadata_records/{}/'.format(node_id)
raw_payload = {
'data': {
'id': node_id,
'type': 'custom-item-metadata-records',
'attributes': {
'language': 'eng',
'resource_type_general': 'Collection',
},
}
}
session.put(url=url, raw_body=json.dumps(raw_payload))


def delete_project_contributor(session, node_id, user_name):
cslzchen marked this conversation as resolved.
Show resolved Hide resolved
"""This method deletes the given contributor
from contributors list for the given project guid"""

url = '/v2/nodes/{}/contributors/'.format(node_id)
data = session.get(url)['data']

for i in range(0, len(data)):
if data[i]['embeds']['users']['data']['attributes']['full_name'] == user_name:
user_id = data[i]['embeds']['users']['data']['id']
delete_url = '/v2/nodes/{}/contributors/{}/'.format(node_id, user_id)
session.delete(delete_url, item_type='users')
break


def get_most_recent_registration_node_id_by_user(user_name, registration_card):
"""Return the most recently approved public registration
node id by the given user and having the title as given in registration_card
"""
session = client.Session(
api_base_url=settings.API_DOMAIN,
auth=(settings.REGISTRATIONS_USER, settings.REGISTRATIONS_USER_PASSWORD),
)
url = '/v2/registrations/?filter[title][icontains]=selenium'
cslzchen marked this conversation as resolved.
Show resolved Hide resolved
data = session.get(url)['data']
if data:
for registration in data:
if registration['attributes']['title'] == registration_card:
return registration['id']

return None


def update_registration_metadata_with_custom_data(registration_id):
"""Updates project metadata fields resource_type and
resource_language and support funder info with custom values"""
session = client.Session(
api_base_url=settings.API_DOMAIN,
auth=(settings.REGISTRATIONS_USER, settings.REGISTRATIONS_USER_PASSWORD),
)
url = 'v2/custom_item_metadata_records/{}/'.format(registration_id)
raw_payload = {
'data': {
'id': registration_id,
'type': 'custom-item-metadata-records',
'attributes': {
'language': 'eng',
'resource_type_general': 'Collection',
},
}
}
session.patch(
url=url,
raw_body=json.dumps(raw_payload),
item_type='registrations',
item_id=registration_id,
)


def get_funder_data_project(session, project_guid):
"""Returns the funder name for a project/registration
if project/registration already has funder information data
otherwise returns none"""

url = 'v2/custom_item_metadata_records/{}/'.format(project_guid)
data = session.get(url)['data']
if not data['attributes']['funders']:
return None
return data['attributes']['funders'][0]['funder_name']


def get_funder_data_registration(registration_guid):
"""Returns the funder name for a project/registration
if project/registration already has funder information data
otherwise returns none"""
session = client.Session(
api_base_url=settings.API_DOMAIN,
auth=(settings.REGISTRATIONS_USER, settings.REGISTRATIONS_USER_PASSWORD),
)
url = 'v2/custom_item_metadata_records/{}/'.format(registration_guid)
data = session.get(url)['data']
if not data['attributes']['funders']:
return None
return data['attributes']['funders'][0]['funder_name']
128 changes: 128 additions & 0 deletions pages/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -490,3 +490,131 @@ class RegistrationsPage(GuidBasePage):
delete_draft_registration_modal = ComponentLocator(
ConfirmDeleteDraftRegistrationModal
)


class FilesMetadataPage(GuidBasePage):

base_url = settings.OSF_HOME + '/{guid}'

identity = Locator(By.CSS_SELECTOR, '[data-test-filename]', settings.LONG_TIMEOUT)
heading = Locator(By.CSS_SELECTOR, '[h2._metadata-heading_oqi4qj]')
files_metadata_edit_button = Locator(
By.CSS_SELECTOR, '[data-test-edit-metadata-button]'
)
files_metadata_download_button = Locator(
By.CSS_SELECTOR, '[svg.svg-inline--fa.fa-download]'
)
files_metadata_title = Locator(By.CSS_SELECTOR, '[data-test-file-title]')
files_metadata_description = Locator(
By.CSS_SELECTOR, '[data-test-file-description]'
)
files_metadata_resource_type = Locator(
By.CSS_SELECTOR, '[data-test-file-resource-type]'
)
files_metadata_resource_language = Locator(
By.CSS_SELECTOR, '[data-test-file-language]'
)

files_metadata_edit_identity = Locator(
By.CSS_SELECTOR, '[div._metadata-pane_gdsp72]'
)
edit_title = Locator(By.CSS_SELECTOR, '[data-test-title-field]')
title_input = Locator(By.CSS_SELECTOR, '[data-test-title-field] textarea')
edit_description = Locator(By.CSS_SELECTOR, '[data-test-description-field]')
description_input = Locator(
By.CSS_SELECTOR,
'[textarea#ember148__title.ember-text-area.ember-view.form-control]',
)
resource_type = Locator(By.CSS_SELECTOR, '[data-test-select-resource-type]')

resource_language = Locator(By.CSS_SELECTOR, '[data-test-select-resource-language]')
dropdown_options = GroupLocator(
By.CSS_SELECTOR,
'#ember-basic-dropdown-wormhole > div > ul > li>span',
)

def select_from_dropdown_listbox(self, selection):
for option in self.dropdown_options:
if option.text == selection:
option.click()
break

cancel_editing_button = Locator(
By.CSS_SELECTOR, '[data-test-cancel-editing-metadata-button]'
)
save_metadata_button = Locator(By.CSS_SELECTOR, '[data-test-save-metadata-button]')


class ProjectMetadataPage(GuidBasePage):
base_url = settings.OSF_HOME + '/{guid}/metadata/osf'

identity = Locator(
By.CSS_SELECTOR, '[data-test-metadata-header]', settings.LONG_TIMEOUT
)
description = Locator(By.CSS_SELECTOR, '[data-test-display-node-description]')
save_description_button = Locator(
By.CSS_SELECTOR, '[data-test-save-node-description-button]'
)
cancel_description_button = Locator(
By.CSS_SELECTOR, '[data-test-cancel-editing-node-description-button]'
)
contributors_list = Locator(By.CSS_SELECTOR, '[data-test-contributor-name]')
edit_contributors_button = Locator(By.CSS_SELECTOR, '[data-test-edit-contributors]')
add_contributor_button = Locator(
By.CSS_SELECTOR, 'a.btn.btn-success.btn-sm.m-l-md[href="#addContributors"]'
)
contributor_search_button = Locator(By.XPATH, '//input[@class="btn btn-default"]')
add_displayed_contributor_button = Locator(
By.CSS_SELECTOR, '[a.btn.btn-success.contrib-button.btn-mini]'
)
search_input = Locator(By.XPATH, '//input[@class="form-control"]')
resource_type = Locator(
By.CSS_SELECTOR, '[data-test-display-resource-type-general]'
)
resource_language = Locator(
By.CSS_SELECTOR, '[data-test-display-resource-language]'
)
resource_type_dropdown = Locator(
By.CSS_SELECTOR, '[data-test-select-resource-type]'
)
resource_language_dropdown = Locator(
By.CSS_SELECTOR, '[data-test-select-resource-language]'
)

dropdown_options = GroupLocator(
By.CSS_SELECTOR,
'#ember-basic-dropdown-wormhole > div > ul > li>span',
)

def select_from_dropdown_listbox(self, selection):
for option in self.dropdown_options:
if option.text == selection:
option.click()
break

resource_information_save_button = Locator(
By.CSS_SELECTOR, '[data-test-save-resource-metadata-button]'
)

funder_name = Locator(By.XPATH, '//span[@class="ember-power-select-status-icon"]')
funder_name_search_input = Locator(
By.XPATH, '//input[@class="ember-power-select-search-input"]'
)
award_title = Locator(By.XPATH, '//input[@name="award_title"]')
award_info_URI = Locator(By.XPATH, '//input[@name="award_uri"]')
award_number = Locator(By.XPATH, '//input[@name="award_number"]')
add_funder_button = Locator(By.XPATH, '//button[text()="Add funder"]')
delete_funder_button = Locator(By.XPATH, '//button[text()="Delete funder"][2]')
save_funder_info_button = Locator(
By.CSS_SELECTOR, '[data-test-save-funding-metadata-button]'
)
display_funder_name = Locator(By.CSS_SELECTOR, '[data-test-display-funder-name]')
display_award_title = Locator(
By.CSS_SELECTOR, '[data-test-display-funder-award-title]'
)
display_award_number = Locator(
By.CSS_SELECTOR, '[data-test-display-funder-award-number]'
)
dispaly_award_info_uri = Locator(
By.CSS_SELECTOR, '[data-test-display-funder-award-uri]'
)
65 changes: 65 additions & 0 deletions pages/registries.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,71 @@ class RegistrationMetadataPage(BaseSubmittedRegistrationPage):
url_addition = 'metadata'
identity = Locator(By.CSS_SELECTOR, '[data-test-display-resource-type-general]')

metadata_description = Locator(
By.CSS_SELECTOR, '[data-test-display-node-description]'
)
edit_metadata_description_button = Locator(
By.CSS_SELECTOR, '[data-test-edit-node-description-button]'
)
save_metadata_description_button = Locator(
By.CSS_SELECTOR, '[data-test-save-node-description-button]'
)
contributors_list = Locator(By.CSS_SELECTOR, '[data-test-contributors-list]')
contributor_search_button = Locator(By.XPATH, '//input[@class="btn btn-default"]')
add_displayed_contributor_button = Locator(
By.CSS_SELECTOR, '[a.btn.btn-success.contrib-button.btn-mini]'
)
search_input = Locator(By.XPATH, '//input[@class="form-control"]')
resource_type = Locator(
By.CSS_SELECTOR, '[data-test-display-resource-type-general]'
)
resource_language = Locator(
By.CSS_SELECTOR, '[data-test-display-resource-language]'
)
resource_type_dropdown = Locator(
By.CSS_SELECTOR, '[data-test-select-resource-type]'
)
resource_language_dropdown = Locator(
By.CSS_SELECTOR, '[data-test-select-resource-language]'
)

dropdown_options = GroupLocator(
By.CSS_SELECTOR,
'#ember-basic-dropdown-wormhole > div > ul > li>span',
)

def select_from_dropdown_listbox(self, selection):
for option in self.dropdown_options:
if option.text == selection:
option.click()
break

resource_information_save_button = Locator(
By.CSS_SELECTOR, '[data-test-save-resource-metadata-button]'
)
funder_name = Locator(By.XPATH, '//span[@class="ember-power-select-status-icon"]')
funder_name_search_input = Locator(
By.XPATH, '//input[@class="ember-power-select-search-input"]'
)
award_title = Locator(By.XPATH, '//input[@name="award_title"]')
award_info_URI = Locator(By.XPATH, '//input[@name="award_uri"]')
award_number = Locator(By.XPATH, '//input[@name="award_number"]')
add_funder_button = Locator(By.XPATH, '//button[text()="Add funder"]')
delete_funder_button = Locator(By.XPATH, '//button[text()="Delete funder"][2]')
save_funder_info_button = Locator(
By.CSS_SELECTOR, '[data-test-save-funding-metadata-button]'
)
display_funder_name = Locator(By.CSS_SELECTOR, '[data-test-display-funder-name]')
display_award_title = Locator(
By.CSS_SELECTOR, '[data-test-display-funder-award-title]'
)
display_award_number = Locator(
By.CSS_SELECTOR, '[data-test-display-funder-award-number]'
)
dispaly_award_info_uri = Locator(
By.CSS_SELECTOR, '[data-test-display-funder-award-uri]'
)


class RegistrationFilesListPage(BaseSubmittedRegistrationPage):
url_addition = 'files'
Expand Down
2 changes: 2 additions & 0 deletions settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@

NEW_USER_EMAIL = env('NEW_USER_EMAIL')


cslzchen marked this conversation as resolved.
Show resolved Hide resolved
# Preferred node must be set to run tests on production
PREFERRED_NODE = env('PREFERRED_NODE', None)
# Initialize Popular Pages environment variable to None which is what it should be for
Expand Down Expand Up @@ -146,6 +147,7 @@
STAGE3 = DOMAIN == 'stage3'
TEST = DOMAIN == 'test'
PRODUCTION = DOMAIN == 'prod'
FUNDER_INFO_URL = 'https://staging-share.osf.io/api/v3/index-value-search?valueSearchPropertyPath=funder&acceptMediatype=application%2Fvnd.api%2Bjson'

# Users for testing CAS login scemarios
DEACTIVATED_USER = env('DEACTIVATED_USER')
Expand Down
25 changes: 25 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,28 @@ def project_with_file(session, default_project):
else:
osf_api.upload_fake_file(session, default_project)
return default_project


@pytest.fixture
def default_project_with_metadata(session):
"""Creates a new project through the api and returns it. Deletes the project at the end of the test run.
If PREFERRED_NODE is set, returns the APIDetail of preferred node.
"""
if settings.PREFERRED_NODE:
project = osf_api.get_node(session)
osf_api.update_custom_project_metadata(session, node_id=project.id)
yield project
else:
project = osf_api.create_project(session, title='OSF Test Project')
osf_api.update_custom_project_metadata(session, node_id=project.id)
yield project
project.delete()


@pytest.fixture(scope='class')
def must_be_logged_in_as_registration_user(driver):
safe_login(
driver,
user=settings.REGISTRATIONS_USER,
password=settings.REGISTRATIONS_USER_PASSWORD,
)