holado 0.2.1__tar.gz

holado-0.2.1/.gitignore

@@ -0,0 +1,8 @@
+# Byte-compiled
+__pycache__/
+*.py[cod]
+
+# Project files
+.project
+.pydevproject
+.settings/

holado-0.2.1/.gitlab-ci.yml

@@ -0,0 +1,26 @@
+stages:
+  - docker-build-publish
+
+variables:
+  DOCKER_IMAGE_TAG: "20.10"
+ 
+docker-build-publish:
+  stage: docker-build-publish
+
+  image:
+    name: docker:${DOCKER_IMAGE_TAG}
+
+#  services:
+#    - name: docker:${DOCKER_IMAGE_TAG}-dind
+#      alias: thedockerhost
+
+  variables:
+    IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
+#    DOCKER_HOST: "tcp://thedockerhost:2375"
+#    DOCKER_HOST: "tcp://docker:2376"
+#    DOCKER_TLS_CERTDIR: "/certs"
+  script:
+    - docker build -t ${IMAGE_TAG} .
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - docker push ${IMAGE_TAG}
+    

holado-0.2.1/Dockerfile

@@ -0,0 +1,77 @@
+# Note: HolAdo tests are currently failing with Python 3.13.0
+
+### Build
+
+#FROM python:3.10.15-alpine3.20 AS build
+#FROM python:3.11.10-alpine3.20 AS build
+#FROM python:3.12.8-alpine3.21 AS build
+FROM python:3.12.9-alpine3.21 AS build
+#FROM python:3.13.2-alpine3.21 AS build
+
+# Install to build python requirements
+RUN apk update \
+    && apk --no-cache --update add build-base \
+    && apk --update add alpine-sdk \
+    && apk add libffi-dev \
+    && apk add postgresql-dev gcc python3-dev musl-dev \
+    && apk add protobuf-dev
+
+# Add tools
+RUN apk --no-cache add bash \
+    && apk --no-cache add nano \
+    && apk --no-cache add curl
+
+# Create user
+RUN addgroup appuser \
+    && adduser -G appuser -s /bin/bash -D appuser
+
+# Create /code folder
+RUN mkdir /code \
+    && chown -R appuser:appuser /code
+
+# Switch to user appuser
+USER appuser
+
+# Copy HolAdo sources
+COPY --chown=appuser . /code/holado/python
+WORKDIR /code/holado/python
+
+# Create python venv and install requirements
+RUN python -m venv /code/env \
+    && source /code/env/bin/activate \
+    && pip install -r requirements_docker.txt
+
+
+
+### Runtime
+
+#FROM python:3.10.15-alpine3.20 AS runtime
+#FROM python:3.11.10-alpine3.20 AS runtime
+#FROM python:3.12.8-alpine3.21 AS runtime
+FROM python:3.12.9-alpine3.21 AS runtime
+#FROM python:3.13.2-alpine3.21 AS runtime
+
+# Install for python requirements
+RUN apk update \
+    && apk --no-cache add libstdc++ \
+    && apk --no-cache add postgresql-dev gcc python3-dev musl-dev
+
+# Add tools
+RUN apk --no-cache add bash \
+    && apk --no-cache add nano \
+    && apk --no-cache add curl
+
+# Create and switch to user appuser as in build
+RUN addgroup appuser \
+    && adduser -G appuser -s /bin/bash -D appuser
+USER appuser
+
+# Copy /code from build
+COPY --chown=appuser --from=build /code /code
+
+# Set working directory in HolAdo
+WORKDIR /code/holado/python
+
+# Activate permanently python venv
+ENV PATH=/code/env/bin:$PATH
+

holado-0.2.1/INSTALL

@@ -0,0 +1,7 @@
+Python modules dependencies:
+- behave
+- python-dateutil
+- for Web Service management: suds or zeep
+- for docker: docker
+- for RabbitMQ Client: pika
+- for Protobuf: google, protobuf

holado-0.2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 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.

holado-0.2.1/NOTES.md

