Descargar overhave - Descargar el código fuente de overhave

overhave

Datos del sitio web

5.2.1

Descargar

Verificar

Overhave es el trabajo de marco web para BDD: escalable, configurable, fácil de usar, basado en Flask Admin y Pydantic.

Características

Interfaz web listo para la gestión de características de BDD fácil con Ace Editor
Formato tradicional de Gherkin para escenarios proporcionados por Pytest-BDD
Ejecución e informes de funciones de BDD basadas en Allure
Colección automática de los pasos Pytest-BDD y se muestra en la interfaz web
Estructura de escenarios simples, escala horizontal fácil
Envoltorios integrados para ganchos Pytest-BDD para complementar el informe Allure
Capacidad para crear y usar varios diccionario de palabras clave BDD con diferentes idiomas
Versión y despliegue de borradores de escenarios a Bitbucket o Gitlab
Sincronización entre el repositorio de git y la base de datos con características
Gestión de acceso configurable incorporada de usuarios y grupos
Estrategia configurable para la autorización del usuario (también se proporciona LDAP)
Esquema de la base de datos basado en modelos Sqlalchemy y funciona con PostgreSQL
Todavía configurable como administrador de frascos, admite complementos y extensiones
Tiene una aplicación API incorporada con Docs Swagger, basado en Fastapi
Arquitectura distribuida del consumidor del productor basada en las transmisiones de Walrus Redis
Interfaz de línea de comandos, proporcionada con Typer
Interacción integrada para el almacenamiento de archivos con S3-Cloud basada en Boto3
Capacidad de emulación de navegador web con kit de herramientas personalizado (Gotty, por ejemplo)

Instalación

Puede instalar Overhave a través de PIP desde Pypi:

pip install overhave

Descripción general

Interfaz web

La interfaz web es una herramienta básica para la administración de características de BDD. Consiste en:

Información: página de índice con información opcional sobre su herramienta o proyecto;
Escenarios: sección para la gestión de características, contiene subsecciones
Características, ejecuciones de prueba, versiones y etiquetas:
- Características
  ofrece una interfaz para la administración de registros de características y proporciona información sobre ID, nombre de nombre, tiempo, editor y estado de publicación; Es posible buscar, editar o eliminar elementos a través del panel de script.
- Ejecución de pruebas
  Da una interfaz para la administración de ejecuciones de prueba y proporciona información sobre.
- Versiones
  contiene versiones de características en correspondencia a las ejecuciones de prueba; Las versiones contienen enlaces PR al repositorio de git remoto.
- Etiquetas
  Contiene valores de etiquetas, que se utilizan para el etiquetado de la función.
Usuarios de prueba: sección para ver y configurar usuarios de prueba;
Acceso - Sección para la gestión de acceso, contiene usuarios y
Agrupar subsecciones;
Emulación: sección experimental para la implementación de herramientas alternativas
(en desarrollo).

Las características de Overhave podrían crearse y/o editarse a través del panel de script especial en el modo de edición de funciones. La función debe tener el tipo registrado por la aplicación, el nombre único, la lista de tareas especificadas con el formato tradicional `PRJ-NUMBER` y el texto del escenario.

El panel de script tiene una tabla Pytest-BDD Pass en el lado derecho de la interfaz. Estos pasos deben definirse en módulos de accesorio apropiados y registrarse en la aplicación en el inicio que se mostrará.

Ejemplo del panel de script de Overhave en el modo de edición de funciones

Informe Allure

Overhave genera un informe Allure después de la ejecución de las pruebas en la interfaz web. Si ejecuta pruebas manualmente a través de PyTest, estos resultados se pueden convertir en el informe Allure también con la herramienta Allure CLI. Este informe contiene descripciones de escenarios como se describen en las características.

Ejemplo del informe de Allure generado después de la ejecución de la función Overhave

Modo de demostración (QuickStart)

Overhave tiene un modo de demostración especial (en desarrollo), que posiblemente podría usarse para la demostración del marco y la depuración / prueba manual. El marco proporciona un CLI EntryPoints para una fácil ejecución del servidor en modo de depuración:

make up  # start PostgreSQL database and Redis
overhave db create-all  # create Overhave database schema
overhave-demo admin  # start Overhave admin on port 8076 in debug mode
overhave-demo consumer -s test  # start Overhave test execution consumer

Nota : Puede ejecutar Admin en modo especial, que no requiere consumidores. Este modo utiliza Threadpool para ejecutar tareas de prueba y publicación de forma asincrónica:

overhave-demo admin --threadpool --language=ru

Pero este modo Threadpool no se puede calcular en el paradigma de Kubernetes . Por lo tanto, se recomienda usar exactamente los consumidores correspondientes.

