diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ad7063e8..d34b11d4 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -7,9 +7,9 @@ jobs: strategy: matrix: python-version: - - 3.7 - - 3.8 - - 3.9 + - '3.8' + - '3.9' + - '3.10' services: postgres: image: postgres:9.6 @@ -42,7 +42,7 @@ jobs: uses: actions/checkout@v2 - name: Install project Python dependencies run: | - pip install wheel==0.36.2 + pip install wheel==0.37.1 pip install -r requirements/local.txt pip install -r requirements/test.txt - name: Download icons diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b19dd933..e185d07a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -23,7 +23,7 @@ before_script: - python3 -m venv ./env - source ./env/bin/activate # - sh ./utility/install_python_dependencies.sh - - pip3 install wheel==0.36.2 + - pip3 install wheel==0.37.1 - pip3 install -r ./requirements/local.txt - pip3 install -r ./requirements/test.txt diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8ac13718..ff024e4f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -7,6 +7,62 @@ Changelog for the **SODAR Core** Django app package. Loosely follows the Note that the issue IDs here refer to ones in the private CUBI GitLab. +v0.10.8 (2022-02-02) +==================== + +Added +----- + +- **Projectroles** + - Disabling ``ManagementCommandLogger`` with ``LOGGING_DISABLE_CMD_OUTPUT`` (#894) +- **Siteinfo** + - Missing site settings in ``CORE_SETTINGS`` (#877) +- **Timeline** + - ``get_plugin_lookup()`` and ``get_app_icon_html()`` template tags (#888) + - Template tag tests (#891) + +Changed +------- + +- **General** + - Upgrade minimum Python version to v3.8, add v3.10 support (#885) + - Upgrade minimum Django version to v3.2.12 (#879, #902) + - Upgrade Python dependencies (#884, #893, #901) + - Upgrade to Chromedriver v97 (#905) +- **Projectroles** + - Display admin icon in user dropdown (#886) + - Refactor UI tests (#882) +- **Timeline** + - Improve event list layout responsivity (#887) + - Replace event list app column with app icon (#888) + - Set default kwarg values for model test helpers (#890) + - Move ``get_request()`` to ``TimelineAPIMixin`` + - Display recent events regardless of status in details card (#899) + - Optimize ``get_details_events()`` (#899) + +Fixed +----- + +- **Projectroles** + - Parent owner set as owner in project create form for non-owner category members (#878) + - Project header icon tooltip alignment (#895) + - Redundant public access icon display for categories (#896) + - Icon size syntax (#875) + - Content of ``sodar-code-input`` partially hidden in Chrome (#904) +- **Siteinfo** + - Layout responsivity issues with long labels (#883) +- **Timeline** + - Redundant app plugin queries in event list (#889, #900) + +Removed +------- + +- **Projectroles** + - ``_add_remote_association()`` helper from UI tests (#882) +- **Timeline** + - Unused ``get_app_url()`` template tag (#888) + + v0.10.7 (2021-12-14) ==================== diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 719f0171..71b40f64 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -112,10 +112,10 @@ Before you submit a pull request, check that it meets these guidelines: 4. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in ``CHANGELOG.rst``. -5. The pull request should work for Python version 3.7, 3.8 and 3.9. Check +5. The pull request should work for Python version 3.8, 3.9 and 3.10. Check https://github.com/bihealth/sodar-core/actions and make sure that the tests pass for supported Python versions. - From v1.0 onwards SODAR Core no longer supports Python 3.6. + From v0.10.8 onwards SODAR Core no longer supports Python 3.7. Deploying ========= diff --git a/README.rst b/README.rst index 1b204fdf..64f132e6 100644 --- a/README.rst +++ b/README.rst @@ -113,7 +113,7 @@ from PyPI as follows. .. code-block:: console - pip install django-sodar-core==0.10.7 + pip install django-sodar-core==0.10.8 For installing a development version you can point your dependency to a specific commit ID in GitHub. Note that these versions may not be stable. diff --git a/adminalerts/tests/test_ui.py b/adminalerts/tests/test_ui.py index 8f7df94c..fd9eb92c 100644 --- a/adminalerts/tests/test_ui.py +++ b/adminalerts/tests/test_ui.py @@ -4,11 +4,12 @@ from django.utils import timezone from selenium.common.exceptions import NoSuchElementException +from selenium.webdriver.common.by import By # Projectroles dependency from projectroles.tests.test_ui import TestUIBase -from .test_models import AdminAlertMixin +from adminalerts.tests.test_models import AdminAlertMixin class TestAlertUIBase(AdminAlertMixin, TestUIBase): @@ -38,7 +39,6 @@ def test_message(self): """Test visibility of alert message in home view""" expected = [(self.superuser, 1), (self.regular_user, 1)] url = reverse('home') - self.assert_element_count( expected, url, 'sodar-alert-site-app', 'class' ) @@ -50,7 +50,6 @@ def test_message_inactive(self): expected = [(self.superuser, 0), (self.regular_user, 0)] url = reverse('home') - self.assert_element_count( expected, url, 'sodar-alert-site-app', 'class' ) @@ -62,7 +61,6 @@ def test_message_expired(self): expected = [(self.superuser, 0), (self.regular_user, 0)] url = reverse('home') - self.assert_element_count( expected, url, 'sodar-alert-site-app', 'class' ) @@ -70,9 +68,8 @@ def test_message_expired(self): def test_message_login(self): """Test visibility of alert in login view with auth requirement""" self.selenium.get(self.build_selenium_url(reverse('login'))) - with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_class_name('sodar-alert-site-app') + self.selenium.find_element(By.CLASS_NAME, 'sodar-alert-site-app') def test_message_login_no_auth(self): """Test visibility of alert in login view without auth requirement""" @@ -81,7 +78,7 @@ def test_message_login_no_auth(self): self.selenium.get(self.build_selenium_url(reverse('login'))) self.assertIsNotNone( - self.selenium.find_element_by_class_name('sodar-alert-site-app') + self.selenium.find_element(By.CLASS_NAME, 'sodar-alert-site-app') ) @@ -92,12 +89,10 @@ def test_list_items(self): """Test existence of items in list""" expected = [(self.superuser, 1)] url = reverse('adminalerts:list') - self.assert_element_count(expected, url, 'sodar-aa-alert-item', 'id') def test_list_buttons(self): """Test existence of buttons in list""" expected = [(self.superuser, 1)] url = reverse('adminalerts:list') - self.assert_element_count(expected, url, 'sodar-aa-alert-buttons', 'id') diff --git a/appalerts/tests/test_ui.py b/appalerts/tests/test_ui.py index 8c2c6559..5f1fad7e 100644 --- a/appalerts/tests/test_ui.py +++ b/appalerts/tests/test_ui.py @@ -63,15 +63,15 @@ def test_alert_dismiss(self): url = reverse('appalerts:list') self.login_and_redirect(self.regular_user, url) self.assertEqual( - self.selenium.find_element_by_id('sodar-app-alert-count').text, '2' + self.selenium.find_element(By.ID, 'sodar-app-alert-count').text, '2' ) self.assertEqual( - self.selenium.find_element_by_id('sodar-app-alert-legend').text, + self.selenium.find_element(By.ID, 'sodar-app-alert-legend').text, 'alerts', ) - button = self.selenium.find_elements_by_class_name( - 'sodar-app-alert-btn-dismiss-single' + button = self.selenium.find_elements( + By.CLASS_NAME, 'sodar-app-alert-btn-dismiss-single' )[0] button.click() WebDriverWait(self.selenium, self.wait_time).until( @@ -80,16 +80,16 @@ def test_alert_dismiss(self): ) ) self.assertEqual( - self.selenium.find_element_by_id('sodar-app-alert-count').text, '1' + self.selenium.find_element(By.ID, 'sodar-app-alert-count').text, '1' ) self.assertEqual( - self.selenium.find_element_by_id('sodar-app-alert-legend').text, + self.selenium.find_element(By.ID, 'sodar-app-alert-legend').text, 'alert', ) self.assertEqual(AppAlert.objects.filter(active=True).count(), 1) self.assertFalse( - self.selenium.find_element_by_id( - 'sodar-app-alert-empty' + self.selenium.find_element( + By.ID, 'sodar-app-alert-empty' ).is_displayed() ) @@ -100,15 +100,15 @@ def test_alert_dismiss_all(self): url = reverse('appalerts:list') self.login_and_redirect(self.regular_user, url) self.assertEqual( - self.selenium.find_element_by_id('sodar-app-alert-count').text, '2' + self.selenium.find_element(By.ID, 'sodar-app-alert-count').text, '2' ) self.assertEqual( - self.selenium.find_element_by_id('sodar-app-alert-legend').text, + self.selenium.find_element(By.ID, 'sodar-app-alert-legend').text, 'alerts', ) - self.selenium.find_element_by_id( - 'sodar-app-alert-btn-dismiss-all' + self.selenium.find_element( + By.ID, 'sodar-app-alert-btn-dismiss-all' ).click() WebDriverWait(self.selenium, self.wait_time).until( ec.invisibility_of_element_located( @@ -116,10 +116,10 @@ def test_alert_dismiss_all(self): ) ) self.assertEqual( - self.selenium.find_element_by_id('sodar-app-alert-count').text, '' + self.selenium.find_element(By.ID, 'sodar-app-alert-count').text, '' ) self.assertEqual( - self.selenium.find_element_by_id('sodar-app-alert-legend').text, + self.selenium.find_element(By.ID, 'sodar-app-alert-legend').text, '', ) self.assertEqual(AppAlert.objects.filter(active=True).count(), 0) @@ -127,8 +127,8 @@ def test_alert_dismiss_all(self): ec.visibility_of_element_located((By.ID, 'sodar-app-alert-empty')) ) self.assertTrue( - self.selenium.find_element_by_id( - 'sodar-app-alert-empty' + self.selenium.find_element( + By.ID, 'sodar-app-alert-empty' ).is_displayed() ) @@ -140,12 +140,12 @@ def test_alert_reload(self): url = reverse('appalerts:list') self.login_and_redirect(self.regular_user, url) self.assertTrue( - self.selenium.find_element_by_id( - 'sodar-app-alert-empty' + self.selenium.find_element( + By.ID, 'sodar-app-alert-empty' ).is_displayed() ) with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_id('sodar-app-alert-reload') + self.selenium.find_element(By.ID, 'sodar-app-alert-reload') self._make_app_alert(user=self.regular_user, url=reverse('home')) @@ -153,8 +153,8 @@ def test_alert_reload(self): ec.visibility_of_element_located((By.ID, 'sodar-app-alert-reload')) ) self.assertTrue( - self.selenium.find_element_by_id( - 'sodar-app-alert-reload' + self.selenium.find_element( + By.ID, 'sodar-app-alert-reload' ).is_displayed() ) @@ -166,12 +166,12 @@ def test_render(self): """Test existence of alert badge for user with alerts""" url = reverse('home') self.login_and_redirect(self.regular_user, url) - alert_badge = self.selenium.find_element_by_id('sodar-app-alert-badge') + alert_badge = self.selenium.find_element(By.ID, 'sodar-app-alert-badge') self.assertIsNotNone(alert_badge) self.assertTrue(alert_badge.is_displayed()) - alert_count = self.selenium.find_element_by_id('sodar-app-alert-count') - alert_legend = self.selenium.find_element_by_id( - 'sodar-app-alert-legend' + alert_count = self.selenium.find_element(By.ID, 'sodar-app-alert-count') + alert_legend = self.selenium.find_element( + By.ID, 'sodar-app-alert-legend' ) self.assertEqual(alert_count.text, '2') self.assertEqual(alert_legend.text, 'alerts') @@ -180,7 +180,7 @@ def test_render_no_alerts(self): """Test existence of alert badge for user without alerts""" url = reverse('home') self.login_and_redirect(self.no_alert_user, url) - alert_badge = self.selenium.find_element_by_id('sodar-app-alert-badge') + alert_badge = self.selenium.find_element(By.ID, 'sodar-app-alert-badge') self.assertIsNotNone(alert_badge) self.assertFalse(alert_badge.is_displayed()) @@ -188,9 +188,9 @@ def test_render_add(self): """Test adding an alert for user with alerts""" url = reverse('home') self.login_and_redirect(self.regular_user, url) - alert_count = self.selenium.find_element_by_id('sodar-app-alert-count') - alert_legend = self.selenium.find_element_by_id( - 'sodar-app-alert-legend' + alert_count = self.selenium.find_element(By.ID, 'sodar-app-alert-count') + alert_legend = self.selenium.find_element( + By.ID, 'sodar-app-alert-legend' ) self.assertEqual(alert_count.text, '2') self.assertEqual(alert_legend.text, 'alerts') @@ -208,9 +208,9 @@ def test_render_delete(self): """Test deleting an alert from user with alerts""" url = reverse('home') self.login_and_redirect(self.regular_user, url) - alert_count = self.selenium.find_element_by_id('sodar-app-alert-count') - alert_legend = self.selenium.find_element_by_id( - 'sodar-app-alert-legend' + alert_count = self.selenium.find_element(By.ID, 'sodar-app-alert-count') + alert_legend = self.selenium.find_element( + By.ID, 'sodar-app-alert-legend' ) self.assertEqual(alert_count.text, '2') self.assertEqual(alert_legend.text, 'alerts') @@ -228,7 +228,7 @@ def test_render_delete_all(self): """Test deleting all alerts from user with alerts""" url = reverse('home') self.login_and_redirect(self.regular_user, url) - alert_badge = self.selenium.find_element_by_id('sodar-app-alert-badge') + alert_badge = self.selenium.find_element(By.ID, 'sodar-app-alert-badge') self.assertTrue(alert_badge.is_displayed()) self.alert.delete() @@ -242,7 +242,7 @@ def test_render_add_no_alerts(self): """Test adding an alert for user without prior alerts""" url = reverse('home') self.login_and_redirect(self.no_alert_user, url) - alert_badge = self.selenium.find_element_by_id('sodar-app-alert-badge') + alert_badge = self.selenium.find_element(By.ID, 'sodar-app-alert-badge') self.assertFalse(alert_badge.is_displayed()) self._make_app_alert(user=self.no_alert_user, url=reverse('home')) @@ -251,9 +251,9 @@ def test_render_add_no_alerts(self): ) self.assertTrue(alert_badge.is_displayed()) - alert_count = self.selenium.find_element_by_id('sodar-app-alert-count') - alert_legend = self.selenium.find_element_by_id( - 'sodar-app-alert-legend' + alert_count = self.selenium.find_element(By.ID, 'sodar-app-alert-count') + alert_legend = self.selenium.find_element( + By.ID, 'sodar-app-alert-legend' ) self.assertEqual(alert_count.text, '1') self.assertEqual(alert_legend.text, 'alert') @@ -265,8 +265,8 @@ def test_alert_dismiss_all(self): url = reverse('home') self.login_and_redirect(self.regular_user, url) - self.selenium.find_element_by_id( - 'sodar-app-alert-badge-btn-dismiss' + self.selenium.find_element( + By.ID, 'sodar-app-alert-badge-btn-dismiss' ).click() WebDriverWait(self.selenium, self.wait_time).until( ec.invisibility_of_element_located( diff --git a/codemeta.json b/codemeta.json index 8b791e38..362e074e 100644 --- a/codemeta.json +++ b/codemeta.json @@ -40,12 +40,12 @@ ], "identifier": "https://doi.org/10.5281/zenodo.4269346", "codeRepository": "https://github.com/bihealth/sodar_core", - "datePublished": "2021-12-14", - "dateModified": "2021-12-14", + "datePublished": "2022-02-02", + "dateModified": "2022-02-02", "dateCreated": "2019-06-26", "description": "SODAR Core: A Django-based framework for scientific data management and analysis web apps", "keywords": "Python, Django, scientific data managmenent, software library", "license": "MIT", "title": "SODAR Core", - "version": "v0.10.7" + "version": "v0.10.8" } diff --git a/config/settings/test.py b/config/settings/test.py index 68780f17..4b668b9c 100644 --- a/config/settings/test.py +++ b/config/settings/test.py @@ -64,6 +64,7 @@ LOGGING_LEVEL = env.str('LOGGING_LEVEL', 'CRITICAL') LOGGING = set_logging(LOGGING_LEVEL) +LOGGING_DISABLE_CMD_OUTPUT = True # Local App Settings diff --git a/docs/source/_static/app_timeline/sodar_timeline.png b/docs/source/_static/app_timeline/sodar_timeline.png index 9ed5be97..de212143 100644 Binary files a/docs/source/_static/app_timeline/sodar_timeline.png and b/docs/source/_static/app_timeline/sodar_timeline.png differ diff --git a/docs/source/app_projectroles_integration.rst b/docs/source/app_projectroles_integration.rst index 50d123fe..bb36bbe6 100644 --- a/docs/source/app_projectroles_integration.rst +++ b/docs/source/app_projectroles_integration.rst @@ -86,7 +86,7 @@ desired release tag or commit ID. .. code-block:: console -e git+https://github.com/mikkonie/django-plugins.git@42e86e7904e5c09f1da32173862b26843eda5dd8#egg=django-plugins - django-sodar-core==0.10.7 + django-sodar-core==0.10.8 Install the requirements for development: diff --git a/docs/source/app_projectroles_settings.rst b/docs/source/app_projectroles_settings.rst index f3fa3c18..ced592ac 100644 --- a/docs/source/app_projectroles_settings.rst +++ b/docs/source/app_projectroles_settings.rst @@ -645,3 +645,7 @@ production, ``ERROR`` debug level is recommended. The example site and SODAR Django Site template provide the ``LOGGING_APPS`` and ``LOGGING_FILE_PATH`` helpers for easily adding SODAR Core apps to logging and providing a system path for optional log file writing. + +If you are using ``ManagementCommandLogger`` for logging your management command +output, you can disable redundant console input in e.g. your test configuration +by setting ``LOGGING_DISABLE_CMD_OUTPUT`` to ``True``. diff --git a/docs/source/conf.py b/docs/source/conf.py index bb9880ed..5d7238ba 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -29,7 +29,7 @@ # The short X.Y version version = '0.10' # The full version, including alpha/beta/rc tags -release = '0.10.7' +release = '0.10.8' # -- General configuration --------------------------------------------------- diff --git a/docs/source/dev_general.rst b/docs/source/dev_general.rst index 9f73b2e6..2d8b19b8 100644 --- a/docs/source/dev_general.rst +++ b/docs/source/dev_general.rst @@ -63,7 +63,6 @@ used. An example can be seen below: {% include 'projectroles/_pagination.html' with pg_small=True %} - Management Command Logger ------------------------- @@ -87,6 +86,12 @@ to access the actual Python logger being used, you can access it via the example site and the SODAR Django Site template, including the use of a ``LOGGING_LEVEL`` Django settings variable. +.. hint:: + + To disable redundant console output from commands using this logger in e.g. + your site's test configuration, you can set the + ``LOGGING_DISABLE_CMD_OUTPUT`` Django setting to ``True``. + Using Icons =========== diff --git a/docs/source/dev_sodar_core.rst b/docs/source/dev_sodar_core.rst index a6e7936d..77fcc251 100644 --- a/docs/source/dev_sodar_core.rst +++ b/docs/source/dev_sodar_core.rst @@ -43,7 +43,7 @@ system of choice. System Installation ------------------- -First you need to install OS dependencies, PostgreSQL >=9.6 and Python >=3.7. +First you need to install OS dependencies, PostgreSQL >=9.6 and Python >=3.8. .. code-block:: console diff --git a/docs/source/for_the_impatient.rst b/docs/source/for_the_impatient.rst index c1910b6b..c9f93a28 100644 --- a/docs/source/for_the_impatient.rst +++ b/docs/source/for_the_impatient.rst @@ -54,7 +54,7 @@ PostgreSQL administrative user. Development Essentials - We assume that you have ``git``, Python 3.7 or above, and other essential + We assume that you have ``git``, Python 3.8 or above, and other essential tools installed. If you are using a mainstream Unix-like distribution (Mac qualifies) then you should be good to go. @@ -109,7 +109,7 @@ We simply use ``pip`` for this: # you must have your miniconda3 install sourced, skip if done already $ source ~/miniconda3/bin/activate - $ pip install django-sodar-core==0.10.7 + $ pip install django-sodar-core==0.10.8 Download Example Site diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 8756c601..e329c74f 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -17,7 +17,7 @@ the package is under active development and breaking changes are expected. .. code-block:: console - pip install django-sodar-core==0.10.7 + pip install django-sodar-core==0.10.8 Please note that the django-sodar-core package only installs :term:`Django apps`, which you need to include in a @@ -58,7 +58,7 @@ your Django site are listed below. For a complete requirement list, see the - Ubuntu (20.04 Focal recommended and supported) / CentOS 7 - System library requirements (see the ``utility`` directory and/or your own Django project) -- Python >=3.7 (**NOTE:** Python 3.6 no longer supported in SODAR Core v0.10+) +- Python >=3.8 (**NOTE:** Python 3.7 no longer supported in SODAR Core v0.10.8+) - Django 3.2 - PostgreSQL >=9.6 and psycopg2-binary - Bootstrap 4.x diff --git a/docs/source/major_changes.rst b/docs/source/major_changes.rst index 723f2186..bae40caf 100644 --- a/docs/source/major_changes.rst +++ b/docs/source/major_changes.rst @@ -10,6 +10,49 @@ older SODAR Core version. For a complete list of changes in current and previous releases, see the :ref:`full changelog`. +v0.10.8 (2022-02-02) +******************** + +Release Highlights +================== + +- Drop Python 3.7 support, add Python 3.10 support +- Display missing site settings in siteinfo app +- Fix project creation owner assignment for non-owner category members +- Improve layout in siteinfo and timeline apps +- Upgrade third party Python package dependencies +- Optimize queries in timeline app + +Breaking Changes +================ + +System Prerequisites +-------------------- + +SODAR Core no longer supports Python 3.7. Python 3.8 is currently both the +minimum and default version to run SODAR Core and its dependencies. + +Third party Python package dependencies have been upgraded. See the +``requirements`` directory for up-to-date package versions and upgrade your +project accordingly. + +Deprecated Selenium Methods +--------------------------- + +The minimum Selenium version has been upgraded to v4.0.x. Some test methods have +been deprecated in this version and will be removed in a future releases. UI +test helpers from this version onwards will use the non-deprecated versions. You +should the dependency in your projects, run tests, check the output and update +any deprecated method calls if used. + +Timeline App API Updated +------------------------ + +If you are using ``TimelineAPI.get_event_description()`` in your own apps, +please note that the method signature has changed. This may affect the use of +positional arguments. + + v0.10.7 (2021-12-14) ******************** diff --git a/projectroles/__init__.py b/projectroles/__init__.py index 472d70d4..2943e678 100644 --- a/projectroles/__init__.py +++ b/projectroles/__init__.py @@ -10,3 +10,7 @@ default_app_config = ( 'projectroles.apps.ProjectrolesConfig' # pylint: disable=invalid-name ) + +from . import _version # noqa + +__version__ = _version.get_versions()['version'] diff --git a/projectroles/_version.py b/projectroles/_version.py index 6b08142d..cb34852e 100644 --- a/projectroles/_version.py +++ b/projectroles/_version.py @@ -5,7 +5,7 @@ # that just contains the computed version number. # This file is released into the public domain. Generated by -# versioneer-0.19 (https://github.com/python-versioneer/python-versioneer) +# versioneer-0.21 (https://github.com/python-versioneer/python-versioneer) """Git implementation of _version.py.""" @@ -14,6 +14,7 @@ import re import subprocess import sys +from typing import Callable, Dict def get_keywords(): @@ -51,8 +52,8 @@ class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" -LONG_VERSION_PY = {} -HANDLERS = {} +LONG_VERSION_PY: Dict[str, str] = {} +HANDLERS: Dict[str, Dict[str, Callable]] = {} def register_vcs_handler(vcs, method): # decorator @@ -73,20 +74,20 @@ def run_command( ): """Call the given command(s).""" assert isinstance(commands, list) - p = None - for c in commands: + process = None + for command in commands: try: - dispcmd = str([c] + args) + dispcmd = str([command] + args) # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen( - [c] + args, + process = subprocess.Popen( + [command] + args, cwd=cwd, env=env, stdout=subprocess.PIPE, stderr=(subprocess.PIPE if hide_stderr else None), ) break - except EnvironmentError: + except OSError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue @@ -98,13 +99,13 @@ def run_command( if verbose: print("unable to find command, tried %s" % (commands,)) return None, None - stdout = p.communicate()[0].strip().decode() - if p.returncode != 0: + stdout = process.communicate()[0].strip().decode() + if process.returncode != 0: if verbose: print("unable to run %s (error)" % dispcmd) print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode + return None, process.returncode + return stdout, process.returncode def versions_from_parentdir(parentdir_prefix, root, verbose): @@ -116,7 +117,7 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): """ rootdirs = [] - for i in range(3): + for _ in range(3): dirname = os.path.basename(root) if dirname.startswith(parentdir_prefix): return { @@ -126,9 +127,8 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): "error": None, "date": None, } - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level + rootdirs.append(root) + root = os.path.dirname(root) # up a level if verbose: print( @@ -147,22 +147,21 @@ def git_get_keywords(versionfile_abs): # _version.py. keywords = {} try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: + with open(versionfile_abs, "r") as fobj: + for line in fobj: + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + except OSError: pass return keywords @@ -170,8 +169,8 @@ def git_get_keywords(versionfile_abs): @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") + if "refnames" not in keywords: + raise NotThisMethod("Short version file found") date = keywords.get("date") if date is not None: # Use only the last line. Previous lines may contain GPG signature @@ -190,11 +189,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) + refs = {r.strip() for r in refnames.strip("()").split(",")} # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " - tags = set([r[len(TAG) :] for r in refs if r.startswith(TAG)]) + tags = {r[len(TAG) :] for r in refs if r.startswith(TAG)} if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %d @@ -203,7 +202,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) + tags = {r for r in refs if re.search(r'\d', r)} if verbose: print("discarding '%s', no digits" % ",".join(refs - tags)) if verbose: @@ -212,6 +211,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix) :] + # Filter out refs that exactly match prefix or that don't start + # with a number once the prefix is stripped (mostly a concern + # when prefix is '') + if not re.match(r'\d', r): + continue if verbose: print("picking %s" % r) return { @@ -234,7 +238,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): @register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): +def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* @@ -242,12 +246,12 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): version string, meaning we're inside a checked out source tree. """ GITS = ["git"] + TAG_PREFIX_REGEX = "*" if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] + TAG_PREFIX_REGEX = r"\*" - out, rc = run_command( - GITS, ["rev-parse", "--git-dir"], cwd=root, hide_stderr=True - ) + _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, hide_stderr=True) if rc != 0: if verbose: print("Directory %s not under git control" % root) @@ -255,7 +259,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command( + describe_out, rc = runner( GITS, [ "describe", @@ -264,7 +268,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): "--always", "--long", "--match", - "%s*" % tag_prefix, + "%s%s" % (tag_prefix, TAG_PREFIX_REGEX), ], cwd=root, ) @@ -272,7 +276,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() @@ -282,6 +286,40 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None + branch_name, rc = runner( + GITS, ["rev-parse", "--abbrev-ref", "HEAD"], cwd=root + ) + # --abbrev-ref was added in git-1.6.3 + if rc != 0 or branch_name is None: + raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") + branch_name = branch_name.strip() + + if branch_name == "HEAD": + # If we aren't exactly on a branch, pick a branch which represents + # the current commit. If all else fails, we are on a branchless + # commit. + branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) + # --contains was added in git-1.5.4 + if rc != 0 or branches is None: + raise NotThisMethod("'git branch --contains' returned error") + branches = branches.split("\n") + + # Remove the first line if we're running detached + if "(" in branches[0]: + branches.pop(0) + + # Strip off the leading "* " from the list of branches. + branches = [branch[2:] for branch in branches] + if "master" in branches: + branch_name = "master" + elif not branches: + branch_name = None + else: + # Pick the first branch that is returned. Good or bad. + branch_name = branches[0] + + pieces["branch"] = branch_name + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out @@ -298,7 +336,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: - # unparseable. Maybe git-describe is misbehaving? + # unparsable. Maybe git-describe is misbehaving? pieces["error"] = ( "unable to parse git-describe output: '%s'" % describe_out ) @@ -326,13 +364,11 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): else: # HEX: no tags pieces["closest-tag"] = None - count_out, rc = run_command( - GITS, ["rev-list", "HEAD", "--count"], cwd=root - ) + count_out, rc = runner(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[ + date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[ 0 ].strip() # Use only the last line. Previous lines may contain GPG signature @@ -374,16 +410,66 @@ def render_pep440(pieces): return rendered +def render_pep440_branch(pieces): + """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . + + The ".dev0" means not master branch. Note that .dev0 sorts backwards + (a feature branch will appear "older" than the master branch). + + Exceptions: + 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0" + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+untagged.%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def pep440_split_post(ver): + """Split pep440 version string at the post-release segment. + + Returns the release segments before the post-release and the + post-release version number (or -1 if no post-release segment is present). + """ + vc = str.split(ver, ".post") + return vc[0], int(vc[1] or 0) if len(vc) == 2 else None + + def render_pep440_pre(pieces): - """TAG[.post0.devDISTANCE] -- No -dirty. + """TAG[.postN.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post0.devDISTANCE """ if pieces["closest-tag"]: - rendered = pieces["closest-tag"] if pieces["distance"]: - rendered += ".post0.dev%d" % pieces["distance"] + # update the post release segment + tag_version, post_version = pep440_split_post(pieces["closest-tag"]) + rendered = tag_version + if post_version is not None: + rendered += ".post%d.dev%d" % ( + post_version + 1, + pieces["distance"], + ) + else: + rendered += ".post0.dev%d" % (pieces["distance"]) + else: + # no commits, use the tag as the version + rendered = pieces["closest-tag"] else: # exception #1 rendered = "0.post0.dev%d" % pieces["distance"] @@ -417,6 +503,35 @@ def render_pep440_post(pieces): return rendered +def render_pep440_post_branch(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . + + The ".dev0" means not master branch. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . @@ -495,10 +610,14 @@ def render(pieces, style): if style == "pep440": rendered = render_pep440(pieces) + elif style == "pep440-branch": + rendered = render_pep440_branch(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) + elif style == "pep440-post-branch": + rendered = render_pep440_post_branch(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": @@ -539,7 +658,7 @@ def get_versions(): # versionfile_source is the relative path from the top of the source # tree (where the .git directory might live) to this file. Invert # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): + for _ in cfg.versionfile_source.split('/'): root = os.path.dirname(root) except NameError: return { diff --git a/projectroles/forms.py b/projectroles/forms.py index c70eb0d1..3196ebf1 100644 --- a/projectroles/forms.py +++ b/projectroles/forms.py @@ -524,19 +524,19 @@ def __init__(self, project=None, current_user=None, *args, **kwargs): # Hide parent selection self.fields['parent'].widget = forms.HiddenInput() + # Set owner + if self.current_user.is_superuser and parent_project: + self.initial['owner'] = parent_project.get_owner().user + else: + self.initial['owner'] = self.current_user + # Hide owner select widget for regular users + if not self.current_user.is_superuser: + self.fields['owner'].widget = forms.HiddenInput() + # Creating a subproject if parent_project: # Parent must be current parent self.initial['parent'] = parent_project.sodar_uuid - # Set owner of parent category as initial owner - self.initial['owner'] = parent_project.get_owner().user - - # If current user is not parent owner, disable owner select - if ( - not self.current_user.is_superuser - and self.current_user != parent_project.get_owner().user - ): - self.fields['owner'].widget = forms.HiddenInput() # Creating a top level project else: @@ -549,8 +549,6 @@ def __init__(self, project=None, current_user=None, *args, **kwargs): self.fields['type'].widget = forms.HiddenInput() # Set up parent field self.initial['parent'] = None - # Set current user as initial owner - self.initial['owner'] = self.current_user if self.instance.is_remote(): self.fields['title'].widget = forms.HiddenInput() diff --git a/projectroles/management/logging.py b/projectroles/management/logging.py index db70c40a..691e8c41 100644 --- a/projectroles/management/logging.py +++ b/projectroles/management/logging.py @@ -15,12 +15,16 @@ class ManagementCommandLogger: logger = None #: Site logging level - log_level = getattr(settings, 'LOGGING_LEVEL', 'INFO') - site_level = getattr(logging, log_level, 'INFO') + site_level = getattr( + logging, getattr(settings, 'LOGGING_LEVEL', 'INFO'), 'INFO' + ) #: Whether console logging is enabled console_log = CONSOLE_HANDLER in settings.LOGGING.get('handlers', {}).keys() + #: Disable console output if True + disable_output = getattr(settings, 'LOGGING_DISABLE_CMD_OUTPUT', False) + def __init__(self, name): self.logger = logging.getLogger(name) @@ -35,6 +39,8 @@ def log(self, message, level=logging.INFO): if isinstance(level, str): level = getattr(logging, level) self.logger.log(level, message) + if self.disable_output: + return printed = False if level >= self.site_level: printed = self.console_log diff --git a/projectroles/static/projectroles/css/projectroles.css b/projectroles/static/projectroles/css/projectroles.css index 28fcc44f..3aa9ed3a 100644 --- a/projectroles/static/projectroles/css/projectroles.css +++ b/projectroles/static/projectroles/css/projectroles.css @@ -663,6 +663,10 @@ div#sodar-modal div.modal-dialog{ color: #dfdfdf; } +span.sodar-pr-header-icon { + display: inline-block; +} + a#sodar-pr-link-project-star { outline: 0; border: none; @@ -696,6 +700,7 @@ pre#sodar-email-body { .sodar-code-input { font-family: monospace; font-size: 85%; + line-height: 36px; /* Fix for Chrome rendering issue (#904) */ } .spin { diff --git a/projectroles/templates/projectroles/_project_header.html b/projectroles/templates/projectroles/_project_header.html index 6328087d..1c99cf70 100644 --- a/projectroles/templates/projectroles/_project_header.html +++ b/projectroles/templates/projectroles/_project_header.html @@ -24,9 +24,9 @@