@@ -0,0 +1,21 @@
+# Howto create a gitlab runner
+
+1. Setup OS.   
+Example as a VM:  
+*  Create a VM with last ubuntu
+*  Update repo: 
+> sudo apt update
+*  update system:  
+> sudo apt full-upgrade
+
+2.  Install dev tools: 
+> sudo apt install build-essential
+
+3.  Follow this howto:   
+<https://www.balticlsc.eu/gitlab/help/ci/docker/using_docker_build.md>
+  
+Known working installation:
+*  Install gitlab-runner by deb package: download last 'deb/gitlab-runner_amd64.deb', and install "dpkg -i gitlab-runner_amd64.deb"
+*  Install docker by distribution packages. Example: on ubuntu 20.04, install 'docker' and 'docker-io'
+
+

holado-0.2.1/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: holado
+Version: 0.2.1
+Summary: HolAdo framework
+Project-URL: Homepage, https://gitlab.com/holado_framework/python
+Project-URL: Issues, https://gitlab.com/holado_framework/python/-/issues
+Author-email: Eric Klumpp <eric.klumpp@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: AIS,BDD,Behavior Driver Development,Behaviour Driven Development,DB,Protobuf,REST,RabbitMQ,Redis,S3,Specification By Example,Web Services,YAML,automation,docker,functional test,gRPC,logging,multitask,script,test,test automation
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: behave==1.2.7.dev6
+Requires-Dist: python-dateutil
+Provides-Extra: ais
+Requires-Dist: pyais; extra == 'ais'
+Provides-Extra: db
+Requires-Dist: pypika; extra == 'db'
+Provides-Extra: db-postgresql
+Requires-Dist: psycopg; extra == 'db-postgresql'
+Provides-Extra: docker
+Requires-Dist: docker; extra == 'docker'
+Provides-Extra: helper-debug
+Requires-Dist: pympler; extra == 'helper-debug'
+Provides-Extra: protobuf-grpc
+Requires-Dist: google; extra == 'protobuf-grpc'
+Requires-Dist: google-api-core; extra == 'protobuf-grpc'
+Requires-Dist: grpc-requests; extra == 'protobuf-grpc'
+Requires-Dist: grpcio; extra == 'protobuf-grpc'
+Requires-Dist: grpcio-reflection; extra == 'protobuf-grpc'
+Requires-Dist: grpcio-tools; extra == 'protobuf-grpc'
+Requires-Dist: protobuf; extra == 'protobuf-grpc'
+Provides-Extra: rabbitmq
+Requires-Dist: pika; extra == 'rabbitmq'
+Provides-Extra: redis
+Requires-Dist: redis; extra == 'redis'
+Requires-Dist: redis-om; extra == 'redis'
+Provides-Extra: s3
+Requires-Dist: boto3; extra == 's3'
+Requires-Dist: flask; extra == 's3'
+Requires-Dist: flask-cors; extra == 's3'
+Requires-Dist: minio; extra == 's3'
+Requires-Dist: moto; extra == 's3'
+Provides-Extra: sftp
+Requires-Dist: pysftp; extra == 'sftp'
+Requires-Dist: sftpserver; extra == 'sftp'
+Provides-Extra: ws-suds
+Requires-Dist: suds; extra == 'ws-suds'
+Provides-Extra: ws-zeep
+Requires-Dist: zeep; extra == 'ws-zeep'
+Provides-Extra: yaml
+Requires-Dist: pyyaml; extra == 'yaml'
+Description-Content-Type: text/markdown
+
+# HolAdo (Holistic Automation do)
+
+# HolAdo
+
+HolAdo, or Holistic Automation do, gives a road to holistic automation in software development.
+It's aim is to facilitate many actions by unifying in one framework all needed modules.
+Each module delivers a specific need, and it is generally internally using another framework focussed on this need.
+
+HolAdo framework makes it easy to build a solution with many capabilities.
+Historically, it was created to easily build powerful functional testing solutions.
+But it's conception allows to use it in any context, by integrating only needed HolAdo modules.
+
+In order to improve transparency and maintainability of built solution, 
+the Gherkin language is used as a meta-language humanly readable.
+Each module includes dedicated steps to easily write scenarios (for testing) or processes (for configuration, deployment,...).
+
+
+# Status
+
+HolAdo can be used as is, it is stable and maintained.
+
+Until v1.0.0, it is still considered under construction, it is regularly refactored with breaking changes.
+
+To facilitate it's use, each breaking change will result to a new middle version 0.X.0, so that you can update minor versions without problem.
+
+
+# Python
+
+HolAdo project for Python development.
+Python is currently the only one supported language.
+
+Currently, main available modules are:
+* ais: manage AIS data
+* binary: manipulate binary data, like bit series
+* db: manage DB actions (clients, query)
+* docker: manage Docker actions
+* grpc: manage gRPC clients
+* helper: many helpers to easily use HolAdo possibilities (ex: build script/executable using Gherkin language outside of testing context, like to write automatic processes with pseudo code)
+* json: manipulate JSON data
+* keycloak: a Keycloak client
+* logging: add logging capabilities
+* multitask: manage multithreading and multiprocessing
+* protobuf: manage Protobuf
+* python: some tools over python libraries
+* rabbitmq: manage RabbitMQ
+* redis: manage Redis clients
+* report: manage reporting
+* rest: manage REST clients
+* s3: manage S3 clients
+* scripting: add scripting capabilities in other modules
+* sftp: manage sFTP clients
+* system: manage system actions
+* test: core module for testing capability (currently, only BDD tool "behave" is supported)
+* value: manage values (like tables with scripting capabilities)
+* ws: manage Web Service clients
+
+Major upcomming capabilities:
+* WebUI interactions (with playright or selenium)
+
+
+# Community
+
+A community around HolAdo is under construction.
+
+For the moment you can contact me by email (eric.klumpp@gmail.com).
+
+For any support, please write scenarios (executable with 'behave') illustating your problem:
+* If you encounter a bug, scenarios reproducing the bug.
+* If you need an evolution, scenarios illustrating the expected behavior.
+
+If you have implemented a new module, please send it to me, and I will include it in HolAdo framework.
+
+<!-- 
+
+# Howto run HolAdo non-regression tests from docker image got from registry.gitlab.com
+
+Note: Read HolAdo non-regression tests is a good way to discover its capabilities.
+
+* docker login -u XXX registry.gitlab.com
+* docker pull registry.gitlab.com/holado_framework/python:main
+* docker run --rm -it registry.gitlab.com/holado_framework/python:main /bin/sh -c "cd /code/holado/python; ./run_test_nonreg.sh"
+
+-->
+

