holado 0.13.22__py3-none-any.whl

holado_examples/projects/server_rest/server_rest_example/initialize_holado.py

@@ -0,0 +1,72 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+
+#################################################
+# GOAL: Tools when using a clone of HolAdo project.
+#
+# This file contains methods usefull to initialize environments using a clone of HolAdo project.
+#
+# USAGE: 
+#   - Copy this file in projects using HolAdo.
+#   - Define environment variable HOLADO_PATH with path to cloned HolAdo project.
+#     If HOLADO_PATH is defined, sources of cloned HolAdo project are used, else installed holado package is used.
+#################################################
+
+
+
+import os
+import sys
+
+
+def insert_sys_path(path, index=0):
+    """Insert a path in sys.path if it doesn't already exists.
+    """
+    if path not in sys.path:
+        sys.path.insert(index, path)
+
+def insert_sys_paths(list_paths, index=0):
+    """Insert a list of path in sys.path if it doesn't already exists.
+    """
+    if list_paths:
+        for path in list_paths:
+            insert_sys_path(path, index=index)
+
+def insert_holado_source_paths(with_test_behave=True):
+    """Insert in sys.path all HolAdo source paths.
+    If environment variable HOLADO_PATH is defined with path to HolAdo project, following paths are inserted in sys.path:
+        - HOLADO_PATH/src: path to holado modules sources
+        - HOLADO_PATH/tests/behave (if with_test_behave==True): path to holado test sources, needed by testing solutions
+    """
+    holado_path = os.getenv('HOLADO_PATH')
+    if holado_path is None:
+        try:
+            import holado  # @UnusedImport
+        except Exception as exc:
+            if "No module named" in str(exc):
+                raise Exception(f"If environment variable HOLADO_PATH is not defined with path to HolAdo project, 'holado' python package must be installed")
+            else:
+                raise exc
+        else:
+            # holado is installed, and all sources are already accessible
+            pass
+    else:
+        print(f"Using HolAdo project installed in '{holado_path}'")
+        # import traceback
+        # print("".join(traceback.format_list(traceback.extract_stack())))
+        # insert_sys_path(holado_path)
+        insert_sys_path(os.path.join(holado_path, "src"))
+        if with_test_behave:
+            insert_sys_path(os.path.join(holado_path, "tests", "behave"))
+    
+

holado_examples/projects/server_rest/server_rest_example/rest_api/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'rest_api.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/application/admin.py

@@ -0,0 +1,3 @@
+# from django.contrib import admin
+
+# Register your models here.

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/application/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+
+class ApplicationConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'application'

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/application/models.py

@@ -0,0 +1,3 @@
+# from django.db import models
+
+# Create your models here.

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/application/serializers.py

@@ -0,0 +1,15 @@
+from django.contrib.auth.models import User, Group
+from rest_framework import serializers
+
+
+class UserSerializer(serializers.HyperlinkedModelSerializer):
+    class Meta:
+        model = User
+        fields = ['url', 'username', 'email', 'groups']
+
+
+class GroupSerializer(serializers.HyperlinkedModelSerializer):
+    class Meta:
+        model = Group
+        fields = ['url', 'name']
+        

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/application/tests.py

@@ -0,0 +1,3 @@
+# from django.test import TestCase
+
+# Create your tests here.

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/application/views.py

@@ -0,0 +1,24 @@
+from django.shortcuts import render
+from django.contrib.auth.models import User, Group
+from rest_framework import viewsets
+from rest_framework import permissions
+from .serializers import UserSerializer, GroupSerializer
+
+
+class UserViewSet(viewsets.ModelViewSet):
+    """
+    API endpoint that allows users to be viewed or edited.
+    """
+    queryset = User.objects.all().order_by('-date_joined')
+    serializer_class = UserSerializer
+    permission_classes = [permissions.IsAuthenticated]
+
+
+class GroupViewSet(viewsets.ModelViewSet):
+    """
+    API endpoint that allows groups to be viewed or edited.
+    """
+    queryset = Group.objects.all()
+    serializer_class = GroupSerializer
+    permission_classes = [permissions.IsAuthenticated]
+    

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for server_rest_example project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'rest_api.settings')
+
+application = get_asgi_application()

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/settings.py

