Zephyr data processor synchronizes the test in th2 with Zephyr Squad and Zephyr Scale. It searches for events that match format in the configuration and updates test executions.
When the data processor finds the event it tries to extract information about folder, version and cycle. It checks the event tree. It should have the following format
Root event with name `version|CycleName|Any other information you want`
|- Sub event with folder name. _NOTE: if there are several sub events the closest one to the issue event will be taken_
|- TEST-1253 // the issue event. Its name must match the format in the configuration
Root event
|- Sub event(s)
|- Event with cycle name and version `<CycleName>|<version>|<Any other information>
|- TEST-T1253 // the test case event. Its name must match the format in the configuration
There is an example of full configuration for the data processor
apiVersion: th2.exactpro.com/v1
kind: Th2Box
metadata:
name: zephyr-processor
spec:
image-name: ghcr.io/th2-net/th2-data-processor-zephyr
image-version: 0.2.0
type: th2-act
pins:
- name: server
connection-type: grpc
- name: to_data_provider
connection-type: grpc
custom-config:
zephyrType: SQUAD
connection:
baseUrl: "https://your.jira.address.com"
jira:
username: "jira-user"
key: "you password" # or api key
dataService:
name: "ZephyrService"
versionMarker: "0.0.1"
syncParameters:
issueFormat: "QAP_\\d+"
delimiter: '|'
statusMapping:
SUCCESS: PASS
FAILED: WIP
jobAwaitTimeout: 1000
testExecutionMode: UPDATE_LAST # CREATE_NEW
relatedIssuesStrategies:
- type: linked
trackLinkedIssues:
- linkName: "is cloned by"
whitelist:
- projectKey: "P1"
issues:
- TEST-1
- TEST-2
- TEST-3
- projectName: "P2 Project"
issues:
- TEST-1
- TEST-2
- TEST-4
httpLogging:
level: INFO
extended-settings:
service:
enabled: true
type: ClusterIP
endpoints:
- name: 'grpc'
targetPort: 8080
envVariables:
JAVA_TOOL_OPTIONS: '-XX:+ExitOnOutOfMemoryError -XX:+UseContainerSupport -XX:MaxRAMPercentage=85'
resources:
limits:
memory: 250Mi
cpu: 200m
requests:
memory: 100Mi
cpu: 50mDeterminate which type of synchronization to use. Possible values:
- SQUAD
- SCALE_SERVER
- SCALE_CLOUD
The default value is SQUAD
Contains information about the endpoint ot connect
- baseUrl - url to the Jira instance
- jira - block contains credentials to connect to Jira. There are several types of credentials:
- basic - username and password
- username - the Jira username
- key - the Jira password or API key for authentication
jira: username: "jira-user" key: "you password" # or api key
- bearer - generated token
- token - the generated token to access jira
jira: type: bearer token: "some generated token"
- basic - username and password
- zephyr - block contains credentials to connect to Zephyr. By default, the same credentials as for Jira are used.
- zephyrUrl - url to the Zephyr API. By default, equal to baseUrl.
Contains information about name and version for current data service. It is used to mark the events that already processed by this service
- name - the data service name
- versionMarker - the data service version
Contains parameters for synchronization with Zephyr
- issueFormat - the regular expression to match the event that corresponds to the issue
- delimiter - the delimiter to use to extract version and cycle from the root event
- statusMapping - mapping between event status and status in Zephyr. NOTE: mapping for SUCCESS and FAILED event statuses is required
- jobAwaitTimeout - the timeout to await the job for adding test to a cycle/folder
- relatedIssuesStrategies - configures the strategies to find the additional issues related to the currently processing one. They will be updated using the version, cycle and folder for the current issue.
- testExecutionMode - defines how the test execution should be reported. By default, it tries to update an existing execution. You can change the behavior by using CREATE_NEW value. The default value it UPDATE_LAST.
- versionPattern - the regexp that will be used to match the version part for Zephyr Scale events structure see structure here.
Has no effect for Zephyr SQUAD. The default value is
(((\d+)|([a-zA-Z]+))\.?)+(please do not forget to escape\by adding another one before\\) - customFields - the custom fields that should be added to the test case execution. It is a mapping between field name and how its value should be computed.
Has no effect for Zephyr SQUAD.
The value can be:
- some constant value
customFields: "Const Field": type: const value: 42
- extracted from event (ID, NAME)
customFields: "From Event Field": type: event extract: ID
- extracted from related JIRA information (VERSION, ACCOUNT_ID, ACCOUNT_NAME)
customFields: "From Jira Field": type: jira extract: VERSION
- some constant value
- cachesConfiguration - configuration that will be applied to the internal caches inside the zephyr processors (e.g. cycles cache)
- cycles - configuration for cycle caching
- size - cache size. Default value is 100.
- expireAfterSeconds - element expiration time in seconds. Default value is 86400 (1 day).
- invalidateAt - time in UTC (e.g. 00:00:00) when all values in cache should be invalidated. Repeats every day.
By default,
nullmeaning no scheduled invalidation is configured
- cycles - configuration for cycle caching
All strategies should be configured in the following way:
relatedIssuesStrategies:
- type: <strat type>
strategySpecificParameters:
#...
- type: <another strat>
strategySpecificParameters:
#...Finds the issues that are linked to the current one. Uses configuration to decide which links should be taken into account. Configuration example:
relatedIssuesStrategies:
- type: linked
trackLinkedIssues:
- linkName: "is cloned by"
whitelist:
- projectKey: P1
issues:
- TEST-3
- projectName: "P2 Project"
issues:
- TEST-1
- TEST-2
- linkName: "is similar to"
direction: INWARD # or OUTWARD
whitelist:
- projectKey: P1
issues:
- TEST-42
- linkName: "is duplicated by"
disable: true
whitelist:
- projectKey: P3
issues:
- *- trackLinkedIssues - the list of links to track
- linkName - the link name to track. Can be found in the JIRA in Issue Links/Linked Issues block. Required parameter
- direction - the link direction. Can be used to clarify which link to use if the linkName for both directions is the same. Possible values are: INWARD - another issue is linked to us. OUTWARD - we are linked to another issue.
- disable - you can disable the tracking of the specific link in the configuration
- whitelist - the list contains information about which issues should be taken to follow and for which projects.
E.g. we have issue A-42 that is cloned by the issue B-42 (project B).
If the issue A-42 is in the whitelist for project B this link will be followed
- projectKey - project identifier. It is inner key for JIRA
- projectName - project name in JIRA. Can be used instead of projectKey. NOTE: only one of the parameters projectKey or projectName can be used
- issues - the set of issues for with the link with specified type should be tracked if the linked issues belongs to the specified project.
If you want to allow to track any issue which has links with specified type and linked issue belongs to the specified project
you can use wildcard mark
*
Contains parameters to set up the Logging for inner HTTP clients that are used to connect to the Jira and Zephyr
- level - level logging for HTTP client. Available levels: ALL, HEADERS, BODY, INFO, NONE
The data processor zephyr requires the link to the data provider working in gRPC mode. Link example:
apiVersion: th2.exactpro.com/v1
kind: Th2Link
metadata:
name: zephyr-service-links
spec:
boxes-relation:
router-grpc:
- name: data-service-zephyr-to-data-provider
from:
strategy: filter
box: zephyr-service
pin: to_data_provider
to:
service-class: com.exactpro.th2.dataprovider.grpc.DataProviderService
strategy: robin
box: data-provider
pin: server- Parameters to configure when cycle cache for Zephyr Scale processor is invalidated. Please refer to configuration block.
- Support for Zephyr Scale Cloud. Separate zephyrUrl parameter was added to support different URL for Jira and Zephyr
By default it has the same value as baseUrl.
NOTE: the testExecutionMode UPDATE_LAST is not support by Zephyr Scale Cloud
- Dependencies update:
- BOM (3.0.0 -> 4.4.0)
- Kotlin (1.5.32 -> 1.6.21)
- th2 common (3.39.2 -> 3.44.1)
- JIRA rest Java client (5.2.2 -> 5.2.6)
- Ktor (1.6.5 -> 1.6.8)
- Support for Zephyr Scale Server
- Strategies for finding related issues
- Create strategy for following issue links
- th2-common - https://github.com/th2-net/th2-common-j