holado-0.2.1/README.md

@@ -0,0 +1,84 @@
+# HolAdo (Holistic Automation do)
+
+# HolAdo
+
+HolAdo, or Holistic Automation do, gives a road to holistic automation in software development.
+It's aim is to facilitate many actions by unifying in one framework all needed modules.
+Each module delivers a specific need, and it is generally internally using another framework focussed on this need.
+
+HolAdo framework makes it easy to build a solution with many capabilities.
+Historically, it was created to easily build powerful functional testing solutions.
+But it's conception allows to use it in any context, by integrating only needed HolAdo modules.
+
+In order to improve transparency and maintainability of built solution, 
+the Gherkin language is used as a meta-language humanly readable.
+Each module includes dedicated steps to easily write scenarios (for testing) or processes (for configuration, deployment,...).
+
+
+# Status
+
+HolAdo can be used as is, it is stable and maintained.
+
+Until v1.0.0, it is still considered under construction, it is regularly refactored with breaking changes.
+
+To facilitate it's use, each breaking change will result to a new middle version 0.X.0, so that you can update minor versions without problem.
+
+
+# Python
+
+HolAdo project for Python development.
+Python is currently the only one supported language.
+
+Currently, main available modules are:
+* ais: manage AIS data
+* binary: manipulate binary data, like bit series
+* db: manage DB actions (clients, query)
+* docker: manage Docker actions
+* grpc: manage gRPC clients
+* helper: many helpers to easily use HolAdo possibilities (ex: build script/executable using Gherkin language outside of testing context, like to write automatic processes with pseudo code)
+* json: manipulate JSON data
+* keycloak: a Keycloak client
+* logging: add logging capabilities
+* multitask: manage multithreading and multiprocessing
+* protobuf: manage Protobuf
+* python: some tools over python libraries
+* rabbitmq: manage RabbitMQ
+* redis: manage Redis clients
+* report: manage reporting
+* rest: manage REST clients
+* s3: manage S3 clients
+* scripting: add scripting capabilities in other modules
+* sftp: manage sFTP clients
+* system: manage system actions
+* test: core module for testing capability (currently, only BDD tool "behave" is supported)
+* value: manage values (like tables with scripting capabilities)
+* ws: manage Web Service clients
+
+Major upcomming capabilities:
+* WebUI interactions (with playright or selenium)
+
+
+# Community
+
+A community around HolAdo is under construction.
+
+For the moment you can contact me by email (eric.klumpp@gmail.com).
+
+For any support, please write scenarios (executable with 'behave') illustating your problem:
+* If you encounter a bug, scenarios reproducing the bug.
+* If you need an evolution, scenarios illustrating the expected behavior.
+
+If you have implemented a new module, please send it to me, and I will include it in HolAdo framework.
+
+<!-- 
+
+# Howto run HolAdo non-regression tests from docker image got from registry.gitlab.com
+
+Note: Read HolAdo non-regression tests is a good way to discover its capabilities.
+
+* docker login -u XXX registry.gitlab.com
+* docker pull registry.gitlab.com/holado_framework/python:main
+* docker run --rm -it registry.gitlab.com/holado_framework/python:main /bin/sh -c "cd /code/holado/python; ./run_test_nonreg.sh"
+
+-->
+