@@ -0,0 +1,130 @@
+"""
+Django settings for server_rest_example project.
+
+Generated by 'django-admin startproject' using Django 5.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-(4nx+&@_ylqw(sa25syu5gdnu1q0bhyy69%*)^al_=2*%c*=ar'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'rest_framework',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'rest_api.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'rest_api.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.2/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+
+
+REST_FRAMEWORK = {
+    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
+    'PAGE_SIZE': 10
+}
+

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/urls.py

@@ -0,0 +1,31 @@
+"""
+URL configuration for server_rest_example project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+from rest_framework import routers
+from django.urls.conf import include
+from .application import views
+
+router = routers.DefaultRouter()
+router.register(r'users', views.UserViewSet)
+router.register(r'groups', views.GroupViewSet)
+
+urlpatterns = [
+    path('', include(router.urls)),
+    path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
+    path('admin/', admin.site.urls),
+]

holado_examples/projects/server_rest/server_rest_example/rest_api/rest_api/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for server_rest_example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'rest_api.settings')
+
+application = get_wsgi_application()

holado_examples/projects/server_rest/server_rest_example/rest_server.py

@@ -0,0 +1,37 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+
+# Uncomment next lines to insert holado sources when using a clone of holado project rather than holado package 
+# from initialize_holado import insert_holado_source_paths
+# insert_holado_source_paths()
+
+import os
+from holado_django.server.django_server import DjangoServer
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+
+if __name__ == "__main__":
+    here = os.path.abspath(os.path.dirname(__file__))
+    django_project_path = os.path.join(here, "rest_api")
+     
+    server = DjangoServer("Example of REST server", django_project_path)
+    server.start()
+    try:
+        server.join()
+    except (InterruptedError, KeyboardInterrupt):
+        pass
+    

holado_examples/scripts/script_custom_initialization.py

@@ -0,0 +1,16 @@
+import holado
+
+
+# Initialize HolAdo with default behaviours and custom parameters
+
+holado.initialize_for_script(log_on_console=True, log_in_file=True)
+
+import logging
+logging.print("After 'holado.initialize_for_script(log_on_console=True, log_in_file=True)', HolAdo is initialized for scripts with:")
+logging.print("  - add logging levels 'trace' and 'print'")
+logging.print("  - do logs on console and in file")
+logging.print("  - a default session context is initialialized with all available HolAdo services")
+logging.print("  - a session folder is created that will contains at least log files")
+logging.print("  - launch garbage collector periodically (without specifying garbage_collector_periodicity, default periodicity is 10 s)")
+
+

holado_examples/scripts/script_minimal_initialization.py

@@ -0,0 +1,23 @@
+import holado
+
+
+# Minimal HolAdo initialization for scripts
+holado.initialize_for_script()
+
+import logging
+logging.print("After 'holado.initialize_for_script()', HolAdo is initialized minimally for scripts with:")
+logging.print("  - add logging levels 'trace' and 'print'")
+logging.print("  - do logs on console but not in file")
+logging.print("  - a default session context is initialialized with all available HolAdo services")
+logging.print("  - no session folder is created")
+
+
+# Launch manually garbage collector periodically
+from holado.common.tools.gc_manager import GcManager
+from holado.common.handlers.undefined import default_value
+GcManager.collect_periodically(collect_periodicity=default_value) 
+logging.print("After 'GcManager.collect_periodically(collect_periodicity=default_value)', garbage collector is launched periodically (with default periodicity that is 10 s)")
+
+
+
+

holado_examples/tests/behave/testing_solution/__main__.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+
+# This main is only needed to debug behave execution (and thus testing solution) with breakpoints
+
+import re
+import sys
+
+from behave.__main__ import main
+
+if __name__ == '__main__':
+    sys.argv[0] = re.sub(r'(-script\.pyw?|\.exe)?$', '', sys.argv[0])
+    sys.exit(main())

holado_examples/tests/behave/testing_solution/behave_environment.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+import holado_test.behave.behave_environment
+
+
+# Import default hook implementation
+from holado_test.behave.behave_environment import *
+
+# Redefine specific hook implementation
+def before_all(context):
+    holado_test.behave.behave_environment.before_all(context)
+
+def after_all(context):
+    holado_test.behave.behave_environment.after_all(context)
+
+def before_feature(context, feature):
+    holado_test.behave.behave_environment.before_feature(context, feature)
+
+def after_feature(context, feature):
+    holado_test.behave.behave_environment.after_feature(context, feature)
+
+def before_scenario(context, scenario):
+    holado_test.behave.behave_environment.before_scenario(context, scenario)
+
+def after_scenario(context, scenario):
+    holado_test.behave.behave_environment.after_scenario(context, scenario)
+
+def before_step(context, step):
+    holado_test.behave.behave_environment.before_step(context, step)
+
+def after_step(context, step):
+    holado_test.behave.behave_environment.after_step(context, step)
+
+    
+