Interfaz de línea de comandos

Overhave tiene una CLI que proporciona una forma simple de iniciar la interfaz web del servicio, ejecutar el consumidor y ejecutar operaciones básicas de la base de datos. Los ejemplos están a continuación:

overhave db create-all
overhave admin --port 8080
overhave consumer -s publication
overhave api -p 8000 -w 4

Nota : El inicio del servicio toma un conjunto de configuraciones, por lo que puede configurarlos a través del entorno virtual con prefijo `OVERHAVE_` , por ejemplo` `OVERHAVE_DB_URL` . Si desea configurar la configuración de una manera más explícita a través de la inyección de contexto, consulte la siguiente parte de los documentos.

Inyección de contexto

Configuración de contexto

El servicio podría configurarse a través de la inyección de contexto de aplicación con una instancia preparada del objeto OverhaveContext. Este contexto podría establecerse utilizando la función `set_context` de la instancia` `ProxyFactory` inicializada.

Por ejemplo, preparado `my_custom_context` . Por lo tanto, el inicio de la aplicación podría realizarse con el código de seguimiento:

 from overhave import overhave_app , overhave_admin_factory

factory = overhave_admin_factory ()
factory . set_context ( my_custom_context )
overhave_app ( factory ). run ( host = 'localhost' , port = 8080 , debug = True )

Nota :

`overhave_app` es la aplicación de matraz preparada con ya habilitado
Complementos de administrador de frascos y gerentes de inicio de sesión;
`overhave_factory` es una función para la instancia en caché de LRU de la Overhave
fábrica `ProxyFactory` ; La instancia tiene un acceso a los componentes de la aplicación, utilizados directamente en `overhave_app` .
`my_custom_context` es un ejemplo de configuración de contexto, consulte un
Código de ejemplo en context_example.rst.

Rehacer

Redissentinel - Redis Connection a través de Sentinel. Para habilitar la conexión Sentinel use Env Overhave_redis_sentinel_enabled = True
Redis : conexión Redis predeterminada sin Sentinel.

Consumidores

Overhave tiene una arquitectura de consumidor de productores, basada en transmisiones de Redis, y admitió 3 tipos de consumidores:

Prueba : consumidor para la ejecución de la prueba con su propia fábrica
`overhave_test_execution_factory` ;
Publicación - Consumidor para la publicación de características con su propia fábrica
`overhave_publication_factory` ;
Emulación : consumidor para emulación específica con su propia fábrica
`overhave_emulation_factory` .