holado-0.2.1/README.rst

@@ -0,0 +1,39 @@
+/!\ UNDER CONSTRUCTION
+
+==============
+HolAdo (Holistic Automation do)
+==============
+
+Framework dedicated to facilitate automation, including functional testing automation.
+
+
+Howto run tests from docker image got from registry.gitlab.com
+==============
+
+- docker login -u XXX registry.gitlab.com
+- docker pull registry.gitlab.com/testing-solution/python:main
+- docker run --rm -it registry.gitlab.com/testing-solution/python:main /bin/sh -c "cd /code/testing-solution/python; ./run_test.sh"
+
+
+Howto create a gitlab runner
+==============
+
+1. Setup OS.   
+Example as a VM:  
+- Create a VM with last ubuntu
+- Update repo: 
+  sudo apt update
+- update system:  
+  sudo apt full-upgrade
+
+2.  Install dev tools: 
+  sudo apt install build-essential
+
+3.  Follow this howto:   
+<https://www.balticlsc.eu/gitlab/help/ci/docker/using_docker_build.md>
+  
+Known working installation:
+- Install gitlab-runner by deb package: download last 'deb/gitlab-runner_amd64.deb', and install "dpkg -i gitlab-runner_amd64.deb"
+- Install docker by distribution packages. Example: on ubuntu 20.04, install 'docker' and 'docker-io'
+
+

holado-0.2.1/TODO

@@ -0,0 +1,14 @@
+Missing services:
+    UI: common UI objects
+        CLI: ssh, bash, cmd
+        GUI:
+            WebUI: Selenium, Playwright,...
+            Qt: Squish,...
+            System: LDTP
+            Image analyse: Eggplant,...
+    CI: Jenkins
+    QA: Jira RTM, Squash TM
+    Runners: script without scenario
+    Bindings: Robot Framework, Postman, Squash Autom
+    Docker: a docker image dedicated to control docker
+

holado-0.2.1/dependencies/protoc/README.txt

@@ -0,0 +1,2 @@
+The protoc precompiled versions are downloadable from GitHub:
+    https://github.com/protocolbuffers/protobuf/releases