holado_examples/tests/behave/testing_solution/environment.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+import logging
+
+
+
+# Add testing solution project source path
+here = os.path.abspath(os.path.dirname(__file__))
+source_path = os.path.normpath(os.path.join(here, 'src'))
+sys.path.insert(0, source_path)
+
+# Add HolAdo source paths (needed when using a clone of HolAdo project)
+from initialize_holado import insert_holado_source_paths  # @UnresolvedImport
+insert_holado_source_paths()
+
+
+# Configure HolAdo
+import holado
+from context.session_context import TSSessionContext  # @UnresolvedImport
+# holado.initialize(TSessionContext=TSSessionContext, 
+holado.initialize(TSessionContext=None, 
+                  logging_config_file_path=os.path.join(here, 'logging.conf'), log_level=logging.INFO,
+                  garbage_collector_periodicity=None)
+
+
+# Import generic environment methods
+from behave_environment import *  # @UnresolvedImport
+
+# Define project specific environment methods
+# TestConfig.profile_memory_in_features = True
+# TestConfig.profile_memory_in_scenarios = True
+
+
+

holado_examples/tests/behave/testing_solution/features/Configuration/Actions/configure_system.feature

@@ -0,0 +1,10 @@
+@configure_system
+Feature: Configure system
+
+    @default_settings
+    Scenario: Configure system with default settings
+        Given ensure system is configured with default settings
+        
+        
+        
+        

holado_examples/tests/behave/testing_solution/features/NonReg/example.feature

@@ -0,0 +1,26 @@
+@example
+Feature: Example of feature
+
+    Scenario: Get and verify file content
+        ### PRECONDITIONS - BEGIN
+        Given begin preconditions
+        
+        Given DT_NOW = datetime now
+        Given DT_NOW_STR = convert datetime DT_NOW to string with format '%Y-%m-%dT%H-%M-%S-%f'
+        Given FILENAME = 'test_${DT_NOW_STR}.xml'
+        
+        Given TEXT = 'text'
+        Given FILE_PATH = create file with name FILENAME
+            """
+            <node>${TEXT}</node>
+            """
+            
+        Given end preconditions
+        ### PRECONDITIONS - END
+        
+        Given FILE_CONTENT = content of file FILE_PATH
+        Given FILE_CONTENT_STR = convert object value FILE_CONTENT to string
+        Then FILE_CONTENT_STR == '<node>text</node>'
+
+        
+        

holado_examples/tests/behave/testing_solution/initialize_holado.py

@@ -0,0 +1,62 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+
+#################################################
+# GOAL: Tools when using a clone of HolAdo project.
+#
+# This file contains methods usefull to initialize environments using a clone of HolAdo project.
+#
+# USAGE: 
+#   - Copy this file in projects using HolAdo.
+#   - Define environment variable HOLADO_PATH with path to cloned HolAdo project.
+#     If HOLADO_PATH is defined, sources of cloned HolAdo project are used, else installed holado package is used.
+#################################################
+
+
+
+import os
+import sys
+
+
+def insert_sys_path(path, index=0):
+    """Insert a path in sys.path if it doesn't already exists.
+    """
+    if path not in sys.path:
+        sys.path.insert(index, path)
+
+def insert_holado_source_paths(with_test_behave=True):
+    """Insert in sys.path all HolAdo source paths.
+    If environment variable HOLADO_PATH is defined with path to HolAdo project, following paths are inserted in sys.path:
+        - HOLADO_PATH/src: path to holado modules sources
+        - HOLADO_PATH/tests/behave (if with_test_behave==True): path to holado test sources, needed by testing solutions
+    """
+    holado_path = os.getenv('HOLADO_PATH')
+    if holado_path is None:
+        try:
+            import holado  # @UnusedImport
+        except Exception as exc:
+            if "No module named" in str(exc):
+                raise Exception(f"If environment variable HOLADO_PATH is not defined with path to HolAdo project, 'holado' python package must be installed")
+            else:
+                raise exc
+        else:
+            # holado is installed, and all sources are already accessible
+            pass
+    else:
+        print(f"Using HolAdo project installed in '{holado_path}'")
+        insert_sys_path(os.path.join(holado_path, "src"))
+        if with_test_behave:
+            insert_sys_path(os.path.join(holado_path, "tests", "behave"))
+    
+