Merge pull request #698 from CSCfi/stable

Merge stable to master v0.9.35-rc-2

etsin_finder/app.py

@@ -7,35 +7,176 @@
 from flask import Flask
 from flask_mail import Mail
 
-from etsin_finder.app_config import get_app_config
+from etsin_finder.app_config import load_app_config
 from etsin_finder.cache import CatalogRecordCache, RemsCache
-from etsin_finder.utils import executing_travis, get_log_config
-from etsin_finder.converters import IdentifierConverter
+from etsin_finder.utils.utils import executing_travis, get_log_config
+from etsin_finder.utils.converters import IdentifierConverter
+from etsin_finder.utils.flags import validate_flags, initialize_supported_flags
 
+from flask_restful import Api
+from etsin_finder.utils.flags import flag_enabled
 
-def create_app():
-    """Create flask app
+def add_download_v2_resources(api):
+    """Set download API v2 endpoints"""
+    from etsin_finder.resources.download_resources_v2 import (
+        Requests,
+        Authorize,
+    )
+    api.add_resource(Requests, '/api/v2/dl/requests', endpoint="dl_requests")
+    api.add_resource(Authorize, '/api/v2/dl/authorize', endpoint="dl_download")
 
-    Returns:
-        objetc: The flask.Flask app instance object.
 
-    """
-    is_testing = bool(os.environ.get('TESTING', False))
-    app = Flask(__name__, template_folder="./frontend/build")
+def add_restful_resources(app):
+    """Set Flask Restful API endpoints
 
-    app.config.update(get_app_config(is_testing))
-    if not app.testing and not executing_travis():
-        _setup_app_logging(app)
-    if not executing_travis():
-        app.config.update({'SAML_PATH': '/home/etsin-user'})
-        app.config.update({'SAML_PATH_ETSIN': '/home/etsin-user/etsin'})
-        app.config.update({'SAML_PATH_QVAIN': '/home/etsin-user/qvain'})
-    app.mail = Mail(app)
-    app.cr_cache = CatalogRecordCache(app)
-    app.rems_cache = RemsCache(app)
-    app.url_map.converters['id'] = IdentifierConverter
+    Args:
+        app (object): flask.Flask object instance.
 
-    return app
+    """
+    api = Api(app)
+    from etsin_finder.resources.etsin_resources import (
+        REMSApplyForPermission,
+        Contact,
+        Dataset,
+        V2Dataset,
+        DatasetMetadata,
+        User,
+        Session,
+        Files,
+        Download,
+        AppConfig,
+        SupportedFlags
+    )
+    from etsin_finder.resources.qvain_resources import (
+        ProjectFiles,
+        DirectoryFiles,
+        FileCharacteristics,
+        QvainDatasets,
+        QvainDataset
+    )
+    from etsin_finder.resources.qvain_rpc import (
+        QvainDatasetChangeCumulativeState,
+        QvainDatasetRefreshDirectoryContent,
+        QvainDatasetFixDeprecated
+    )
+
+    from etsin_finder.resources.qvain_rpc_v2 import (
+        QvainDatasetChangeCumulativeState as V2QvainDatasetChangeCumulativeState,
+        QvainDatasetCreateNewVersion as V2QvainDatasetCreateNewVersion,
+        QvainDatasetPublishDataset as V2QvainDatasetPublishDataset,
+        QvainDatasetMergeDraft as V2QvainDatasetMergeDraft,
+        QvainDatasetCreateDraft as V2QvainDatasetCreateDraft
+    )
+
+    from etsin_finder.resources.qvain_resources_v2 import (
+        QvainDataset as V2QvainDataset,
+        QvainDatasets as V2QvainDatasets,
+        QvainDatasetFiles as V2QvainDatasetFiles,
+        FileCharacteristics as V2FileCharacteristics,
+    )
+
+    from etsin_finder.resources.common_resources_v2 import (
+        ProjectFiles as V2ProjectFiles,
+        DirectoryFiles as V2DirectoryFiles,
+        DatasetUserMetadata as V2DatasetUserMetadata,
+        DatasetProjects as V2DatasetProjects,
+    )
+
+    # Download API v2 endpoints
+    if flag_enabled('DOWNLOAD_API_V2.BACKEND', app):
+        add_download_v2_resources(api)
+
+    if flag_enabled('METAX_API_V2.BACKEND', app):
+        # Common Qvain and Etsin endpoints for Metax v2
+        api.add_resource(V2DatasetUserMetadata, '/api/v2/common/datasets/<id:cr_id>/user_metadata', endpoint='v2_dataset_user_metadata')
+        api.add_resource(V2DatasetProjects, '/api/v2/common/datasets/<id:cr_id>/projects', endpoint='v2_dataset_projects')
+        api.add_resource(V2ProjectFiles, '/api/v2/common/projects/<string:pid>/files', endpoint='v2_project_files')
+        api.add_resource(V2DirectoryFiles, '/api/v2/common/directories/<string:dir_id>/files', endpoint='v2_directory_files')
+
+        # Qvain API endpoints for Metax v2
+        api.add_resource(V2FileCharacteristics, '/api/v2/qvain/files/<string:file_id>/file_characteristics', endpoint='v2_file_characteristics')
+        api.add_resource(V2QvainDatasets, '/api/v2/qvain/datasets', endpoint='v2_datasets')
+        api.add_resource(V2QvainDataset, '/api/v2/qvain/datasets/<id:cr_id>', endpoint='v2_dataset_edit')
+        api.add_resource(V2QvainDatasetFiles, '/api/v2/qvain/datasets/<id:cr_id>/files', endpoint='v2_dataset_files')
+
+        # Qvain API RPC endpoints for Metax v2
+        api.add_resource(V2QvainDatasetChangeCumulativeState, '/api/v2/rpc/datasets/change_cumulative_state', endpoint='v2_change_cumulative_state')
+        api.add_resource(V2QvainDatasetCreateNewVersion, '/api/v2/rpc/datasets/create_new_version', endpoint='v2_create_new_version')
+        api.add_resource(V2QvainDatasetCreateDraft, '/api/v2/rpc/datasets/create_draft', endpoint='v2_create_draft')
+        api.add_resource(V2QvainDatasetPublishDataset, '/api/v2/rpc/datasets/publish_dataset', endpoint='v2_publish_dataset')
+        api.add_resource(V2QvainDatasetMergeDraft, '/api/v2/rpc/datasets/merge_draft', endpoint='v2_merge_draft')
+
+        # Etsin API endpoint for Metax v2 dataset, needed for draft_of
+        api.add_resource(V2Dataset, '/api/v2/dataset/<id:cr_id>', endpoint='v2_etsin_dataset')
+
+    # Etsin API endpoints
+    api.add_resource(Dataset, '/api/dataset/<id:cr_id>')
+    api.add_resource(DatasetMetadata, '/api/format')
+    api.add_resource(Files, '/api/files/<id:cr_id>')
+    api.add_resource(Contact, '/api/email/<id:cr_id>')
+    api.add_resource(User, '/api/user')
+    api.add_resource(Session, '/api/session')
+    api.add_resource(Download, '/api/dl')
+    api.add_resource(AppConfig, '/api/app_config')
+    api.add_resource(SupportedFlags, '/api/supported_flags')
+
+    # Qvain API endpoints
+    api.add_resource(ProjectFiles, '/api/qvain/projects/<string:pid>/files')
+    api.add_resource(DirectoryFiles, '/api/qvain/directories/<string:dir_id>/files')
+    api.add_resource(FileCharacteristics, '/api/qvain/files/<string:file_id>/file_characteristics')
+    api.add_resource(QvainDatasets, '/api/qvain/datasets')
+    api.add_resource(QvainDataset, '/api/qvain/datasets/<id:cr_id>')
+
+    # Qvain API RPC endpoints
+    api.add_resource(QvainDatasetChangeCumulativeState, '/api/rpc/datasets/change_cumulative_state')
+    api.add_resource(QvainDatasetRefreshDirectoryContent, '/api/rpc/datasets/refresh_directory_content')
+    api.add_resource(QvainDatasetFixDeprecated, '/api/rpc/datasets/fix_deprecated')
+
+    # REMS API endpoints
+    api.add_resource(REMSApplyForPermission, '/api/rems/<id:cr_id>')
+
+
+def add_views(app):
+    """Add views to app"""
+    from etsin_finder.views.index_views import index_views
+    from etsin_finder.views.auth_views import auth_views
+    from etsin_finder.views.dev_views import dev_views
+
+    app.register_blueprint(index_views)
+    app.register_blueprint(auth_views)
+
+    # add development helper views
+    if app.config.get('DEV_VIEWS'):
+        app.register_blueprint(dev_views)
+
+
+def validate_config(app):
+    """Validate required config options"""
+    app.logger.info("Validating configuration")
+    with app.app_context():
+        from etsin_finder.services import (
+            common_service_v2,
+            qvain_service,
+            qvain_service_v2,
+            cr_service,
+            cr_service_v2,
+            download_metadata_service,
+            download_service,
+            download_service_v2,
+        )
+
+        # Services that use app parameter
+        validate_flags(app)
+        cr_service.MetaxAPIService(app)
+        cr_service_v2.MetaxAPIService(app)
+        download_metadata_service.DatasetMetadataService(app)
+        download_service.DownloadAPIService(app)
+        download_service_v2.DownloadAPIService(app)
+
+        # Services that use app context
+        common_service_v2.MetaxCommonAPIService().validate_config(False)
+        qvain_service.MetaxQvainAPIService().validate_config(False)
+        qvain_service_v2.MetaxQvainAPIServiceV2().validate_config(False)
 
 
 def _setup_app_logging(app):