{{ project.title }}

title="{% if project_starred %}Unstar{% else %}Star{% endif %}" data-toggle="tooltip" data-placement="top"> {% if project_starred %} - + {% else %} - + {% endif %} {% endif %} @@ -54,7 +54,8 @@

{{ project.title }}

{# Remote status #} {% if project.is_remote and request.user.is_superuser %} - {{ project.title }} {% endif %} {# Public access status #} - {% if project.public_guest_access %} - diff --git a/projectroles/templates/projectroles/_project_list_item.html b/projectroles/templates/projectroles/_project_list_item.html index ab30d103..39c83c7b 100644 --- a/projectroles/templates/projectroles/_project_list_item.html +++ b/projectroles/templates/projectroles/_project_list_item.html @@ -33,7 +33,7 @@ {% if request.user.is_superuser and remote_icon %} {{ remote_icon | safe }} {% endif %} - {% if p.public_guest_access %} + {% if p.type == 'PROJECT' and p.public_guest_access %} diff --git a/projectroles/templates/projectroles/_site_titlebar.html b/projectroles/templates/projectroles/_site_titlebar.html index ef57c713..e265cc42 100644 --- a/projectroles/templates/projectroles/_site_titlebar.html +++ b/projectroles/templates/projectroles/_site_titlebar.html @@ -73,7 +73,7 @@ - +
  • diff --git a/projectroles/templates/projectroles/_site_titlebar_dropdown.html b/projectroles/templates/projectroles/_site_titlebar_dropdown.html index 0c6defcd..3251a871 100644 --- a/projectroles/templates/projectroles/_site_titlebar_dropdown.html +++ b/projectroles/templates/projectroles/_site_titlebar_dropdown.html @@ -54,7 +54,9 @@ - {% if request.user.is_authenticated %} + {% if request.user.is_superuser %} + + {% elif request.user.is_authenticated %} {% else %} diff --git a/projectroles/tests/test_ui.py b/projectroles/tests/test_ui.py index 14aa1aae..df454cf2 100644 --- a/projectroles/tests/test_ui.py +++ b/projectroles/tests/test_ui.py @@ -17,12 +17,12 @@ from selenium import webdriver from selenium.common.exceptions import NoSuchElementException from selenium.webdriver.common.by import By -from selenium.webdriver.support.ui import WebDriverWait from selenium.webdriver.support import expected_conditions as ec +from selenium.webdriver.support.ui import WebDriverWait +from projectroles.app_settings import AppSettingAPI from projectroles.models import Role, SODAR_CONSTANTS, PROJECT_TAG_STARRED from projectroles.plugins import get_active_plugins -from projectroles.app_settings import AppSettingAPI from projectroles.tests.test_models import ( ProjectMixin, RoleAssignmentMixin, @@ -32,10 +32,13 @@ RemoteSiteMixin, RemoteProjectMixin, ) - from projectroles.utils import build_secret +app_settings = AppSettingAPI() +User = auth.get_user_model() + + # SODAR constants PROJECT_ROLE_OWNER = SODAR_CONSTANTS['PROJECT_ROLE_OWNER'] PROJECT_ROLE_DELEGATE = SODAR_CONSTANTS['PROJECT_ROLE_DELEGATE'] @@ -61,11 +64,6 @@ REMOTE_SITE_DESC = 'New description' REMOTE_SITE_SECRET = build_secret() -# App settings API -app_settings = AppSettingAPI() - -User = auth.get_user_model() - class LiveUserMixin: """Mixin for creating users to work with LiveServerTestCase""" @@ -116,10 +114,8 @@ def setUp(self): # Init Chrome options = webdriver.ChromeOptions() - for arg in self.chrome_options: options.add_argument(arg) - self.selenium = webdriver.Chrome(chrome_options=options) # Prevent ElementNotVisibleException @@ -143,14 +139,10 @@ def setUp(self): self.user_guest = self._make_user('user_guest', False) self.user_no_roles = self._make_user('user_no_roles', False) - # Init projects - - # Top level category + # Init category and project self.category = self._make_project( title='TestCategoryTop', type=PROJECT_TYPE_CATEGORY, parent=None ) - - # Subproject under category self.project = self._make_project( title='TestProjectSub', type=PROJECT_TYPE_PROJECT, @@ -158,10 +150,8 @@ def setUp(self): ) # Init role assignments - # Category self._make_assignment(self.category, self.user_owner, self.role_owner) - # Sub level project self.owner_as = self._make_assignment( self.project, self.user_owner, self.role_owner @@ -201,7 +191,6 @@ def login_and_redirect( :param user: User object :param url: URL to redirect to (string) """ - # Legacy login mode if getattr(settings, 'PROJECTROLES_TEST_UI_LEGACY_LOGIN', False): return self.login_and_redirect_with_ui( @@ -216,14 +205,12 @@ def login_and_redirect( session[BACKEND_SESSION_KEY] = settings.AUTHENTICATION_BACKENDS[1] session[HASH_SESSION_KEY] = user.get_session_auth_hash() session.save() - cookie = { 'name': settings.SESSION_COOKIE_NAME, 'value': session.session_key, 'path': '/', 'domain': self.build_selenium_url().split('//')[1].split(':')[0], } - self.selenium.add_cookie(cookie) self.selenium.get(self.build_selenium_url(url)) @@ -233,7 +220,6 @@ def login_and_redirect( (By.ID, 'sodar-navbar-user-dropdown') ) ) - # Wait for optional element if wait_elem: WebDriverWait(self.selenium, self.wait_time).until( @@ -255,7 +241,6 @@ def login_and_redirect_with_ui( :param wait_loc: Locator of optional wait element (string, corresponds to selenium "By" class members) """ - self.selenium.get(self.build_selenium_url('/')) ######################## @@ -263,8 +248,8 @@ def login_and_redirect_with_ui( ######################## try: - user_button = self.selenium.find_element_by_id( - 'sodar-navbar-user-dropdown' + user_button = self.selenium.find_element( + By.ID, 'sodar-navbar-user-dropdown' ) user_button.click() # Wait for element to be visible @@ -274,8 +259,8 @@ def login_and_redirect_with_ui( ) ) try: - signout_button = self.selenium.find_element_by_id( - 'sodar-navbar-link-logout' + signout_button = self.selenium.find_element( + By.ID, 'sodar-navbar-link-logout' ) signout_button.click() # Wait for redirect @@ -293,19 +278,18 @@ def login_and_redirect_with_ui( self.selenium.get(self.build_selenium_url(url)) # Submit user data into form - field_user = self.selenium.find_element_by_id('sodar-login-username') + field_user = self.selenium.find_element(By.ID, 'sodar-login-username') # field_user.send_keys(user.username) field_user.send_keys(user.username) - field_pass = self.selenium.find_element_by_id('sodar-login-password') + field_pass = self.selenium.find_element(By.ID, 'sodar-login-password') field_pass.send_keys('password') - self.selenium.find_element_by_id('sodar-login-submit').click() + self.selenium.find_element(By.ID, 'sodar-login-submit').click() # Wait for redirect WebDriverWait(self.selenium, self.wait_time).until( ec.presence_of_element_located( (By.ID, 'sodar-navbar-user-dropdown') ) ) - # Wait for optional element if wait_elem: WebDriverWait(self.selenium, self.wait_time).until( @@ -336,15 +320,13 @@ def assert_element_exists( """ for user in users: self.login_and_redirect(user, url, wait_elem, wait_loc) - if exists: self.assertIsNotNone( - self.selenium.find_element_by_id(element_id) + self.selenium.find_element(By.ID, element_id) ) - else: with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_id(element_id) + self.selenium.find_element(By.ID, element_id) def assert_element_count( self, @@ -381,8 +363,9 @@ def assert_element_count( if expected_count > 0: self.assertEqual( len( - self.selenium.find_elements_by_xpath( - xpath.format(path, attribute, search_string) + self.selenium.find_elements( + By.XPATH, + xpath.format(path, attribute, search_string), ) ), expected_count, @@ -390,8 +373,9 @@ def assert_element_count( ) else: with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_xpath( - xpath.format(path, attribute, search_string) + self.selenium.find_element( + By.XPATH, + xpath.format(path, attribute, search_string), ) def assert_element_set( @@ -416,17 +400,13 @@ def assert_element_set( for e in expected: user = e[0] elements = e[1] - self.login_and_redirect(user, url, wait_elem, wait_loc) - for element in elements: - self.assertIsNotNone(self.selenium.find_element_by_id(element)) - + self.assertIsNotNone(self.selenium.find_element(By.ID, element)) not_expected = list(set(all_elements) ^ set(elements)) - for n in not_expected: with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_id(n) + self.selenium.find_element(By.ID, n) def assert_element_active( self, @@ -456,16 +436,13 @@ def assert_element_active( ec.presence_of_element_located((By.ID, element_id)) ) - element = self.selenium.find_element_by_id(element_id) - + element = self.selenium.find_element(By.ID, element_id) self.assertIsNotNone(element) self.assertIn('active', element.get_attribute('class')) not_expected = [e for e in all_elements if e != element_id] - # print(not_expected) # DEBUG - for n in not_expected: - element = self.selenium.find_element_by_id(n) + element = self.selenium.find_element(By.ID, n) self.assertIsNotNone(element) self.assertNotIn('active', element.get_attribute('class')) @@ -476,7 +453,6 @@ class TestBaseTemplate(TestUIBase): def test_admin_link(self): """Test admin site link visibility according to user permissions""" expected_true = [self.superuser] - expected_false = [ self.owner_as.user, self.delegate_as.user, @@ -484,13 +460,10 @@ def test_admin_link(self): self.guest_as.user, self.user_no_roles, ] - url = reverse('home') - self.assert_element_exists( expected_true, url, 'sodar-navbar-link-admin', True ) - self.assert_element_exists( expected_false, url, 'sodar-navbar-link-admin', False ) @@ -503,8 +476,8 @@ def _get_item_vis_count(self): return len( [ e - for e in self.selenium.find_elements_by_class_name( - 'sodar-pr-project-list-item' + for e in self.selenium.find_elements( + By.CLASS_NAME, 'sodar-pr-project-list-item' ) if e.get_attribute('style') != 'display: none;' ] @@ -529,8 +502,8 @@ def test_project_list_filter(self): self.login_and_redirect(self.owner_as.user, url) self.assertEqual(self._get_item_vis_count(), 2) - f_input = self.selenium.find_element_by_id( - 'sodar-pr-project-list-filter' + f_input = self.selenium.find_element( + By.ID, 'sodar-pr-project-list-filter' ) f_input.send_keys('sub') self.assertEqual(self._get_item_vis_count(), 1) @@ -544,14 +517,14 @@ def test_project_list_star(self): self.login_and_redirect(self.owner_as.user, url) self.assertEqual(self._get_item_vis_count(), 2) - button = self.selenium.find_element_by_id( - 'sodar-pr-project-list-link-star' + button = self.selenium.find_element( + By.ID, 'sodar-pr-project-list-link-star' ) button.click() self.assertEqual(self._get_item_vis_count(), 1) self.assertEqual( - self.selenium.find_element_by_id( - 'sodar-pr-home-display-nostars' + self.selenium.find_element( + By.ID, 'sodar-pr-home-display-nostars' ).get_attribute('style'), 'display: none;', ) @@ -562,20 +535,20 @@ def test_project_list_star_no_project(self): self.login_and_redirect(self.owner_as.user, url) self.assertEqual(self._get_item_vis_count(), 2) - button = self.selenium.find_element_by_id( - 'sodar-pr-project-list-link-star' + button = self.selenium.find_element( + By.ID, 'sodar-pr-project-list-link-star' ) button.click() self.assertEqual(self._get_item_vis_count(), 0) self.assertNotEqual( - self.selenium.find_element_by_id( - 'sodar-pr-home-display-nostars' + self.selenium.find_element( + By.ID, 'sodar-pr-home-display-nostars' ).get_attribute('style'), 'display: none;', ) def test_link_create_toplevel(self): - """Test project creation link visibility according to user permissions""" + """Test project creation link visibility""" expected_true = [self.superuser] expected_false = [ self.owner_as.user, @@ -599,7 +572,7 @@ def test_inline_head_include_enabled(self): url = reverse('home') self.login_and_redirect(self.owner_as.user, url) self.assertIsNotNone( - self.selenium.find_element_by_xpath('//meta[@name="keywords"]') + self.selenium.find_element(By.XPATH, '//meta[@name="keywords"]') ) def test_inline_head_include_disabled(self): @@ -607,16 +580,16 @@ def test_inline_head_include_disabled(self): url = reverse('home') self.login_and_redirect(self.owner_as.user, url) with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_xpath('//meta[@name="keywords"]') + self.selenium.find_element(By.XPATH, '//meta[@name="keywords"]') -class TestProjectDetail(TestUIBase, RemoteSiteMixin, RemoteProjectMixin): - """Tests for the project detail page UI functionalities""" +class TestProjectDetailView(RemoteSiteMixin, RemoteProjectMixin, TestUIBase): + """Tests for ProjectDetailView UI""" def _setup_remote_project( self, site_mode=SITE_MODE_TARGET, user_visibility=True ): - """Create a remote site and project with given user_visibility setting""" + """Create remote site and project with given user_visibility setting""" self.remote_site = self._make_site( name=REMOTE_SITE_NAME, url=REMOTE_SITE_URL, @@ -634,32 +607,8 @@ def _setup_remote_project( project=self.project, ) - def _add_remote_association(self): - """Fill an submits add source/target site form""" - # Instead we could also set up a real RemoteProject, but this makes - # the test run faster - url = reverse('projectroles:remote_site_create') - self.login_and_redirect(self.superuser, url) - - name_field = self.selenium.find_element_by_id('id_name') - url_field = self.selenium.find_element_by_id('id_url') - secret_field = self.selenium.find_element_by_id('id_secret') - - name_field.send_keys('some name') - url_field.send_keys('http://url.url') - secret_field.send_keys('b2oitbge4rlme5yxtciqszf98vffsg2p') - - secret_field.submit() - # Wait for form submit - WebDriverWait(self.selenium, self.wait_time).until( - ec.presence_of_element_located( - (By.ID, 'sodar-pr-remote-site-table') - ) - ) - def test_project_links(self): - """Test visibility of project links according to user - permissions""" + """Test visibility of project links""" expected = [ ( self.superuser, @@ -694,17 +643,13 @@ def test_project_links(self): ['sodar-pr-link-project-roles', 'sodar-pr-link-project-star'], ), ] - url = reverse( 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_set(expected, PROJECT_LINK_IDS, url) def test_project_links_category(self): - """Test visibility of top level category links according to user - permissions""" - + """Test visibility of top level category links""" # Add user with rights only for the subproject sub_user = self._make_user('sub_user', False) self._make_assignment(self.project, sub_user, self.role_contributor) @@ -733,7 +678,6 @@ def test_project_links_category(self): url = reverse( 'projectroles:detail', kwargs={'project': self.category.sodar_uuid} ) - self.assert_element_set(expected, PROJECT_LINK_IDS, url) def test_copy_uuid_visibility_default(self): @@ -750,9 +694,8 @@ def test_copy_uuid_visibility_default(self): ) for user in users: self.login_and_redirect(user, url) - with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_id('sodar-pr-btn-copy-uuid') + self.selenium.find_element(By.ID, 'sodar-pr-btn-copy-uuid') def test_copy_uuid_visibility_enabled(self): """Test UUID copy button visibility with setting enabled""" @@ -769,6 +712,22 @@ def test_copy_uuid_visibility_enabled(self): [self.user_owner], url, 'sodar-pr-btn-copy-uuid', True ) + def test_plugin_links(self): + """Test visibility of app plugin links""" + expected = [(self.superuser, len(get_active_plugins()))] + url = reverse( + 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} + ) + self.assert_element_count(expected, url, 'sodar-pr-link-app-plugin') + + def test_plugin_cards(self): + """Test visibility of app plugin cards""" + expected = [(self.superuser, len(get_active_plugins()))] + url = reverse( + 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} + ) + self.assert_element_count(expected, url, 'sodar-pr-app-item') + def test_remote_project_visible(self): """Test project card for enabled visbility for all users""" self._setup_remote_project(user_visibility=True) @@ -786,11 +745,11 @@ def test_remote_project_visible(self): # Visibile for all users for user in users: self.login_and_redirect(user, url) - project_details = self.selenium.find_element_by_id( - 'sodar-pr-details-card-remote' + project_details = self.selenium.find_element( + By.ID, 'sodar-pr-details-card-remote' ) - remote_project = project_details.find_element_by_class_name( - 'btn-info' + remote_project = project_details.find_element( + By.CLASS_NAME, 'btn-info' ) self.assertEqual(remote_project.text, REMOTE_SITE_NAME) @@ -806,16 +765,17 @@ def test_remote_project_invisible(self): for user in users: self.login_and_redirect(user, url) with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_id('sodar-pr-details-card-remote') - + self.selenium.find_element( + By.ID, 'sodar-pr-details-card-remote' + ) # Greyed out for superuser and owner for user in [self.superuser, self.user_owner]: self.login_and_redirect(user, url) - project_details = self.selenium.find_element_by_id( - 'sodar-pr-details-card-remote' + project_details = self.selenium.find_element( + By.ID, 'sodar-pr-details-card-remote' ) - remote_project = project_details.find_element_by_class_name( - 'btn-secondary' + remote_project = project_details.find_element( + By.CLASS_NAME, 'btn-secondary' ) self.assertEqual(remote_project.text, REMOTE_SITE_NAME) @@ -836,14 +796,15 @@ def test_peer_project_source_invisible(self): for user in users: self.login_and_redirect(user, url) - with self.assertRaises(NoSuchElementException): - self.selenium.find_element_by_id('sodar-pr-details-card-remote') + self.selenium.find_element( + By.ID, 'sodar-pr-details-card-remote' + ) @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) def test_peer_project_target_visible(self): """Test visibility of peer projects on TARGET site (user_display=False)""" - # There needs to be a source mode remote project as master project + # There needs to be a source mode remote project as master project, # otherwise peer project logic wont be reached source_site = self._make_site( name='Second Remote Site', @@ -874,8 +835,8 @@ def test_peer_project_target_visible(self): for user in users: self.login_and_redirect(user, url) - remote_links = self.selenium.find_elements_by_class_name( - 'sodar-pr-link-remote' + remote_links = self.selenium.find_elements( + By.CLASS_NAME, 'sodar-pr-link-remote' ) self.assertEqual(len(remote_links), 2) self.assertIn( @@ -890,7 +851,7 @@ def test_peer_project_target_visible(self): @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) def test_peer_project_target_invisible(self): """Test invisibility of peer projects on TARGET site for users (user_display=False)""" - # There needs to be a source mode remote project as master project + # There needs to be a source mode remote project as master project, # otherwise peer project logic wont be reached source_site = self._make_site( name='Second Remote Site', @@ -900,14 +861,12 @@ def test_peer_project_target_invisible(self): secret=build_secret(), user_display=False, ) - self._make_remote_project( project_uuid=self.project.sodar_uuid, site=source_site, level=SODAR_CONSTANTS['REMOTE_LEVEL_READ_ROLES'], project=self.project, ) - self._setup_remote_project( site_mode=SITE_MODE_PEER, user_visibility=False ) @@ -924,8 +883,8 @@ def test_peer_project_target_invisible(self): for user in expected_true: self.login_and_redirect(user, url) - remote_links = self.selenium.find_elements_by_class_name( - 'sodar-pr-link-remote' + remote_links = self.selenium.find_elements( + By.CLASS_NAME, 'sodar-pr-link-remote' ) self.assertEqual(len(remote_links), 2) self.assertIn( @@ -939,8 +898,8 @@ def test_peer_project_target_invisible(self): for user in expected_false: self.login_and_redirect(user, url) - remote_links = self.selenium.find_elements_by_class_name( - 'sodar-pr-link-remote' + remote_links = self.selenium.find_elements( + By.CLASS_NAME, 'sodar-pr-link-remote' ) self.assertEqual(len(remote_links), 1) self.assertIn( @@ -948,77 +907,17 @@ def test_peer_project_target_invisible(self): remote_links[0].get_attribute('class'), ) - @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) - def test_target_visibility(self): - """Test form toggle and remote site table column on target site""" - # Check Form Toggle visibility on TARGET site - url = reverse('projectroles:remote_site_create') - self.login_and_redirect(self.superuser, url) - - self.assertFalse( - self.selenium.find_element_by_id('id_user_display').is_displayed() - ) - - self._add_remote_association() - # Check Visible to User column visibility - remote_site_table = self.selenium.find_element_by_id( - 'sodar-pr-remote-site-table' - ) - with self.assertRaises(NoSuchElementException): - remote_site_table.find_element_by_xpath( - "//th[contains(text(), 'Visible to users')]" - ) - - with self.assertRaises(NoSuchElementException): - remote_site_table.find_element_by_xpath( - "//td[contains(text(), 'Yes')]" - ) - - def test_source_visibility(self): - """Test form toggle and remote site table column on source site""" - # Check Form Toggle visibility on SOURCE site - url = reverse('projectroles:remote_site_create') - self.login_and_redirect(self.superuser, url) - element = self.selenium.find_element_by_id('div_id_user_display') - self.assertIsNotNone(element) - - self._add_remote_association() - # Check Visible to User column visibility - remote_site_table = self.selenium.find_element_by_id( - 'sodar-pr-remote-site-table' - ) - try: - remote_site_table.find_element_by_xpath( - "//th[contains(text(), 'Visible')]" - ) - except NoSuchElementException: - self.fail( - 'User Display column (header) should exist on SOURCE remote ' - 'site overview' - ) - try: - remote_site_table.find_element_by_xpath( - "//td[contains(text(), 'Yes')]" - ) - except NoSuchElementException: - self.fail( - 'User Display column (data) should exist on SOURCE remote site ' - 'overview' - ) - -class TestProjectRoles(RemoteTargetMixin, TestUIBase): - """Tests for the project roles page UI functionalities""" +class TestProjectRoleView(RemoteTargetMixin, TestUIBase): + """Tests for ProjectRoleView UI""" def test_list_buttons(self): - """Test visibility of role list button group according to user - permissions""" + """Test visibility of role list button group""" good_users = [self.superuser, self.owner_as.user, self.delegate_as.user] bad_users = [self.contributor_as.user, self.guest_as.user] url = reverse( 'projectroles:roles', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_exists( good_users, url, 'sodar-pr-btn-role-op', True ) @@ -1029,7 +928,6 @@ def test_list_buttons(self): @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) def test_list_buttons_target(self): """Test visibility of role list button group as target""" - # Set up site as target self._set_up_as_target(projects=[self.category, self.project]) @@ -1042,18 +940,16 @@ def test_list_buttons_target(self): url = reverse( 'projectroles:roles', kwargs={'project': self.project.sodar_uuid} ) - self.login_and_redirect(self.superuser, url) - btn = self.selenium.find_element_by_id('sodar-pr-btn-role-op') - self.assertEqual(btn.is_enabled(), False) + btn = self.selenium.find_element(By.ID, 'sodar-pr-btn-role-op') + self.assertEqual(btn.is_enabled(), False) self.assert_element_exists( non_superusers, url, 'sodar-pr-btn-role-op', False ) def test_role_list_invite_button(self): - """Test visibility of role invite button according to user - permissions""" + """Test visibility of role invite button""" expected_true = [ self.superuser, self.owner_as.user, @@ -1063,18 +959,15 @@ def test_role_list_invite_button(self): url = reverse( 'projectroles:roles', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_exists( expected_true, url, 'sodar-pr-btn-role-list-invite', True ) - self.assert_element_exists( expected_false, url, 'sodar-pr-btn-role-list-invite', False ) def test_role_list_add_button(self): - """Test visibility of role invite button according to user - permissions""" + """Test visibility of role invite button""" expected_true = [ self.superuser, self.owner_as.user, @@ -1084,18 +977,15 @@ def test_role_list_add_button(self): url = reverse( 'projectroles:roles', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_exists( expected_true, url, 'sodar-pr-btn-role-list-create', True ) - self.assert_element_exists( expected_false, url, 'sodar-pr-btn-role-list-create', False ) def test_role_buttons(self): - """Test visibility of role management buttons according to user - permissions""" + """Test visibility of role management buttons""" expected = [ (self.superuser, 4), (self.owner_as.user, 4), @@ -1116,15 +1006,15 @@ def test_role_preview(self): ) self.login_and_redirect(self.owner_as.user, url) - button = self.selenium.find_element_by_id('sodar-pr-email-preview-link') + button = self.selenium.find_element( + By.ID, 'sodar-pr-email-preview-link' + ) button.click() - WebDriverWait(self.selenium, self.wait_time).until( ec.presence_of_element_located((By.ID, 'sodar-email-body')) ) - self.assertIsNotNone( - self.selenium.find_element_by_id('sodar-email-body') + self.selenium.find_element(By.ID, 'sodar-email-body') ) def test_invite_preview(self): @@ -1135,17 +1025,15 @@ def test_invite_preview(self): ) self.login_and_redirect(self.owner_as.user, url) - button = self.selenium.find_element_by_id( - 'sodar-pr-invite-preview-link' + button = self.selenium.find_element( + By.ID, 'sodar-pr-invite-preview-link' ) button.click() - WebDriverWait(self.selenium, self.wait_time).until( ec.presence_of_element_located((By.ID, 'sodar-email-body')) ) - self.assertIsNotNone( - self.selenium.find_element_by_id('sodar-email-body') + self.selenium.find_element(By.ID, 'sodar-email-body') ) def test_widget_user_options(self): @@ -1156,36 +1044,33 @@ def test_widget_user_options(self): ) self.login_and_redirect(self.owner_as.user, url) - widget = self.selenium.find_element_by_class_name( - 'select2-container--default' + widget = self.selenium.find_element( + By.CLASS_NAME, 'select2-container--default' ) widget.click() - WebDriverWait(self.selenium, self.wait_time).until( ec.presence_of_element_located((By.ID, 'select2-id_user-results')) ) - # assert that options are displayed + # Assert that options are displayed self.assertIsNotNone( - self.selenium.find_element_by_class_name('select2-results__option') + self.selenium.find_element(By.CLASS_NAME, 'select2-results__option') ) - self.assertEqual( len( - self.selenium.find_elements_by_class_name( - 'select2-selection__rendered' + self.selenium.find_elements( + By.CLASS_NAME, 'select2-selection__rendered' ) ), 1, ) -class TestProjectInviteList(ProjectInviteMixin, TestUIBase): - """Tests for the project invite list page UI functionalities""" +class TestProjectInviteView(ProjectInviteMixin, TestUIBase): + """Tests for ProjectInviteView UI""" def test_list_buttons(self): - """Test visibility of invite list button group according to user - permissions""" + """Test visibility of invite list button group""" expected_true = [ self.superuser, self.owner_as.user, @@ -1194,14 +1079,12 @@ def test_list_buttons(self): url = reverse( 'projectroles:invites', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_exists( expected_true, url, 'sodar-pr-btn-role-list', True ) def test_role_list_invite_button(self): - """Test visibility of role invite button according to user - permissions""" + """Test visibility of role invite button""" expected_true = [ self.superuser, self.owner_as.user, @@ -1210,14 +1093,12 @@ def test_role_list_invite_button(self): url = reverse( 'projectroles:invites', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_exists( expected_true, url, 'sodar-pr-btn-role-list-invite', True ) def test_role_list_add_button(self): - """Test visibility of role invite button according to user - permissions""" + """Test visibility of role invite button""" expected_true = [ self.superuser, self.owner_as.user, @@ -1226,15 +1107,12 @@ def test_role_list_add_button(self): url = reverse( 'projectroles:invites', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_exists( expected_true, url, 'sodar-pr-btn-role-list-create', True ) def test_invite_buttons(self): - """Test visibility of invite management buttons according to user - permissions""" - + """Test visibility of invite management buttons""" self._make_invite( email='test@example.com', project=self.project, @@ -1242,7 +1120,6 @@ def test_invite_buttons(self): issuer=self.owner_as.user, message='', ) - expected = [ (self.superuser, 1), (self.owner_as.user, 1), @@ -1254,29 +1131,113 @@ def test_invite_buttons(self): self.assert_element_count(expected, url, 'sodar-pr-btn-grp-invite') -class TestPlugins(TestUIBase): - """Tests for app plugins in the UI""" +class TestProjectCreateView(TestUIBase): + """Tests for ProjectCreateView UI""" - # NOTE: Setting up the plugins is done during migration - def setUp(self): - super().setUp() - self.plugin_count = len(get_active_plugins()) + def test_owner_widget_top(self): + """Test rendering the owner widget on the top level""" + url = reverse('projectroles:create') + self.assert_element_exists([self.superuser], url, 'div_id_owner', True) - def test_plugin_links(self): - """Test visibility of app plugin links""" - expected = [(self.superuser, self.plugin_count)] + def test_owner_widget_sub(self): + """Test rendering the owner widget under a category""" + # Add new user, make them a contributor in category + new_user = self._make_user('new_user') + self._make_assignment(self.category, new_user, self.role_contributor) url = reverse( - 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} + 'projectroles:create', kwargs={'project': self.category.sodar_uuid} + ) + self.assert_element_exists([self.superuser], url, 'div_id_owner', True) + self.assert_element_exists( + [self.user_owner, new_user], url, 'div_id_owner', False ) - self.assert_element_count(expected, url, 'sodar-pr-link-app-plugin') - def test_plugin_cards(self): - """Test visibility of app plugin cards""" - expected = [(self.superuser, self.plugin_count)] - url = reverse( - 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} + +class TestRemoteSiteCreateView(RemoteSiteMixin, TestUIBase): + """Tests for RemoteSiteCreateView UI""" + + def test_source_user_toggle(self): + """Test site create form user display toggle on source site""" + url = reverse('projectroles:remote_site_create') + self.login_and_redirect(self.superuser, url) + element = self.selenium.find_element(By.ID, 'div_id_user_display') + self.assertIsNotNone(element) + + @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) + def test_target_user_toggle(self): + """Test site create form user display toggle on target site""" + url = reverse('projectroles:remote_site_create') + self.login_and_redirect(self.superuser, url) + self.assertFalse( + self.selenium.find_element(By.ID, 'id_user_display').is_displayed() ) - self.assert_element_count(expected, url, 'sodar-pr-app-item') + + +class TestRemoteSiteListView(RemoteSiteMixin, TestUIBase): + """Tests for RemoteSiteListView UI""" + + def test_source_user_display(self): + """Test site list user display elements on source site""" + self._make_site( + name=REMOTE_SITE_NAME, + url=REMOTE_SITE_URL, + mode=SITE_MODE_TARGET, + description='', + secret=REMOTE_SITE_SECRET, + user_display=True, + ) + url = reverse('projectroles:remote_sites') + self.login_and_redirect(self.superuser, url) + + # Check Visible to User column visibility + remote_site_table = self.selenium.find_element( + By.ID, 'sodar-pr-remote-site-table' + ) + try: + remote_site_table.find_element( + By.XPATH, '//th[contains(text(), "Visible")]' + ) + except NoSuchElementException: + self.fail( + 'User Display column (header) should exist on SOURCE remote ' + 'site overview' + ) + try: + remote_site_table.find_element( + By.XPATH, '//td[contains(text(), "Yes")]' + ) + except NoSuchElementException: + self.fail( + 'User Display column (data) should exist on SOURCE remote site ' + 'overview' + ) + + @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) + def test_target_list_user_display(self): + """Test site list user display elements on target site""" + self._make_site( + name=REMOTE_SITE_NAME, + url=REMOTE_SITE_URL, + mode=SITE_MODE_SOURCE, + description='', + secret=REMOTE_SITE_SECRET, + user_display=True, + ) + url = reverse('projectroles:remote_sites') + self.login_and_redirect(self.superuser, url) + + # Check Visible to User column visibility + remote_site_table = self.selenium.find_element( + By.ID, 'sodar-pr-remote-site-table' + ) + with self.assertRaises(NoSuchElementException): + remote_site_table.find_element( + By.XPATH, '//th[contains(text(), "Visible to users")]' + ) + with self.assertRaises(NoSuchElementException): + remote_site_table.find_element( + By.XPATH, '//td[contains(text(), "Yes")]' + ) class TestProjectSidebar(ProjectInviteMixin, RemoteTargetMixin, TestUIBase): @@ -1284,13 +1245,11 @@ class TestProjectSidebar(ProjectInviteMixin, RemoteTargetMixin, TestUIBase): def setUp(self): super().setUp() - self.sidebar_ids = [ 'sodar-pr-nav-project-detail', 'sodar-pr-nav-project-roles', 'sodar-pr-nav-project-update', ] - # Add app plugin navs for p in get_active_plugins(): self.sidebar_ids.append('sodar-pr-nav-app-plugin-{}'.format(p.name)) @@ -1300,7 +1259,6 @@ def test_render_detail(self): url = reverse( 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_exists( [self.superuser], url, 'sodar-pr-sidebar', True ) @@ -1308,7 +1266,6 @@ def test_render_detail(self): def test_render_home(self): """Test visibility of sidebar in the home view""" url = reverse('home') - self.assert_element_exists( [self.superuser], url, 'sodar-pr-sidebar', True ) @@ -1319,7 +1276,6 @@ def test_app_links(self): 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} ) expected = [(self.superuser, len(get_active_plugins()))] - self.assert_element_count(expected, url, 'sodar-pr-nav-app-plugin') @override_settings(PROJECTROLES_HIDE_APP_LINKS=['timeline']) @@ -1332,7 +1288,6 @@ def test_app_links_hide(self): (self.superuser, len(get_active_plugins())), (self.user_owner, len(get_active_plugins()) - 1), ] - self.assert_element_count(expected, url, 'sodar-pr-nav-app-plugin') def test_update_link(self): @@ -1346,7 +1301,6 @@ def test_update_link(self): url = reverse( 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_exists( expected_true, url, 'sodar-pr-nav-project-update', True ) @@ -1363,7 +1317,6 @@ def test_update_link(self): @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) def test_update_link_target(self): """Test visibility of update link as target""" - # Set up site as target self._set_up_as_target(projects=[self.category, self.project]) @@ -1445,7 +1398,6 @@ def test_create_link_disable_categories(self): @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) def test_create_link_target_remote(self): """Test visibility of create link as target under a remote category""" - # Set up site as target self._set_up_as_target(projects=[self.category, self.project]) @@ -1470,7 +1422,6 @@ def test_create_link_target_remote(self): @override_settings(PROJECTROLES_SITE_MODE=SITE_MODE_TARGET) def test_create_link_target_local(self): """Test visibility of create link as target under a local category""" - expected_true = [self.superuser, self.owner_as.user] expected_false = [ self.delegate_as.user, @@ -1500,10 +1451,7 @@ def test_create_link_target_local(self): ) def test_create_link_target_disable(self): """Test visibility of create link as target with creation not allowed""" - - # Set up site as target self._set_up_as_target(projects=[self.category, self.project]) - expected_false = [ self.superuser, self.owner_as.user, @@ -1514,7 +1462,6 @@ def test_create_link_target_disable(self): url = reverse( 'projectroles:detail', kwargs={'project': self.category.sodar_uuid} ) - self.assert_element_exists( expected_false, url, 'sodar-pr-nav-project-create', False ) @@ -1527,7 +1474,6 @@ def test_link_active_detail(self): url = reverse( 'projectroles:detail', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_active( self.superuser, 'sodar-pr-nav-project-detail', self.sidebar_ids, url ) @@ -1613,7 +1559,6 @@ def test_link_active_role_invite_resend(self): issuer=self.owner_as.user, message='', ) - self.assert_element_active( self.superuser, 'sodar-pr-nav-project-roles', @@ -1633,7 +1578,6 @@ def test_link_active_role_invite_revoke(self): issuer=self.owner_as.user, message='', ) - self.assert_element_active( self.superuser, 'sodar-pr-nav-project-roles', @@ -1649,14 +1593,13 @@ def test_link_active_update(self): url = reverse( 'projectroles:update', kwargs={'project': self.project.sodar_uuid} ) - self.assert_element_active( self.superuser, 'sodar-pr-nav-project-update', self.sidebar_ids, url ) -class TestProjectSearch(TestUIBase): - """Tests for the project search UI functionalities""" +class TestProjectSearchResultsView(TestUIBase): + """Tests for ProjectSearchResultsView UI""" def test_search_results(self): """Test project search items visibility according to user permissions""" diff --git a/projectroles/tests/test_views.py b/projectroles/tests/test_views.py index e197ff60..45b9829b 100644 --- a/projectroles/tests/test_views.py +++ b/projectroles/tests/test_views.py @@ -140,7 +140,7 @@ def setUp(self): ) def test_render(self): - """Test to ensure the home view renders correctly""" + """Test rendering the home view""" with self.login(self.user): response = self.client.get(reverse('home')) self.assertEqual(response.status_code, 200) @@ -414,7 +414,7 @@ def test_render_sub(self): ) self._make_assignment(category, self.user, self.role_owner) # Create another user to enable checking for owner selection - self.make_user('newuser') + self.make_user('new_user') with self.login(self.user): response = self.client.get( @@ -441,13 +441,35 @@ def test_render_sub(self): ], ) self.assertIsInstance(form.fields['parent'].widget, HiddenInput) + self.assertEqual(form.initial['owner'], self.user) + + def test_render_sub_cat_member(self): + """Test rendering under a category as a category non-owner""" + category = self._make_project( + 'TestCategory', PROJECT_TYPE_CATEGORY, None + ) + self._make_assignment(category, self.user, self.role_owner) + new_user = self.make_user('new_user') + self._make_assignment(category, new_user, self.role_contributor) + + with self.login(new_user): + response = self.client.get( + reverse( + 'projectroles:create', + kwargs={'project': category.sodar_uuid}, + ) + ) + self.assertEqual(response.status_code, 200) + form = response.context['form'] + # Current user should be the initial value for owner + self.assertEqual(form.initial['owner'], new_user) def test_render_sub_project(self): """Test rendering if creating under a project (should fail)""" project = self._make_project('TestProject', PROJECT_TYPE_PROJECT, None) self._make_assignment(project, self.user, self.role_owner) # Create another user to enable checking for owner selection - self.make_user('newuser') + self.make_user('new_user') with self.login(self.user): response = self.client.get( @@ -474,7 +496,7 @@ def test_render_parent_owner(self): category = self._make_project( 'TestCategory', PROJECT_TYPE_CATEGORY, None ) - user_new = self.make_user('newuser') + user_new = self.make_user('new_user') self._make_assignment(category, user_new, self.role_owner) with self.login(self.user): @@ -599,7 +621,6 @@ def test_create_project(self): APP_SETTING_SCOPE_PROJECT, post_safe=True ) ) - with self.login(self.user): response = self.client.post( reverse( @@ -612,7 +633,6 @@ def test_create_project(self): self.assertEqual(response.status_code, 302) self.assertEqual(Project.objects.all().count(), 2) project = Project.objects.get(type=PROJECT_TYPE_PROJECT) - self.assertIsNotNone(project) # No alerts or emails should be sent as the same user triggered this self.assertEqual(self.app_alert_model.objects.count(), 0) self.assertEqual(len(mail.outbox), 0) @@ -645,6 +665,46 @@ def test_create_project(self): } self.assertEqual(model_to_dict(owner_as), expected) + def test_create_project_cat_member(self): + """Test Project creation as category member""" + # Create category and add new user as member + category = self._make_project( + title='TestCategory', type=PROJECT_TYPE_CATEGORY, parent=None + ) + self._make_assignment(category, self.user, self.role_owner) + new_user = self.make_user('new_user') + self._make_assignment(category, new_user, self.role_contributor) + + values = { + 'title': 'TestProject', + 'type': PROJECT_TYPE_PROJECT, + 'parent': category.sodar_uuid, + 'owner': new_user.sodar_uuid, + 'description': 'description', + 'public_guest_access': False, + } + values.update( + app_settings.get_all_defaults( + APP_SETTING_SCOPE_PROJECT, post_safe=True + ) + ) + with self.login(self.user): + response = self.client.post( + reverse( + 'projectroles:create', + kwargs={'project': category.sodar_uuid}, + ), + values, + ) + + self.assertEqual(response.status_code, 302) + self.assertEqual(Project.objects.all().count(), 2) + project = Project.objects.get(type=PROJECT_TYPE_PROJECT) + self.assertEqual(project.get_owner().user, new_user) + # Alert and email for parent owner should be created + self.assertEqual(self.app_alert_model.objects.count(), 1) + self.assertEqual(len(mail.outbox), 1) + class TestProjectUpdateView( ProjectMixin, RoleAssignmentMixin, RemoteTargetMixin, TestViewsBase @@ -688,7 +748,7 @@ def test_render_project(self): def test_render_parent(self): """Test current parent selectability without parent role""" # Create new user and project, make new user the owner - user_new = self.make_user('newuser') + user_new = self.make_user('new_user') self.owner_as.user = user_new self.owner_as.save() # Create another category with new user as owner @@ -2342,7 +2402,7 @@ def setUp(self): ) # Create guest user and role - self.user_new = self.make_user('newuser') + self.user_new = self.make_user('new_user') self.role_as = self._make_assignment( self.project, self.user_new, self.role_guest ) diff --git a/projectroles/views_api.py b/projectroles/views_api.py index f26ef9fb..000dce37 100644 --- a/projectroles/views_api.py +++ b/projectroles/views_api.py @@ -101,6 +101,7 @@ '0.10.5', '0.10.6', '0.10.7', + '0.10.8', ] # Local constants diff --git a/requirements/base.txt b/requirements/base.txt index f97432b6..66b29e6d 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -1,41 +1,41 @@ # Wheel -wheel==0.36.2 +wheel==0.37.1 # Django -django>=3.2.10, <3.3 +django>=3.2.12, <3.3 # Configuration -django-environ>=0.4.5, <0.5 +django-environ>=0.8.1, <0.9 # Forms -django-crispy-forms>=1.11.2, <1.12 +django-crispy-forms>=1.13.0, <1.14 # Models -django-model-utils>=4.1.1, <4.2 +django-model-utils>=4.2.0, <4.3 # Password storage -argon2-cffi>=20.1.0, <20.2 +argon2-cffi>=21.3.0, <21.4 # Python-PostgreSQL Database Adapter -psycopg2-binary>=2.8.6, <2.9 +psycopg2-binary>=2.9.3, <2.10 # Unicode slugification awesome-slugify>=1.6.5, <1.7 # Time zones support -pytz>=2021.1 +pytz>=2021.3 # SVG icon support -django-iconify==0.1.0.post1 +django-iconify==0.1.1 # Online documentation via django-docs -docutils>=0.16, <0.17 # 0.17 currently breaks sphinx-rtd-theme -Sphinx>=4.0.2, <4.1 -django-docs>=0.3.1, <0.4 -sphinx-rtd-theme>=0.5.2, <0.6 +docutils==0.17.1 +Sphinx==4.3.2 +django-docs==0.3.1 +sphinx-rtd-theme==1.0.0 # Versioning -versioneer>=0.19 +versioneer==0.21 ###################### # Project app imports @@ -48,7 +48,7 @@ versioneer>=0.19 rules>=3.0, <3.1 # REST framework -djangorestframework>=3.12.4, <3.13 +djangorestframework>=3.13.1, <3.14 # Keyed list addon for DRF -e git+https://github.com/mikkonie/drf-keyed-list.git@b03607b866c5706b0e1ea46a7eeaab6527030734#egg=drf-keyed-list @@ -57,16 +57,16 @@ djangorestframework>=3.12.4, <3.13 django-rest-knox>=4.1.0, <4.2 # Markdown field support -markdown>=3.3.4, <3.4 -django-markupfield>=2.0.0, <2.1 -django-pagedown>=2.2.0, <2.3 -mistune>=0.8.4, <0.9 +markdown==3.3.4 # NOTE: Markdown 3.3.6+ requires Python>=3.10 +django-markupfield>=2.0.1, <2.1 +django-pagedown>=2.2.1, <2.3 +mistune>=2.0.1, <2.1 # Database file storage for filesfolders django-db-file-storage==0.5.5 # Backround Jobs requirements -celery>=5.1.0, <5.2 +celery>=5.2.3, <5.3 # Django autocomplete light (DAL) django-autocomplete-light>=3.8.2, <3.9 diff --git a/requirements/ldap.txt b/requirements/ldap.txt index b54cc7ea..e02f596b 100644 --- a/requirements/ldap.txt +++ b/requirements/ldap.txt @@ -1,4 +1,4 @@ # Optional LDAP dependencies go here -django-auth-ldap==2.4.0 +django-auth-ldap==4.0.0 python-ldap==3.4.0 diff --git a/requirements/local.txt b/requirements/local.txt index 05e929c2..60733701 100644 --- a/requirements/local.txt +++ b/requirements/local.txt @@ -1,10 +1,10 @@ # Local development dependencies go here -r base.txt -django-extensions==3.1.3 -Werkzeug==2.0.1 +django-extensions==3.1.5 +Werkzeug==2.0.2 -django-debug-toolbar>=3.2.1, <3.3 +django-debug-toolbar>=3.2.4, <3.3 # improved REPL ipdb==0.13.9, <0.14 diff --git a/requirements/test.txt b/requirements/test.txt index fd23dddf..a32c1cd3 100644 --- a/requirements/test.txt +++ b/requirements/test.txt @@ -1,27 +1,27 @@ # Test dependencies go here. -r base.txt -flake8==3.9.2 -django-test-plus==1.4.0 -factory-boy==3.2.0 -coverage==5.4 -django-coverage-plugin==1.8.0 +flake8==4.0.1 +django-test-plus==2.2.0 +factory-boy==3.2.1 +coverage==6.2 +django-coverage-plugin==2.0.2 # pytest -pytest-django==4.1.0 +pytest-django==4.5.2 pytest-sugar==0.9.4 # Selenium for UI testing -selenium==3.141.0 +selenium==4.1.0 # Tblib for tracebacks tblib==1.7.0 # BeautifulSoup for HTML testing -beautifulsoup4==4.9.3 +beautifulsoup4==4.10.0 # Coverage through Codacy codacy-coverage==1.3.11 # Black for formatting -black==21.6b0 +black==22.1.0 diff --git a/setup.cfg b/setup.cfg index e9028bb6..beb0f109 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,7 @@ [flake8] max-line-length = 80 exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules,src/*, - config/*,versioneer.py,env/*,.venv + config/*,versioneer.py,env/*,.venv,_version.py ignore = E203, E266, E501, W503, W504 max-complexity = 18 select = B,C,E,F,W,T4,B9 diff --git a/setup.py b/setup.py index 0583733c..7cf085ff 100755 --- a/setup.py +++ b/setup.py @@ -84,11 +84,11 @@ def is_requirement(line): 'Operating System :: POSIX :: Linux', 'Programming Language :: Python', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: 3.10', 'Topic :: Internet :: WWW/HTTP', 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', ], - python_requires='>=3.7', + python_requires='>=3.8', ) diff --git a/siteinfo/templates/siteinfo/_plugin_settings.html b/siteinfo/templates/siteinfo/_plugin_settings.html index b86212b3..9f56c0ec 100644 --- a/siteinfo/templates/siteinfo/_plugin_settings.html +++ b/siteinfo/templates/siteinfo/_plugin_settings.html @@ -11,11 +11,11 @@

    {% for k, v in pl_data.settings.items %} -
    {{ k }}
    +
    {{ k }}
    {% if v.set %} -
    {% get_info_val v.value %}
    +
    {% get_info_val v.value %}
    {% else %} -
    (Unset)
    +
    (Unset)
    {% endif %} {% endfor %}
    diff --git a/siteinfo/templates/siteinfo/site_info.html b/siteinfo/templates/siteinfo/site_info.html index 4f772964..70cedd27 100644 --- a/siteinfo/templates/siteinfo/site_info.html +++ b/siteinfo/templates/siteinfo/site_info.html @@ -149,11 +149,11 @@

    Project Apps

    {% for plugin in project_plugins.keys %} -
    +
    {{ plugin.title }}
    -
    {{ plugin.description }}
    +
    {{ plugin.description }}
    {% endfor %}
    @@ -166,11 +166,11 @@

    Site Apps

    {% for plugin in site_plugins %} -
    +
    {{ plugin.title }}
    -
    {{ plugin.description }}
    +
    {{ plugin.description }}
    {% endfor %}
    @@ -183,11 +183,11 @@

    Backend Apps

    {% for plugin in backend_plugins.keys %} -
    +
    {{ plugin.title }}
    -
    {{ plugin.description }}
    +
    {{ plugin.description }}
    {% endfor %}
    @@ -209,11 +209,11 @@

    {% for k, v in settings_core.items %} -
    {{ k }}
    +
    {{ k }}
    {% if v.set %} -
    {% get_info_val v.value %}
    +
    {% get_info_val v.value %}
    {% else %} -
    (Unset)
    +
    (Unset)
    {% endif %} {% endfor %}
    diff --git a/siteinfo/views.py b/siteinfo/views.py index 8e679ba3..145157e3 100644 --- a/siteinfo/views.py +++ b/siteinfo/views.py @@ -20,9 +20,29 @@ # Local constants CORE_SETTINGS = [ + 'ALLOWED_HOSTS', + 'APPS_DIR', + 'AUTH_LDAP_SERVER_URI', + 'AUTH_LDAP2_SERVER_URI', + 'DEBUG', + 'EMAIL_BACKEND', + 'EMAIL_HOST', + 'EMAIL_PORT', + 'EMAIL_SENDER', + 'ENABLE_LDAP', + 'ENABLE_SAML', 'ENABLED_BACKEND_PLUGINS', + 'ICONIFY_JSON_ROOT', + 'INSTALLED_APPS', + 'LANGUAGE_CODE', + 'LOGGING_APPS', + 'LOGGING_FILE_PATH', + 'LOGGING_LEVEL', + 'MANAGERS', + 'MIDDLEWARE', 'PROJECTROLES_ALLOW_ANONYMOUS', 'PROJECTROLES_ALLOW_LOCAL_USERS', + 'PROJECTROLES_BROWSER_WARNING', 'PROJECTROLES_CUSTOM_JS_INCLUDES', 'PROJECTROLES_CUSTOM_CSS_INCLUDES', 'PROJECTROLES_DEFAULT_ADMIN', @@ -30,6 +50,7 @@ 'PROJECTROLES_DISABLE_CATEGORIES', 'PROJECTROLES_DISABLE_CDN_INCLUDES', 'PROJECTROLES_EMAIL_SENDER_REPLY', + 'PROJECTROLES_ENABLE_PROFILING', 'PROJECTROLES_ENABLE_SEARCH', 'PROJECTROLES_HELP_HIGHLIGHT_DAYS', 'PROJECTROLES_HIDE_APP_LINKS', @@ -41,6 +62,8 @@ 'PROJECTROLES_SEND_EMAIL', 'PROJECTROLES_SITE_MODE', 'PROJECTROLES_TARGET_CREATE', + 'ROOT_DIR', + 'SITE_PACKAGE', 'SITE_TITLE', 'SITE_SUBTITLE', 'SITE_INSTANCE_TITLE', @@ -48,6 +71,11 @@ 'SODAR_API_DEFAULT_VERSION', 'SODAR_API_DEFAULT_HOST', 'SODAR_API_MEDIA_TYPE', + 'STATICFILES_DIRS', + 'STATICFILES_FINDERS', + 'TEMPLATES', + 'TIME_ZONE', + 'USE_TZ', ] diff --git a/timeline/api.py b/timeline/api.py index 047e8543..28961fcb 100644 --- a/timeline/api.py +++ b/timeline/api.py @@ -262,11 +262,12 @@ def get_project_events(cls, project, classified=False): return events @classmethod - def get_event_description(cls, event, request=None): + def get_event_description(cls, event, plugin_lookup=None, request=None): """ Return the description of a timeline event as HTML. :param event: ProjectEvent object + :param plugin_lookup: App plugin lookup dict (optional) :param request: Request object (optional) :return: String (contains HTML) """ @@ -279,7 +280,10 @@ def get_event_description(cls, event, request=None): app_plugin = None if event.app != 'projectroles': - app_plugin = get_app_plugin(event.app) + if plugin_lookup: + app_plugin = plugin_lookup.get(event.app) + else: + app_plugin = get_app_plugin(event.app) if not app_plugin: msg = 'Plugin not found: {}'.format(event.app) logger.error(msg + ' (UUID={})'.format(event.sodar_uuid)) diff --git a/timeline/static/timeline/css/timeline.css b/timeline/static/timeline/css/timeline.css index e7f0b394..ad88350b 100644 --- a/timeline/static/timeline/css/timeline.css +++ b/timeline/static/timeline/css/timeline.css @@ -1,9 +1,11 @@ /* Main table */ -table#sodar-tl-table tbody tr td:nth-child(1) { +table#sodar-tl-table tbody tr td:nth-child(1), +table#sodar-tl-table tbody tr td:nth-child(2), +table#sodar-tl-table tbody tr td:nth-child(3) { white-space: nowrap; } -table#sodar-tl-table tbody tr td:nth-child(5) { +table#sodar-tl-table tbody tr td:nth-child(4) { width: 100%; } @@ -30,33 +32,27 @@ a.sodar-tl-link-extra { } /* Responsive modifications */ -@media screen and (max-width: 1200px) { +@media screen and (max-width: 1100px) { .table#sodar-tl-table thead tr th:nth-child(2), .table#sodar-tl-table tbody tr td:nth-child(2) { display: none; } } -@media screen and (max-width: 1000px) { - .table#sodar-tl-table thead tr th:nth-child(3), - .table#sodar-tl-table tbody tr td:nth-child(3) { - display: none; - } -} - -@media screen and (max-width: 800px) { +@media screen and (max-width: 900px) { .table#sodar-tl-table tbody tr td:nth-child(1) { white-space: normal; } - .table#sodar-tl-table thead tr th:nth-child(4), - .table#sodar-tl-table tbody tr td:nth-child(4) { + + .table#sodar-tl-table thead tr th:nth-child(3), + .table#sodar-tl-table tbody tr td:nth-child(3) { display: none; } } @media screen and (max-width: 500px) { - .table#sodar-tl-table thead tr th:nth-child(6), - .table#sodar-tl-table tbody tr td:nth-child(6) { + .table#sodar-tl-table thead tr th:nth-child(5), + .table#sodar-tl-table tbody tr td:nth-child(5) { display: none; } } diff --git a/timeline/templates/timeline/_details_card.html b/timeline/templates/timeline/_details_card.html index 8772d4ad..8454b946 100644 --- a/timeline/templates/timeline/_details_card.html +++ b/timeline/templates/timeline/_details_card.html @@ -5,11 +5,13 @@ {% if can_view_timeline %} + {% get_plugin_lookup as plugin_lookup %} {% include 'timeline/_list_header.html' with details_card_mode=True %} @@ -65,7 +63,7 @@ {% endfor %} {% else %} - + {% endif %} diff --git a/timeline/templates/timeline/_list_header.html b/timeline/templates/timeline/_list_header.html index d50c2c18..62f77455 100644 --- a/timeline/templates/timeline/_list_header.html +++ b/timeline/templates/timeline/_list_header.html @@ -1,6 +1,5 @@ - diff --git a/timeline/templates/timeline/_list_item.html b/timeline/templates/timeline/_list_item.html index 2f56cf60..d25e99cf 100644 --- a/timeline/templates/timeline/_list_item.html +++ b/timeline/templates/timeline/_list_item.html @@ -12,14 +12,10 @@ -
    No eventsNo events
    TimestampApp Event User Description - {% get_app_url event as app_url %} - {% if app_url != '#' %} - {{ event.app }} - {% else %} - {{ event.app }} - {% endif %} + {% get_app_icon_html event plugin_lookup as event_icon %} + {{ event_icon|safe }} + {{ event.event_name }} {{ event.event_name }} {% if event.user %} {% get_user_html event.user as user_html %} @@ -29,9 +25,8 @@ {% endif %} - {% autoescape off %} - {% get_event_description event request %} - {% endautoescape %} + {% get_event_description event plugin_lookup request as event_desc %} + {{ event_desc|safe }} {% if not details_card_mode and event|has_extra_data %}

    {{ timeline_title }}

    diff --git a/timeline/templatetags/timeline_tags.py b/timeline/templatetags/timeline_tags.py index eae4b342..75b5c2ef 100644 --- a/timeline/templatetags/timeline_tags.py +++ b/timeline/templatetags/timeline_tags.py @@ -4,15 +4,18 @@ from django.urls import reverse from django.utils.timezone import localtime -# Projectroles dependency -from projectroles.plugins import get_app_plugin +from djangoplugins.models import Plugin from timeline.api import TimelineAPI from timeline.models import ProjectEvent + timeline = TimelineAPI() register = template.Library() + +ICON_PROJECTROLES = 'mdi:cube' +ICON_UNKNOWN_APP = 'mdi:help-circle' STATUS_STYLES = { 'OK': 'bg-success', 'INIT': 'bg-secondary', @@ -33,22 +36,56 @@ def get_timestamp(event): @register.simple_tag -def get_event_description(event, request=None): +def get_event_description(event, plugin_lookup, request=None): """Return printable version of event description""" - return timeline.get_event_description(event, request) + return timeline.get_event_description(event, plugin_lookup, request) @register.simple_tag -def get_details_events(project, view_classified): +def get_details_events(project, view_classified=False): """Return recent events for card on project details page""" - events = ProjectEvent.objects.filter(project=project) + c_kwargs = {'classified': False} if not view_classified else {} + return ProjectEvent.objects.filter(project=project, **c_kwargs).order_by( + '-pk' + )[:5] - if not view_classified: - events = events.exclude(classified=True) - events = events.order_by('-pk') +@register.simple_tag +def get_plugin_lookup(): + """Return lookup dict of app plugins with app name as key""" + return {p.name: p.get_plugin() for p in Plugin.objects.all()} - return [x for x in events if x.get_current_status().status_type == 'OK'][:5] + +@register.simple_tag +def get_app_icon_html(event, plugin_lookup): + """Return icon link HTML for app by plugin lookup""" + url = None + url_kwargs = {} + if event.project: + url_kwargs['project'] = event.project.sodar_uuid + title = event.app + icon = ICON_UNKNOWN_APP # Default in case the plugin is not found + + if event.app == 'projectroles': + if event.project: + url = reverse('projectroles:detail', kwargs=url_kwargs) + title = 'Projectroles' + icon = ICON_PROJECTROLES + elif event.app in plugin_lookup.keys(): + plugin = plugin_lookup[event.app] + entry_point = getattr(plugin, 'entry_point_url_id', None) + if entry_point: + url = reverse(entry_point, kwargs=url_kwargs) + title = plugin.title + if getattr(plugin, 'icon', None): + icon = plugin.icon + + return ( + '    ' + ''.format( + 'href="{}"'.format(url) if url else '', title, icon + ) + ) # Template rendering ----------------------------------------------------------- @@ -64,30 +101,6 @@ def get_status_style(status): ) -@register.simple_tag -def get_app_url(event): - """Return URL for event application""" - url_kwargs = {} - if event.project: - url_kwargs['project'] = event.project.sodar_uuid - - # Projectroles is a special case - if event.app == 'projectroles' and event.project: - return reverse('projectroles:detail', kwargs=url_kwargs) - elif event.app != 'projectroles': - app_plugin = get_app_plugin(event.app, plugin_type='project_app') - if app_plugin: - return reverse( - app_plugin.entry_point_url_id, - kwargs=url_kwargs, - ) - # Try site apps - app_plugin = get_app_plugin(event.app, plugin_type='site_app') - if app_plugin: - return reverse(app_plugin.entry_point_url_id) - return '#' - - @register.simple_tag def get_event_details(event): """Return HTML data for event detail popover""" @@ -203,28 +216,23 @@ def html_print_array(array, str_list, indent): @register.filter -def collect_extra_data(event: ProjectEvent): +def collect_extra_data(event): ls = [] - if event.extra_data is not None and len(event.extra_data) > 0: ls.append(('extra-data', 'Extra Data', event)) - for status in event.get_status_changes(): if status.extra_data is not None and len(status.extra_data) > 0: ls.append( ('status-extra-data', 'Status: ' + status.status_type, status) ) - return ls @register.filter -def has_extra_data(event: ProjectEvent): +def has_extra_data(event): if event.extra_data is not None and len(event.extra_data) > 0: return True - for status in event.get_status_changes(): if status.extra_data is not None and len(status.extra_data) > 0: return True - return False diff --git a/timeline/tests/test_api.py b/timeline/tests/test_api.py index cdb3241c..dbfbe2f7 100644 --- a/timeline/tests/test_api.py +++ b/timeline/tests/test_api.py @@ -28,6 +28,7 @@ ProjectEventObjectRef, DEFAULT_MESSAGES, ) +from timeline.templatetags import timeline_tags as tags # Global constants from settings @@ -39,21 +40,27 @@ PROJECT_TYPE_PROJECT = SODAR_CONSTANTS['PROJECT_TYPE_PROJECT'] +class TimelineAPIMixin: + """Helpers for timeline API use""" + + @classmethod + def get_request(cls, user, project): + """Return mock request""" + request = RequestFactory().get( + 'timeline:list', kwargs={'project': project} + ) + request.user = user + return request + + class TestTimelineAPI( + TimelineAPIMixin, ProjectEventMixin, ProjectEventStatusMixin, RemoteSiteMixin, FolderMixin, TestProjectEventBase, ): - def _get_request(self, user): - """Return mock request""" - request = RequestFactory().get( - 'timeline:list', kwargs={'project': self.project} - ) - request.user = user - return request - def setUp(self): super().setUp() self.timeline = get_backend_api('timeline_backend') @@ -419,7 +426,7 @@ def test_get_event_description_project(self): name=self.project.title, ) desc = self.timeline.get_event_description( - event, self._get_request(self.user_owner) + event, request=self.get_request(self.user_owner, self.project) ) self.assertIn(self.project.title, desc) self.assertIn('sodar-tl-project-link', desc) @@ -440,7 +447,7 @@ def test_get_event_description_remote_site(self): name=site.name, ) desc = self.timeline.get_event_description( - event, self._get_request(self.superuser) + event, request=self.get_request(self.superuser, self.project) ) self.assertIn(site.name, desc) self.assertIn('sodar-tl-object-link', desc) @@ -467,7 +474,36 @@ def test_get_event_description_plugin_app(self): name=folder.name, ) desc = self.timeline.get_event_description( - event, self._get_request(self.superuser) + event, request=self.get_request(self.superuser, self.project) + ) + self.assertIn(folder.name, desc) + self.assertIn('sodar-tl-object-link', desc) + + def test_get_event_description_plugin_lookup(self): + """Test getting event description with app plugin and lookup dict""" + event = self.timeline.add_event( + project=self.project, + app_name='filesfolders', + user=self.user_owner, + event_name='test_event', + description='event with {obj}', + ) + folder = self._make_folder( + name='folder', + project=self.project, + folder=None, + description='', + owner=self.user_owner, + ) + event.add_object( + obj=folder, + label='obj', + name=folder.name, + ) + desc = self.timeline.get_event_description( + event, + plugin_lookup=tags.get_plugin_lookup(), + request=self.get_request(self.superuser, self.project), ) self.assertIn(folder.name, desc) self.assertIn('sodar-tl-object-link', desc) @@ -489,7 +525,7 @@ def test_get_event_description_invalid_app(self): name=self.project.title, ) desc = self.timeline.get_event_description( - event, self._get_request(self.superuser) + event, request=self.get_request(self.superuser, self.project) ) self.assertNotIn(self.project.title, desc) self.assertIn('sodar-tl-plugin-error', desc) diff --git a/timeline/tests/test_models.py b/timeline/tests/test_models.py index 0940b26d..58ca3538 100644 --- a/timeline/tests/test_models.py +++ b/timeline/tests/test_models.py @@ -29,7 +29,14 @@ class ProjectEventMixin: @classmethod def _make_event( - cls, project, app, user, event_name, description, classified, extra_data + cls, + project, + app, + user, + event_name, + description='', + classified=False, + extra_data=None, ): values = { 'project': project, @@ -38,7 +45,7 @@ def _make_event( 'event_name': event_name, 'description': description, 'classified': classified, - 'extra_data': extra_data, + 'extra_data': extra_data or {}, } result = ProjectEvent(**values) result.save() @@ -49,14 +56,14 @@ class ProjectEventObjectRefMixin: """Helper mixin for ProjectEventObjectRef creation""" @classmethod - def _make_object_ref(cls, event, obj, label, name, uuid, extra_data): + def _make_object_ref(cls, event, obj, label, name, uuid, extra_data=None): values = { 'event': event, 'label': label, 'name': name, 'object_model': obj.__class__.__name__, 'object_uuid': uuid, - 'extra_data': extra_data, + 'extra_data': extra_data or {}, } result = ProjectEventObjectRef(**values) result.save() @@ -67,12 +74,14 @@ class ProjectEventStatusMixin: """Helper mixin for ProjectEventStatus creation""" @classmethod - def _make_event_status(cls, event, status_type, description, extra_data): + def _make_event_status( + cls, event, status_type, description, extra_data=None + ): values = { 'event': event, 'status_type': status_type, 'description': description, - 'extra_data': extra_data, + 'extra_data': extra_data or {}, } result = ProjectEventStatus(**values) result.save() diff --git a/timeline/tests/test_templatetags.py b/timeline/tests/test_templatetags.py new file mode 100644 index 00000000..59811d6a --- /dev/null +++ b/timeline/tests/test_templatetags.py @@ -0,0 +1,209 @@ +"""Tests for template tags in the timeline app""" + +from django.urls import reverse + +from djangoplugins.models import Plugin + +# Projectroles dependency +from projectroles.plugins import get_app_plugin, get_backend_api + +from timeline.models import ProjectEvent, DEFAULT_MESSAGES +from timeline.templatetags import timeline_tags as tags +from timeline.tests.test_api import TimelineAPIMixin +from timeline.tests.test_models import ( + TestProjectEventBase, + ProjectEventMixin, + ProjectEventStatusMixin, + ProjectEventObjectRefMixin, +) + + +INVALID_APP_NAME = 'asdfghjk1235' +TEST_EVENT_NAME = 'test_event' +TEST_EVENT_DESC = 'test event' + + +class TestTemplateTags( + TimelineAPIMixin, + ProjectEventMixin, + ProjectEventStatusMixin, + ProjectEventObjectRefMixin, + TestProjectEventBase, +): + """Tests for timeline template tags""" + + def setUp(self): + super().setUp() + + # Initialize project event + self.event = self._make_event( + project=self.project, + app='projectroles', + user=self.user_owner, + event_name='project_create', + description='create project with {owner} as owner', + ) + self.event_status = self._make_event_status( + event=self.event, + status_type='OK', + description=DEFAULT_MESSAGES['OK'], + ) + + # Generate plugin lookup dict + self.plugin_lookup = tags.get_plugin_lookup() + # Get timeline API + self.timeline = get_backend_api('timeline_backend') + + def test_get_event_description(self): + """Test get_event_description()""" + request = self.get_request(self.user_owner, self.project) + self.assertEqual( + tags.get_event_description(self.event, self.plugin_lookup, request), + self.timeline.get_event_description(self.event, request=request), + ) + + def test_get_event_description_no_request(self): + """Test get_event_description() without a request object""" + self.assertEqual( + tags.get_event_description(self.event, self.plugin_lookup), + self.timeline.get_event_description(self.event), + ) + + def test_get_details_events(self): + """Test get_details_events()""" + self.assertEqual(ProjectEvent.objects.count(), 1) + self.assertEqual(len(tags.get_details_events(self.project)), 1) + # Create 5 additional events for a total of 6 + for _ in range(5): + event = self._make_event( + project=self.project, + app='projectroles', + user=self.user_owner, + event_name=TEST_EVENT_NAME, + description=TEST_EVENT_DESC, + ) + self._make_event_status( + event=event, + status_type='OK', + description=DEFAULT_MESSAGES['OK'], + ) + self.assertEqual(ProjectEvent.objects.count(), 6) + self.assertEqual(len(tags.get_details_events(self.project)), 5) + + def test_get_details_events_classified_disabled(self): + """Test get_details_events() with disabled classified event display""" + self.assertEqual(len(tags.get_details_events(self.project)), 1) + event = self._make_event( + project=self.project, + app='projectroles', + user=self.user_owner, + event_name=TEST_EVENT_NAME, + description=TEST_EVENT_DESC, + classified=True, + ) + self._make_event_status( + event=event, + status_type='OK', + description=DEFAULT_MESSAGES['OK'], + ) + self.assertEqual(ProjectEvent.objects.count(), 2) + self.assertEqual(len(tags.get_details_events(self.project)), 1) + + def test_get_details_events_classified_enabled(self): + """Test get_details_events() with enabled classified event display""" + self.assertEqual(len(tags.get_details_events(self.project)), 1) + event = self._make_event( + project=self.project, + app='projectroles', + user=self.user_owner, + event_name=TEST_EVENT_NAME, + description=TEST_EVENT_DESC, + classified=True, + ) + self._make_event_status( + event=event, + status_type='OK', + description=DEFAULT_MESSAGES['OK'], + ) + ret = tags.get_details_events(self.project, view_classified=True) + self.assertEqual(len(ret), 2) + self.assertEqual(ret[0], event) # Latest event should be first + + def test_get_plugin_lookup(self): + """Test get_plugin_lookup()""" + ret = tags.get_plugin_lookup() + for p in Plugin.objects.all(): + self.assertIn(p.name, ret.keys()) + self.assertEqual(ret[p.name].__class__, p.get_plugin().__class__) + + def test_get_app_icon_html(self): + """Test get_app_icon_html()""" + ret = tags.get_app_icon_html(self.event, self.plugin_lookup) + url = reverse( + 'projectroles:detail', + kwargs={'project': self.project.sodar_uuid}, + ) + self.assertIn('mdi:cube', ret) + self.assertIn('Projectroles', ret) + self.assertIn(url, ret) + + def test_get_app_icon_html_no_project(self): + """Test get_app_icon_html() on event without project""" + event = self._make_event( + project=None, + app='projectroles', + user=self.user_owner, + event_name=TEST_EVENT_NAME, + description=TEST_EVENT_DESC, + ) + ret = tags.get_app_icon_html(event, self.plugin_lookup) + self.assertIn(tags.ICON_PROJECTROLES, ret) + self.assertIn('Projectroles', ret) + self.assertNotIn('href=', ret) + + def test_get_app_icon_html_app(self): + """Test get_app_icon_html() on event from an app""" + plugin = get_app_plugin('filesfolders') + url = reverse( + plugin.entry_point_url_id, + kwargs={'project': self.project.sodar_uuid}, + ) + event = self._make_event( + project=self.project, + app='filesfolders', + user=self.user_owner, + event_name=TEST_EVENT_NAME, + description=TEST_EVENT_DESC, + ) + ret = tags.get_app_icon_html(event, self.plugin_lookup) + self.assertIn(plugin.icon, ret) + self.assertIn(plugin.title, ret) + self.assertIn(url, ret) + + def test_get_app_icon_html_invalid_app(self): + """Test get_app_icon_html() on event from an invalid app""" + event = self._make_event( + project=self.project, + app=INVALID_APP_NAME, + user=self.user_owner, + event_name=TEST_EVENT_NAME, + description=TEST_EVENT_DESC, + ) + ret = tags.get_app_icon_html(event, self.plugin_lookup) + self.assertIn(tags.ICON_UNKNOWN_APP, ret) + self.assertIn(INVALID_APP_NAME, ret) # No title = use app name in event + self.assertNotIn('href=', ret) + + def test_get_status_style(self): + """Test get_status_style()""" + self.assertEqual( + tags.get_status_style(self.event_status), + tags.STATUS_STYLES[self.event_status.status_type] + ' text-light', + ) + + def test_get_status_style_invalid(self): + """Test get_status_style() with an invalid stauts""" + self.event_status.status_type = 'qwerty123456' + self.assertEqual(tags.get_status_style(self.event_status), 'bg-light') + + # TODO: Test extra data tags once refactored diff --git a/timeline/tests/test_ui.py b/timeline/tests/test_ui.py index cfbb5779..d52cc2ce 100644 --- a/timeline/tests/test_ui.py +++ b/timeline/tests/test_ui.py @@ -112,9 +112,9 @@ def test_render_object(self): def test_render_details(self): """Test visibility of events on the project details page""" expected = [ - (self.superuser, 1), - (self.owner_as.user, 1), - (self.delegate_as.user, 1), + (self.superuser, 2), + (self.owner_as.user, 2), + (self.delegate_as.user, 2), (self.contributor_as.user, 1), (self.guest_as.user, 1), ] diff --git a/tokens/tests/test_ui.py b/tokens/tests/test_ui.py index a603ed42..72f06fc0 100644 --- a/tokens/tests/test_ui.py +++ b/tokens/tests/test_ui.py @@ -6,6 +6,8 @@ from django.utils import timezone from knox.models import AuthToken +from selenium.webdriver.common.by import By + # Projectroles dependency from projectroles.tests.test_ui import TestUIBase @@ -41,12 +43,12 @@ def test_list_expiry(self): """Test token expiry dates in token list""" url = reverse('tokens:list') self.login_and_redirect(self.regular_user, url) - items = self.selenium.find_elements_by_class_name('sodar-tk-list-item') + items = self.selenium.find_elements(By.CLASS_NAME, 'sodar-tk-list-item') self.assertEqual(len(items), 2) expiry_time = timezone.localtime(self.token.expiry).strftime( '%Y-%m-%d %H:%M' ) values = [] for item in items: - values.append(item.find_elements_by_tag_name('td')[2].text) + values.append(item.find_elements(By.TAG_NAME, 'td')[2].text) self.assertCountEqual(values, ['Never', expiry_time]) diff --git a/utility/install_chrome.sh b/utility/install_chrome.sh index b048a878..9fe43247 100755 --- a/utility/install_chrome.sh +++ b/utility/install_chrome.sh @@ -5,7 +5,7 @@ echo "Installing Chrome + Driver for UI Testing" echo "***********************************************" # Version -CHROME_DRIVER_VERSION=96.0.4664.35 +CHROME_DRIVER_VERSION=97.0.4692.71 # Install dependencies sudo apt-get update diff --git a/utility/install_chrome_gitlab.sh b/utility/install_chrome_gitlab.sh index 3600b837..1fe02e7a 100644 --- a/utility/install_chrome_gitlab.sh +++ b/utility/install_chrome_gitlab.sh @@ -5,7 +5,7 @@ echo "Installing Chrome + Driver for UI Testing" echo "***********************************************" # Version -CHROME_DRIVER_VERSION=96.0.4664.35 +CHROME_DRIVER_VERSION=97.0.4692.71 # Install dependencies apt-get -y install unzip libgconf-2-4 xvfb gtk2-engines-pixbuf diff --git a/utility/install_python_dependencies.sh b/utility/install_python_dependencies.sh index 2038c2ea..294f740c 100755 --- a/utility/install_python_dependencies.sh +++ b/utility/install_python_dependencies.sh @@ -22,6 +22,7 @@ if [ -z "$VIRTUAL_ENV" ]; then echo >&2 -e "\n" exit 1; else + pip install wheel==0.37.1 pip install -r $PROJECT_DIR/requirements/local.txt pip install -r $PROJECT_DIR/requirements/test.txt pip install -r $PROJECT_DIR/requirements.txt diff --git a/versioneer.py b/versioneer.py index 1040c218..b4cd1d6c 100644 --- a/versioneer.py +++ b/versioneer.py @@ -1,5 +1,5 @@ -# Version: 0.19 +# Version: 0.21 """The Versioneer - like a rocketeer, but for versions. @@ -256,6 +256,8 @@ dependency * [minver](https://github.com/jbweston/miniver) - a lightweight reimplementation of versioneer +* [versioningit](https://github.com/jwodder/versioningit) - a PEP 518-based setuptools + plugin ## License @@ -272,6 +274,11 @@ [travis-url]: https://travis-ci.com/github/python-versioneer/python-versioneer """ +# pylint:disable=invalid-name,import-outside-toplevel,missing-function-docstring +# pylint:disable=missing-class-docstring,too-many-branches,too-many-statements +# pylint:disable=raise-missing-from,too-many-lines,too-many-locals,import-error +# pylint:disable=too-few-public-methods,redefined-outer-name,consider-using-with +# pylint:disable=attribute-defined-outside-init,too-many-arguments import configparser import errno @@ -280,6 +287,7 @@ import re import subprocess import sys +from typing import Callable, Dict class VersioneerConfig: @@ -314,12 +322,12 @@ def get_root(): # module-import table will cache the first one. So we can't use # os.path.dirname(__file__), as that will find whichever # versioneer.py was first imported, even in later projects. - me = os.path.realpath(os.path.abspath(__file__)) - me_dir = os.path.normcase(os.path.splitext(me)[0]) + my_path = os.path.realpath(os.path.abspath(__file__)) + me_dir = os.path.normcase(os.path.splitext(my_path)[0]) vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) if me_dir != vsr_dir: print("Warning: build in %s is using versioneer.py from %s" - % (os.path.dirname(me), versioneer_py)) + % (os.path.dirname(my_path), versioneer_py)) except NameError: pass return root @@ -327,30 +335,29 @@ def get_root(): def get_config_from_root(root): """Read the project setup.cfg file to determine Versioneer config.""" - # This might raise EnvironmentError (if setup.cfg is missing), or + # This might raise OSError (if setup.cfg is missing), or # configparser.NoSectionError (if it lacks a [versioneer] section), or # configparser.NoOptionError (if it lacks "VCS="). See the docstring at # the top of versioneer.py for instructions on writing your setup.cfg . setup_cfg = os.path.join(root, "setup.cfg") parser = configparser.ConfigParser() - with open(setup_cfg, "r") as f: - parser.read_file(f) + with open(setup_cfg, "r") as cfg_file: + parser.read_file(cfg_file) VCS = parser.get("versioneer", "VCS") # mandatory - def get(parser, name): - if parser.has_option("versioneer", name): - return parser.get("versioneer", name) - return None + # Dict-like interface for non-mandatory entries + section = parser["versioneer"] + cfg = VersioneerConfig() cfg.VCS = VCS - cfg.style = get(parser, "style") or "" - cfg.versionfile_source = get(parser, "versionfile_source") - cfg.versionfile_build = get(parser, "versionfile_build") - cfg.tag_prefix = get(parser, "tag_prefix") + cfg.style = section.get("style", "") + cfg.versionfile_source = section.get("versionfile_source") + cfg.versionfile_build = section.get("versionfile_build") + cfg.tag_prefix = section.get("tag_prefix") if cfg.tag_prefix in ("''", '""'): cfg.tag_prefix = "" - cfg.parentdir_prefix = get(parser, "parentdir_prefix") - cfg.verbose = get(parser, "verbose") + cfg.parentdir_prefix = section.get("parentdir_prefix") + cfg.verbose = section.get("verbose") return cfg @@ -359,17 +366,15 @@ class NotThisMethod(Exception): # these dictionaries contain VCS-specific tools -LONG_VERSION_PY = {} -HANDLERS = {} +LONG_VERSION_PY: Dict[str, str] = {} +HANDLERS: Dict[str, Dict[str, Callable]] = {} def register_vcs_handler(vcs, method): # decorator """Create decorator to mark a method as the handler of a VCS.""" def decorate(f): """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f + HANDLERS.setdefault(vcs, {})[method] = f return f return decorate @@ -378,17 +383,17 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None): """Call the given command(s).""" assert isinstance(commands, list) - p = None - for c in commands: + process = None + for command in commands: try: - dispcmd = str([c] + args) + dispcmd = str([command] + args) # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) + process = subprocess.Popen([command] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) break - except EnvironmentError: + except OSError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue @@ -400,13 +405,13 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, if verbose: print("unable to find command, tried %s" % (commands,)) return None, None - stdout = p.communicate()[0].strip().decode() - if p.returncode != 0: + stdout = process.communicate()[0].strip().decode() + if process.returncode != 0: if verbose: print("unable to run %s (error)" % dispcmd) print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode + return None, process.returncode + return stdout, process.returncode LONG_VERSION_PY['git'] = r''' @@ -417,7 +422,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, # that just contains the computed version number. # This file is released into the public domain. Generated by -# versioneer-0.19 (https://github.com/python-versioneer/python-versioneer) +# versioneer-0.21 (https://github.com/python-versioneer/python-versioneer) """Git implementation of _version.py.""" @@ -426,6 +431,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, import re import subprocess import sys +from typing import Callable, Dict def get_keywords(): @@ -463,8 +469,8 @@ class NotThisMethod(Exception): """Exception raised if a method is not valid for the current scenario.""" -LONG_VERSION_PY = {} -HANDLERS = {} +LONG_VERSION_PY: Dict[str, str] = {} +HANDLERS: Dict[str, Dict[str, Callable]] = {} def register_vcs_handler(vcs, method): # decorator @@ -482,17 +488,17 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None): """Call the given command(s).""" assert isinstance(commands, list) - p = None - for c in commands: + process = None + for command in commands: try: - dispcmd = str([c] + args) + dispcmd = str([command] + args) # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) + process = subprocess.Popen([command] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) break - except EnvironmentError: + except OSError: e = sys.exc_info()[1] if e.errno == errno.ENOENT: continue @@ -504,13 +510,13 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, if verbose: print("unable to find command, tried %%s" %% (commands,)) return None, None - stdout = p.communicate()[0].strip().decode() - if p.returncode != 0: + stdout = process.communicate()[0].strip().decode() + if process.returncode != 0: if verbose: print("unable to run %%s (error)" %% dispcmd) print("stdout was %%s" %% stdout) - return None, p.returncode - return stdout, p.returncode + return None, process.returncode + return stdout, process.returncode def versions_from_parentdir(parentdir_prefix, root, verbose): @@ -522,15 +528,14 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): """ rootdirs = [] - for i in range(3): + for _ in range(3): dirname = os.path.basename(root) if dirname.startswith(parentdir_prefix): return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level + rootdirs.append(root) + root = os.path.dirname(root) # up a level if verbose: print("Tried directories %%s but none started with prefix %%s" %% @@ -547,22 +552,21 @@ def git_get_keywords(versionfile_abs): # _version.py. keywords = {} try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: + with open(versionfile_abs, "r") as fobj: + for line in fobj: + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + except OSError: pass return keywords @@ -570,8 +574,8 @@ def git_get_keywords(versionfile_abs): @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") + if "refnames" not in keywords: + raise NotThisMethod("Short version file found") date = keywords.get("date") if date is not None: # Use only the last line. Previous lines may contain GPG signature @@ -590,11 +594,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) + refs = {r.strip() for r in refnames.strip("()").split(",")} # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + tags = {r[len(TAG):] for r in refs if r.startswith(TAG)} if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %%d @@ -603,7 +607,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) + tags = {r for r in refs if re.search(r'\d', r)} if verbose: print("discarding '%%s', no digits" %% ",".join(refs - tags)) if verbose: @@ -612,6 +616,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] + # Filter out refs that exactly match prefix or that don't start + # with a number once the prefix is stripped (mostly a concern + # when prefix is '') + if not re.match(r'\d', r): + continue if verbose: print("picking %%s" %% r) return {"version": r, @@ -627,7 +636,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): @register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): +def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* @@ -635,11 +644,13 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): version string, meaning we're inside a checked out source tree. """ GITS = ["git"] + TAG_PREFIX_REGEX = "*" if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] + TAG_PREFIX_REGEX = r"\*" - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) + _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) if rc != 0: if verbose: print("Directory %%s not under git control" %% root) @@ -647,15 +658,16 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%%s*" %% tag_prefix], - cwd=root) + describe_out, rc = runner(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", + "%%s%%s" %% (tag_prefix, TAG_PREFIX_REGEX)], + cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() @@ -665,6 +677,39 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None + branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], + cwd=root) + # --abbrev-ref was added in git-1.6.3 + if rc != 0 or branch_name is None: + raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") + branch_name = branch_name.strip() + + if branch_name == "HEAD": + # If we aren't exactly on a branch, pick a branch which represents + # the current commit. If all else fails, we are on a branchless + # commit. + branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) + # --contains was added in git-1.5.4 + if rc != 0 or branches is None: + raise NotThisMethod("'git branch --contains' returned error") + branches = branches.split("\n") + + # Remove the first line if we're running detached + if "(" in branches[0]: + branches.pop(0) + + # Strip off the leading "* " from the list of branches. + branches = [branch[2:] for branch in branches] + if "master" in branches: + branch_name = "master" + elif not branches: + branch_name = None + else: + # Pick the first branch that is returned. Good or bad. + branch_name = branches[0] + + pieces["branch"] = branch_name + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out @@ -681,7 +726,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: - # unparseable. Maybe git-describe is misbehaving? + # unparsable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%%s'" %% describe_out) return pieces @@ -706,13 +751,11 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): else: # HEX: no tags pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) + count_out, rc = runner(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], - cwd=root)[0].strip() + date = runner(GITS, ["show", "-s", "--format=%%ci", "HEAD"], cwd=root)[0].strip() # Use only the last line. Previous lines may contain GPG signature # information. date = date.splitlines()[-1] @@ -753,16 +796,64 @@ def render_pep440(pieces): return rendered +def render_pep440_branch(pieces): + """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . + + The ".dev0" means not master branch. Note that .dev0 sorts backwards + (a feature branch will appear "older" than the master branch). + + Exceptions: + 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0" + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+untagged.%%d.g%%s" %% (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def pep440_split_post(ver): + """Split pep440 version string at the post-release segment. + + Returns the release segments before the post-release and the + post-release version number (or -1 if no post-release segment is present). + """ + vc = str.split(ver, ".post") + return vc[0], int(vc[1] or 0) if len(vc) == 2 else None + + def render_pep440_pre(pieces): - """TAG[.post0.devDISTANCE] -- No -dirty. + """TAG[.postN.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post0.devDISTANCE """ if pieces["closest-tag"]: - rendered = pieces["closest-tag"] if pieces["distance"]: - rendered += ".post0.dev%%d" %% pieces["distance"] + # update the post release segment + tag_version, post_version = pep440_split_post(pieces["closest-tag"]) + rendered = tag_version + if post_version is not None: + rendered += ".post%%d.dev%%d" %% (post_version+1, pieces["distance"]) + else: + rendered += ".post0.dev%%d" %% (pieces["distance"]) + else: + # no commits, use the tag as the version + rendered = pieces["closest-tag"] else: # exception #1 rendered = "0.post0.dev%%d" %% pieces["distance"] @@ -796,6 +887,35 @@ def render_pep440_post(pieces): return rendered +def render_pep440_post_branch(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . + + The ".dev0" means not master branch. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%%s" %% pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+g%%s" %% pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . @@ -872,10 +992,14 @@ def render(pieces, style): if style == "pep440": rendered = render_pep440(pieces) + elif style == "pep440-branch": + rendered = render_pep440_branch(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) + elif style == "pep440-post-branch": + rendered = render_pep440_post_branch(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": @@ -911,7 +1035,7 @@ def get_versions(): # versionfile_source is the relative path from the top of the source # tree (where the .git directory might live) to this file. Invert # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): + for _ in cfg.versionfile_source.split('/'): root = os.path.dirname(root) except NameError: return {"version": "0+unknown", "full-revisionid": None, @@ -946,22 +1070,21 @@ def git_get_keywords(versionfile_abs): # _version.py. keywords = {} try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: + with open(versionfile_abs, "r") as fobj: + for line in fobj: + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + except OSError: pass return keywords @@ -969,8 +1092,8 @@ def git_get_keywords(versionfile_abs): @register_vcs_handler("git", "keywords") def git_versions_from_keywords(keywords, tag_prefix, verbose): """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") + if "refnames" not in keywords: + raise NotThisMethod("Short version file found") date = keywords.get("date") if date is not None: # Use only the last line. Previous lines may contain GPG signature @@ -989,11 +1112,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): if verbose: print("keywords are unexpanded, not using") raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) + refs = {r.strip() for r in refnames.strip("()").split(",")} # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # just "foo-1.0". If we see a "tag: " prefix, prefer those. TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + tags = {r[len(TAG):] for r in refs if r.startswith(TAG)} if not tags: # Either we're using git < 1.8.3, or there really are no tags. We use # a heuristic: assume all version tags have a digit. The old git %d @@ -1002,7 +1125,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # between branches and tags. By ignoring refnames without digits, we # filter out many common branch names like "release" and # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) + tags = {r for r in refs if re.search(r'\d', r)} if verbose: print("discarding '%s', no digits" % ",".join(refs - tags)) if verbose: @@ -1011,6 +1134,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): # sorting will prefer e.g. "2.0" over "2.0rc1" if ref.startswith(tag_prefix): r = ref[len(tag_prefix):] + # Filter out refs that exactly match prefix or that don't start + # with a number once the prefix is stripped (mostly a concern + # when prefix is '') + if not re.match(r'\d', r): + continue if verbose: print("picking %s" % r) return {"version": r, @@ -1026,7 +1154,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose): @register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): +def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command): """Get version from 'git describe' in the root of the source tree. This only gets called if the git-archive 'subst' keywords were *not* @@ -1034,11 +1162,13 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): version string, meaning we're inside a checked out source tree. """ GITS = ["git"] + TAG_PREFIX_REGEX = "*" if sys.platform == "win32": GITS = ["git.cmd", "git.exe"] + TAG_PREFIX_REGEX = r"\*" - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) + _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) if rc != 0: if verbose: print("Directory %s not under git control" % root) @@ -1046,15 +1176,16 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) + describe_out, rc = runner(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", + "%s%s" % (tag_prefix, TAG_PREFIX_REGEX)], + cwd=root) # --long was added in git-1.5.5 if describe_out is None: raise NotThisMethod("'git describe' failed") describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) if full_out is None: raise NotThisMethod("'git rev-parse' failed") full_out = full_out.strip() @@ -1064,6 +1195,39 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): pieces["short"] = full_out[:7] # maybe improved later pieces["error"] = None + branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], + cwd=root) + # --abbrev-ref was added in git-1.6.3 + if rc != 0 or branch_name is None: + raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") + branch_name = branch_name.strip() + + if branch_name == "HEAD": + # If we aren't exactly on a branch, pick a branch which represents + # the current commit. If all else fails, we are on a branchless + # commit. + branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) + # --contains was added in git-1.5.4 + if rc != 0 or branches is None: + raise NotThisMethod("'git branch --contains' returned error") + branches = branches.split("\n") + + # Remove the first line if we're running detached + if "(" in branches[0]: + branches.pop(0) + + # Strip off the leading "* " from the list of branches. + branches = [branch[2:] for branch in branches] + if "master" in branches: + branch_name = "master" + elif not branches: + branch_name = None + else: + # Pick the first branch that is returned. Good or bad. + branch_name = branches[0] + + pieces["branch"] = branch_name + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] # TAG might have hyphens. git_describe = describe_out @@ -1080,7 +1244,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): # TAG-NUM-gHEX mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) if not mo: - # unparseable. Maybe git-describe is misbehaving? + # unparsable. Maybe git-describe is misbehaving? pieces["error"] = ("unable to parse git-describe output: '%s'" % describe_out) return pieces @@ -1105,13 +1269,11 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): else: # HEX: no tags pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) + count_out, rc = runner(GITS, ["rev-list", "HEAD", "--count"], cwd=root) pieces["distance"] = int(count_out) # total number of commits # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() + date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() # Use only the last line. Previous lines may contain GPG signature # information. date = date.splitlines()[-1] @@ -1133,27 +1295,26 @@ def do_vcs_install(manifest_in, versionfile_source, ipy): if ipy: files.append(ipy) try: - me = __file__ - if me.endswith(".pyc") or me.endswith(".pyo"): - me = os.path.splitext(me)[0] + ".py" - versioneer_file = os.path.relpath(me) + my_path = __file__ + if my_path.endswith(".pyc") or my_path.endswith(".pyo"): + my_path = os.path.splitext(my_path)[0] + ".py" + versioneer_file = os.path.relpath(my_path) except NameError: versioneer_file = "versioneer.py" files.append(versioneer_file) present = False try: - f = open(".gitattributes", "r") - for line in f.readlines(): - if line.strip().startswith(versionfile_source): - if "export-subst" in line.strip().split()[1:]: - present = True - f.close() - except EnvironmentError: + with open(".gitattributes", "r") as fobj: + for line in fobj: + if line.strip().startswith(versionfile_source): + if "export-subst" in line.strip().split()[1:]: + present = True + break + except OSError: pass if not present: - f = open(".gitattributes", "a+") - f.write("%s export-subst\n" % versionfile_source) - f.close() + with open(".gitattributes", "a+") as fobj: + fobj.write(f"{versionfile_source} export-subst\n") files.append(".gitattributes") run_command(GITS, ["add", "--"] + files) @@ -1167,15 +1328,14 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): """ rootdirs = [] - for i in range(3): + for _ in range(3): dirname = os.path.basename(root) if dirname.startswith(parentdir_prefix): return {"version": dirname[len(parentdir_prefix):], "full-revisionid": None, "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level + rootdirs.append(root) + root = os.path.dirname(root) # up a level if verbose: print("Tried directories %s but none started with prefix %s" % @@ -1184,7 +1344,7 @@ def versions_from_parentdir(parentdir_prefix, root, verbose): SHORT_VERSION_PY = """ -# This file was generated by 'versioneer.py' (0.19) from +# This file was generated by 'versioneer.py' (0.21) from # revision-control system data, or from the parent directory name of an # unpacked source archive. Distribution tarballs contain a pre-generated copy # of this file. @@ -1206,7 +1366,7 @@ def versions_from_file(filename): try: with open(filename) as f: contents = f.read() - except EnvironmentError: + except OSError: raise NotThisMethod("unable to read _version.py") mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", contents, re.M | re.S) @@ -1261,16 +1421,64 @@ def render_pep440(pieces): return rendered +def render_pep440_branch(pieces): + """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . + + The ".dev0" means not master branch. Note that .dev0 sorts backwards + (a feature branch will appear "older" than the master branch). + + Exceptions: + 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0" + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def pep440_split_post(ver): + """Split pep440 version string at the post-release segment. + + Returns the release segments before the post-release and the + post-release version number (or -1 if no post-release segment is present). + """ + vc = str.split(ver, ".post") + return vc[0], int(vc[1] or 0) if len(vc) == 2 else None + + def render_pep440_pre(pieces): - """TAG[.post0.devDISTANCE] -- No -dirty. + """TAG[.postN.devDISTANCE] -- No -dirty. Exceptions: 1: no tags. 0.post0.devDISTANCE """ if pieces["closest-tag"]: - rendered = pieces["closest-tag"] if pieces["distance"]: - rendered += ".post0.dev%d" % pieces["distance"] + # update the post release segment + tag_version, post_version = pep440_split_post(pieces["closest-tag"]) + rendered = tag_version + if post_version is not None: + rendered += ".post%d.dev%d" % (post_version+1, pieces["distance"]) + else: + rendered += ".post0.dev%d" % (pieces["distance"]) + else: + # no commits, use the tag as the version + rendered = pieces["closest-tag"] else: # exception #1 rendered = "0.post0.dev%d" % pieces["distance"] @@ -1304,6 +1512,35 @@ def render_pep440_post(pieces): return rendered +def render_pep440_post_branch(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . + + The ".dev0" means not master branch. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["branch"] != "master": + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + def render_pep440_old(pieces): """TAG[.postDISTANCE[.dev0]] . @@ -1380,10 +1617,14 @@ def render(pieces, style): if style == "pep440": rendered = render_pep440(pieces) + elif style == "pep440-branch": + rendered = render_pep440_branch(pieces) elif style == "pep440-pre": rendered = render_pep440_pre(pieces) elif style == "pep440-post": rendered = render_pep440_post(pieces) + elif style == "pep440-post-branch": + rendered = render_pep440_post_branch(pieces) elif style == "pep440-old": rendered = render_pep440_old(pieces) elif style == "git-describe": @@ -1568,7 +1809,9 @@ def run(self): write_to_version_file(target_versionfile, versions) cmds["build_py"] = cmd_build_py - if "setuptools" in sys.modules: + if 'build_ext' in cmds: + _build_ext = cmds['build_ext'] + elif "setuptools" in sys.modules: from setuptools.command.build_ext import build_ext as _build_ext else: from distutils.command.build_ext import build_ext as _build_ext @@ -1588,7 +1831,7 @@ def run(self): # now locate _version.py in the new build/ directory and replace # it with an updated value target_versionfile = os.path.join(self.build_lib, - cfg.versionfile_source) + cfg.versionfile_build) print("UPDATING %s" % target_versionfile) write_to_version_file(target_versionfile, versions) cmds["build_ext"] = cmd_build_ext @@ -1720,21 +1963,26 @@ def make_release_tree(self, base_dir, files): """ -INIT_PY_SNIPPET = """ +OLD_SNIPPET = """ from ._version import get_versions __version__ = get_versions()['version'] del get_versions """ +INIT_PY_SNIPPET = """ +from . import {0} +__version__ = {0}.get_versions()['version'] +""" + def do_setup(): """Do main VCS-independent setup function for installing Versioneer.""" root = get_root() try: cfg = get_config_from_root(root) - except (EnvironmentError, configparser.NoSectionError, + except (OSError, configparser.NoSectionError, configparser.NoOptionError) as e: - if isinstance(e, (EnvironmentError, configparser.NoSectionError)): + if isinstance(e, (OSError, configparser.NoSectionError)): print("Adding sample versioneer config to setup.cfg", file=sys.stderr) with open(os.path.join(root, "setup.cfg"), "a") as f: @@ -1758,12 +2006,18 @@ def do_setup(): try: with open(ipy, "r") as f: old = f.read() - except EnvironmentError: + except OSError: old = "" - if INIT_PY_SNIPPET not in old: + module = os.path.splitext(os.path.basename(cfg.versionfile_source))[0] + snippet = INIT_PY_SNIPPET.format(module) + if OLD_SNIPPET in old: + print(" replacing boilerplate in %s" % ipy) + with open(ipy, "w") as f: + f.write(old.replace(OLD_SNIPPET, snippet)) + elif snippet not in old: print(" appending to %s" % ipy) with open(ipy, "a") as f: - f.write(INIT_PY_SNIPPET) + f.write(snippet) else: print(" %s unmodified" % ipy) else: @@ -1782,7 +2036,7 @@ def do_setup(): if line.startswith("include "): for include in line.split()[1:]: simple_includes.add(include) - except EnvironmentError: + except OSError: pass # That doesn't cover everything MANIFEST.in can do # (http://docs.python.org/2/distutils/sourcedist.html#commands), so