mirror of
https://github.com/Cian-H/invenio-config-iform.git
synced 2025-12-23 05:21:57 +00:00
Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9d2ad34601 | ||
|
|
1eb836aec8 | ||
|
|
42e7a332d0 | ||
|
|
5dd1bf0602 | ||
|
|
956a9eea76 | ||
|
|
4310ca8755 | ||
|
|
ce97c5378c | ||
|
|
e2b1c59c5d | ||
|
|
cb7f00d76c | ||
|
|
be22817a91 | ||
|
|
1ca39d2f8d | ||
|
|
7069bbe481 | ||
|
|
396f44fbd8 | ||
|
|
8f2670235b | ||
|
|
d70c690ab3 | ||
|
|
6803ce9614 | ||
|
|
4d89290b58 | ||
|
|
2ccd24cfca | ||
|
|
0a37a8015e |
@@ -32,8 +32,8 @@ indent_size = 4
|
|||||||
[*.{css,html,js,json,yml}]
|
[*.{css,html,js,json,yml}]
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|
||||||
# Matches the exact files either package.json or .travis.yml
|
# Matches the exact files either package.json or .github/workflows/*.yml
|
||||||
[{package.json,.travis.yml}]
|
[{package.json,.github/workflows/*.yml}]
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|
||||||
# Dockerfile
|
# Dockerfile
|
||||||
|
|||||||
54
.github/workflows/tests.yml
vendored
Normal file
54
.github/workflows/tests.yml
vendored
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: master
|
||||||
|
pull_request:
|
||||||
|
branches: master
|
||||||
|
schedule:
|
||||||
|
# * is a special character in YAML so you have to quote this string
|
||||||
|
- cron: '0 3 * * 6'
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
reason:
|
||||||
|
description: 'Reason'
|
||||||
|
required: false
|
||||||
|
default: 'Manual trigger'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
Tests:
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
python-version: [3.6, 3.7, 3.8]
|
||||||
|
requirements-level: [min, pypi]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
with:
|
||||||
|
python-version: ${{ matrix.python-version }}
|
||||||
|
|
||||||
|
- name: Generate dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip setuptools py wheel requirements-builder
|
||||||
|
requirements-builder -e all --level=${{ matrix.requirements-level }} setup.py > .${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt
|
||||||
|
|
||||||
|
- name: Cache pip
|
||||||
|
uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: ~/.cache/pip
|
||||||
|
key: ${{ runner.os }}-pip-${{ hashFiles('.${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt') }}
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install -r .${{matrix.requirements-level}}-${{ matrix.python-version }}-requirements.txt
|
||||||
|
pip install .[all]
|
||||||
|
pip freeze
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: |
|
||||||
|
./run-tests.sh
|
||||||
53
.travis.yml
53
.travis.yml
@@ -1,53 +0,0 @@
|
|||||||
# -*- coding: utf-8 -*-
|
|
||||||
#
|
|
||||||
# Copyright (C) 2020 Mojib Wali.
|
|
||||||
#
|
|
||||||
# invenio-config-tugraz is free software; you can redistribute it and/or
|
|
||||||
# modify it under the terms of the MIT License; see LICENSE file for more
|
|
||||||
# details.
|
|
||||||
branches:
|
|
||||||
except:
|
|
||||||
- /^v\d+\.\d+(\.\d+)?(\S*)?$/
|
|
||||||
|
|
||||||
notifications:
|
|
||||||
email: false
|
|
||||||
|
|
||||||
sudo: false
|
|
||||||
|
|
||||||
language: python
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
fast_finish: true
|
|
||||||
allow_failures:
|
|
||||||
# To allow failures, you need to specify the full environment
|
|
||||||
- env: REQUIREMENTS=devel
|
|
||||||
|
|
||||||
cache:
|
|
||||||
- pip
|
|
||||||
|
|
||||||
env:
|
|
||||||
- REQUIREMENTS=lowest
|
|
||||||
- REQUIREMENTS=release DEPLOY=true
|
|
||||||
- REQUIREMENTS=devel
|
|
||||||
|
|
||||||
python:
|
|
||||||
- "3.6"
|
|
||||||
- "3.7"
|
|
||||||
|
|
||||||
before_install:
|
|
||||||
- "nvm install 6; nvm use 6"
|
|
||||||
- "travis_retry pip install --upgrade pip setuptools py"
|
|
||||||
- "travis_retry pip install twine wheel coveralls requirements-builder"
|
|
||||||
- "requirements-builder -e all --level=min setup.py > .travis-lowest-requirements.txt"
|
|
||||||
- "requirements-builder -e all --level=pypi setup.py > .travis-release-requirements.txt"
|
|
||||||
- "requirements-builder -e all --level=dev --req requirements-devel.txt setup.py > .travis-devel-requirements.txt"
|
|
||||||
|
|
||||||
install:
|
|
||||||
- "travis_retry pip install -r .travis-${REQUIREMENTS}-requirements.txt"
|
|
||||||
- "travis_retry pip install -e .[all]"
|
|
||||||
|
|
||||||
script:
|
|
||||||
- "./run-tests.sh"
|
|
||||||
|
|
||||||
after_success:
|
|
||||||
- coveralls
|
|
||||||
@@ -10,7 +10,7 @@ Types of Contributions
|
|||||||
Report Bugs
|
Report Bugs
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
Report bugs at https://github.com/mb-wali/invenio-config-tugraz/issues.
|
Report bugs at https://github.com/tu-graz-library/invenio-config-tugraz/issues.
|
||||||
|
|
||||||
If you are reporting a bug, please include:
|
If you are reporting a bug, please include:
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ Submit Feedback
|
|||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The best way to send feedback is to file an issue at
|
The best way to send feedback is to file an issue at
|
||||||
https://github.com/mb-wali/invenio-config-tugraz/issues.
|
https://github.com/tu-graz-library/invenio-config-tugraz/issues.
|
||||||
|
|
||||||
If you are proposing a feature:
|
If you are proposing a feature:
|
||||||
|
|
||||||
@@ -113,6 +113,6 @@ Before you submit a pull request, check that it meets these guidelines:
|
|||||||
1. The pull request should include tests and must not decrease test coverage.
|
1. The pull request should include tests and must not decrease test coverage.
|
||||||
2. If the pull request adds functionality, the docs should be updated. Put
|
2. If the pull request adds functionality, the docs should be updated. Put
|
||||||
your new functionality into a function with a docstring.
|
your new functionality into a function with a docstring.
|
||||||
3. The pull request should work for Python 2.7, 3.5 and 3.6. Check
|
3. The pull request should work for Python 3.6 and 3.7. Check
|
||||||
https://travis-ci.org/https://github.com/https://github.com/mb-/pull_requests
|
https://github.com/github/tu-graz-library/invenio-config-tugraz//actions?query=event%3Apull_request
|
||||||
and make sure that the tests pass for all supported Python versions.
|
and make sure that the tests pass for all supported Python versions.
|
||||||
|
|||||||
@@ -42,3 +42,7 @@ recursive-include invenio_config_tugraz *.crt
|
|||||||
recursive-include invenio_config_tugraz *.json
|
recursive-include invenio_config_tugraz *.json
|
||||||
recursive-include invenio_config_tugraz *.key
|
recursive-include invenio_config_tugraz *.key
|
||||||
recursive-include invenio_config_tugraz *.xml
|
recursive-include invenio_config_tugraz *.xml
|
||||||
|
recursive-include invenio_config_tugraz *.gitkeep
|
||||||
|
|
||||||
|
# added by check-manifest
|
||||||
|
recursive-include invenio_config_tugraz *.csv
|
||||||
|
|||||||
@@ -9,8 +9,8 @@
|
|||||||
invenio-config-tugraz
|
invenio-config-tugraz
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
.. image:: https://travis-ci.com/mb-wali/invenio-config-tugraz.svg
|
.. image:: https://github.com/tu-graz-library/invenio-config-tugraz/workflows/CI/badge.svg
|
||||||
:target: https://travis-ci.com/github/mb-wali/invenio-config-tugraz
|
:target: https://github.com/tu-graz-library/invenio-config-tugraz/actions
|
||||||
|
|
||||||
.. image:: https://img.shields.io/pypi/dm/invenio-config-tugraz.svg
|
.. image:: https://img.shields.io/pypi/dm/invenio-config-tugraz.svg
|
||||||
:target: https://pypi.python.org/pypi/invenio-config-tugraz
|
:target: https://pypi.python.org/pypi/invenio-config-tugraz
|
||||||
@@ -27,6 +27,9 @@
|
|||||||
.. image:: https://img.shields.io/coveralls/mb-wali/invenio-config-tugraz.svg
|
.. image:: https://img.shields.io/coveralls/mb-wali/invenio-config-tugraz.svg
|
||||||
:target: https://coveralls.io/r/mb-wali/invenio-config-tugraz
|
:target: https://coveralls.io/r/mb-wali/invenio-config-tugraz
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
||||||
|
:target: https://github.com/psf/black
|
||||||
|
|
||||||
invenio module that adds tugraz configs.
|
invenio module that adds tugraz configs.
|
||||||
|
|
||||||
Override configs from diffrent invenio modules to meet TU Graz requirement:
|
Override configs from diffrent invenio modules to meet TU Graz requirement:
|
||||||
|
|||||||
214
docs/conf.py
214
docs/conf.py
@@ -10,45 +10,45 @@
|
|||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
||||||
import sphinx.environment
|
# import sphinx.environment
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
# If your documentation needs a minimal Sphinx version, state it here.
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
#needs_sphinx = '1.0'
|
# needs_sphinx = '1.0'
|
||||||
|
|
||||||
# Do not warn on external images.
|
# Do not warn on external images.
|
||||||
suppress_warnings = ['image.nonlocal_uri']
|
suppress_warnings = ["image.nonlocal_uri"]
|
||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
"sphinx.ext.autodoc",
|
||||||
'sphinx.ext.coverage',
|
"sphinx.ext.coverage",
|
||||||
'sphinx.ext.doctest',
|
"sphinx.ext.doctest",
|
||||||
'sphinx.ext.intersphinx',
|
"sphinx.ext.intersphinx",
|
||||||
'sphinx.ext.viewcode',
|
"sphinx.ext.viewcode",
|
||||||
]
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ["_templates"]
|
||||||
|
|
||||||
# The suffix(es) of source filenames.
|
# The suffix(es) of source filenames.
|
||||||
# You can specify multiple suffix as a list of string:
|
# You can specify multiple suffix as a list of string:
|
||||||
# source_suffix = ['.rst', '.md']
|
# source_suffix = ['.rst', '.md']
|
||||||
source_suffix = '.rst'
|
source_suffix = ".rst"
|
||||||
|
|
||||||
# The encoding of source files.
|
# The encoding of source files.
|
||||||
#source_encoding = 'utf-8-sig'
|
# source_encoding = 'utf-8-sig'
|
||||||
|
|
||||||
# The master toctree document.
|
# The master toctree document.
|
||||||
master_doc = 'index'
|
master_doc = "index"
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'invenio-config-tugraz'
|
project = u"invenio-config-tugraz"
|
||||||
copyright = u'2020, Mojib Wali'
|
copyright = u"2020, Mojib Wali"
|
||||||
author = u'Mojib Wali'
|
author = u"Mojib Wali"
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
@@ -58,11 +58,14 @@ author = u'Mojib Wali'
|
|||||||
|
|
||||||
# Get the version string. Cannot be done with import!
|
# Get the version string. Cannot be done with import!
|
||||||
g = {}
|
g = {}
|
||||||
with open(os.path.join(os.path.dirname(__file__), '..',
|
with open(
|
||||||
'invenio_config_tugraz', 'version.py'),
|
os.path.join(
|
||||||
'rt') as fp:
|
os.path.dirname(__file__), "..", "invenio_config_tugraz", "version.py"
|
||||||
|
),
|
||||||
|
"rt",
|
||||||
|
) as fp:
|
||||||
exec(fp.read(), g)
|
exec(fp.read(), g)
|
||||||
version = g['__version__']
|
version = g["__version__"]
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = version
|
release = version
|
||||||
@@ -76,9 +79,9 @@ language = None
|
|||||||
|
|
||||||
# There are two options for replacing |today|: either, you set today to some
|
# There are two options for replacing |today|: either, you set today to some
|
||||||
# non-false value, then it is used:
|
# non-false value, then it is used:
|
||||||
#today = ''
|
# today = ''
|
||||||
# Else, today_fmt is used as the format for a strftime call.
|
# Else, today_fmt is used as the format for a strftime call.
|
||||||
#today_fmt = '%B %d, %Y'
|
# today_fmt = '%B %d, %Y'
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
# List of patterns, relative to source directory, that match files and
|
||||||
# directories to ignore when looking for source files.
|
# directories to ignore when looking for source files.
|
||||||
@@ -86,46 +89,46 @@ exclude_patterns = []
|
|||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all
|
# The reST default role (used for this markup: `text`) to use for all
|
||||||
# documents.
|
# documents.
|
||||||
#default_role = None
|
# default_role = None
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
#add_function_parentheses = True
|
# add_function_parentheses = True
|
||||||
|
|
||||||
# If true, the current module name will be prepended to all description
|
# If true, the current module name will be prepended to all description
|
||||||
# unit titles (such as .. function::).
|
# unit titles (such as .. function::).
|
||||||
#add_module_names = True
|
# add_module_names = True
|
||||||
|
|
||||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||||
# output. They are ignored by default.
|
# output. They are ignored by default.
|
||||||
#show_authors = False
|
# show_authors = False
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = "sphinx"
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
#modindex_common_prefix = []
|
# modindex_common_prefix = []
|
||||||
|
|
||||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||||
#keep_warnings = False
|
# keep_warnings = False
|
||||||
|
|
||||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||||
todo_include_todos = False
|
todo_include_todos = False
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output ----------------------------------------------
|
# -- Options for HTML output ----------------------------------------------
|
||||||
html_theme = 'alabaster'
|
html_theme = "alabaster"
|
||||||
|
|
||||||
html_theme_options = {
|
html_theme_options = {
|
||||||
'description': 'invenio module that adds tugraz configs.',
|
"description": "invenio module that adds tugraz configs.",
|
||||||
'github_user': 'inveniosoftware',
|
"github_user": "TU Graz",
|
||||||
'github_repo': 'invenio-config-tugraz',
|
"github_repo": "invenio-config-tugraz",
|
||||||
'github_button': False,
|
"github_button": False,
|
||||||
'github_banner': True,
|
"github_banner": True,
|
||||||
'show_powered_by': False,
|
"show_powered_by": False,
|
||||||
'extra_nav_links': {
|
"extra_nav_links": {
|
||||||
'invenio-config-tugraz@GitHub': 'https://github.com/mb-wali/invenio-config-tugraz',
|
"invenio-config-tugraz@GitHub": "https://github.com/tu-graz-library/invenio-config-tugraz",
|
||||||
'invenio-config-tugraz@PyPI': 'https://pypi.python.org/pypi/invenio-config-tugraz/',
|
"invenio-config-tugraz@PyPI": "https://pypi.python.org/pypi/invenio-config-tugraz/",
|
||||||
}
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
@@ -134,146 +137,148 @@ html_theme_options = {
|
|||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
# further. For a list of options available for each theme, see the
|
# further. For a list of options available for each theme, see the
|
||||||
# documentation.
|
# documentation.
|
||||||
#html_theme_options = {}
|
# html_theme_options = {}
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
#html_theme_path = []
|
# html_theme_path = []
|
||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> documentation".
|
# "<project> v<release> documentation".
|
||||||
#html_title = None
|
# html_title = None
|
||||||
|
|
||||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||||
#html_short_title = None
|
# html_short_title = None
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
# of the sidebar.
|
# of the sidebar.
|
||||||
#html_logo = None
|
# html_logo = None
|
||||||
|
|
||||||
# The name of an image file (within the static path) to use as favicon of the
|
# The name of an image file (within the static path) to use as favicon of the
|
||||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
# pixels large.
|
# pixels large.
|
||||||
#html_favicon = None
|
# html_favicon = None
|
||||||
|
|
||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
#html_static_path = ['_static']
|
# html_static_path = ['_static']
|
||||||
|
|
||||||
# Add any extra paths that contain custom files (such as robots.txt or
|
# Add any extra paths that contain custom files (such as robots.txt or
|
||||||
# .htaccess) here, relative to this directory. These files are copied
|
# .htaccess) here, relative to this directory. These files are copied
|
||||||
# directly to the root of the documentation.
|
# directly to the root of the documentation.
|
||||||
#html_extra_path = []
|
# html_extra_path = []
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
# using the given strftime format.
|
# using the given strftime format.
|
||||||
#html_last_updated_fmt = '%b %d, %Y'
|
# html_last_updated_fmt = '%b %d, %Y'
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
# typographically correct entities.
|
# typographically correct entities.
|
||||||
#html_use_smartypants = True
|
# html_use_smartypants = True
|
||||||
|
|
||||||
# Custom sidebar templates, maps document names to template names.
|
# Custom sidebar templates, maps document names to template names.
|
||||||
html_sidebars = {
|
html_sidebars = {
|
||||||
'**': [
|
"**": [
|
||||||
'about.html',
|
"about.html",
|
||||||
'navigation.html',
|
"navigation.html",
|
||||||
'relations.html',
|
"relations.html",
|
||||||
'searchbox.html',
|
"searchbox.html",
|
||||||
'donate.html',
|
"donate.html",
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
# Additional templates that should be rendered to pages, maps page names to
|
# Additional templates that should be rendered to pages, maps page names to
|
||||||
# template names.
|
# template names.
|
||||||
#html_additional_pages = {}
|
# html_additional_pages = {}
|
||||||
|
|
||||||
# If false, no module index is generated.
|
# If false, no module index is generated.
|
||||||
#html_domain_indices = True
|
# html_domain_indices = True
|
||||||
|
|
||||||
# If false, no index is generated.
|
# If false, no index is generated.
|
||||||
#html_use_index = True
|
# html_use_index = True
|
||||||
|
|
||||||
# If true, the index is split into individual pages for each letter.
|
# If true, the index is split into individual pages for each letter.
|
||||||
#html_split_index = False
|
# html_split_index = False
|
||||||
|
|
||||||
# If true, links to the reST sources are added to the pages.
|
# If true, links to the reST sources are added to the pages.
|
||||||
#html_show_sourcelink = True
|
# html_show_sourcelink = True
|
||||||
|
|
||||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||||
#html_show_sphinx = True
|
# html_show_sphinx = True
|
||||||
|
|
||||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||||
#html_show_copyright = True
|
# html_show_copyright = True
|
||||||
|
|
||||||
# If true, an OpenSearch description file will be output, and all pages will
|
# If true, an OpenSearch description file will be output, and all pages will
|
||||||
# contain a <link> tag referring to it. The value of this option must be the
|
# contain a <link> tag referring to it. The value of this option must be the
|
||||||
# base URL from which the finished HTML is served.
|
# base URL from which the finished HTML is served.
|
||||||
#html_use_opensearch = ''
|
# html_use_opensearch = ''
|
||||||
|
|
||||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||||
#html_file_suffix = None
|
# html_file_suffix = None
|
||||||
|
|
||||||
# Language to be used for generating the HTML full-text search index.
|
# Language to be used for generating the HTML full-text search index.
|
||||||
# Sphinx supports the following languages:
|
# Sphinx supports the following languages:
|
||||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
||||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
||||||
#html_search_language = 'en'
|
# html_search_language = 'en'
|
||||||
|
|
||||||
# A dictionary with options for the search language support, empty by default.
|
# A dictionary with options for the search language support, empty by default.
|
||||||
# Now only 'ja' uses this config value
|
# Now only 'ja' uses this config value
|
||||||
#html_search_options = {'type': 'default'}
|
# html_search_options = {'type': 'default'}
|
||||||
|
|
||||||
# The name of a javascript file (relative to the configuration directory) that
|
# The name of a javascript file (relative to the configuration directory) that
|
||||||
# implements a search results scorer. If empty, the default will be used.
|
# implements a search results scorer. If empty, the default will be used.
|
||||||
#html_search_scorer = 'scorer.js'
|
# html_search_scorer = 'scorer.js'
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'invenio-config-tugraz_namedoc'
|
htmlhelp_basename = "invenio-config-tugraz_namedoc"
|
||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- Options for LaTeX output ---------------------------------------------
|
||||||
|
|
||||||
latex_elements = {
|
latex_elements = {
|
||||||
# The paper size ('letterpaper' or 'a4paper').
|
# The paper size ('letterpaper' or 'a4paper').
|
||||||
#'papersize': 'letterpaper',
|
# 'papersize': 'letterpaper',
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
# The font size ('10pt', '11pt' or '12pt').
|
# 'pointsize': '10pt',
|
||||||
#'pointsize': '10pt',
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
# 'preamble': '',
|
||||||
# Additional stuff for the LaTeX preamble.
|
# Latex figure (float) alignment
|
||||||
#'preamble': '',
|
# 'figure_align': 'htbp',
|
||||||
|
|
||||||
# Latex figure (float) alignment
|
|
||||||
#'figure_align': 'htbp',
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
(master_doc, 'invenio-config-tugraz.tex', u'invenio-config-tugraz Documentation',
|
(
|
||||||
u'Mojib Wali', 'manual'),
|
master_doc,
|
||||||
|
"invenio-config-tugraz.tex",
|
||||||
|
u"invenio-config-tugraz Documentation",
|
||||||
|
u"Mojib Wali",
|
||||||
|
"manual",
|
||||||
|
),
|
||||||
]
|
]
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
# the title page.
|
# the title page.
|
||||||
#latex_logo = None
|
# latex_logo = None
|
||||||
|
|
||||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||||
# not chapters.
|
# not chapters.
|
||||||
#latex_use_parts = False
|
# latex_use_parts = False
|
||||||
|
|
||||||
# If true, show page references after internal links.
|
# If true, show page references after internal links.
|
||||||
#latex_show_pagerefs = False
|
# latex_show_pagerefs = False
|
||||||
|
|
||||||
# If true, show URL addresses after external links.
|
# If true, show URL addresses after external links.
|
||||||
#latex_show_urls = False
|
# latex_show_urls = False
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals.
|
# Documents to append as an appendix to all manuals.
|
||||||
#latex_appendices = []
|
# latex_appendices = []
|
||||||
|
|
||||||
# If false, no module index is generated.
|
# If false, no module index is generated.
|
||||||
#latex_domain_indices = True
|
# latex_domain_indices = True
|
||||||
|
|
||||||
|
|
||||||
# -- Options for manual page output ---------------------------------------
|
# -- Options for manual page output ---------------------------------------
|
||||||
@@ -281,12 +286,17 @@ latex_documents = [
|
|||||||
# One entry per manual page. List of tuples
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
man_pages = [
|
||||||
(master_doc, 'invenio-config-tugraz', u'invenio-config-tugraz Documentation',
|
(
|
||||||
[author], 1)
|
master_doc,
|
||||||
|
"invenio-config-tugraz",
|
||||||
|
u"invenio-config-tugraz Documentation",
|
||||||
|
[author],
|
||||||
|
1,
|
||||||
|
)
|
||||||
]
|
]
|
||||||
|
|
||||||
# If true, show URL addresses after external links.
|
# If true, show URL addresses after external links.
|
||||||
#man_show_urls = False
|
# man_show_urls = False
|
||||||
|
|
||||||
|
|
||||||
# -- Options for Texinfo output -------------------------------------------
|
# -- Options for Texinfo output -------------------------------------------
|
||||||
@@ -295,30 +305,36 @@ man_pages = [
|
|||||||
# (source start file, target name, title, author,
|
# (source start file, target name, title, author,
|
||||||
# dir menu entry, description, category)
|
# dir menu entry, description, category)
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
(master_doc, 'invenio-config-tugraz', u'invenio-config-tugraz Documentation',
|
(
|
||||||
author, 'invenio-config-tugraz', 'invenio module that adds tugraz configs.',
|
master_doc,
|
||||||
'Miscellaneous'),
|
"invenio-config-tugraz",
|
||||||
|
u"invenio-config-tugraz Documentation",
|
||||||
|
author,
|
||||||
|
"invenio-config-tugraz",
|
||||||
|
"invenio module that adds tugraz configs.",
|
||||||
|
"Miscellaneous",
|
||||||
|
),
|
||||||
]
|
]
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals.
|
# Documents to append as an appendix to all manuals.
|
||||||
#texinfo_appendices = []
|
# texinfo_appendices = []
|
||||||
|
|
||||||
# If false, no module index is generated.
|
# If false, no module index is generated.
|
||||||
#texinfo_domain_indices = True
|
# texinfo_domain_indices = True
|
||||||
|
|
||||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||||
#texinfo_show_urls = 'footnote'
|
# texinfo_show_urls = 'footnote'
|
||||||
|
|
||||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||||
#texinfo_no_detailmenu = False
|
# texinfo_no_detailmenu = False
|
||||||
|
|
||||||
|
|
||||||
# Example configuration for intersphinx: refer to the Python standard library.
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
intersphinx_mapping = {
|
intersphinx_mapping = {
|
||||||
'python': ('https://docs.python.org/', None),
|
"python": ("https://docs.python.org/", None),
|
||||||
# TODO: Configure external documentation references, eg:
|
# TODO: Configure external documentation references, eg:
|
||||||
# 'Flask-Admin': ('https://flask-admin.readthedocs.io/en/latest/', None),
|
# 'Flask-Admin': ('https://flask-admin.readthedocs.io/en/latest/', None),
|
||||||
}
|
}
|
||||||
|
|
||||||
# Autodoc configuraton.
|
# Autodoc configuraton.
|
||||||
autoclass_content = 'both'
|
autoclass_content = "both"
|
||||||
|
|||||||
@@ -8,8 +8,8 @@
|
|||||||
|
|
||||||
"""invenio module that adds tugraz configs."""
|
"""invenio module that adds tugraz configs."""
|
||||||
|
|
||||||
from .ext import invenioconfigtugraz
|
from .ext import InvenioConfigTugraz
|
||||||
from .generators import RecordIp
|
from .generators import RecordIp
|
||||||
from .version import __version__
|
from .version import __version__
|
||||||
|
|
||||||
__all__ = ('__version__', 'invenioconfigtugraz', 'RecordIp')
|
__all__ = ("__version__", "InvenioConfigTugraz", "RecordIp")
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
#
|
#
|
||||||
# Copyright (C) 2020 Mojib Wali.
|
# Copyright (C) 2020 Graz University of Technology.
|
||||||
#
|
#
|
||||||
# invenio-config-tugraz is free software; you can redistribute it and/or
|
# invenio-config-tugraz is free software; you can redistribute it and/or
|
||||||
# modify it under the terms of the MIT License; see LICENSE file for more
|
# modify it under the terms of the MIT License; see LICENSE file for more
|
||||||
@@ -46,11 +46,15 @@ Using Custom Generator for a policy:
|
|||||||
RECORDS_PERMISSIONS_RECORD_POLICY = TUGRAZPermissionPolicy
|
RECORDS_PERMISSIONS_RECORD_POLICY = TUGRAZPermissionPolicy
|
||||||
|
|
||||||
|
|
||||||
Permissions for Invenio (RDM) Records.
|
Permissions for Invenio records.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from invenio_records_permissions.generators import Admin, AnyUser, \
|
from invenio_records_permissions.generators import (
|
||||||
AnyUserIfPublic, Disable, RecordOwners
|
Admin,
|
||||||
|
AnyUser,
|
||||||
|
AnyUserIfPublic,
|
||||||
|
RecordOwners,
|
||||||
|
)
|
||||||
from invenio_records_permissions.policies.base import BasePermissionPolicy
|
from invenio_records_permissions.policies.base import BasePermissionPolicy
|
||||||
|
|
||||||
from .generators import RecordIp
|
from .generators import RecordIp
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
#
|
#
|
||||||
# Copyright (C) 2020 Mojib Wali.
|
# Copyright (C) 2020 Graz University of Technology.
|
||||||
#
|
#
|
||||||
# invenio-config-tugraz is free software; you can redistribute it and/or
|
# invenio-config-tugraz is free software; you can redistribute it and/or
|
||||||
# modify it under the terms of the MIT License; see LICENSE file for more
|
# modify it under the terms of the MIT License; see LICENSE file for more
|
||||||
@@ -8,6 +8,8 @@
|
|||||||
|
|
||||||
"""invenio module that adds tugraz configs."""
|
"""invenio module that adds tugraz configs."""
|
||||||
|
|
||||||
|
from os.path import abspath, dirname, join
|
||||||
|
|
||||||
from flask_babelex import gettext as _
|
from flask_babelex import gettext as _
|
||||||
|
|
||||||
INVENIO_CONFIG_TUGRAZ_SHIBBOLETH = True
|
INVENIO_CONFIG_TUGRAZ_SHIBBOLETH = True
|
||||||
@@ -31,46 +33,48 @@ INVENIO_CONFIG_TUGRAZ_IP_RANGES =
|
|||||||
# ===========
|
# ===========
|
||||||
# See https://invenio-app.readthedocs.io/en/latest/configuration.html
|
# See https://invenio-app.readthedocs.io/en/latest/configuration.html
|
||||||
|
|
||||||
APP_ALLOWED_HOSTS = ['0.0.0.0',
|
APP_ALLOWED_HOSTS = [
|
||||||
'localhost',
|
"0.0.0.0",
|
||||||
'127.0.0.1',
|
"localhost",
|
||||||
'invenio-dev01.tugraz.at',
|
"127.0.0.1",
|
||||||
'invenio-test.tugraz.at'
|
"invenio-dev01.tugraz.at",
|
||||||
]
|
"invenio-test.tugraz.at",
|
||||||
|
"repository.tugraz.at"
|
||||||
|
]
|
||||||
"""Allowed Hosts"""
|
"""Allowed Hosts"""
|
||||||
|
|
||||||
APP_DEFAULT_SECURE_HEADERS = {
|
APP_DEFAULT_SECURE_HEADERS = {
|
||||||
'content_security_policy': {
|
"content_security_policy": {
|
||||||
'default-src': [
|
"default-src": [
|
||||||
"'self'",
|
"'self'",
|
||||||
'fonts.googleapis.com',
|
"fonts.googleapis.com",
|
||||||
'*.gstatic.com',
|
"*.gstatic.com",
|
||||||
'data:',
|
"data:",
|
||||||
"'unsafe-inline'",
|
"'unsafe-inline'",
|
||||||
"'unsafe-eval'",
|
"'unsafe-eval'",
|
||||||
"blob:",
|
"blob:",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
'content_security_policy_report_only': False,
|
"content_security_policy_report_only": False,
|
||||||
'content_security_policy_report_uri': None,
|
"content_security_policy_report_uri": None,
|
||||||
'force_file_save': False,
|
"force_file_save": False,
|
||||||
'force_https': True,
|
"force_https": True,
|
||||||
'force_https_permanent': False,
|
"force_https_permanent": False,
|
||||||
'frame_options': 'sameorigin',
|
"frame_options": "sameorigin",
|
||||||
'frame_options_allow_from': None,
|
"frame_options_allow_from": None,
|
||||||
'session_cookie_http_only': True,
|
"session_cookie_http_only": True,
|
||||||
'session_cookie_secure': True,
|
"session_cookie_secure": True,
|
||||||
'strict_transport_security': True,
|
"strict_transport_security": True,
|
||||||
'strict_transport_security_include_subdomains': True,
|
"strict_transport_security_include_subdomains": True,
|
||||||
'strict_transport_security_max_age': 31556926, # One year in seconds
|
"strict_transport_security_max_age": 31556926, # One year in seconds
|
||||||
'strict_transport_security_preload': False,
|
"strict_transport_security_preload": False,
|
||||||
}
|
}
|
||||||
|
|
||||||
# Invenio-Mail
|
# Invenio-Mail
|
||||||
# ===========
|
# ===========
|
||||||
# See https://invenio-mail.readthedocs.io/en/latest/configuration.html
|
# See https://invenio-mail.readthedocs.io/en/latest/configuration.html
|
||||||
|
|
||||||
MAIL_SERVER = 'localhost'
|
MAIL_SERVER = "localhost"
|
||||||
"""Domain ip where mail server is running."""
|
"""Domain ip where mail server is running."""
|
||||||
|
|
||||||
SECURITY_EMAIL_SENDER = "info@invenio-test.tugraz.at"
|
SECURITY_EMAIL_SENDER = "info@invenio-test.tugraz.at"
|
||||||
@@ -102,38 +106,44 @@ Set this to False when sending actual emails.
|
|||||||
# ]
|
# ]
|
||||||
# REST_ENABLE_CORS = True
|
# REST_ENABLE_CORS = True
|
||||||
|
|
||||||
|
# Invenio-userprofiles
|
||||||
# Invenio-shibboleth
|
|
||||||
# ===========
|
# ===========
|
||||||
# See https://invenio-shibboleth.readthedocs.io/en/latest/configuration.html
|
# See https://invenio-userprofiles.readthedocs.io/en/latest/configuration.html
|
||||||
|
|
||||||
USERPROFILES_EXTEND_SECURITY_FORMS = True
|
USERPROFILES_EXTEND_SECURITY_FORMS = False
|
||||||
"""Set True in order to register user_profile.
|
"""Set True in order to register user_profile.
|
||||||
|
|
||||||
This also forces user to add username and fullname
|
This also forces user to add username and fullname
|
||||||
when register.
|
when register.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
USERPROFILES_EMAIL_ENABLED = False
|
||||||
|
"""Exclude the user email in the profile form."""
|
||||||
|
|
||||||
|
# Invenio-shibboleth
|
||||||
|
# ===========
|
||||||
|
# See https://invenio-shibboleth.readthedocs.io/en/latest/configuration.html
|
||||||
|
|
||||||
SSO_SAML_IDPS = {}
|
SSO_SAML_IDPS = {}
|
||||||
"""Configuration of IDPS. Actual values can be find in to invenio.cfg file"""
|
"""Configuration of IDPS. Actual values can be find in to invenio.cfg file"""
|
||||||
|
|
||||||
SSO_SAML_DEFAULT_BLUEPRINT_PREFIX = '/shibboleth'
|
SSO_SAML_DEFAULT_BLUEPRINT_PREFIX = "/shibboleth"
|
||||||
"""Base URL for the extensions endpoint."""
|
"""Base URL for the extensions endpoint."""
|
||||||
|
|
||||||
SSO_SAML_DEFAULT_METADATA_ROUTE = '/metadata/<idp>'
|
SSO_SAML_DEFAULT_METADATA_ROUTE = "/metadata/<idp>"
|
||||||
"""URL route for the metadata request."""
|
"""URL route for the metadata request."""
|
||||||
"""This is also SP entityID https://domain/shibboleth/metadata/<idp>"""
|
"""This is also SP entityID https://domain/shibboleth/metadata/<idp>"""
|
||||||
|
|
||||||
SSO_SAML_DEFAULT_SSO_ROUTE = '/login/<idp>'
|
SSO_SAML_DEFAULT_SSO_ROUTE = "/login/<idp>"
|
||||||
"""URL route for the SP login."""
|
"""URL route for the SP login."""
|
||||||
|
|
||||||
SSO_SAML_DEFAULT_ACS_ROUTE = '/authorized/<idp>'
|
SSO_SAML_DEFAULT_ACS_ROUTE = "/authorized/<idp>"
|
||||||
"""URL route to handle the IdP login request."""
|
"""URL route to handle the IdP login request."""
|
||||||
|
|
||||||
SSO_SAML_DEFAULT_SLO_ROUTE = '/slo/<idp>'
|
SSO_SAML_DEFAULT_SLO_ROUTE = "/slo/<idp>"
|
||||||
"""URL route for the SP logout."""
|
"""URL route for the SP logout."""
|
||||||
|
|
||||||
SSO_SAML_DEFAULT_SLS_ROUTE = '/sls/<idp>'
|
SSO_SAML_DEFAULT_SLS_ROUTE = "/sls/<idp>"
|
||||||
"""URL route to handle the IdP logout request."""
|
"""URL route to handle the IdP logout request."""
|
||||||
|
|
||||||
# Invenio-accounts
|
# Invenio-accounts
|
||||||
@@ -186,8 +196,28 @@ RECAPTCHA_PRIVATE_KEY = None
|
|||||||
# See:
|
# See:
|
||||||
# https://invenio-records-permissions.readthedocs.io/en/latest/configuration.html
|
# https://invenio-records-permissions.readthedocs.io/en/latest/configuration.html
|
||||||
#
|
#
|
||||||
# Uncomment these to enable overriden
|
# Uncomment these to enable overriding Base permissions - (NOT RECOMMANDED)
|
||||||
# RECORDS_PERMISSIONS_RECORD_POLICY = (
|
# RECORDS_PERMISSIONS_RECORD_POLICY = (
|
||||||
# 'invenio_config_tugraz.permissions.TUGRAZPermissionPolicy'
|
# 'invenio_config_tugraz.base_permissions.TUGRAZPermissionPolicy'
|
||||||
|
# )
|
||||||
|
#
|
||||||
|
# Uncomment these to enable overriding RDM permissions
|
||||||
|
# RDM_RECORDS_BIBLIOGRAPHIC_SERVICE_CONFIG = (
|
||||||
|
# 'invenio_config_tugraz.rdm_permissions.TUGRAZBibliographicRecordServiceConfig'
|
||||||
# )
|
# )
|
||||||
"""Access control configuration for records."""
|
"""Access control configuration for records."""
|
||||||
|
|
||||||
|
# invenio-rdm-records
|
||||||
|
# =======
|
||||||
|
# See:
|
||||||
|
# https://invenio-rdm-records.readthedocs.io/en/latest/configuration.html
|
||||||
|
#
|
||||||
|
# Custom Access Right
|
||||||
|
RDM_RECORDS_CUSTOM_VOCABULARIES = {
|
||||||
|
'access_right': {
|
||||||
|
'path': join(
|
||||||
|
dirname(abspath(__file__)),
|
||||||
|
'restrictions', 'access_right', 'access_right_limit.csv'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -8,12 +8,10 @@
|
|||||||
|
|
||||||
"""invenio module that adds tugraz configs."""
|
"""invenio module that adds tugraz configs."""
|
||||||
|
|
||||||
from flask_babelex import gettext as _
|
|
||||||
|
|
||||||
from . import config
|
from . import config
|
||||||
|
|
||||||
|
|
||||||
class invenioconfigtugraz(object):
|
class InvenioConfigTugraz(object):
|
||||||
"""invenio-config-tugraz extension."""
|
"""invenio-config-tugraz extension."""
|
||||||
|
|
||||||
def __init__(self, app=None):
|
def __init__(self, app=None):
|
||||||
@@ -24,10 +22,10 @@ class invenioconfigtugraz(object):
|
|||||||
def init_app(self, app):
|
def init_app(self, app):
|
||||||
"""Flask application initialization."""
|
"""Flask application initialization."""
|
||||||
self.init_config(app)
|
self.init_config(app)
|
||||||
app.extensions['invenio-config-tugraz'] = self
|
app.extensions["invenio-config-tugraz"] = self
|
||||||
|
|
||||||
def init_config(self, app):
|
def init_config(self, app):
|
||||||
"""Initialize configuration."""
|
"""Initialize configuration."""
|
||||||
for k in dir(config):
|
for k in dir(config):
|
||||||
if k.startswith('INVENIO_CONFIG_TUGRAZ_'):
|
if k.startswith("INVENIO_CONFIG_TUGRAZ_"):
|
||||||
app.config.setdefault(k, getattr(config, k))
|
app.config.setdefault(k, getattr(config, k))
|
||||||
|
|||||||
@@ -153,28 +153,33 @@ The succinct encoding of the permissions for your instance gives you
|
|||||||
|
|
||||||
from elasticsearch_dsl.query import Q
|
from elasticsearch_dsl.query import Q
|
||||||
from flask import current_app, request
|
from flask import current_app, request
|
||||||
|
from invenio_access.permissions import any_user, authenticated_user, superuser_access
|
||||||
from invenio_records_permissions.generators import Generator
|
from invenio_records_permissions.generators import Generator
|
||||||
|
|
||||||
|
|
||||||
class RecordIp(Generator):
|
class RecordIp(Generator):
|
||||||
"""Allowed any user with accessing with the IP."""
|
"""Allowed any user with accessing with the IP."""
|
||||||
|
|
||||||
# TODO: Implement
|
def needs(self, record=None, **kwargs):
|
||||||
def needs(self, **kwargs):
|
"""Enabling Needs, Set of Needs granting permission."""
|
||||||
"""Enabling Needs, Set of Needs granting permission.
|
if record is None:
|
||||||
|
return []
|
||||||
|
|
||||||
If ANY of the Needs are matched, permission is granted.
|
# check if singleip is in the records restriction
|
||||||
|
is_single_ip = record.get("access", {}).get("access_right") == "singleip"
|
||||||
|
|
||||||
.. note::
|
# check if the user ip is on list
|
||||||
|
visible = self.check_permission()
|
||||||
|
|
||||||
``_load_permissions()`` method from `Permission
|
if not is_single_ip:
|
||||||
<https://invenio-access.readthedocs.io/en/latest/api.html
|
# if record does not have singleip - return any_user
|
||||||
#invenio_access.permissions.Permission>`_ adds by default the
|
return [any_user]
|
||||||
``superuser_access`` Need (if tied to a User or Role) for us.
|
# if record has singleip, then check the ip of user - if ip user is on list - return any_user
|
||||||
It also expands ActionNeeds into the Users/Roles that
|
elif visible:
|
||||||
provide them.
|
return [any_user]
|
||||||
"""
|
else:
|
||||||
return []
|
# non of the above - return empty
|
||||||
|
return []
|
||||||
|
|
||||||
def excludes(self, **kwargs):
|
def excludes(self, **kwargs):
|
||||||
"""Preventing Needs, Set of Needs denying permission.
|
"""Preventing Needs, Set of Needs denying permission.
|
||||||
@@ -196,19 +201,40 @@ class RecordIp(Generator):
|
|||||||
"""
|
"""
|
||||||
return []
|
return []
|
||||||
|
|
||||||
def query_filter(self, **kwargs):
|
def query_filter(self, *args, **kwargs):
|
||||||
"""Elasticsearch filters, List of ElasticSearch query filters.
|
"""Filters for singleip records."""
|
||||||
|
# check if the user ip is on list
|
||||||
|
visible = self.check_permission()
|
||||||
|
|
||||||
These filters consist of additive queries mapping to what the current
|
if not visible:
|
||||||
user should be able to retrieve via search.
|
# If user ip is not on the list, and If the record contains 'singleip' will not be seen
|
||||||
"""
|
return ~Q("match", **{"access.access_right": "singleip"})
|
||||||
return Q('match_all')
|
|
||||||
|
# Lists all records
|
||||||
|
return Q("match_all")
|
||||||
|
|
||||||
def check_permission(self):
|
def check_permission(self):
|
||||||
"""Check for User IP address in config variable."""
|
"""Check for User IP address in config variable."""
|
||||||
# Get user IP
|
# Get user IP
|
||||||
user_ip = request.remote_addr # pragma: no cover
|
user_ip = request.remote_addr
|
||||||
# Checks if the user IP is among single IPs
|
# Checks if the user IP is among single IPs
|
||||||
if user_ip in current_app.config['INVENIO_CONFIG_TUGRAZ_SINGLE_IP']:
|
if user_ip in current_app.config["INVENIO_CONFIG_TUGRAZ_SINGLE_IP"]:
|
||||||
return True # pragma: no cover
|
return True
|
||||||
return False # pragma: no cover
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
class AuthenticatedUser(Generator):
|
||||||
|
"""Allows authenticated users."""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
"""Constructor."""
|
||||||
|
super(AuthenticatedUser, self).__init__()
|
||||||
|
|
||||||
|
def needs(self, **kwargs):
|
||||||
|
"""Enabling Needs."""
|
||||||
|
return [authenticated_user]
|
||||||
|
|
||||||
|
def query_filter(self, **kwargs):
|
||||||
|
"""Filters for current identity as super user."""
|
||||||
|
# TODO: Implement with new permissions metadata
|
||||||
|
return []
|
||||||
|
|||||||
111
invenio_config_tugraz/rdm_permissions.py
Normal file
111
invenio_config_tugraz/rdm_permissions.py
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Copyright (C) 2020 Graz University of Technology.
|
||||||
|
#
|
||||||
|
# invenio-config-tugraz is free software; you can redistribute it and/or
|
||||||
|
# modify it under the terms of the MIT License; see LICENSE file for more
|
||||||
|
# details.
|
||||||
|
|
||||||
|
"""
|
||||||
|
Records permission policies.
|
||||||
|
|
||||||
|
Default policies for records:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
# Read access given to everyone.
|
||||||
|
can_search = [AnyUser()]
|
||||||
|
# Create action given to no one (Not even superusers) bc Deposits should
|
||||||
|
# be used.
|
||||||
|
can_create = [Disable()]
|
||||||
|
# Read access given to everyone if public record/files and owners always.
|
||||||
|
can_read = [AnyUserIfPublic(), RecordOwners()]
|
||||||
|
# Update access given to record owners.
|
||||||
|
can_update = [RecordOwners()]
|
||||||
|
# Delete access given to admins only.
|
||||||
|
can_delete = [Admin()]
|
||||||
|
# Associated files permissions (which are really bucket permissions)
|
||||||
|
can_read_files = [AnyUserIfPublic(), RecordOwners()]
|
||||||
|
can_update_files = [RecordOwners()]
|
||||||
|
|
||||||
|
How to override default policies for rdm-records.
|
||||||
|
|
||||||
|
Using Custom Generator for a policy:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
from invenio_rdm_records.services import (
|
||||||
|
BibliographicRecordServiceConfig,
|
||||||
|
RDMRecordPermissionPolicy,
|
||||||
|
)
|
||||||
|
|
||||||
|
from invenio_config_tugraz.generators import RecordIp
|
||||||
|
|
||||||
|
class TUGRAZPermissionPolicy(RDMRecordPermissionPolicy):
|
||||||
|
|
||||||
|
# Create access given to SuperUser only.
|
||||||
|
|
||||||
|
can_create = [SuperUser()]
|
||||||
|
|
||||||
|
RDM_RECORDS_BIBLIOGRAPHIC_SERVICE_CONFIG = TUGRAZBibliographicRecordServiceConfig
|
||||||
|
|
||||||
|
|
||||||
|
Permissions for Invenio (RDM) Records.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from invenio_rdm_records.services import (
|
||||||
|
BibliographicRecordServiceConfig,
|
||||||
|
RDMRecordPermissionPolicy,
|
||||||
|
)
|
||||||
|
from invenio_records_permissions.generators import (
|
||||||
|
Admin,
|
||||||
|
AnyUser,
|
||||||
|
RecordOwners,
|
||||||
|
SuperUser,
|
||||||
|
)
|
||||||
|
|
||||||
|
from .generators import AuthenticatedUser, RecordIp
|
||||||
|
|
||||||
|
|
||||||
|
class TUGRAZPermissionPolicy(RDMRecordPermissionPolicy):
|
||||||
|
"""Access control configuration for rdm records.
|
||||||
|
|
||||||
|
This overrides the origin:
|
||||||
|
https://github.com/inveniosoftware/invenio-rdm-records/blob/master/invenio_rdm_records/services/permissions.py.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Read access given to:
|
||||||
|
# TODO:
|
||||||
|
# AnyUserIfPublic : grant access if record is public
|
||||||
|
# RecordIp: grant access for single_ip
|
||||||
|
# RecordOwners: owner of records, enable once the deposit is allowed only for loged-in users.
|
||||||
|
# CURRENT:
|
||||||
|
# RecordIp: grant access for single_ip
|
||||||
|
can_read = [RecordIp()] # RecordOwners()
|
||||||
|
|
||||||
|
# Search access given to:
|
||||||
|
# AnyUser : grant access anyUser
|
||||||
|
# RecordIp: grant access for single_ip
|
||||||
|
can_search = [AnyUser(), RecordIp()]
|
||||||
|
|
||||||
|
# Update access given to record owners.
|
||||||
|
can_update = [RecordOwners()]
|
||||||
|
|
||||||
|
# Delete access given to admins only.
|
||||||
|
can_delete = [Admin()]
|
||||||
|
|
||||||
|
# Create action given to AuthenticatedUser
|
||||||
|
# UI - if user is loged in
|
||||||
|
# API - if user has Access token (Bearer API-TOKEN)
|
||||||
|
can_create = [AuthenticatedUser()]
|
||||||
|
|
||||||
|
# Associated files permissions (which are really bucket permissions)
|
||||||
|
# can_read_files = [AnyUserIfPublic(), RecordOwners()]
|
||||||
|
# can_update_files = [RecordOwners()]
|
||||||
|
|
||||||
|
|
||||||
|
class TUGRAZBibliographicRecordServiceConfig(BibliographicRecordServiceConfig):
|
||||||
|
"""Overriding BibliographicRecordServiceConfig."""
|
||||||
|
|
||||||
|
permission_policy_cls = TUGRAZPermissionPolicy
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
access_right,access_right_name,icon,notes
|
||||||
|
open, Open Access, lock open
|
||||||
|
embargoed, Embargoed, ban
|
||||||
|
restricted, Restricted, key
|
||||||
|
closed, Private, lock
|
||||||
|
singleip, Single Ip, lock
|
||||||
|
@@ -0,0 +1,2 @@
|
|||||||
|
access_right,access_right_name,icon,notes
|
||||||
|
open, Open Access, lock open
|
||||||
|
@@ -12,4 +12,4 @@ This file is imported by ``invenio_config_tugraz.__init__``,
|
|||||||
and parsed by ``setup.py``.
|
and parsed by ``setup.py``.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
__version__ = '0.2.1'
|
__version__ = "0.4.1"
|
||||||
|
|||||||
@@ -7,6 +7,6 @@
|
|||||||
# details.
|
# details.
|
||||||
|
|
||||||
[pytest]
|
[pytest]
|
||||||
addopts = --isort --pydocstyle --pycodestyle --doctest-glob="*.rst" --doctest-modules --cov=invenio_config_tugraz --cov-report=term-missing
|
addopts = --isort --pydocstyle --pycodestyle --doctest-glob="*.rst" --doctest-modules --cov=invenio_config_tugraz --cov-report=term-missing tests invenio_config_tugraz
|
||||||
testpaths = tests invenio_config_tugraz
|
testpaths = tests invenio_config_tugraz
|
||||||
live_server_scope = module
|
live_server_scope = module
|
||||||
32
run-tests.sh
32
run-tests.sh
@@ -1,17 +1,33 @@
|
|||||||
#!/usr/bin/env sh
|
#!/usr/bin/env bash
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
#
|
#
|
||||||
# Copyright (C) 2020 Mojib Wali.
|
# Copyright (C) 2019-2020 CERN.
|
||||||
|
# Copyright (C) 2019-2020 Northwestern University.
|
||||||
|
# Copyright (C) 2020 Graz University of Technology.
|
||||||
#
|
#
|
||||||
# invenio-config-tugraz is free software; you can redistribute it and/or
|
# invenio-config-tugraz is free software; you can redistribute it and/or
|
||||||
# modify it under the terms of the MIT License; see LICENSE file for more
|
# modify it under the terms of the MIT License; see LICENSE file for more
|
||||||
# details.
|
# details.
|
||||||
|
|
||||||
docker-services-cli up postgresql es redis
|
|
||||||
python -m check_manifest --ignore ".travis-*" && \
|
# Quit on errors
|
||||||
python -m sphinx.cmd.build -qnNW docs docs/_build/html && \
|
set -o errexit
|
||||||
docker-services-cli up es postgresql redis
|
|
||||||
|
# Quit on unbound symbols
|
||||||
|
set -o nounset
|
||||||
|
|
||||||
|
# Always bring down docker services
|
||||||
|
|
||||||
|
function cleanup() {
|
||||||
|
eval "$(docker-services-cli down --env)"
|
||||||
|
}
|
||||||
|
trap cleanup EXIT
|
||||||
|
|
||||||
|
|
||||||
|
python -m check_manifest --ignore ".*-requirements.txt"
|
||||||
|
python -m sphinx.cmd.build -qnNW docs docs/_build/html
|
||||||
|
eval "$(docker-services-cli up --db ${DB:-postgresql} --search ${SEARCH:-elasticsearch} --cache ${CACHE:-redis} --env)"
|
||||||
python -m pytest
|
python -m pytest
|
||||||
tests_exit_code=$?
|
tests_exit_code=$?
|
||||||
docker-services-cli down
|
python -m sphinx.cmd.build -qnNW -b doctest docs docs/_build/doctest
|
||||||
exit "$tests_exit_code"
|
exit "$tests_exit_code"
|
||||||
|
|||||||
17
setup.cfg
17
setup.cfg
@@ -37,3 +37,20 @@ output-dir = invenio_config_tugraz/translations/
|
|||||||
[update_catalog]
|
[update_catalog]
|
||||||
input-file = invenio_config_tugraz/translations/messages.pot
|
input-file = invenio_config_tugraz/translations/messages.pot
|
||||||
output-dir = invenio_config_tugraz/translations/
|
output-dir = invenio_config_tugraz/translations/
|
||||||
|
|
||||||
|
[flake8]
|
||||||
|
max-line-length = 88
|
||||||
|
extend-ignore = E203
|
||||||
|
select = C,E,F,W,B,B950
|
||||||
|
ignore = E501
|
||||||
|
|
||||||
|
[isort]
|
||||||
|
multi_line_output = 3
|
||||||
|
include_trailing_comma = True
|
||||||
|
force_grid_wrap = 0
|
||||||
|
use_parentheses = True
|
||||||
|
ensure_newline_before_comments = True
|
||||||
|
line_length = 88
|
||||||
|
|
||||||
|
[pycodestyle]
|
||||||
|
ignore = E203,E501
|
||||||
|
|||||||
88
setup.py
88
setup.py
@@ -12,35 +12,37 @@ import os
|
|||||||
|
|
||||||
from setuptools import find_packages, setup
|
from setuptools import find_packages, setup
|
||||||
|
|
||||||
readme = open('README.rst').read()
|
readme = open("README.rst").read()
|
||||||
history = open('CHANGES.rst').read()
|
history = open("CHANGES.rst").read()
|
||||||
|
|
||||||
tests_require = [
|
tests_require = [
|
||||||
'pytest-invenio>=1.4.0',
|
"pytest-invenio>=1.4.0",
|
||||||
|
"SQLAlchemy-Utils>=0.33.1,<0.36",
|
||||||
|
"invenio-rdm-records~=0.20.8",
|
||||||
|
"invenio-search[elasticsearch7]>=1.4.0",
|
||||||
|
"psycopg2-binary>=2.8.6",
|
||||||
]
|
]
|
||||||
|
|
||||||
extras_require = {
|
extras_require = {
|
||||||
'docs': [
|
"docs": [
|
||||||
'Sphinx>=1.5.1',
|
"Sphinx>=3",
|
||||||
],
|
],
|
||||||
'tests': tests_require,
|
"tests": tests_require,
|
||||||
}
|
}
|
||||||
|
|
||||||
extras_require['all'] = []
|
extras_require["all"] = []
|
||||||
for reqs in extras_require.values():
|
for reqs in extras_require.values():
|
||||||
extras_require['all'].extend(reqs)
|
extras_require["all"].extend(reqs)
|
||||||
|
|
||||||
setup_requires = [
|
setup_requires = [
|
||||||
'Babel>=1.3',
|
"Babel>=1.3",
|
||||||
'pytest-runner>=3.0.0,<5',
|
"pytest-runner>=3.0.0,<5",
|
||||||
]
|
]
|
||||||
|
|
||||||
install_requires = [
|
install_requires = [
|
||||||
'Flask-BabelEx>=0.9.4',
|
"Flask-BabelEx>=0.9.4",
|
||||||
'elasticsearch_dsl>=7.2.1',
|
"elasticsearch_dsl>=7.2.1",
|
||||||
'invenio-rdm-records~=0.18.3',
|
"sqlalchemy-continuum>=1.3.11",
|
||||||
'invenio_search>=1.3.1',
|
|
||||||
|
|
||||||
]
|
]
|
||||||
|
|
||||||
packages = find_packages()
|
packages = find_packages()
|
||||||
@@ -48,33 +50,33 @@ packages = find_packages()
|
|||||||
|
|
||||||
# Get the version string. Cannot be done with import!
|
# Get the version string. Cannot be done with import!
|
||||||
g = {}
|
g = {}
|
||||||
with open(os.path.join('invenio_config_tugraz', 'version.py'), 'rt') as fp:
|
with open(os.path.join("invenio_config_tugraz", "version.py"), "rt") as fp:
|
||||||
exec(fp.read(), g)
|
exec(fp.read(), g)
|
||||||
version = g['__version__']
|
version = g["__version__"]
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='invenio-config-tugraz',
|
name="invenio-config-tugraz",
|
||||||
version=version,
|
version=version,
|
||||||
description=__doc__,
|
description=__doc__,
|
||||||
long_description=readme + '\n\n' + history,
|
long_description=readme + "\n\n" + history,
|
||||||
keywords='invenio, config, Tu Graz',
|
keywords="invenio, config, Tu Graz",
|
||||||
license='MIT',
|
license="MIT",
|
||||||
author='Mojib Wali',
|
author="Mojib Wali",
|
||||||
author_email='mojib.wali@tugraz.at',
|
author_email="mb_wali@hotmail.com",
|
||||||
url='https://github.com/mb-wali/invenio-config-tugraz',
|
url="https://github.com/tu-graz-library/invenio-config-tugraz",
|
||||||
packages=packages,
|
packages=packages,
|
||||||
zip_safe=False,
|
zip_safe=False,
|
||||||
include_package_data=True,
|
include_package_data=True,
|
||||||
platforms='any',
|
platforms="any",
|
||||||
entry_points={
|
entry_points={
|
||||||
'invenio_base.apps': [
|
"invenio_base.apps": [
|
||||||
'invenio_config_tugraz = invenio_config_tugraz:invenioconfigtugraz',
|
"invenio_config_tugraz = invenio_config_tugraz:InvenioConfigTugraz",
|
||||||
],
|
],
|
||||||
'invenio_i18n.translations': [
|
"invenio_i18n.translations": [
|
||||||
'messages = invenio_config_tugraz',
|
"messages = invenio_config_tugraz",
|
||||||
],
|
],
|
||||||
'invenio_config.module': [
|
"invenio_config.module": [
|
||||||
'invenio_config_tugraz = invenio_config_tugraz.config',
|
"invenio_config_tugraz = invenio_config_tugraz.config",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
extras_require=extras_require,
|
extras_require=extras_require,
|
||||||
@@ -82,17 +84,17 @@ setup(
|
|||||||
setup_requires=setup_requires,
|
setup_requires=setup_requires,
|
||||||
tests_require=tests_require,
|
tests_require=tests_require,
|
||||||
classifiers=[
|
classifiers=[
|
||||||
'Environment :: Web Environment',
|
"Environment :: Web Environment",
|
||||||
'Intended Audience :: Developers',
|
"Intended Audience :: Developers",
|
||||||
'License :: OSI Approved :: MIT License',
|
"License :: OSI Approved :: MIT License",
|
||||||
'Operating System :: OS Independent',
|
"Operating System :: OS Independent",
|
||||||
'Programming Language :: Python',
|
"Programming Language :: Python",
|
||||||
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
|
"Topic :: Internet :: WWW/HTTP :: Dynamic Content",
|
||||||
'Topic :: Software Development :: Libraries :: Python Modules',
|
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||||
'Programming Language :: Python :: 3',
|
"Programming Language :: Python :: 3",
|
||||||
'Programming Language :: Python :: 3.6',
|
"Programming Language :: Python :: 3.6",
|
||||||
'Programming Language :: Python :: 3.7',
|
"Programming Language :: Python :: 3.7",
|
||||||
'Programming Language :: Python :: 3.8',
|
"Programming Language :: Python :: 3.8",
|
||||||
'Development Status :: 3 - Alpha',
|
"Development Status :: 3 - Alpha",
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -12,17 +12,20 @@ See https://pytest-invenio.readthedocs.io/ for documentation on which test
|
|||||||
fixtures are available.
|
fixtures are available.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
import tempfile
|
import tempfile
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from flask import Flask
|
from flask import Flask
|
||||||
from flask_babelex import Babel
|
from flask_babelex import Babel
|
||||||
|
from invenio_db import InvenioDB, db
|
||||||
|
from sqlalchemy_utils.functions import create_database, database_exists, drop_database
|
||||||
|
|
||||||
from invenio_config_tugraz import invenioconfigtugraz
|
from invenio_config_tugraz import InvenioConfigTugraz
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope='module')
|
@pytest.fixture(scope="module")
|
||||||
def celery_config():
|
def celery_config():
|
||||||
"""Override pytest-invenio fixture.
|
"""Override pytest-invenio fixture.
|
||||||
|
|
||||||
@@ -31,13 +34,130 @@ def celery_config():
|
|||||||
return {}
|
return {}
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope='module')
|
@pytest.fixture()
|
||||||
def create_app(instance_path):
|
def create_app(request):
|
||||||
"""Application factory fixture."""
|
"""Basic Flask application."""
|
||||||
def factory(**config):
|
instance_path = tempfile.mkdtemp()
|
||||||
app = Flask('testapp', instance_path=instance_path)
|
app = Flask("testapp")
|
||||||
app.config.update(**config)
|
DB = os.getenv("SQLALCHEMY_DATABASE_URI", "sqlite://")
|
||||||
Babel(app)
|
app.config.update(
|
||||||
invenioconfigtugraz(app)
|
INVENIO_CONFIG_TUGRAZ_SINGLE_IP=["127.0.0.1", "127.0.0.2"],
|
||||||
return app
|
INVENIO_CONFIG_TUGRAZ_IP_RANGES=[
|
||||||
return factory
|
["127.0.0.2", "127.0.0.99"],
|
||||||
|
["127.0.1.3", "127.0.1.5"],
|
||||||
|
],
|
||||||
|
SQLALCHEMY_DATABASE_URI=DB,
|
||||||
|
SQLALCHEMY_TRACK_MODIFICATIONS=False,
|
||||||
|
)
|
||||||
|
Babel(app)
|
||||||
|
InvenioConfigTugraz(app)
|
||||||
|
InvenioDB(app)
|
||||||
|
|
||||||
|
with app.app_context():
|
||||||
|
db_url = str(db.engine.url)
|
||||||
|
if db_url != "sqlite://" and not database_exists(db_url):
|
||||||
|
create_database(db_url)
|
||||||
|
db.create_all()
|
||||||
|
|
||||||
|
def teardown():
|
||||||
|
with app.app_context():
|
||||||
|
db_url = str(db.engine.url)
|
||||||
|
db.session.close()
|
||||||
|
if db_url != "sqlite://":
|
||||||
|
drop_database(db_url)
|
||||||
|
shutil.rmtree(instance_path)
|
||||||
|
|
||||||
|
request.addfinalizer(teardown)
|
||||||
|
app.test_request_context().push()
|
||||||
|
|
||||||
|
return app
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope='function')
|
||||||
|
def open_record():
|
||||||
|
"""Open record data as dict coming from the external world."""
|
||||||
|
return {
|
||||||
|
"access": {
|
||||||
|
"metadata": False,
|
||||||
|
"files": False,
|
||||||
|
"owned_by": [1],
|
||||||
|
"access_right": "open"
|
||||||
|
},
|
||||||
|
"metadata": {
|
||||||
|
"publication_date": "2020-06-01",
|
||||||
|
"resource_type": {
|
||||||
|
"type": "image",
|
||||||
|
"subtype": "image-photo"
|
||||||
|
},
|
||||||
|
# Technically not required
|
||||||
|
"creators": [{
|
||||||
|
"name": "Troy Brown",
|
||||||
|
"type": "personal"
|
||||||
|
}, {
|
||||||
|
"name": "Phillip Lester",
|
||||||
|
"type": "personal",
|
||||||
|
"identifiers": {"orcid": "0000-0002-1825-0097"},
|
||||||
|
"affiliations": [{
|
||||||
|
"name": "Carter-Morris",
|
||||||
|
"identifiers": {"ror": "03yrm5c26"}
|
||||||
|
}]
|
||||||
|
}, {
|
||||||
|
"name": "Steven Williamson",
|
||||||
|
"type": "personal",
|
||||||
|
"identifiers": {"orcid": "0000-0002-1825-0097"},
|
||||||
|
"affiliations": [{
|
||||||
|
"name": "Ritter and Sons",
|
||||||
|
"identifiers": {"ror": "03yrm5c26"}
|
||||||
|
}, {
|
||||||
|
"name": "Montgomery, Bush and Madden",
|
||||||
|
"identifiers": {"ror": "03yrm5c26"}
|
||||||
|
}]
|
||||||
|
}],
|
||||||
|
"title": "A Romans story"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope='function')
|
||||||
|
def singleip_record():
|
||||||
|
"""Single Ip record data as dict coming from the external world."""
|
||||||
|
return {
|
||||||
|
"access": {
|
||||||
|
"metadata": False,
|
||||||
|
"files": False,
|
||||||
|
"owned_by": [1],
|
||||||
|
"access_right": "singleip"
|
||||||
|
},
|
||||||
|
"metadata": {
|
||||||
|
"publication_date": "2020-06-01",
|
||||||
|
"resource_type": {
|
||||||
|
"type": "image",
|
||||||
|
"subtype": "image-photo"
|
||||||
|
},
|
||||||
|
# Technically not required
|
||||||
|
"creators": [{
|
||||||
|
"name": "Troy Brown",
|
||||||
|
"type": "personal"
|
||||||
|
}, {
|
||||||
|
"name": "Phillip Lester",
|
||||||
|
"type": "personal",
|
||||||
|
"identifiers": {"orcid": "0000-0002-1825-0097"},
|
||||||
|
"affiliations": [{
|
||||||
|
"name": "Carter-Morris",
|
||||||
|
"identifiers": {"ror": "03yrm5c26"}
|
||||||
|
}]
|
||||||
|
}, {
|
||||||
|
"name": "Steven Williamson",
|
||||||
|
"type": "personal",
|
||||||
|
"identifiers": {"orcid": "0000-0002-1825-0097"},
|
||||||
|
"affiliations": [{
|
||||||
|
"name": "Ritter and Sons",
|
||||||
|
"identifiers": {"ror": "03yrm5c26"}
|
||||||
|
}, {
|
||||||
|
"name": "Montgomery, Bush and Madden",
|
||||||
|
"identifiers": {"ror": "03yrm5c26"}
|
||||||
|
}]
|
||||||
|
}],
|
||||||
|
"title": "A Romans story"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -6,12 +6,33 @@
|
|||||||
# modify it under the terms of the MIT License; see LICENSE file for more
|
# modify it under the terms of the MIT License; see LICENSE file for more
|
||||||
# details.
|
# details.
|
||||||
|
|
||||||
from invenio_config_tugraz.generators import RecordIp
|
"""Test Generators."""
|
||||||
|
|
||||||
|
from invenio_access.permissions import any_user, authenticated_user
|
||||||
|
|
||||||
|
from invenio_config_tugraz.generators import AuthenticatedUser, RecordIp
|
||||||
|
|
||||||
|
|
||||||
def test_recordip():
|
def test_recordip(create_app, open_record, singleip_record):
|
||||||
|
"""Test Generator RecordIp."""
|
||||||
generator = RecordIp()
|
generator = RecordIp()
|
||||||
|
open_record = open_record
|
||||||
|
singleiprec = singleip_record
|
||||||
|
|
||||||
assert generator.needs() == []
|
assert generator.needs(record=None) == []
|
||||||
|
assert generator.needs(record=open_record) == [any_user]
|
||||||
|
assert generator.needs(record=singleiprec) == []
|
||||||
|
|
||||||
|
assert generator.excludes(record=open_record) == []
|
||||||
|
assert generator.excludes(record=open_record) == []
|
||||||
|
|
||||||
|
assert generator.query_filter().to_dict() == {'bool': {'must_not': [{'match': {'access.access_right': 'singleip'}}]}}
|
||||||
|
|
||||||
|
|
||||||
|
def test_authenticateduser():
|
||||||
|
"""Test Generator AuthenticatedUser."""
|
||||||
|
generator = AuthenticatedUser()
|
||||||
|
|
||||||
|
assert generator.needs() == [authenticated_user]
|
||||||
assert generator.excludes() == []
|
assert generator.excludes() == []
|
||||||
assert generator.query_filter().to_dict() == {'match_all': {}}
|
assert generator.query_filter() == []
|
||||||
|
|||||||
@@ -10,23 +10,24 @@
|
|||||||
|
|
||||||
from flask import Flask
|
from flask import Flask
|
||||||
|
|
||||||
from invenio_config_tugraz import invenioconfigtugraz
|
from invenio_config_tugraz import InvenioConfigTugraz
|
||||||
|
|
||||||
|
|
||||||
def test_version():
|
def test_version():
|
||||||
"""Test version import."""
|
"""Test version import."""
|
||||||
from invenio_config_tugraz import __version__
|
from invenio_config_tugraz import __version__
|
||||||
|
|
||||||
assert __version__
|
assert __version__
|
||||||
|
|
||||||
|
|
||||||
def test_init():
|
def test_init():
|
||||||
"""Test extension initialization."""
|
"""Test extension initialization."""
|
||||||
app = Flask('testapp')
|
app = Flask("testapp")
|
||||||
ext = invenioconfigtugraz(app)
|
ext = InvenioConfigTugraz(app)
|
||||||
assert 'invenio-config-tugraz' in app.extensions
|
assert "invenio-config-tugraz" in app.extensions
|
||||||
|
|
||||||
app = Flask('testapp')
|
app = Flask("testapp")
|
||||||
ext = invenioconfigtugraz()
|
ext = InvenioConfigTugraz()
|
||||||
assert 'invenio-config-tugraz' not in app.extensions
|
assert "invenio-config-tugraz" not in app.extensions
|
||||||
ext.init_app(app)
|
ext.init_app(app)
|
||||||
assert 'invenio-config-tugraz' in app.extensions
|
assert "invenio-config-tugraz" in app.extensions
|
||||||
|
|||||||
Reference in New Issue
Block a user