The Zowe Conformance Test Evaluation Guide is a set of self-certify and self-service tests to help the developer community integrate and extend specific technology into the Zowe framework.
Below are the requirements for the available conformance programs. Items marked (required) are required for achieving conformance in a given program.
Zowe API Mediation layer - 2019
...
- An application provides at least one service or UI (required)
...
- A service must be registered using one of the following methods: (required)
Dynamic registration - preferred (best practice)
Static definition - minimum requirement
- The service must provide a default service ID that is prefixed by the provider name (for example: `acme`, `xyzcorp`, `bar`). (required)
- The service ID must be configurable externally after deployment. (required)
- The service ID must written in lower case, contain no symbols, and is limited to 64 characters. (required)
- The API ID must follow the same rules as for Java packages. The example of the API ID: zowe.apiml.apicatalog. (required)
- The published service URL must follow the gateway URL conventions. (required)
- For versioned APIs, service URLs must contain a service version before the service ID in the following formats:
- api/v1/{serviceId} reserved for REST APIs
- ui/v1/{serviceId} reserved for UIs
- ws/v1/{serviceId} reserved for WebSockets
For non-versioned APIs or APIs versioned differently (e.g. z/OSMF), use the following formats:
- api/{serviceId} reserved for REST APIs
- ui/{serviceId} reserved for UIs
- ws/{serviceId} reserved for WebSockets
(required)
...
- Documentation is Swagger/Open API 2.0 compliant. (required)
- Every public resource is documented with a description of each resource. (required)
- Every method of each REST endpoint is documented. (required)
- Every method of each REST endpoint is demonstrated by an example. (required)
- Every parameter (headers, query parameters, payload, cookies, etc.) is documented with definitions of all possible values and their associated meanings. (required)
- Every error code, including errors returned in the payload is documented. (required)
...
- Encoded slash is not used. (required)
- The service interprets values independent of their URL encoding. (required)
- lowerCamelCase is used for names of resources, parameters, and JSON properties.
...
- API - Request and response payloads are in JSON or binary data format.
- API - In JSON format, links are relative, and must not contain the schema, hostname, and port. (required)
- WebSocket - Service URIs contained in WebSocket messages payload are addressed through the API ML Gateway. (required)
- UI - UI uses relative links and does not contain the schema, hostname, and port. (required)
...
- Resources are protected by mainframe credentials. (required)
- Services accept basic authentication (minimum requirement). (required)
- Services accept Zowe JWT token in the cookie.
...
- Service implementation follows the semantic versioning model.
- Last two major versions are supported by API services. (required)
...
- UI uses only relative URLs. (required)
...
- WebSocket connection creation, all subsequent communication between WebSocket client, and server is routed through the API ML Gateway. (required)
- WebSocket connections are closed by the initiator through API ML Gateway. (required)
Zowe CLI - 2019
...
- Plug-in is constructed on the Imperative CLI Framework. (required)
- Plug-in is NOT run as a standalone CLI. (required)
- Plug-in commands write to stdout or stderr via Imperative Framework response.console APIs. (required)
...
- Plug-in is installable with the zowe plugins install command. (required)
- Plug-in is installable into the @lts-incremental version of the core Zowe CLI and follows semantic versioning. (required)
- Plug-in is uninstallable via the zowe plugins uninstall command. (required)
...
- If the plug-in introduces a command group name, it does not conflict with existing conformant plug-in group names. (required)
...
- If the plug-in has unique connection details, it introduces a profile that lets users store these details for repeated use. (required)
- Plug-in users are able to override all profile settings via the command line and/or environment variables.
Zowe App Framework – 2019
...
- Every plugin must have a unique ID. The ID format follows java package naming conventions. The Zowe project reserves org.zowe. (required)
- Every plugin and each of its services must have a version. (required)
- Directory layout adheres to the ZLUX App filesystem structure. (required)
- Source code layout is recommended adheres to the ZLUX App filesystem structure for tooling consistency.
...
- All Apps must contain an icon image file to represent it, located at web/assets/icon.png within the App's package. (required)
...
- IFrame Apps (apps with framework type "iframe") which embed a top-level iframe within (example: https://github.com/zowe/api-layer/blob/master/zlux-api-catalog/web/index.html) must use the ID "zluxIframe" for that element. This is required for the app to be a recipient of app to app communication. (required)
...
- DOM elements originating from your App should always be a child of the Zowe viewport DOM element, "com-rs-mvd-viewport". (required)
- Network requests to the Zowe App Server must never be done without the use of the URI Broker. (required)
- Access to resources outside the App Server should also be made through the URI Broker whenever possible.
- Apps must not pollute the global namespace with regards Javascript, HTML, and CSS. (required)
- When using a library present in the Zowe App Framework core, you must depend on the same version. (required)
- Web apps should extend the framework's default build scripts for webpack and typescript.
...
- Apps should follow the UI Design guidelines at https://github.com/zowe/zlc/blob/master/process/UI_GUIDELINES.md
...
- The active language to be used for string selection must be retrieved using ZoweZLUX.globalization.getLanguage(), which determines language by multiple factors. (required)
- No strings visible in a UI should be hard-coded, rather resource strings must be used in accordance with one of the existing internationalization support mechanisms.
...
- Data services should be written such that all synchronous and asynchronous errors are caught. Utilize try-catch and check the existence of error objects from asynchronous calls. Uncaught exceptions effect server responsiveness and disrupt clients. (required)
...
- Every HTTP API must be documented in swagger 2.0. The swagger document must be stored in doc/swagger. (required)
- In addition, it is recommended to have documentation about the format of any Websocket APIs, to be placed within doc.
...
- An Apps non-IFrame web components, or App Framework dataservices (eg Javascript and Typescript) must log only through the "zlux" logger. (required)
- ZSS services log only through the Zowe ZSS Logger. (required)
- Passwords must never be logged. (required)
- Error reporting should follow the standard tooling.
...
Complete this form for each Participant (e.g., company or other entity) that desires to participate in the Zowe Conformance Program and to use the Conformance Marks. The Project Word Mark and the Conformance Marks are trademarks of The Linux Foundation. Capitalized terms used herein and not otherwise defined shall have the same meanings set forth in the Program Terms.
By signing below and submitting this form to The Linux Foundation:
- The Participant agrees to the Terms and Conditions of the Zowe Conformance Program (the “Program Terms”), available at https://www.openmainframeproject.org/projects/zowe/conformance/terms-and-conditions
- The Participant confirms that the products and services identified below as Qualifying Offerings either (a) have passed all of the tests that are marked required below, as described in the Test Evaluation Guide at https://www.openmainframeproject.org/projects/zowe/conformance/test-evaluation-guide, and are Qualifying Offerings under the Program Terms; or (b) prior to usage of the Conformance Marks, will pass all of the tests described in the Test Evaluation Guide, and will be Qualifying Offerings under the Program Terms.
- The Participant confirms that it has submitted, or will submit, to The Linux Foundation the results of the tests prior to its first public use of the Conformance Marks associated with the corresponding version of the Zowe Conformance Program.
- The Participant confirms that it will either (a) maintain conformance of the Qualifying Offerings with the Test Evaluation Guide, or (b) cease use of the Conformance Marks if the products or services cease to be Qualifying Offerings.
- The Participant confirms that it will promptly submit an updated Participant Form to The Linux Foundation prior to using the Conformance Marks with Qualifying Offerings not listed here.
- I confirm that I am authorized to make the above statements and to submit this form on behalf of the Participant.
Participant Information
Company / Entity name: ___________________________________________________
Contact address: ___________________________________________________
___________________________________________________
___________________________________________________
Contact telephone: ___________________________________________________
Contact email: ___________________________________________________
Select one: [ ] Participant is a member of Open Mainframe Project
[ ] Participant is NOT a member of the Open Mainframe Project. Please contact Open Mainframe Project at omp-zowe-conformance@lists.openmainframeproject.org to discuss fees for participation in the conformance program.
Qualifying Offerings
Name, brief description and URLs for more information: ________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
Conformance Details
Initial Version and Components of Zowe Conformance Program tests for Conformance. Please verify and comment where needed that the participating offering has achieved the conformance criteria for each conformance type. A participating offering may submit for one or more of the Zowe Conformance types (API Mediation Layer, CLI, and/or App Framework) in a single application. For more details on the testing criteria, please refer to the Test Evaluation Guide.
[ ] Zowe API Mediation layer - 2019
Please list any items where your offering does not meet the criteria set forth in the Test Evaluation Guide:
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
[ ] Zowe CLI - 2019
Please list any items where your offering does not meet the criteria set forth in the Test Evaluation Guide:
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
[ ] Zowe App Framework - 2019
Please list any items where your offering does not meet the criteria set forth in the Test Evaluation Guide:
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
__________________________________________________________________
Conformance Submission Date: __________________
Signed on behalf of Participant by:
__________________________________
Name: ____________________________
Title: ____________________________
Date: ____________________________