holado-0.2.1/packaging/generate_distribution_archive.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cd ${SCRIPT_DIR}/..
+
+if ! python -m pip install --upgrade build; then
+    echo "ERROR: Failed to update 'build' package"
+    exit 1;
+fi
+
+if ! python -m build --outdir ${SCRIPT_DIR}/dist; then
+    echo "ERROR: Failed to build HolAdo distribution archive"
+    exit 1;
+fi

holado-0.2.1/packaging/publish_distribution_archive.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cd ${SCRIPT_DIR}/..
+
+if ! python -m pip install --upgrade twine; then
+    echo "ERROR: Failed to update 'twine' package"
+    exit 1;
+fi
+
+if ! python -m twine upload --repository testpypi packaging/dist/*; then
+    echo "ERROR: Failed to upload HolAdo distribution archives"
+    exit 1;
+fi

holado-0.2.1/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "holado"
+version = "0.2.1"
+authors = [
+  { name="Eric Klumpp", email="eric.klumpp@gmail.com" },
+]
+description = "HolAdo framework"
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+keywords = [
+    "automation", "test", "test automation", "functional test", "script", 
+    "Specification By Example", "BDD", "Behavior Driver Development", "Behaviour Driven Development", 
+    "AIS", "logging", "DB", "docker", "gRPC", "multitask", "Protobuf", 
+    "RabbitMQ", "Redis", "REST", "S3", "Web Services", "YAML"]
+dependencies = [
+  "behave==1.2.7.dev6",
+  "python-dateutil",
+]
+
+[project.optional-dependencies]
+ais = ["pyais"]
+db = ["pypika"]
+db-postgresql = ["psycopg"]
+docker = ["docker"]
+helper_debug = ["pympler"]
+protobuf_grpc = ["google", "google-api-core", "grpc_requests", "protobuf", "grpcio", "grpcio-reflection", "grpcio-tools"]
+rabbitmq = ["pika"]
+redis = ["redis", "redis-om"]
+s3 = ["minio", "boto3", "moto", "flask", "flask_cors"]
+sftp = ["pysftp", "sftpserver"]
+ws-suds = ["suds"]
+ws-zeep = ["zeep"]
+yaml = ["pyyaml"]
+
+[project.urls]
+Homepage = "https://gitlab.com/holado_framework/python"
+Issues = "https://gitlab.com/holado_framework/python/-/issues"

holado-0.2.1/requirements.txt

@@ -0,0 +1,2 @@
+-r requirements_docker.txt
+docker

holado-0.2.1/requirements_docker.txt

@@ -0,0 +1,89 @@
+#behave
+behave==1.2.7.dev6
+#git+https://github.com/behave/behave@v1.2.7.dev5
+
+python-dateutil
+
+# For RabbitMQ module
+pika
+
+# For Web-Service module
+#suds
+
+# For Protobuf and gRPC modules
+google
+google-api-core
+grpc_requests
+# protobuf and grpcio have dependencies
+# Previous used versions
+#protobuf==3.17.3
+#grpcio==1.42.0
+#grpcio-reflection==1.42.0
+#grpcio-tools==1.42.0
+
+# Last update & tested versions
+#protobuf==4.21.12
+#grpcio==1.51.1
+#grpcio-reflection==1.51.1
+#grpcio-tools==1.51.1
+
+protobuf
+grpcio
+grpcio-reflection
+grpcio-tools
+
+# For internal tests 
+django
+djangorestframework
+djangogrpcframework
+
+# For sftp
+pysftp
+sftpserver
+
+# For S3 module
+minio
+boto3
+moto
+# Needed by moto:
+flask
+flask_cors
+
+# For redis module
+redis
+redis-om
+
+# For AIS module
+pyais
+
+# For .xslt files support
+openpyxl
+
+# For memory profiling
+pympler
+
+# For yaml module
+pyyaml
+
+
+### DB modules
+
+# For PostreSQL module
+# Prerequirement: install libpq
+#    Example on ubuntu: sudo apt install libpq5
+psycopg
+
+# For query builder
+pypika
+
+
+### UI modules
+
+# For screenshots
+mss
+
+# For Selenium
+selenium
+Selenium-Screenshot
+
+