Nota : El `overhave_test_execution_factory` tiene capacidad para la inyección de contexto y podría enriquecerse con el contexto personalizado como` `overhave_admin_factory` .

Estructura de proyectos

Overhave admite su propia estructura de proyecto especial:

El enfoque correcto es crear un directorio raíz (como "demostración" dentro del repositorio actual) que contenga características , accesorios y directorios de pasos .

El directorio de características contiene diferentes tipos de características como directorios separados, cada uno de ellos corresponde al conjunto de pasos Pytest-BDD predefinidos.

El directorio de accesorios contiene módulos pytest típicos divididos por diferentes tipos de características. Estos módulos se utilizan para las ejecuciones de prueba aisladas Pytest-BDD. Es necesario debido al mecanismo especial de la colección de pasos Pytest-BDD.

El directorio de pasos contiene paquetes de pasos Pytest-BDD divididos también por tipos de características diferentes. Cada subdirectorio de pasos tiene sus propios pasos declarados según el tipo de característica compatible.

Por lo tanto, es posible crear su propia estructura horizontal de diferentes instrucciones del producto con pasos únicos y accesorios de pytest.

Nota : Esta estructura se utiliza en la aplicación de Overhave . Los datos formados brindan la posibilidad de especificar el tipo de función registrada en el panel de script de interfaz web. Además, esta estructura define qué pasos se mostrarán en el lado derecho del panel de script .

Formato de características

Overhave tiene su propio formato de texto de característica especial, que hereda Gherkin de Pytest-BDD con actualizaciones únicas:

Etiqueta requerida que está relacionada con el directorio de tipo de características existente, donde
Se encuentra la función actual;
cualquier cantidad de etiquetas arbitrarias;
Etiqueta de gravedad: implementa la gravedad de Allure para presentar o simplemente etiquetado
escenario (por ejemplo: `@severity.blocker` );
Información sobre la función: quién es el creador, el último editor y editor;
Tareas del rastreador con formato `PRJ-1234` ;

Un ejemplo de contenido de características llenas se encuentra en function_example.rst.

Marcadores de pytest

Overhave implementa la solución para el uso de marcadores de pytest con información adicional personalizada:

"Desactivado": igual que Skip Marker, pero es necesario configurar la razón;
"Xfail": XFail tradicional con presencia de razón estricta.

Ejemplos:

 @disabled(not ready)
Feature : My business feature

 @disabled(TODO: https://tracker.myorg.com/browse/PRJ-333; deadline 01.01.25)
Scenario : Yet another business feature

 @xfail(bug: https://tracker.myorg.com/browse/PRJ-555)
Scenario outline: Other business feature

Si la razón contiene URL, por lo que Overhave adjuntará Allure Link al Informe: Para discapacitado, será LinkType.link, para XFail - LinkType.issue.

Enlaces de características

Overhave tiene la capacidad de establecer enlaces a su propio servicio de administración en los casos de prueba Allure. El enlace se establecerá automáticamente cuando genere un informe Allure. Esta función se puede habilitar mediante la configuración de la variable de entorno `OVERHAVE_ADMIN_URL` :

 export OVERHAVE_ADMIN_URL=https://overhave-admin.myorg.com

Además, Overhave tiene la capacidad de establecer enlaces para presentar el archivo en el repositorio Git. El enlace se establecerá automáticamente cuando genere un informe Allure. Esta función se puede habilitar mediante la configuración de la variable de entorno `OVERHAVE_GIT_PROJECT_URL` :

 export OVERHAVE_GIT_PROJECT_URL=https://git.myorg.com/bdd-features-repo

Idioma

El idioma de la interfaz web es ENG de forma predeterminada y no se puede cambiar (si es necesario, por favor, cree una `feature request` o contribuya).

El texto de la función y las palabras clave Pytest-BDD BDD son configurables con modelos adicionales de Overhave , por ejemplo, las palabras clave RUS ya están definidas en el marco y están disponibles para su uso:

 from overhave . extra import RUSSIAN_PREFIXES

language_settings = OverhaveLanguageSettings ( step_prefixes = RUSSIAN_PREFIXES )

Nota : Puede crear su propia asignación de valor de prefijo para su idioma:

 from overhave import StepPrefixesModel

GERMAN_PREFIXES = StepPrefixesModel (
    FEATURE = "Merkmal:" ,
    SCENARIO_OUTLINE = "Szenarioübersicht:" ,
    SCENARIO = "Szenario:" ,
    BACKGROUND = "Hintergrund:" ,
    EXAMPLES = "Beispiele:" ,
    EXAMPLES_VERTICAL = "Beispiele: Vertikal" ,
    GIVEN = "Gegeben " ,
    WHEN = "Wann " ,
    THEN = "Dann " ,
    AND = "Und " ,
    BUT = "Aber " ,
)

Integración de git

Overhave brinda la capacidad de enviar sus nuevas características o cambios al repositorio remoto de Git, que está alojado por Bitbucket o GitLab. La integración con Bitbucket es nativa, mientras que la integración con GitLab utiliza la biblioteca Python-GitLab.

Puede establecer la configuración necesaria para su proyecto:

 publisher_settings = OverhaveGitlabPublisherSettings (
    repository_id = '123' ,
    default_target_branch_name = 'master' ,
)
client_settings = OverhaveGitlabClientSettings (
    url = "https://gitlab.mycompany.com" ,
    auth_token = os . environ . get ( "MY_GITLAB_AUTH_TOKEN" ),
)

Pull-Request (para BitBucket) o Merge-Request (para GITLAB) creado cuando hace clic en el botón Crear solicitud de extracción en la página de prueba de prueba de prueba. Este botón está disponible solo para el resultado de la ejecución de la prueba de éxito.

Nota : Uno de los casos más populares de autenticación de la API de GitLab es el esquema OAuth2 con cuenta de servicio. Según este esquema, debe tener Token Oauth2, lo que podría tener una breve vida útil y no podría especificarse a través del entorno. Para esta situación, Overhave tiene TokenizerClient especial con sus propios TokenizerClientSettings: este cliente simple podría tomar el token de un servicio de tokenizador GitLab personalizado remoto.

Sincronización de git-to database

Overhave ofrece la capacidad de sincronizar el estado de su repositorio Git actual con la base de datos. Significa que sus características, que se encuentran en la base de datos, podrían actualizarse, y la fuente de actualizaciones es su repositorio.

Por ejemplo : tenía que hacer un reemplazo de datos a granel en el repositorio de Git, y ahora desea entregar cambios a la base de datos remota. Esto no tan fácil podría resolverse con herramientas especiales de Overhave :

Puede establecer la configuración necesaria para su proyecto:

overhave sync run  # only update existing features
overhave sync run --create-db-features  # update + create new features
overhave sync run --pull-repository  # pull git repo and run sync

Puede probar esta herramienta con el modo de demostración de Overhave . Por defecto, se crean 3 características en la base de datos de demostración. Simplemente intente cambiarlas o crear nuevas funciones y ejecute el comando de sincronización; obtendrá el resultado.

overhave-demo sync-run  # or with '--create-db-features'

Overhave admite la validación de los archivos de características existentes. Comando intente analizar las funciones y completar el formato de información de características definidas. Si hay algún problema, se lanzará un error especial.

overhave sync validate-features
overhave sync validate-features --raise-if-nullable-id
overhave sync validate-features --pull-repository

Y sí, puede probarlo con el modo de demostración:

overhave-demo validate-features
overhave sync validate-features -r  # --raise-if-nullable-id

Índice personalizado

Overhave proporciona la capacidad de establecer el archivo Custom Index.html para la representación. Ruta al archivo podría establecerse a través del entorno y establecer con contexto:

 admin_settings = OverhaveAdminSettings (
    index_template_path = "/path/to/index.html"
)

Estrategia de autorización

Overhave proporciona varias estrategias de autorización, declaradas por `AuthorizationStrategy` enum:

Simple - Estrategia sin autorización real.
Cada usuario podría usar el nombre preferido. Este nombre se utilizará para la autoridad de usuario. Cada usuario es único. No se requiere contraseña.
Predeterminado: estrategia con autorización real.
Cada usuario podría usar solo credenciales registradas.
LDAP - Estrategia con autorización utilizando el servidor LDAP remoto.
Cada usuario debe usar sus credenciales LDAP. El servidor LDAP devuelve grupos de usuarios. Si el usuario en el grupo 'admin' predeterminado o su lista de grupos contiene el grupo de administración, el usuario será autorizado. Si el usuario ya se colocó en la base de datos, el usuario también estará autorizado. Nadie almacena contraseña.

La estrategia apropiada y los datos adicionales deben colocarse en `OverhaveAuthorizationSettings` , por ejemplo, la estrategia LDAP podría configurarse así:

 auth_settings = OverhaveAuthorizationSettings ( auth_strategy = AuthorizationStrategy . LDAP )
ldap_manager_settings = OverhaveLdapManagerSettings ( ldap_admin_group = "admin" )

Cloud S3

Overhave implementa la funcionalidad para las interacciones en la nube S3 , como la creación y eliminación de deseos, la carga de archivos, la descarga y la eliminación. El marco proporciona la capacidad de almacenar informes y otros archivos en el almacenamiento remoto de la nube S3. Puede enriquecer su entorno con la siguiente configuración:

OVERHAVE_S3_ENABLED=true
OVERHAVE_S3_URL=https://s3.example.com
OVERHAVE_S3_ACCESS_KEY= < MY_ACCESS_KEY >
OVERHAVE_S3_SECRET_KEY= < MY_SECRET_KEY >

Opcionalmente, también puede cambiar la configuración predeterminada:

OVERHAVE_S3_VERIFY=false
OVERHAVE_S3_AUTOCREATE_BUCKETS=true

El marco con la bandera habilitada `OVERHAVE_S3_AUTOCREATE_BUCKETS` creará cubos de aplicación en el almacenamiento remoto si no existen cubos.

API

Overhave tiene su propia interfaz de programación de aplicaciones, basada en Fastapi.

Over Have Openapi.json a través de Swagger

Las posibilidades actuales se pueden mostrar a través de la arrogancia incorporada: solo ejecute la API y abra http: // localhost: 8000 en su navegador.

overhave api -p 8000

La interfaz tiene autorización a través del esquema OAuth2, por lo que debe configurar `OVERHAVE_API_AUTH_SECRET_KEY` para el uso.

En este momento, API implementa tipos de recursos:

Feing_tags
Obtener una etiqueta de característica o obtener una lista de etiquetas de características;
características
Obtener información de características por ID de etiqueta o valor de etiqueta;
test_users
Obtenga la información del usuario de la prueba, las especificaciones, ponga nuevas especificaciones o elimine el usuario de la prueba;
test_runs
Obtenga la información de ejecución de la prueba o cree la ejecución de la prueba con parámetros dados;
emulaciones
Obtenga ejecuciones de emulación por ID de usuario de prueba.

Que contribuye

Las contribuciones son muy bienvenidas.

Preparación

La instalación del proyecto es muy fácil y toma solo unos pocos comandos preparados (haga que los funcionen previamente en la INIT solo para Ubuntu; para que pueda instalar los mismos paquetes para su sistema operativo manualmente):

make pre-init
make init

La gestión de paquetes es proporcionada por la poesía.

Controlar

Las pruebas se pueden ejecutar con Tox. Docker-Compose se utiliza para otros servicios de preparación y servicio, como la base de datos. Pruebas simples y ejecución de los enlaces: