splent-framework 0.0.1__tar.gz

splent_framework-0.0.1/LICENSE

@@ -0,0 +1,113 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of protecting
+users' freedom to change the software. The systematic pattern of such
+abuse occurs in the area of products for individuals to use, which is
+precisely where it is most unacceptable. Therefore, we have designed
+this version of the GPL to prohibit the practice for those products. If
+such problems arise substantially in other domains, we stand ready to
+extend this provision to those domains in future versions of the GPL, as
+needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                        TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+(El texto completo es largo, puedes encontrarlo en https://www.gnu.org/licenses/gpl-3.0.txt)
+

splent_framework-0.0.1/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.2
+Name: splent_framework
+Version: 0.0.1
+Summary: SPLENT-FRAMEWORK is a set of libraries for agile product development within SPLENT.
+Author-email: David Romero <drorganvidez@us.es>
+License:                     GNU GENERAL PUBLIC LICENSE
+                               Version 3, 29 June 2007
+        
+         Copyright (C) 2007 Free Software Foundation, Inc.
+         Everyone is permitted to copy and distribute verbatim copies
+         of this license document, but changing it is not allowed.
+        
+                                    Preamble
+        
+          The GNU General Public License is a free, copyleft license for
+        software and other kinds of works.
+        
+          The licenses for most software and other practical works are designed
+        to take away your freedom to share and change the works. By contrast,
+        the GNU General Public License is intended to guarantee your freedom to
+        share and change all versions of a program--to make sure it remains free
+        software for all its users. We, the Free Software Foundation, use the
+        GNU General Public License for most of our software; it applies also to
+        any other work released this way by its authors. You can apply it to
+        your programs, too.
+        
+          When we speak of free software, we are referring to freedom, not
+        price. Our General Public Licenses are designed to make sure that you
+        have the freedom to distribute copies of free software (and charge for
+        them if you wish), that you receive source code or can get it if you
+        want it, that you can change the software or use pieces of it in new
+        free programs, and that you know you can do these things.
+        
+          To protect your rights, we need to prevent others from denying you
+        these rights or asking you to surrender the rights. Therefore, you have
+        certain responsibilities if you distribute copies of the software, or if
+        you modify it: responsibilities to respect the freedom of others.
+        
+          For example, if you distribute copies of such a program, whether
+        gratis or for a fee, you must pass on to the recipients the same
+        freedoms that you received. You must make sure that they, too, receive
+        or can get the source code. And you must show them these terms so they
+        know their rights.
+        
+          Developers that use the GNU GPL protect your rights with two steps:
+        (1) assert copyright on the software, and (2) offer you this License
+        giving you legal permission to copy, distribute and/or modify it.
+        
+          For the developers' and authors' protection, the GPL clearly explains
+        that there is no warranty for this free software. For both users' and
+        authors' sake, the GPL requires that modified versions be marked as
+        changed, so that their problems will not be attributed erroneously to
+        authors of previous versions.
+        
+          Some devices are designed to deny users access to install or run
+        modified versions of the software inside them, although the manufacturer
+        can do so. This is fundamentally incompatible with the aim of protecting
+        users' freedom to change the software. The systematic pattern of such
+        abuse occurs in the area of products for individuals to use, which is
+        precisely where it is most unacceptable. Therefore, we have designed
+        this version of the GPL to prohibit the practice for those products. If
+        such problems arise substantially in other domains, we stand ready to
+        extend this provision to those domains in future versions of the GPL, as
+        needed to protect the freedom of users.
+        
+          Finally, every program is threatened constantly by software patents.
+        States should not allow patents to restrict development and use of
+        software on general-purpose computers, but in those that do, we wish to
+        avoid the special danger that patents applied to a free program could
+        make it effectively proprietary. To prevent this, the GPL assures that
+        patents cannot be used to render the program non-free.
+        
+          The precise terms and conditions for copying, distribution and
+        modification follow.
+        
+                                TERMS AND CONDITIONS
+        
+          0. Definitions.
+        
+          "This License" refers to version 3 of the GNU General Public License.
+        
+          "Copyright" also means copyright-like laws that apply to other kinds
+        of works, such as semiconductor masks.
+        
+          "The Program" refers to any copyrightable work licensed under this
+        License. Each licensee is addressed as "you". "Licensees" and
+        "recipients" may be individuals or organizations.
+        
+          To "modify" a work means to copy from or adapt all or part of the work
+        in a fashion requiring copyright permission, other than the making of an
+        exact copy. The resulting work is called a "modified version" of the
+        earlier work or a work "based on" the earlier work.
+        
+          A "covered work" means either the unmodified Program or a work based
+        on the Program.
+        
+          To "propagate" a work means to do anything with it that, without
+        permission, would make you directly or secondarily liable for
+        infringement under applicable copyright law, except executing it on a
+        computer or modifying a private copy. Propagation includes copying,
+        distribution (with or without modification), making available to the
+        public, and in some countries other activities as well.
+        
+          To "convey" a work means any kind of propagation that enables other
+        parties to make or receive copies. Mere interaction with a user through
+        a computer network, with no transfer of a copy, is not conveying.
+        
+          An interactive user interface displays "Appropriate Legal Notices"
+        to the extent that it includes a convenient and prominently visible
+        feature that (1) displays an appropriate copyright notice, and (2)
+        tells the user that there is no warranty for the work (except to the
+        extent that warranties are provided), that licensees may convey the
+        work under this License, and how to view a copy of this License. If
+        the interface presents a list of user commands or options, such as a
+        menu, a prominent item in the list meets this criterion.
+        
+        (El texto completo es largo, puedes encontrarlo en https://www.gnu.org/licenses/gpl-3.0.txt)
+        
+        
+Project-URL: Homepage, https://github.com/diverso-lab/splent_framework
+Project-URL: Issues, https://github.com/diverso-lab/splent_framework/issues
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: python-dotenv
+Requires-Dist: sqlalchemy
+Requires-Dist: flask_sqlalchemy
+Requires-Dist: flask_migrate
+Requires-Dist: flask_session
+Requires-Dist: flask_mail
+Requires-Dist: flask_login
+Requires-Dist: flask_wtf
+Requires-Dist: redis
+Requires-Dist: pymysql
+Requires-Dist: docker
+Requires-Dist: psutil
+Requires-Dist: pytz
+Requires-Dist: pytest
+Requires-Dist: pytest-cov
+Requires-Dist: selenium
+Requires-Dist: webdriver_manager
+
+# splent_framework

splent_framework-0.0.1/README.md

@@ -0,0 +1 @@
+# splent_framework

splent_framework-0.0.1/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "splent_framework"
+version = "0.0.1"
+description = "SPLENT-FRAMEWORK is a set of libraries for agile product development within SPLENT."
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [{ name = "David Romero", email = "drorganvidez@us.es" }]
+license = { file = "LICENSE" }
+dependencies = [
+    "click",
+    "python-dotenv",
+    "sqlalchemy",
+    "flask_sqlalchemy",
+    "flask_migrate",
+    "flask_session",
+    "flask_mail",
+    "flask_login",
+    "flask_wtf",
+    "redis",
+    "pymysql",
+    "docker",
+    "psutil",
+    "pytz",
+    "pytest",
+    "pytest-cov",
+    "selenium",
+    "webdriver_manager"
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["splent_framework*"]
+
+[project.urls]
+Homepage = "https://github.com/diverso-lab/splent_framework"
+Issues = "https://github.com/diverso-lab/splent_framework/issues"

splent_framework-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

splent_framework-0.0.1/splent_framework/core/blueprints/base_blueprint.py

@@ -0,0 +1,76 @@
+from flask import Blueprint, Response, abort
+import os
+
+from splent_cli.utils.path_utils import PathUtils
+
+
+class BaseBlueprint(Blueprint):
+    def __init__(
+        self,
+        name,
+        import_name,
+        static_folder=None,
+        static_url_path=None,
+        template_folder=None,
+        url_prefix=None,
+        subdomain=None,
+        url_defaults=None,
+        root_path=None,
+    ):
+        super().__init__(
+            name,
+            import_name,
+            static_folder=static_folder,
+            static_url_path=static_url_path,
+            template_folder=template_folder,
+            url_prefix=url_prefix,
+            subdomain=subdomain,
+            url_defaults=url_defaults,
+            root_path=root_path,
+        )
+        self.module_path = os.path.join(PathUtils.get_modules_dir(), name)
+        self.add_asset_routes()
+
+    def add_asset_routes(self):
+        """Define a dynamic route to serve any file inside subfolders under assets (e.g., js, css)."""
+        assets_folder = os.path.join(self.module_path, "assets")
+        if os.path.exists(assets_folder):
+            # Define a route for any file inside the 'assets' folder and its subfolders
+            self.add_url_rule(
+                f"/{self.name}/<path:subfolder>/<path:filename>",
+                "assets",
+                self.send_file,
+            )
+        else:
+            print(f"(BaseBlueprint) -> {assets_folder} does not exist.")
+
+    def send_file(self, subfolder, filename):
+        """Send any file located in the specified subfolder within the assets folder."""
+        file_path = os.path.join(
+            self.module_path, "assets", subfolder, filename
+        )
+
+        if filename == "webpack.config.js":
+            abort(403, description="Access to this file is forbidden")
+
+        # Check if the file exists and is located within a valid subfolder (e.g., js, css)
+        if os.path.exists(file_path) and subfolder in ["js", "css", "dist"]:
+            try:
+                # Detect the correct MIME type based on file extension
+                if filename.endswith(".js"):
+                    mimetype = "application/javascript"
+                elif filename.endswith(".css"):
+                    mimetype = "text/css"
+                else:
+                    mimetype = "text/plain"
+
+                with open(file_path) as file:
+                    file_content = file.read()
+                return Response(file_content, mimetype=mimetype)
+            except FileNotFoundError:
+                abort(404, description=f"File not found: {file_path}")
+        else:
+            abort(
+                404,
+                description=f"Invalid path or file: {subfolder}/{filename}",
+            )

splent_framework-0.0.1/splent_framework/core/bootstraps/locustfile_bootstrap.py

@@ -0,0 +1,50 @@
+import os
+import glob
+import inspect
+import importlib.util
+from locust import HttpUser
+from dotenv import load_dotenv
+
+
+def load_locustfiles():
+    load_dotenv()
+    working_dir = os.getenv("WORKING_DIR", "")
+    print(f"Working directory: {working_dir}")
+
+    module_dir = os.path.join(working_dir, "app", "modules")
+    print(f"Module directory: {module_dir}")
+
+    locustfile_paths = glob.glob(
+        os.path.join(module_dir, "*", "tests", "locustfile.py")
+    )
+    print(f"Found locustfiles: {locustfile_paths}")
+
+    found_user_classes = []
+
+    for path in locustfile_paths:
+        print(f"Loading locustfile: {path}")
+        module_name = os.path.splitext(os.path.basename(path))[0]
+        spec = importlib.util.spec_from_file_location(module_name, path)
+        locustfile = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(locustfile)
+
+        # Collect all classes that inherit from HttpUser
+        for name, obj in vars(locustfile).items():
+            if (
+                inspect.isclass(obj)
+                and issubclass(obj, HttpUser)
+                and obj is not HttpUser
+            ):
+                unique_name = f"{name}_{os.path.basename(path).split('.')[0]}"
+                globals()[unique_name] = obj  # Add to globals
+                found_user_classes.append((unique_name, obj))
+                print(f"Loaded user class: {unique_name}")
+
+    if not found_user_classes:
+        raise ValueError("No User class found!")
+
+    return found_user_classes
+
+
+found_user_classes = load_locustfiles()
+print(f"Total user classes loaded: {len(found_user_classes)}")

splent_framework-0.0.1/splent_framework/core/configuration/configuration.py

@@ -0,0 +1,25 @@
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+def uploads_folder_name():
+    return os.getenv("UPLOADS_DIR", "uploads")
+
+
+def get_app_version():
+    version_file_path = os.path.join(os.getenv("WORKING_DIR", ""), ".version")
+    try:
+        with open(version_file_path) as file:
+            return file.readline().strip()
+    except FileNotFoundError:
+        return "unknown"
+
+
+def is_develop():
+    return os.getenv("FLASK_ENV") == "development"
+
+
+def is_production():
+    return os.getenv("FLASK_ENV") == "production"

splent_framework-0.0.1/splent_framework/core/decorators/decorators.py

@@ -0,0 +1,18 @@
+from functools import wraps
+
+from flask import abort
+
+
+def pass_or_abort(condition):
+
+    def decorator(f):
+
+        @wraps(f)
+        def decorated_function(*args, **kwargs):
+            if not condition(**kwargs):
+                abort(404)
+            return f(*args, **kwargs)
+
+        return decorated_function
+
+    return decorator

splent_framework-0.0.1/splent_framework/core/environment/host.py

@@ -0,0 +1,65 @@
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+def get_host_for_testing(test_type: str) -> str:
+    """
+    Get the host URL for testing based on the test type and the working directory.
+
+    Parameters:
+    test_type (str): The type of test (either "locust" or "selenium").
+
+    Returns:
+    str: The host URL corresponding to the test type and working directory.
+
+    Raises:
+    ValueError: If the test type is unknown or the WORKING_DIR value is not mapped.
+    """
+    # Define host mappings for locust and selenium tests
+    host_mapping = {
+        "locust": {
+            "": "http://localhost:5000",
+            "/app/": "http://nginx_web_server_container",
+            "/vagrant/": "http://localhost:5000",
+        },
+        "selenium": {
+            "": "http://localhost:5000",
+            "/app/": "http://localhost",
+            "/vagrant/": "http://localhost:5000",
+        },
+    }
+
+    # Check if the provided test type is valid
+    if test_type not in host_mapping:
+        raise ValueError(f"Unknown test type: {test_type}")
+
+    # Get the working directory from the environment variable
+    working_dir = os.getenv("WORKING_DIR", "")
+
+    # Return the host URL based on the working directory
+    if working_dir in host_mapping[test_type]:
+        return host_mapping[test_type][working_dir]
+    else:
+        raise ValueError(f"Unknown WORKING_DIR value: {working_dir}")
+
+
+def get_host_for_locust_testing() -> str:
+    """
+    Get the host URL for locust testing.
+
+    Returns:
+    str: The host URL for locust testing.
+    """
+    return get_host_for_testing("locust")
+
+
+def get_host_for_selenium_testing() -> str:
+    """
+    Get the host URL for selenium testing.
+
+    Returns:
+    str: The host URL for selenium testing.
+    """
+    return get_host_for_testing("selenium")

splent_framework-0.0.1/splent_framework/core/locust/common.py

@@ -0,0 +1,14 @@
+from faker import Faker
+from bs4 import BeautifulSoup
+
+fake = Faker()
+
+
+def get_csrf_token(response):
+    soup = BeautifulSoup(response.text, "html.parser")
+    token_tag = soup.find("input", {"name": "csrf_token"})
+    if token_tag:
+        return token_tag["value"]
+    else:
+        print("Response HTML:", response.text)
+        raise ValueError("CSRF token not found in the response")

splent_framework-0.0.1/splent_framework/core/managers/config_manager.py

@@ -0,0 +1,65 @@
+import os
+import redis
+
+
+class ConfigManager:
+    def __init__(self, app):
+        self.app = app
+
+    def load_config(self, config_name="development"):
+        # If config_name is not provided, use the environment variable FLASK_ENV
+        if config_name is None:
+            config_name = os.getenv("FLASK_ENV", "development")
+
+        # Load configuration
+        if config_name == "testing":
+            self.app.config.from_object(TestingConfig)
+        elif config_name == "production":
+            self.app.config.from_object(ProductionConfig)
+        else:
+            self.app.config.from_object(DevelopmentConfig)
+
+
+class Config:
+    SECRET_KEY = os.getenv(
+        "SECRET_KEY", "dev_test_key_1234567890abcdefghijklmnopqrstu"
+    )
+    SQLALCHEMY_DATABASE_URI = (
+        f"mysql+pymysql://{os.getenv('MARIADB_USER', 'default_user')}:"
+        f"{os.getenv('MARIADB_PASSWORD', 'default_password')}@"
+        f"{os.getenv('MARIADB_HOSTNAME', 'localhost')}:"
+        f"{os.getenv('MARIADB_PORT', '3306')}/"
+        f"{os.getenv('MARIADB_DATABASE', 'default_db')}"
+    )
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+    TIMEZONE = "Europe/Madrid"
+    TEMPLATES_AUTO_RELOAD = True
+    UPLOAD_FOLDER = "uploads"
+    SESSION_TYPE = "redis"
+    SESSION_PERMANENT = False
+    SESSION_USE_SIGNER = True
+    REDIS_URL = os.getenv("REDIS_URL", "redis://redis:6379")
+    SESSION_REDIS = redis.from_url(REDIS_URL)
+    REDIS_WORKER_TIMEOUT = os.getenv("REDIS_WORKER_TIMEOUT", 180)
+
+
+class DevelopmentConfig(Config):
+    DEBUG = True
+
+
+class TestingConfig(Config):
+    TESTING = True
+    SQLALCHEMY_DATABASE_URI = (
+        f"mysql+pymysql://{os.getenv('MARIADB_USER', 'default_user')}:"
+        f"{os.getenv('MARIADB_PASSWORD', 'default_password')}@"
+        f"{os.getenv('MARIADB_HOSTNAME', 'localhost')}:"
+        f"{os.getenv('MARIADB_PORT', '3306')}/"
+        f"{os.getenv('MARIADB_TEST_DATABASE', 'default_db')}"
+    )
+    WTF_CSRF_ENABLED = False
+    SESSION_TYPE = "filesystem"
+    SESSION_FILE_DIR = "/tmp/flask_sessions"
+
+
+class ProductionConfig(Config):
+    DEBUG = False