@@ -56,4 +197,35 @@ def _setup_app_logging(app):
         app.logger.error('Logging not correctly set up due to missing app log path configuration')
 
 
-app = create_app()
+def create_app(testing=None):
+    """Create flask app
+
+    Args:
+        testing (bool): If enabled, use testing configuration
+
+    Returns:
+        object: The flask.Flask app instance object.
+
+    """
+    if testing is None:
+        testing = bool(os.environ.get('TESTING', False))
+
+    app = Flask(__name__, template_folder="./frontend/build")
+
+    app.config.update(load_app_config(testing))
+    initialize_supported_flags(app)
+    if not app.testing and not executing_travis():
+        _setup_app_logging(app)
+    validate_config(app)
+    if not executing_travis():
+        app.config.update({'SAML_PATH': '/home/etsin-user'})
+        app.config.update({'SAML_PATH_ETSIN': '/home/etsin-user/etsin'})
+        app.config.update({'SAML_PATH_QVAIN': '/home/etsin-user/qvain'})
+    app.mail = Mail(app)
+    app.cr_cache = CatalogRecordCache(app)
+    app.rems_cache = RemsCache(app)
+    app.url_map.converters['id'] = IdentifierConverter
+
+    add_restful_resources(app)
+    add_views(app)
+    return app